lfs.c 142 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734
  1. /*
  2. * The little filesystem
  3. *
  4. * Copyright (c) 2017, Arm Limited. All rights reserved.
  5. * SPDX-License-Identifier: BSD-3-Clause
  6. */
  7. #include "lfs.h"
  8. #include "lfs_util.h"
  9. /// Caching block device operations ///
  10. static inline void lfs_cache_drop(lfs_t *lfs, lfs_cache_t *rcache) {
  11. // do not zero, cheaper if cache is readonly or only going to be
  12. // written with identical data (during relocates)
  13. (void)lfs;
  14. rcache->block = 0xffffffff;
  15. }
  16. static inline void lfs_cache_zero(lfs_t *lfs, lfs_cache_t *pcache) {
  17. // zero to avoid information leak
  18. memset(pcache->buffer, 0xff, lfs->cfg->cache_size);
  19. pcache->block = 0xffffffff;
  20. }
  21. static int lfs_bd_read(lfs_t *lfs,
  22. const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
  23. lfs_block_t block, lfs_off_t off,
  24. void *buffer, lfs_size_t size) {
  25. uint8_t *data = buffer;
  26. LFS_ASSERT(block != 0xffffffff);
  27. if (off+size > lfs->cfg->block_size) {
  28. return LFS_ERR_CORRUPT;
  29. }
  30. while (size > 0) {
  31. lfs_size_t diff = size;
  32. if (pcache && block == pcache->block &&
  33. off < pcache->off + pcache->size) {
  34. if (off >= pcache->off) {
  35. // is already in pcache?
  36. diff = lfs_min(diff, pcache->size - (off-pcache->off));
  37. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  38. data += diff;
  39. off += diff;
  40. size -= diff;
  41. continue;
  42. }
  43. // pcache takes priority
  44. diff = lfs_min(diff, pcache->off-off);
  45. }
  46. if (block == rcache->block &&
  47. off < rcache->off + rcache->size) {
  48. if (off >= rcache->off) {
  49. // is already in rcache?
  50. diff = lfs_min(diff, rcache->size - (off-rcache->off));
  51. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  52. data += diff;
  53. off += diff;
  54. size -= diff;
  55. continue;
  56. }
  57. // rcache takes priority
  58. diff = lfs_min(diff, rcache->off-off);
  59. }
  60. // load to cache, first condition can no longer fail
  61. LFS_ASSERT(block < lfs->cfg->block_count);
  62. rcache->block = block;
  63. rcache->off = lfs_aligndown(off, lfs->cfg->read_size);
  64. rcache->size = lfs_min(
  65. lfs_min(
  66. lfs_alignup(off+hint, lfs->cfg->read_size),
  67. lfs->cfg->block_size)
  68. - rcache->off,
  69. lfs->cfg->cache_size);
  70. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  71. rcache->off, rcache->buffer, rcache->size);
  72. LFS_ASSERT(err <= 0);
  73. if (err) {
  74. return err;
  75. }
  76. }
  77. return 0;
  78. }
  79. enum {
  80. LFS_CMP_EQ = 0,
  81. LFS_CMP_LT = 1,
  82. LFS_CMP_GT = 2,
  83. };
  84. static int lfs_bd_cmp(lfs_t *lfs,
  85. const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
  86. lfs_block_t block, lfs_off_t off,
  87. const void *buffer, lfs_size_t size) {
  88. const uint8_t *data = buffer;
  89. for (lfs_off_t i = 0; i < size; i++) {
  90. uint8_t dat;
  91. int err = lfs_bd_read(lfs,
  92. pcache, rcache, hint-i,
  93. block, off+i, &dat, 1);
  94. if (err) {
  95. return err;
  96. }
  97. if (dat != data[i]) {
  98. return (dat < data[i]) ? LFS_CMP_LT : LFS_CMP_GT;
  99. }
  100. }
  101. return LFS_CMP_EQ;
  102. }
  103. static int lfs_bd_flush(lfs_t *lfs,
  104. lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate) {
  105. if (pcache->block != 0xffffffff && pcache->block != 0xfffffffe) {
  106. LFS_ASSERT(pcache->block < lfs->cfg->block_count);
  107. lfs_size_t diff = lfs_alignup(pcache->size, lfs->cfg->prog_size);
  108. int err = lfs->cfg->prog(lfs->cfg, pcache->block,
  109. pcache->off, pcache->buffer, diff);
  110. LFS_ASSERT(err <= 0);
  111. if (err) {
  112. return err;
  113. }
  114. if (validate) {
  115. // check data on disk
  116. lfs_cache_drop(lfs, rcache);
  117. int res = lfs_bd_cmp(lfs,
  118. NULL, rcache, diff,
  119. pcache->block, pcache->off, pcache->buffer, diff);
  120. if (res < 0) {
  121. return res;
  122. }
  123. if (res != LFS_CMP_EQ) {
  124. return LFS_ERR_CORRUPT;
  125. }
  126. }
  127. lfs_cache_zero(lfs, pcache);
  128. }
  129. return 0;
  130. }
  131. static int lfs_bd_sync(lfs_t *lfs,
  132. lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate) {
  133. lfs_cache_drop(lfs, rcache);
  134. int err = lfs_bd_flush(lfs, pcache, rcache, validate);
  135. if (err) {
  136. return err;
  137. }
  138. err = lfs->cfg->sync(lfs->cfg);
  139. LFS_ASSERT(err <= 0);
  140. return err;
  141. }
  142. static int lfs_bd_prog(lfs_t *lfs,
  143. lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate,
  144. lfs_block_t block, lfs_off_t off,
  145. const void *buffer, lfs_size_t size) {
  146. const uint8_t *data = buffer;
  147. LFS_ASSERT(block != 0xffffffff);
  148. LFS_ASSERT(off + size <= lfs->cfg->block_size);
  149. while (size > 0) {
  150. if (block == pcache->block &&
  151. off >= pcache->off &&
  152. off < pcache->off + lfs->cfg->cache_size) {
  153. // already fits in pcache?
  154. lfs_size_t diff = lfs_min(size,
  155. lfs->cfg->cache_size - (off-pcache->off));
  156. memcpy(&pcache->buffer[off-pcache->off], data, diff);
  157. data += diff;
  158. off += diff;
  159. size -= diff;
  160. pcache->size = lfs_max(pcache->size, off - pcache->off);
  161. if (pcache->size == lfs->cfg->cache_size) {
  162. // eagerly flush out pcache if we fill up
  163. int err = lfs_bd_flush(lfs, pcache, rcache, validate);
  164. if (err) {
  165. return err;
  166. }
  167. }
  168. continue;
  169. }
  170. // pcache must have been flushed, either by programming and
  171. // entire block or manually flushing the pcache
  172. LFS_ASSERT(pcache->block == 0xffffffff);
  173. // prepare pcache, first condition can no longer fail
  174. pcache->block = block;
  175. pcache->off = lfs_aligndown(off, lfs->cfg->prog_size);
  176. pcache->size = 0;
  177. }
  178. return 0;
  179. }
  180. static int lfs_bd_erase(lfs_t *lfs, lfs_block_t block) {
  181. LFS_ASSERT(block < lfs->cfg->block_count);
  182. int err = lfs->cfg->erase(lfs->cfg, block);
  183. LFS_ASSERT(err <= 0);
  184. return err;
  185. }
  186. /// Small type-level utilities ///
  187. // operations on block pairs
  188. static inline void lfs_pair_swap(lfs_block_t pair[2]) {
  189. lfs_block_t t = pair[0];
  190. pair[0] = pair[1];
  191. pair[1] = t;
  192. }
  193. static inline bool lfs_pair_isnull(const lfs_block_t pair[2]) {
  194. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  195. }
  196. static inline int lfs_pair_cmp(
  197. const lfs_block_t paira[2],
  198. const lfs_block_t pairb[2]) {
  199. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  200. paira[0] == pairb[1] || paira[1] == pairb[0]);
  201. }
  202. static inline bool lfs_pair_sync(
  203. const lfs_block_t paira[2],
  204. const lfs_block_t pairb[2]) {
  205. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  206. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  207. }
  208. static inline void lfs_pair_fromle32(lfs_block_t pair[2]) {
  209. pair[0] = lfs_fromle32(pair[0]);
  210. pair[1] = lfs_fromle32(pair[1]);
  211. }
  212. static inline void lfs_pair_tole32(lfs_block_t pair[2]) {
  213. pair[0] = lfs_tole32(pair[0]);
  214. pair[1] = lfs_tole32(pair[1]);
  215. }
  216. // operations on 32-bit entry tags
  217. typedef uint32_t lfs_tag_t;
  218. typedef int32_t lfs_stag_t;
  219. #define LFS_MKTAG(type, id, size) \
  220. (((lfs_tag_t)(type) << 20) | ((lfs_tag_t)(id) << 10) | (lfs_tag_t)(size))
  221. static inline bool lfs_tag_isvalid(lfs_tag_t tag) {
  222. return !(tag & 0x80000000);
  223. }
  224. static inline bool lfs_tag_isdelete(lfs_tag_t tag) {
  225. return ((int32_t)(tag << 22) >> 22) == -1;
  226. }
  227. static inline uint16_t lfs_tag_type1(lfs_tag_t tag) {
  228. return (tag & 0x70000000) >> 20;
  229. }
  230. static inline uint16_t lfs_tag_type3(lfs_tag_t tag) {
  231. return (tag & 0x7ff00000) >> 20;
  232. }
  233. static inline uint8_t lfs_tag_chunk(lfs_tag_t tag) {
  234. return (tag & 0x0ff00000) >> 20;
  235. }
  236. static inline int8_t lfs_tag_splice(lfs_tag_t tag) {
  237. return (int8_t)lfs_tag_chunk(tag);
  238. }
  239. static inline uint16_t lfs_tag_id(lfs_tag_t tag) {
  240. return (tag & 0x000ffc00) >> 10;
  241. }
  242. static inline lfs_size_t lfs_tag_size(lfs_tag_t tag) {
  243. return tag & 0x000003ff;
  244. }
  245. static inline lfs_size_t lfs_tag_dsize(lfs_tag_t tag) {
  246. return sizeof(tag) + lfs_tag_size(tag + lfs_tag_isdelete(tag));
  247. }
  248. // operations on attributes in attribute lists
  249. struct lfs_mattr {
  250. lfs_tag_t tag;
  251. const void *buffer;
  252. };
  253. struct lfs_diskoff {
  254. lfs_block_t block;
  255. lfs_off_t off;
  256. };
  257. #define LFS_MKATTRS(...) \
  258. (struct lfs_mattr[]){__VA_ARGS__}, \
  259. sizeof((struct lfs_mattr[]){__VA_ARGS__}) / sizeof(struct lfs_mattr)
  260. // operations on global state
  261. static inline void lfs_gstate_xor(struct lfs_gstate *a,
  262. const struct lfs_gstate *b) {
  263. for (int i = 0; i < 3; i++) {
  264. ((uint32_t*)a)[i] ^= ((const uint32_t*)b)[i];
  265. }
  266. }
  267. static inline bool lfs_gstate_iszero(const struct lfs_gstate *a) {
  268. for (int i = 0; i < 3; i++) {
  269. if (((uint32_t*)a)[i] != 0) {
  270. return false;
  271. }
  272. }
  273. return true;
  274. }
  275. static inline bool lfs_gstate_hasorphans(const struct lfs_gstate *a) {
  276. return lfs_tag_size(a->tag);
  277. }
  278. static inline uint8_t lfs_gstate_getorphans(const struct lfs_gstate *a) {
  279. return lfs_tag_size(a->tag);
  280. }
  281. static inline bool lfs_gstate_hasmove(const struct lfs_gstate *a) {
  282. return lfs_tag_type1(a->tag);
  283. }
  284. static inline bool lfs_gstate_hasmovehere(const struct lfs_gstate *a,
  285. const lfs_block_t *pair) {
  286. return lfs_tag_type1(a->tag) && lfs_pair_cmp(a->pair, pair) == 0;
  287. }
  288. static inline void lfs_gstate_xororphans(struct lfs_gstate *a,
  289. const struct lfs_gstate *b, bool orphans) {
  290. a->tag ^= LFS_MKTAG(0x800, 0, 0) & (b->tag ^ (orphans << 31));
  291. }
  292. static inline void lfs_gstate_xormove(struct lfs_gstate *a,
  293. const struct lfs_gstate *b, uint16_t id, const lfs_block_t pair[2]) {
  294. a->tag ^= LFS_MKTAG(0x7ff, 0x3ff, 0) & (b->tag ^ (
  295. (id != 0x3ff) ? LFS_MKTAG(LFS_TYPE_DELETE, id, 0) : 0));
  296. a->pair[0] ^= b->pair[0] ^ ((id != 0x3ff) ? pair[0] : 0);
  297. a->pair[1] ^= b->pair[1] ^ ((id != 0x3ff) ? pair[1] : 0);
  298. }
  299. static inline void lfs_gstate_fromle32(struct lfs_gstate *a) {
  300. a->tag = lfs_fromle32(a->tag);
  301. a->pair[0] = lfs_fromle32(a->pair[0]);
  302. a->pair[1] = lfs_fromle32(a->pair[1]);
  303. }
  304. static inline void lfs_gstate_tole32(struct lfs_gstate *a) {
  305. a->tag = lfs_tole32(a->tag);
  306. a->pair[0] = lfs_tole32(a->pair[0]);
  307. a->pair[1] = lfs_tole32(a->pair[1]);
  308. }
  309. // other endianness operations
  310. static void lfs_ctz_fromle32(struct lfs_ctz *ctz) {
  311. ctz->head = lfs_fromle32(ctz->head);
  312. ctz->size = lfs_fromle32(ctz->size);
  313. }
  314. static void lfs_ctz_tole32(struct lfs_ctz *ctz) {
  315. ctz->head = lfs_tole32(ctz->head);
  316. ctz->size = lfs_tole32(ctz->size);
  317. }
  318. static inline void lfs_superblock_fromle32(lfs_superblock_t *superblock) {
  319. superblock->version = lfs_fromle32(superblock->version);
  320. superblock->block_size = lfs_fromle32(superblock->block_size);
  321. superblock->block_count = lfs_fromle32(superblock->block_count);
  322. superblock->name_max = lfs_fromle32(superblock->name_max);
  323. superblock->file_max = lfs_fromle32(superblock->file_max);
  324. superblock->attr_max = lfs_fromle32(superblock->attr_max);
  325. }
  326. static inline void lfs_superblock_tole32(lfs_superblock_t *superblock) {
  327. superblock->version = lfs_tole32(superblock->version);
  328. superblock->block_size = lfs_tole32(superblock->block_size);
  329. superblock->block_count = lfs_tole32(superblock->block_count);
  330. superblock->name_max = lfs_tole32(superblock->name_max);
  331. superblock->file_max = lfs_tole32(superblock->file_max);
  332. superblock->attr_max = lfs_tole32(superblock->attr_max);
  333. }
  334. /// Internal operations predeclared here ///
  335. static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
  336. const struct lfs_mattr *attrs, int attrcount);
  337. static int lfs_dir_compact(lfs_t *lfs,
  338. lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
  339. lfs_mdir_t *source, uint16_t begin, uint16_t end);
  340. static int lfs_file_outline(lfs_t *lfs, lfs_file_t *file);
  341. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file);
  342. static void lfs_fs_preporphans(lfs_t *lfs, int8_t orphans);
  343. static void lfs_fs_prepmove(lfs_t *lfs,
  344. uint16_t id, const lfs_block_t pair[2]);
  345. static int lfs_fs_pred(lfs_t *lfs, const lfs_block_t dir[2],
  346. lfs_mdir_t *pdir);
  347. static lfs_stag_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  348. lfs_mdir_t *parent);
  349. static int lfs_fs_relocate(lfs_t *lfs,
  350. const lfs_block_t oldpair[2], lfs_block_t newpair[2]);
  351. static int lfs_fs_forceconsistency(lfs_t *lfs);
  352. static int lfs_deinit(lfs_t *lfs);
  353. #ifdef LFS_MIGRATE
  354. static int lfs1_traverse(lfs_t *lfs,
  355. int (*cb)(void*, lfs_block_t), void *data);
  356. #endif
  357. /// Block allocator ///
  358. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  359. lfs_t *lfs = (lfs_t*)p;
  360. lfs_block_t off = ((block - lfs->free.off)
  361. + lfs->cfg->block_count) % lfs->cfg->block_count;
  362. if (off < lfs->free.size) {
  363. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  364. }
  365. return 0;
  366. }
  367. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  368. while (true) {
  369. while (lfs->free.i != lfs->free.size) {
  370. lfs_block_t off = lfs->free.i;
  371. lfs->free.i += 1;
  372. lfs->free.ack -= 1;
  373. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  374. // found a free block
  375. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  376. // eagerly find next off so an alloc ack can
  377. // discredit old lookahead blocks
  378. while (lfs->free.i != lfs->free.size &&
  379. (lfs->free.buffer[lfs->free.i / 32]
  380. & (1U << (lfs->free.i % 32)))) {
  381. lfs->free.i += 1;
  382. lfs->free.ack -= 1;
  383. }
  384. return 0;
  385. }
  386. }
  387. // check if we have looked at all blocks since last ack
  388. if (lfs->free.ack == 0) {
  389. LFS_ERROR("No more free space %"PRIu32,
  390. lfs->free.i + lfs->free.off);
  391. return LFS_ERR_NOSPC;
  392. }
  393. lfs->free.off = (lfs->free.off + lfs->free.size)
  394. % lfs->cfg->block_count;
  395. lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size, lfs->free.ack);
  396. lfs->free.i = 0;
  397. // find mask of free blocks from tree
  398. memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
  399. int err = lfs_fs_traverse(lfs, lfs_alloc_lookahead, lfs);
  400. if (err) {
  401. return err;
  402. }
  403. }
  404. }
  405. static void lfs_alloc_ack(lfs_t *lfs) {
  406. lfs->free.ack = lfs->cfg->block_count;
  407. }
  408. /// Metadata pair and directory operations ///
  409. static lfs_stag_t lfs_dir_getslice(lfs_t *lfs, const lfs_mdir_t *dir,
  410. lfs_tag_t gmask, lfs_tag_t gtag,
  411. lfs_off_t goff, void *gbuffer, lfs_size_t gsize) {
  412. lfs_off_t off = dir->off;
  413. lfs_tag_t ntag = dir->etag;
  414. lfs_stag_t gdiff = 0;
  415. if (lfs_gstate_hasmovehere(&lfs->gstate, dir->pair) &&
  416. lfs_tag_id(gtag) <= lfs_tag_id(lfs->gstate.tag)) {
  417. // synthetic moves
  418. gdiff -= LFS_MKTAG(0, 1, 0);
  419. }
  420. // iterate over dir block backwards (for faster lookups)
  421. while (off >= sizeof(lfs_tag_t) + lfs_tag_dsize(ntag)) {
  422. off -= lfs_tag_dsize(ntag);
  423. lfs_tag_t tag = ntag;
  424. int err = lfs_bd_read(lfs,
  425. NULL, &lfs->rcache, sizeof(ntag),
  426. dir->pair[0], off, &ntag, sizeof(ntag));
  427. if (err) {
  428. return err;
  429. }
  430. ntag = (lfs_frombe32(ntag) ^ tag) & 0x7fffffff;
  431. if (lfs_tag_id(gmask) != 0 &&
  432. lfs_tag_type1(tag) == LFS_TYPE_SPLICE &&
  433. lfs_tag_id(tag) <= lfs_tag_id(gtag - gdiff)) {
  434. if (tag == (LFS_MKTAG(LFS_TYPE_CREATE, 0, 0) |
  435. (LFS_MKTAG(0, 0x3ff, 0) & (gtag - gdiff)))) {
  436. // found where we were created
  437. return LFS_ERR_NOENT;
  438. }
  439. // move around splices
  440. gdiff += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
  441. }
  442. if ((gmask & tag) == (gmask & (gtag - gdiff))) {
  443. if (lfs_tag_isdelete(tag)) {
  444. return LFS_ERR_NOENT;
  445. }
  446. lfs_size_t diff = lfs_min(lfs_tag_size(tag), gsize);
  447. err = lfs_bd_read(lfs,
  448. NULL, &lfs->rcache, diff,
  449. dir->pair[0], off+sizeof(tag)+goff, gbuffer, diff);
  450. if (err) {
  451. return err;
  452. }
  453. memset((uint8_t*)gbuffer + diff, 0, gsize - diff);
  454. return tag + gdiff;
  455. }
  456. }
  457. return LFS_ERR_NOENT;
  458. }
  459. static lfs_stag_t lfs_dir_get(lfs_t *lfs, const lfs_mdir_t *dir,
  460. lfs_tag_t gmask, lfs_tag_t gtag, void *buffer) {
  461. return lfs_dir_getslice(lfs, dir,
  462. gmask, gtag,
  463. 0, buffer, lfs_tag_size(gtag));
  464. }
  465. static int lfs_dir_getread(lfs_t *lfs, const lfs_mdir_t *dir,
  466. const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
  467. lfs_tag_t gmask, lfs_tag_t gtag,
  468. lfs_off_t off, void *buffer, lfs_size_t size) {
  469. uint8_t *data = buffer;
  470. if (off+size > lfs->cfg->block_size) {
  471. return LFS_ERR_CORRUPT;
  472. }
  473. while (size > 0) {
  474. lfs_size_t diff = size;
  475. if (pcache && pcache->block == 0xfffffffe &&
  476. off < pcache->off + pcache->size) {
  477. if (off >= pcache->off) {
  478. // is already in pcache?
  479. diff = lfs_min(diff, pcache->size - (off-pcache->off));
  480. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  481. data += diff;
  482. off += diff;
  483. size -= diff;
  484. continue;
  485. }
  486. // pcache takes priority
  487. diff = lfs_min(diff, pcache->off-off);
  488. }
  489. if (rcache->block == 0xfffffffe &&
  490. off < rcache->off + rcache->size) {
  491. if (off >= rcache->off) {
  492. // is already in rcache?
  493. diff = lfs_min(diff, rcache->size - (off-rcache->off));
  494. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  495. data += diff;
  496. off += diff;
  497. size -= diff;
  498. continue;
  499. }
  500. // rcache takes priority
  501. diff = lfs_min(diff, rcache->off-off);
  502. }
  503. // load to cache, first condition can no longer fail
  504. rcache->block = 0xfffffffe;
  505. rcache->off = lfs_aligndown(off, lfs->cfg->read_size);
  506. rcache->size = lfs_min(lfs_alignup(off+hint, lfs->cfg->read_size),
  507. lfs->cfg->cache_size);
  508. int err = lfs_dir_getslice(lfs, dir, gmask, gtag,
  509. rcache->off, rcache->buffer, rcache->size);
  510. if (err < 0) {
  511. return err;
  512. }
  513. }
  514. return 0;
  515. }
  516. static int lfs_dir_traverse_filter(void *p,
  517. lfs_tag_t tag, const void *buffer) {
  518. lfs_tag_t *filtertag = p;
  519. (void)buffer;
  520. // which mask depends on unique bit in tag structure
  521. uint32_t mask = (tag & LFS_MKTAG(0x100, 0, 0))
  522. ? LFS_MKTAG(0x7ff, 0x3ff, 0)
  523. : LFS_MKTAG(0x700, 0x3ff, 0);
  524. // check for redundancy
  525. if ((mask & tag) == (mask & *filtertag) ||
  526. lfs_tag_isdelete(*filtertag) ||
  527. (LFS_MKTAG(0x7ff, 0x3ff, 0) & tag) == (
  528. LFS_MKTAG(LFS_TYPE_DELETE, 0, 0) |
  529. (LFS_MKTAG(0, 0x3ff, 0) & *filtertag))) {
  530. return true;
  531. }
  532. // check if we need to adjust for created/deleted tags
  533. if (lfs_tag_type1(tag) == LFS_TYPE_SPLICE &&
  534. lfs_tag_id(tag) <= lfs_tag_id(*filtertag)) {
  535. *filtertag += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
  536. }
  537. return false;
  538. }
  539. static int lfs_dir_traverse(lfs_t *lfs,
  540. const lfs_mdir_t *dir, lfs_off_t off, lfs_tag_t ptag,
  541. const struct lfs_mattr *attrs, int attrcount, bool hasseenmove,
  542. lfs_tag_t tmask, lfs_tag_t ttag,
  543. uint16_t begin, uint16_t end, int16_t diff,
  544. int (*cb)(void *data, lfs_tag_t tag, const void *buffer), void *data) {
  545. // iterate over directory and attrs
  546. while (true) {
  547. lfs_tag_t tag;
  548. const void *buffer;
  549. struct lfs_diskoff disk;
  550. if (off+lfs_tag_dsize(ptag) < dir->off) {
  551. off += lfs_tag_dsize(ptag);
  552. int err = lfs_bd_read(lfs,
  553. NULL, &lfs->rcache, sizeof(tag),
  554. dir->pair[0], off, &tag, sizeof(tag));
  555. if (err) {
  556. return err;
  557. }
  558. tag = (lfs_frombe32(tag) ^ ptag) | 0x80000000;
  559. disk.block = dir->pair[0];
  560. disk.off = off+sizeof(lfs_tag_t);
  561. buffer = &disk;
  562. ptag = tag;
  563. } else if (attrcount > 0) {
  564. tag = attrs[0].tag;
  565. buffer = attrs[0].buffer;
  566. attrs += 1;
  567. attrcount -= 1;
  568. } else if (!hasseenmove &&
  569. lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  570. // Wait, we have pending move? Handle this here (we need to
  571. // or else we risk letting moves fall out of date)
  572. tag = lfs->gpending.tag & LFS_MKTAG(0x7ff, 0x3ff, 0);
  573. buffer = NULL;
  574. hasseenmove = true;
  575. } else {
  576. return 0;
  577. }
  578. lfs_tag_t mask = LFS_MKTAG(0x7ff, 0, 0);
  579. if ((mask & tmask & tag) != (mask & tmask & ttag)) {
  580. continue;
  581. }
  582. // do we need to filter? inlining the filtering logic here allows
  583. // for some minor optimizations
  584. if (lfs_tag_id(tmask) != 0) {
  585. // scan for duplicates and update tag based on creates/deletes
  586. int filter = lfs_dir_traverse(lfs,
  587. dir, off, ptag, attrs, attrcount, hasseenmove,
  588. 0, 0, 0, 0, 0,
  589. lfs_dir_traverse_filter, &tag);
  590. if (filter < 0) {
  591. return filter;
  592. }
  593. if (filter) {
  594. continue;
  595. }
  596. // in filter range?
  597. if (!(lfs_tag_id(tag) >= begin && lfs_tag_id(tag) < end)) {
  598. continue;
  599. }
  600. }
  601. // handle special cases for mcu-side operations
  602. if (lfs_tag_type3(tag) == LFS_FROM_NOOP) {
  603. // do nothing
  604. } else if (lfs_tag_type3(tag) == LFS_FROM_MOVE) {
  605. uint16_t fromid = lfs_tag_size(tag);
  606. uint16_t toid = lfs_tag_id(tag);
  607. int err = lfs_dir_traverse(lfs,
  608. buffer, 0, 0xffffffff, NULL, 0, true,
  609. LFS_MKTAG(0x600, 0x3ff, 0),
  610. LFS_MKTAG(LFS_TYPE_STRUCT, 0, 0),
  611. fromid, fromid+1, toid-fromid+diff,
  612. cb, data);
  613. if (err) {
  614. return err;
  615. }
  616. } else if (lfs_tag_type3(tag) == LFS_FROM_USERATTRS) {
  617. for (unsigned i = 0; i < lfs_tag_size(tag); i++) {
  618. const struct lfs_attr *a = buffer;
  619. int err = cb(data, LFS_MKTAG(LFS_TYPE_USERATTR + a[i].type,
  620. lfs_tag_id(tag) + diff, a[i].size), a[i].buffer);
  621. if (err) {
  622. return err;
  623. }
  624. }
  625. } else {
  626. int err = cb(data, tag + LFS_MKTAG(0, diff, 0), buffer);
  627. if (err) {
  628. return err;
  629. }
  630. }
  631. }
  632. }
  633. static lfs_stag_t lfs_dir_fetchmatch(lfs_t *lfs,
  634. lfs_mdir_t *dir, const lfs_block_t pair[2],
  635. lfs_tag_t fmask, lfs_tag_t ftag, uint16_t *id,
  636. int (*cb)(void *data, lfs_tag_t tag, const void *buffer), void *data) {
  637. // we can find tag very efficiently during a fetch, since we're already
  638. // scanning the entire directory
  639. lfs_stag_t besttag = -1;
  640. // find the block with the most recent revision
  641. uint32_t revs[2] = {0, 0};
  642. int r = 0;
  643. for (int i = 0; i < 2; i++) {
  644. int err = lfs_bd_read(lfs,
  645. NULL, &lfs->rcache, sizeof(revs[i]),
  646. pair[i], 0, &revs[i], sizeof(revs[i]));
  647. revs[i] = lfs_fromle32(revs[i]);
  648. if (err && err != LFS_ERR_CORRUPT) {
  649. return err;
  650. }
  651. if (err != LFS_ERR_CORRUPT &&
  652. lfs_scmp(revs[i], revs[(i+1)%2]) > 0) {
  653. r = i;
  654. }
  655. }
  656. dir->pair[0] = pair[(r+0)%2];
  657. dir->pair[1] = pair[(r+1)%2];
  658. dir->rev = revs[(r+0)%2];
  659. dir->off = 0; // nonzero = found some commits
  660. // now scan tags to fetch the actual dir and find possible match
  661. for (int i = 0; i < 2; i++) {
  662. lfs_off_t off = 0;
  663. lfs_tag_t ptag = 0xffffffff;
  664. uint16_t tempcount = 0;
  665. lfs_block_t temptail[2] = {0xffffffff, 0xffffffff};
  666. bool tempsplit = false;
  667. lfs_stag_t tempbesttag = besttag;
  668. dir->rev = lfs_tole32(dir->rev);
  669. uint32_t crc = lfs_crc(0xffffffff, &dir->rev, sizeof(dir->rev));
  670. dir->rev = lfs_fromle32(dir->rev);
  671. while (true) {
  672. // extract next tag
  673. lfs_tag_t tag;
  674. off += lfs_tag_dsize(ptag);
  675. int err = lfs_bd_read(lfs,
  676. NULL, &lfs->rcache, lfs->cfg->block_size,
  677. dir->pair[0], off, &tag, sizeof(tag));
  678. if (err) {
  679. if (err == LFS_ERR_CORRUPT) {
  680. // can't continue?
  681. dir->erased = false;
  682. break;
  683. }
  684. return err;
  685. }
  686. crc = lfs_crc(crc, &tag, sizeof(tag));
  687. tag = lfs_frombe32(tag) ^ ptag;
  688. // next commit not yet programmed or we're not in valid range
  689. if (!lfs_tag_isvalid(tag) ||
  690. off + lfs_tag_dsize(tag) > lfs->cfg->block_size) {
  691. dir->erased = (lfs_tag_type1(ptag) == LFS_TYPE_CRC &&
  692. dir->off % lfs->cfg->prog_size == 0);
  693. break;
  694. }
  695. ptag = tag;
  696. if (lfs_tag_type1(tag) == LFS_TYPE_CRC) {
  697. // check the crc attr
  698. uint32_t dcrc;
  699. err = lfs_bd_read(lfs,
  700. NULL, &lfs->rcache, lfs->cfg->block_size,
  701. dir->pair[0], off+sizeof(tag), &dcrc, sizeof(dcrc));
  702. if (err) {
  703. if (err == LFS_ERR_CORRUPT) {
  704. dir->erased = false;
  705. break;
  706. }
  707. return err;
  708. }
  709. dcrc = lfs_fromle32(dcrc);
  710. if (crc != dcrc) {
  711. dir->erased = false;
  712. break;
  713. }
  714. // reset the next bit if we need to
  715. ptag ^= (lfs_tag_chunk(tag) & 1U) << 31;
  716. // toss our crc into the filesystem seed for
  717. // pseudorandom numbers
  718. lfs->seed ^= crc;
  719. // update with what's found so far
  720. besttag = tempbesttag;
  721. dir->off = off + lfs_tag_dsize(tag);
  722. dir->etag = ptag;
  723. dir->count = tempcount;
  724. dir->tail[0] = temptail[0];
  725. dir->tail[1] = temptail[1];
  726. dir->split = tempsplit;
  727. // reset crc
  728. crc = 0xffffffff;
  729. continue;
  730. }
  731. // crc the entry first, hopefully leaving it in the cache
  732. for (lfs_off_t j = sizeof(tag); j < lfs_tag_dsize(tag); j++) {
  733. uint8_t dat;
  734. err = lfs_bd_read(lfs,
  735. NULL, &lfs->rcache, lfs->cfg->block_size,
  736. dir->pair[0], off+j, &dat, 1);
  737. if (err) {
  738. if (err == LFS_ERR_CORRUPT) {
  739. dir->erased = false;
  740. break;
  741. }
  742. return err;
  743. }
  744. crc = lfs_crc(crc, &dat, 1);
  745. }
  746. // directory modification tags?
  747. if (lfs_tag_type1(tag) == LFS_TYPE_NAME) {
  748. // increase count of files if necessary
  749. if (lfs_tag_id(tag) >= tempcount) {
  750. tempcount = lfs_tag_id(tag) + 1;
  751. }
  752. } else if (lfs_tag_type1(tag) == LFS_TYPE_SPLICE) {
  753. tempcount += lfs_tag_splice(tag);
  754. if (tag == (LFS_MKTAG(LFS_TYPE_DELETE, 0, 0) |
  755. (LFS_MKTAG(0, 0x3ff, 0) & tempbesttag))) {
  756. tempbesttag |= 0x80000000;
  757. } else if (tempbesttag != -1 &&
  758. lfs_tag_id(tag) <= lfs_tag_id(tempbesttag)) {
  759. tempbesttag += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
  760. }
  761. } else if (lfs_tag_type1(tag) == LFS_TYPE_TAIL) {
  762. tempsplit = (lfs_tag_chunk(tag) & 1);
  763. err = lfs_bd_read(lfs,
  764. NULL, &lfs->rcache, lfs->cfg->block_size,
  765. dir->pair[0], off+sizeof(tag), &temptail, 8);
  766. if (err) {
  767. if (err == LFS_ERR_CORRUPT) {
  768. dir->erased = false;
  769. break;
  770. }
  771. }
  772. lfs_pair_fromle32(temptail);
  773. }
  774. // found a match for our fetcher?
  775. if ((fmask & tag) == (fmask & ftag)) {
  776. int res = cb(data, tag, &(struct lfs_diskoff){
  777. dir->pair[0], off+sizeof(tag)});
  778. if (res < 0) {
  779. if (res == LFS_ERR_CORRUPT) {
  780. dir->erased = false;
  781. break;
  782. }
  783. return res;
  784. }
  785. if (res == LFS_CMP_EQ) {
  786. // found a match
  787. tempbesttag = tag;
  788. } else if (res == LFS_CMP_GT &&
  789. lfs_tag_id(tag) <= lfs_tag_id(tempbesttag)) {
  790. // found a greater match, keep track to keep things sorted
  791. tempbesttag = tag | 0x80000000;
  792. }
  793. }
  794. }
  795. // consider what we have good enough
  796. if (dir->off > 0) {
  797. // synthetic move
  798. if (lfs_gstate_hasmovehere(&lfs->gstate, dir->pair)) {
  799. if (lfs_tag_id(lfs->gstate.tag) == lfs_tag_id(besttag)) {
  800. besttag |= 0x80000000;
  801. } else if (besttag != -1 &&
  802. lfs_tag_id(lfs->gstate.tag) < lfs_tag_id(besttag)) {
  803. besttag -= LFS_MKTAG(0, 1, 0);
  804. }
  805. }
  806. // found tag? or found best id?
  807. if (id) {
  808. *id = lfs_min(lfs_tag_id(besttag), dir->count);
  809. }
  810. if (lfs_tag_isvalid(besttag)) {
  811. return besttag;
  812. } else if (lfs_tag_id(besttag) < dir->count) {
  813. return LFS_ERR_NOENT;
  814. } else {
  815. return 0;
  816. }
  817. }
  818. // failed, try the other block?
  819. lfs_pair_swap(dir->pair);
  820. dir->rev = revs[(r+1)%2];
  821. }
  822. LFS_ERROR("Corrupted dir pair at %"PRIx32" %"PRIx32,
  823. dir->pair[0], dir->pair[1]);
  824. return LFS_ERR_CORRUPT;
  825. }
  826. static int lfs_dir_fetch(lfs_t *lfs,
  827. lfs_mdir_t *dir, const lfs_block_t pair[2]) {
  828. // note, mask=-1, tag=0 can never match a tag since this
  829. // pattern has the invalid bit set
  830. return lfs_dir_fetchmatch(lfs, dir, pair, -1, 0, NULL, NULL, NULL);
  831. }
  832. static int lfs_dir_getgstate(lfs_t *lfs, const lfs_mdir_t *dir,
  833. struct lfs_gstate *gstate) {
  834. struct lfs_gstate temp;
  835. lfs_stag_t res = lfs_dir_get(lfs, dir, LFS_MKTAG(0x7ff, 0, 0),
  836. LFS_MKTAG(LFS_TYPE_MOVESTATE, 0, sizeof(temp)), &temp);
  837. if (res < 0 && res != LFS_ERR_NOENT) {
  838. return res;
  839. }
  840. if (res != LFS_ERR_NOENT) {
  841. // xor together to find resulting gstate
  842. lfs_gstate_fromle32(&temp);
  843. lfs_gstate_xor(gstate, &temp);
  844. }
  845. return 0;
  846. }
  847. static int lfs_dir_getinfo(lfs_t *lfs, lfs_mdir_t *dir,
  848. uint16_t id, struct lfs_info *info) {
  849. if (id == 0x3ff) {
  850. // special case for root
  851. strcpy(info->name, "/");
  852. info->type = LFS_TYPE_DIR;
  853. return 0;
  854. }
  855. lfs_stag_t tag = lfs_dir_get(lfs, dir, LFS_MKTAG(0x780, 0x3ff, 0),
  856. LFS_MKTAG(LFS_TYPE_NAME, id, lfs->name_max+1), info->name);
  857. if (tag < 0) {
  858. return tag;
  859. }
  860. info->type = lfs_tag_type3(tag);
  861. struct lfs_ctz ctz;
  862. tag = lfs_dir_get(lfs, dir, LFS_MKTAG(0x700, 0x3ff, 0),
  863. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  864. if (tag < 0) {
  865. return tag;
  866. }
  867. lfs_ctz_fromle32(&ctz);
  868. if (lfs_tag_type3(tag) == LFS_TYPE_CTZSTRUCT) {
  869. info->size = ctz.size;
  870. } else if (lfs_tag_type3(tag) == LFS_TYPE_INLINESTRUCT) {
  871. info->size = lfs_tag_size(tag);
  872. }
  873. return 0;
  874. }
  875. struct lfs_dir_find_match {
  876. lfs_t *lfs;
  877. const void *name;
  878. lfs_size_t size;
  879. };
  880. static int lfs_dir_find_match(void *data,
  881. lfs_tag_t tag, const void *buffer) {
  882. struct lfs_dir_find_match *name = data;
  883. lfs_t *lfs = name->lfs;
  884. const struct lfs_diskoff *disk = buffer;
  885. // compare with disk
  886. lfs_size_t diff = lfs_min(name->size, lfs_tag_size(tag));
  887. int res = lfs_bd_cmp(lfs,
  888. NULL, &lfs->rcache, diff,
  889. disk->block, disk->off, name->name, diff);
  890. if (res != LFS_CMP_EQ) {
  891. return res;
  892. }
  893. // only equal if our size is still the same
  894. if (name->size != lfs_tag_size(tag)) {
  895. return (name->size < lfs_tag_size(tag)) ? LFS_CMP_LT : LFS_CMP_GT;
  896. }
  897. // found a match!
  898. return LFS_CMP_EQ;
  899. }
  900. static int lfs_dir_find(lfs_t *lfs, lfs_mdir_t *dir,
  901. const char **path, uint16_t *id) {
  902. // we reduce path to a single name if we can find it
  903. const char *name = *path;
  904. if (id) {
  905. *id = 0x3ff;
  906. }
  907. // default to root dir
  908. lfs_stag_t tag = LFS_MKTAG(LFS_TYPE_DIR, 0x3ff, 0);
  909. dir->tail[0] = lfs->root[0];
  910. dir->tail[1] = lfs->root[1];
  911. while (true) {
  912. nextname:
  913. // skip slashes
  914. name += strspn(name, "/");
  915. lfs_size_t namelen = strcspn(name, "/");
  916. // skip '.' and root '..'
  917. if ((namelen == 1 && memcmp(name, ".", 1) == 0) ||
  918. (namelen == 2 && memcmp(name, "..", 2) == 0)) {
  919. name += namelen;
  920. goto nextname;
  921. }
  922. // skip if matched by '..' in name
  923. const char *suffix = name + namelen;
  924. lfs_size_t sufflen;
  925. int depth = 1;
  926. while (true) {
  927. suffix += strspn(suffix, "/");
  928. sufflen = strcspn(suffix, "/");
  929. if (sufflen == 0) {
  930. break;
  931. }
  932. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  933. depth -= 1;
  934. if (depth == 0) {
  935. name = suffix + sufflen;
  936. goto nextname;
  937. }
  938. } else {
  939. depth += 1;
  940. }
  941. suffix += sufflen;
  942. }
  943. // found path
  944. if (name[0] == '\0') {
  945. return tag;
  946. }
  947. // update what we've found so far
  948. *path = name;
  949. // only continue if we hit a directory
  950. if (lfs_tag_type3(tag) != LFS_TYPE_DIR) {
  951. return LFS_ERR_NOTDIR;
  952. }
  953. // grab the entry data
  954. if (lfs_tag_id(tag) != 0x3ff) {
  955. lfs_stag_t res = lfs_dir_get(lfs, dir, LFS_MKTAG(0x700, 0x3ff, 0),
  956. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), dir->tail);
  957. if (res < 0) {
  958. return res;
  959. }
  960. lfs_pair_fromle32(dir->tail);
  961. }
  962. // find entry matching name
  963. while (true) {
  964. tag = lfs_dir_fetchmatch(lfs, dir, dir->tail,
  965. LFS_MKTAG(0x780, 0, 0),
  966. LFS_MKTAG(LFS_TYPE_NAME, 0, namelen),
  967. // are we last name?
  968. (strchr(name, '/') == NULL) ? id : NULL,
  969. lfs_dir_find_match, &(struct lfs_dir_find_match){
  970. lfs, name, namelen});
  971. if (tag < 0) {
  972. return tag;
  973. }
  974. if (tag) {
  975. break;
  976. }
  977. if (!dir->split) {
  978. return LFS_ERR_NOENT;
  979. }
  980. }
  981. // to next name
  982. name += namelen;
  983. }
  984. }
  985. // commit logic
  986. struct lfs_commit {
  987. lfs_block_t block;
  988. lfs_off_t off;
  989. lfs_tag_t ptag;
  990. uint32_t crc;
  991. lfs_off_t begin;
  992. lfs_off_t end;
  993. };
  994. static int lfs_dir_commitprog(lfs_t *lfs, struct lfs_commit *commit,
  995. const void *buffer, lfs_size_t size) {
  996. int err = lfs_bd_prog(lfs,
  997. &lfs->pcache, &lfs->rcache, false,
  998. commit->block, commit->off ,
  999. (const uint8_t*)buffer, size);
  1000. if (err) {
  1001. return err;
  1002. }
  1003. commit->crc = lfs_crc(commit->crc, buffer, size);
  1004. commit->off += size;
  1005. return 0;
  1006. }
  1007. static int lfs_dir_commitattr(lfs_t *lfs, struct lfs_commit *commit,
  1008. lfs_tag_t tag, const void *buffer) {
  1009. // check if we fit
  1010. lfs_size_t dsize = lfs_tag_dsize(tag);
  1011. if (commit->off + dsize > commit->end) {
  1012. return LFS_ERR_NOSPC;
  1013. }
  1014. // write out tag
  1015. lfs_tag_t ntag = lfs_tobe32((tag & 0x7fffffff) ^ commit->ptag);
  1016. int err = lfs_dir_commitprog(lfs, commit, &ntag, sizeof(ntag));
  1017. if (err) {
  1018. return err;
  1019. }
  1020. if (!(tag & 0x80000000)) {
  1021. // from memory
  1022. err = lfs_dir_commitprog(lfs, commit, buffer, dsize-sizeof(tag));
  1023. if (err) {
  1024. return err;
  1025. }
  1026. } else {
  1027. // from disk
  1028. const struct lfs_diskoff *disk = buffer;
  1029. for (lfs_off_t i = 0; i < dsize-sizeof(tag); i++) {
  1030. // rely on caching to make this efficient
  1031. uint8_t dat;
  1032. err = lfs_bd_read(lfs,
  1033. NULL, &lfs->rcache, dsize-sizeof(tag)-i,
  1034. disk->block, disk->off+i, &dat, 1);
  1035. if (err) {
  1036. return err;
  1037. }
  1038. err = lfs_dir_commitprog(lfs, commit, &dat, 1);
  1039. if (err) {
  1040. return err;
  1041. }
  1042. }
  1043. }
  1044. commit->ptag = tag & 0x7fffffff;
  1045. return 0;
  1046. }
  1047. static int lfs_dir_commitcrc(lfs_t *lfs, struct lfs_commit *commit) {
  1048. // align to program units
  1049. const lfs_off_t off1 = commit->off + sizeof(lfs_tag_t);
  1050. const lfs_off_t end = lfs_alignup(off1 + sizeof(uint32_t),
  1051. lfs->cfg->prog_size);
  1052. // create crc tags to fill up remainder of commit, note that
  1053. // padding is not crcd, which lets fetches skip padding but
  1054. // makes committing a bit more complicated
  1055. while (commit->off < end) {
  1056. lfs_off_t off = commit->off + sizeof(lfs_tag_t);
  1057. lfs_off_t noff = lfs_min(end - off, 0x3fe) + off;
  1058. if (noff < end) {
  1059. noff = lfs_min(noff, end - 2*sizeof(uint32_t));
  1060. }
  1061. // read erased state from next program unit
  1062. lfs_tag_t tag = 0xffffffff;
  1063. int err = lfs_bd_read(lfs,
  1064. NULL, &lfs->rcache, sizeof(tag),
  1065. commit->block, noff, &tag, sizeof(tag));
  1066. if (err && err != LFS_ERR_CORRUPT) {
  1067. return err;
  1068. }
  1069. // build crc tag
  1070. bool reset = ~lfs_frombe32(tag) >> 31;
  1071. tag = LFS_MKTAG(LFS_TYPE_CRC + reset, 0x3ff, noff - off);
  1072. // write out crc
  1073. uint32_t footer[2];
  1074. footer[0] = lfs_tobe32(tag ^ commit->ptag);
  1075. commit->crc = lfs_crc(commit->crc, &footer[0], sizeof(footer[0]));
  1076. footer[1] = lfs_tole32(commit->crc);
  1077. err = lfs_bd_prog(lfs,
  1078. &lfs->pcache, &lfs->rcache, false,
  1079. commit->block, commit->off, &footer, sizeof(footer));
  1080. if (err) {
  1081. return err;
  1082. }
  1083. commit->off += sizeof(tag)+lfs_tag_size(tag);
  1084. commit->ptag = tag ^ (reset << 31);
  1085. commit->crc = 0xffffffff; // reset crc for next "commit"
  1086. }
  1087. // flush buffers
  1088. int err = lfs_bd_sync(lfs, &lfs->pcache, &lfs->rcache, false);
  1089. if (err) {
  1090. return err;
  1091. }
  1092. // successful commit, check checksums to make sure
  1093. lfs_off_t off = commit->begin;
  1094. lfs_off_t noff = off1;
  1095. while (off < end) {
  1096. uint32_t crc = 0xffffffff;
  1097. for (lfs_off_t i = off; i < noff+sizeof(uint32_t); i++) {
  1098. // leave it up to caching to make this efficient
  1099. uint8_t dat;
  1100. err = lfs_bd_read(lfs,
  1101. NULL, &lfs->rcache, noff+sizeof(uint32_t)-i,
  1102. commit->block, i, &dat, 1);
  1103. if (err) {
  1104. return err;
  1105. }
  1106. crc = lfs_crc(crc, &dat, 1);
  1107. }
  1108. // detected write error?
  1109. if (crc != 0) {
  1110. return LFS_ERR_CORRUPT;
  1111. }
  1112. // skip padding
  1113. off = lfs_min(end - noff, 0x3fe) + noff;
  1114. if (off < end) {
  1115. off = lfs_min(off, end - 2*sizeof(uint32_t));
  1116. }
  1117. noff = off + sizeof(uint32_t);
  1118. }
  1119. return 0;
  1120. }
  1121. static int lfs_dir_alloc(lfs_t *lfs, lfs_mdir_t *dir) {
  1122. // allocate pair of dir blocks (backwards, so we write block 1 first)
  1123. for (int i = 0; i < 2; i++) {
  1124. int err = lfs_alloc(lfs, &dir->pair[(i+1)%2]);
  1125. if (err) {
  1126. return err;
  1127. }
  1128. }
  1129. // rather than clobbering one of the blocks we just pretend
  1130. // the revision may be valid
  1131. int err = lfs_bd_read(lfs,
  1132. NULL, &lfs->rcache, sizeof(dir->rev),
  1133. dir->pair[0], 0, &dir->rev, sizeof(dir->rev));
  1134. dir->rev = lfs_fromle32(dir->rev);
  1135. if (err && err != LFS_ERR_CORRUPT) {
  1136. return err;
  1137. }
  1138. // make sure we don't immediately evict
  1139. dir->rev += dir->rev & 1;
  1140. // set defaults
  1141. dir->off = sizeof(dir->rev);
  1142. dir->etag = 0xffffffff;
  1143. dir->count = 0;
  1144. dir->tail[0] = 0xffffffff;
  1145. dir->tail[1] = 0xffffffff;
  1146. dir->erased = false;
  1147. dir->split = false;
  1148. // don't write out yet, let caller take care of that
  1149. return 0;
  1150. }
  1151. static int lfs_dir_drop(lfs_t *lfs, lfs_mdir_t *dir, lfs_mdir_t *tail) {
  1152. // steal state
  1153. int err = lfs_dir_getgstate(lfs, tail, &lfs->gdelta);
  1154. if (err) {
  1155. return err;
  1156. }
  1157. // steal tail
  1158. lfs_pair_tole32(tail->tail);
  1159. err = lfs_dir_commit(lfs, dir, LFS_MKATTRS(
  1160. {LFS_MKTAG(LFS_TYPE_TAIL + tail->split, 0x3ff, 8), tail->tail}));
  1161. lfs_pair_fromle32(tail->tail);
  1162. if (err) {
  1163. return err;
  1164. }
  1165. return 0;
  1166. }
  1167. static int lfs_dir_split(lfs_t *lfs,
  1168. lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
  1169. lfs_mdir_t *source, uint16_t split, uint16_t end) {
  1170. // create tail directory
  1171. lfs_mdir_t tail;
  1172. int err = lfs_dir_alloc(lfs, &tail);
  1173. if (err) {
  1174. return err;
  1175. }
  1176. tail.split = dir->split;
  1177. tail.tail[0] = dir->tail[0];
  1178. tail.tail[1] = dir->tail[1];
  1179. err = lfs_dir_compact(lfs, &tail, attrs, attrcount, source, split, end);
  1180. if (err) {
  1181. return err;
  1182. }
  1183. dir->tail[0] = tail.pair[0];
  1184. dir->tail[1] = tail.pair[1];
  1185. dir->split = true;
  1186. // update root if needed
  1187. if (lfs_pair_cmp(dir->pair, lfs->root) == 0 && split == 0) {
  1188. lfs->root[0] = tail.pair[0];
  1189. lfs->root[1] = tail.pair[1];
  1190. }
  1191. return 0;
  1192. }
  1193. static int lfs_dir_commit_size(void *p, lfs_tag_t tag, const void *buffer) {
  1194. lfs_size_t *size = p;
  1195. (void)buffer;
  1196. *size += lfs_tag_dsize(tag);
  1197. return 0;
  1198. }
  1199. struct lfs_dir_commit_commit {
  1200. lfs_t *lfs;
  1201. struct lfs_commit *commit;
  1202. };
  1203. static int lfs_dir_commit_commit(void *p, lfs_tag_t tag, const void *buffer) {
  1204. struct lfs_dir_commit_commit *commit = p;
  1205. return lfs_dir_commitattr(commit->lfs, commit->commit, tag, buffer);
  1206. }
  1207. static int lfs_dir_compact(lfs_t *lfs,
  1208. lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
  1209. lfs_mdir_t *source, uint16_t begin, uint16_t end) {
  1210. // save some state in case block is bad
  1211. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  1212. bool relocated = false;
  1213. bool exhausted = false;
  1214. // should we split?
  1215. while (end - begin > 1) {
  1216. // find size
  1217. lfs_size_t size = 0;
  1218. int err = lfs_dir_traverse(lfs,
  1219. source, 0, 0xffffffff, attrs, attrcount, false,
  1220. LFS_MKTAG(0x400, 0x3ff, 0),
  1221. LFS_MKTAG(LFS_TYPE_NAME, 0, 0),
  1222. begin, end, -begin,
  1223. lfs_dir_commit_size, &size);
  1224. if (err) {
  1225. return err;
  1226. }
  1227. // space is complicated, we need room for tail, crc, gstate,
  1228. // cleanup delete, and we cap at half a block to give room
  1229. // for metadata updates.
  1230. if (end - begin < 0xff &&
  1231. size <= lfs_min(lfs->cfg->block_size - 36,
  1232. lfs_alignup(lfs->cfg->block_size/2,
  1233. lfs->cfg->prog_size))) {
  1234. break;
  1235. }
  1236. // can't fit, need to split, we should really be finding the
  1237. // largest size that fits with a small binary search, but right now
  1238. // it's not worth the code size
  1239. uint16_t split = (end - begin) / 2;
  1240. err = lfs_dir_split(lfs, dir, attrs, attrcount,
  1241. source, begin+split, end);
  1242. if (err) {
  1243. // if we fail to split, we may be able to overcompact, unless
  1244. // we're too big for even the full block, in which case our
  1245. // only option is to error
  1246. if (err == LFS_ERR_NOSPC && size <= lfs->cfg->block_size - 36) {
  1247. break;
  1248. }
  1249. return err;
  1250. }
  1251. end = begin + split;
  1252. }
  1253. // increment revision count
  1254. dir->rev += 1;
  1255. if (lfs->cfg->block_cycles > 0 &&
  1256. (dir->rev % (lfs->cfg->block_cycles+1) == 0)) {
  1257. if (lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) == 0) {
  1258. // oh no! we're writing too much to the superblock,
  1259. // should we expand?
  1260. lfs_ssize_t res = lfs_fs_size(lfs);
  1261. if (res < 0) {
  1262. return res;
  1263. }
  1264. // do we have extra space? littlefs can't reclaim this space
  1265. // by itself, so expand cautiously
  1266. if ((lfs_size_t)res < lfs->cfg->block_count/2) {
  1267. LFS_DEBUG("Expanding superblock at rev %"PRIu32, dir->rev);
  1268. int err = lfs_dir_split(lfs, dir, attrs, attrcount,
  1269. source, begin, end);
  1270. if (err && err != LFS_ERR_NOSPC) {
  1271. return err;
  1272. }
  1273. // welp, we tried, if we ran out of space there's not much
  1274. // we can do, we'll error later if we've become frozen
  1275. if (!err) {
  1276. end = begin;
  1277. }
  1278. }
  1279. #if LFS_MIGRATE
  1280. } else if (lfs_pair_cmp(dir->pair, lfs->root) == 0 && lfs->lfs1) {
  1281. // we can't relocate our root during migrations, as this would
  1282. // cause the superblock to get updated, which would clobber v1
  1283. #endif
  1284. } else {
  1285. // we're writing too much, time to relocate
  1286. exhausted = true;
  1287. goto relocate;
  1288. }
  1289. }
  1290. // begin loop to commit compaction to blocks until a compact sticks
  1291. while (true) {
  1292. {
  1293. // There's nothing special about our global delta, so feed it into
  1294. // our local global delta
  1295. int err = lfs_dir_getgstate(lfs, dir, &lfs->gdelta);
  1296. if (err) {
  1297. return err;
  1298. }
  1299. // setup commit state
  1300. struct lfs_commit commit = {
  1301. .block = dir->pair[1],
  1302. .off = 0,
  1303. .ptag = 0xffffffff,
  1304. .crc = 0xffffffff,
  1305. .begin = 0,
  1306. .end = lfs->cfg->block_size - 8,
  1307. };
  1308. // erase block to write to
  1309. err = lfs_bd_erase(lfs, dir->pair[1]);
  1310. if (err) {
  1311. if (err == LFS_ERR_CORRUPT) {
  1312. goto relocate;
  1313. }
  1314. return err;
  1315. }
  1316. // write out header
  1317. dir->rev = lfs_tole32(dir->rev);
  1318. err = lfs_dir_commitprog(lfs, &commit,
  1319. &dir->rev, sizeof(dir->rev));
  1320. dir->rev = lfs_fromle32(dir->rev);
  1321. if (err) {
  1322. if (err == LFS_ERR_CORRUPT) {
  1323. goto relocate;
  1324. }
  1325. return err;
  1326. }
  1327. // traverse the directory, this time writing out all unique tags
  1328. err = lfs_dir_traverse(lfs,
  1329. source, 0, 0xffffffff, attrs, attrcount, false,
  1330. LFS_MKTAG(0x400, 0x3ff, 0),
  1331. LFS_MKTAG(LFS_TYPE_NAME, 0, 0),
  1332. begin, end, -begin,
  1333. lfs_dir_commit_commit, &(struct lfs_dir_commit_commit){
  1334. lfs, &commit});
  1335. if (err) {
  1336. if (err == LFS_ERR_CORRUPT) {
  1337. goto relocate;
  1338. }
  1339. return err;
  1340. }
  1341. // commit tail, which may be new after last size check
  1342. if (!lfs_pair_isnull(dir->tail)) {
  1343. lfs_pair_tole32(dir->tail);
  1344. err = lfs_dir_commitattr(lfs, &commit,
  1345. LFS_MKTAG(LFS_TYPE_TAIL + dir->split, 0x3ff, 8),
  1346. dir->tail);
  1347. lfs_pair_fromle32(dir->tail);
  1348. if (err) {
  1349. if (err == LFS_ERR_CORRUPT) {
  1350. goto relocate;
  1351. }
  1352. return err;
  1353. }
  1354. }
  1355. if (!relocated && !lfs_gstate_iszero(&lfs->gdelta)) {
  1356. // commit any globals, unless we're relocating,
  1357. // in which case our parent will steal our globals
  1358. lfs_gstate_tole32(&lfs->gdelta);
  1359. err = lfs_dir_commitattr(lfs, &commit,
  1360. LFS_MKTAG(LFS_TYPE_MOVESTATE, 0x3ff,
  1361. sizeof(lfs->gdelta)), &lfs->gdelta);
  1362. lfs_gstate_fromle32(&lfs->gdelta);
  1363. if (err) {
  1364. if (err == LFS_ERR_CORRUPT) {
  1365. goto relocate;
  1366. }
  1367. return err;
  1368. }
  1369. }
  1370. err = lfs_dir_commitcrc(lfs, &commit);
  1371. if (err) {
  1372. if (err == LFS_ERR_CORRUPT) {
  1373. goto relocate;
  1374. }
  1375. return err;
  1376. }
  1377. // successful compaction, swap dir pair to indicate most recent
  1378. LFS_ASSERT(commit.off % lfs->cfg->prog_size == 0);
  1379. lfs_pair_swap(dir->pair);
  1380. dir->count = end - begin;
  1381. dir->off = commit.off;
  1382. dir->etag = commit.ptag;
  1383. // note we able to have already handled move here
  1384. if (lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  1385. lfs_gstate_xormove(&lfs->gpending,
  1386. &lfs->gpending, 0x3ff, NULL);
  1387. }
  1388. }
  1389. break;
  1390. relocate:
  1391. // commit was corrupted, drop caches and prepare to relocate block
  1392. relocated = true;
  1393. lfs_cache_drop(lfs, &lfs->pcache);
  1394. if (!exhausted) {
  1395. LFS_DEBUG("Bad block at %"PRIx32, dir->pair[1]);
  1396. }
  1397. // can't relocate superblock, filesystem is now frozen
  1398. if (lfs_pair_cmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  1399. LFS_WARN("Superblock %"PRIx32" has become unwritable", oldpair[1]);
  1400. return LFS_ERR_NOSPC;
  1401. }
  1402. // relocate half of pair
  1403. int err = lfs_alloc(lfs, &dir->pair[1]);
  1404. if (err && (err != LFS_ERR_NOSPC && !exhausted)) {
  1405. return err;
  1406. }
  1407. continue;
  1408. }
  1409. if (!relocated) {
  1410. lfs->gstate = lfs->gpending;
  1411. lfs->gdelta = (struct lfs_gstate){0};
  1412. } else {
  1413. // update references if we relocated
  1414. LFS_DEBUG("Relocating %"PRIx32" %"PRIx32" -> %"PRIx32" %"PRIx32,
  1415. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  1416. int err = lfs_fs_relocate(lfs, oldpair, dir->pair);
  1417. if (err) {
  1418. return err;
  1419. }
  1420. }
  1421. return 0;
  1422. }
  1423. static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
  1424. const struct lfs_mattr *attrs, int attrcount) {
  1425. // check for any inline files that aren't RAM backed and
  1426. // forcefully evict them, needed for filesystem consistency
  1427. for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
  1428. if (dir != &f->m && lfs_pair_cmp(f->m.pair, dir->pair) == 0 &&
  1429. f->type == LFS_TYPE_REG && (f->flags & LFS_F_INLINE) &&
  1430. f->ctz.size > lfs->cfg->cache_size) {
  1431. int err = lfs_file_outline(lfs, f);
  1432. if (err) {
  1433. return err;
  1434. }
  1435. err = lfs_file_flush(lfs, f);
  1436. if (err) {
  1437. return err;
  1438. }
  1439. }
  1440. }
  1441. // calculate changes to the directory
  1442. lfs_tag_t deletetag = 0xffffffff;
  1443. lfs_tag_t createtag = 0xffffffff;
  1444. for (int i = 0; i < attrcount; i++) {
  1445. if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_CREATE) {
  1446. createtag = attrs[i].tag;
  1447. dir->count += 1;
  1448. } else if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_DELETE) {
  1449. deletetag = attrs[i].tag;
  1450. LFS_ASSERT(dir->count > 0);
  1451. dir->count -= 1;
  1452. } else if (lfs_tag_type1(attrs[i].tag) == LFS_TYPE_TAIL) {
  1453. dir->tail[0] = ((lfs_block_t*)attrs[i].buffer)[0];
  1454. dir->tail[1] = ((lfs_block_t*)attrs[i].buffer)[1];
  1455. dir->split = (lfs_tag_chunk(attrs[i].tag) & 1);
  1456. lfs_pair_fromle32(dir->tail);
  1457. }
  1458. }
  1459. // do we have a pending move?
  1460. if (lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  1461. deletetag = lfs->gpending.tag & LFS_MKTAG(0x7ff, 0x3ff, 0);
  1462. LFS_ASSERT(dir->count > 0);
  1463. dir->count -= 1;
  1464. // mark gdelta so we reflect the move we will fix
  1465. lfs_gstate_xormove(&lfs->gdelta, &lfs->gpending, 0x3ff, NULL);
  1466. }
  1467. // should we actually drop the directory block?
  1468. if (lfs_tag_isvalid(deletetag) && dir->count == 0) {
  1469. lfs_mdir_t pdir;
  1470. int err = lfs_fs_pred(lfs, dir->pair, &pdir);
  1471. if (err && err != LFS_ERR_NOENT) {
  1472. return err;
  1473. }
  1474. if (err != LFS_ERR_NOENT && pdir.split) {
  1475. return lfs_dir_drop(lfs, &pdir, dir);
  1476. }
  1477. }
  1478. if (dir->erased || dir->count >= 0xff) {
  1479. // try to commit
  1480. struct lfs_commit commit = {
  1481. .block = dir->pair[0],
  1482. .off = dir->off,
  1483. .ptag = dir->etag,
  1484. .crc = 0xffffffff,
  1485. .begin = dir->off,
  1486. .end = lfs->cfg->block_size - 8,
  1487. };
  1488. // traverse attrs that need to be written out
  1489. lfs_pair_tole32(dir->tail);
  1490. int err = lfs_dir_traverse(lfs,
  1491. dir, dir->off, dir->etag, attrs, attrcount, false,
  1492. 0, 0, 0, 0, 0,
  1493. lfs_dir_commit_commit, &(struct lfs_dir_commit_commit){
  1494. lfs, &commit});
  1495. lfs_pair_fromle32(dir->tail);
  1496. if (err) {
  1497. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1498. goto compact;
  1499. }
  1500. return err;
  1501. }
  1502. // commit any global diffs if we have any
  1503. if (!lfs_gstate_iszero(&lfs->gdelta)) {
  1504. err = lfs_dir_getgstate(lfs, dir, &lfs->gdelta);
  1505. if (err) {
  1506. return err;
  1507. }
  1508. lfs_gstate_tole32(&lfs->gdelta);
  1509. err = lfs_dir_commitattr(lfs, &commit,
  1510. LFS_MKTAG(LFS_TYPE_MOVESTATE, 0x3ff,
  1511. sizeof(lfs->gdelta)), &lfs->gdelta);
  1512. lfs_gstate_fromle32(&lfs->gdelta);
  1513. if (err) {
  1514. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1515. goto compact;
  1516. }
  1517. return err;
  1518. }
  1519. }
  1520. // finalize commit with the crc
  1521. err = lfs_dir_commitcrc(lfs, &commit);
  1522. if (err) {
  1523. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1524. goto compact;
  1525. }
  1526. return err;
  1527. }
  1528. // successful commit, update dir
  1529. LFS_ASSERT(commit.off % lfs->cfg->prog_size == 0);
  1530. dir->off = commit.off;
  1531. dir->etag = commit.ptag;
  1532. // note we able to have already handled move here
  1533. if (lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  1534. lfs_gstate_xormove(&lfs->gpending, &lfs->gpending, 0x3ff, NULL);
  1535. }
  1536. // update gstate
  1537. lfs->gstate = lfs->gpending;
  1538. lfs->gdelta = (struct lfs_gstate){0};
  1539. } else {
  1540. compact:
  1541. // fall back to compaction
  1542. lfs_cache_drop(lfs, &lfs->pcache);
  1543. int err = lfs_dir_compact(lfs, dir, attrs, attrcount,
  1544. dir, 0, dir->count);
  1545. if (err) {
  1546. return err;
  1547. }
  1548. }
  1549. // update any directories that are affected
  1550. lfs_mdir_t copy = *dir;
  1551. // two passes, once for things that aren't us, and one
  1552. // for things that are
  1553. for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
  1554. if (lfs_pair_cmp(d->m.pair, copy.pair) == 0) {
  1555. d->m = *dir;
  1556. if (d->id == lfs_tag_id(deletetag)) {
  1557. d->m.pair[0] = 0xffffffff;
  1558. d->m.pair[1] = 0xffffffff;
  1559. } else if (d->id > lfs_tag_id(deletetag)) {
  1560. d->id -= 1;
  1561. if (d->type == LFS_TYPE_DIR) {
  1562. ((lfs_dir_t*)d)->pos -= 1;
  1563. }
  1564. } else if (&d->m != dir && d->id >= lfs_tag_id(createtag)) {
  1565. d->id += 1;
  1566. if (d->type == LFS_TYPE_DIR) {
  1567. ((lfs_dir_t*)d)->pos += 1;
  1568. }
  1569. }
  1570. while (d->id >= d->m.count && d->m.split) {
  1571. // we split and id is on tail now
  1572. d->id -= d->m.count;
  1573. int err = lfs_dir_fetch(lfs, &d->m, d->m.tail);
  1574. if (err) {
  1575. return err;
  1576. }
  1577. }
  1578. }
  1579. }
  1580. return 0;
  1581. }
  1582. /// Top level directory operations ///
  1583. int lfs_mkdir(lfs_t *lfs, const char *path) {
  1584. LFS_TRACE("lfs_mkdir(%p, \"%s\")", (void*)lfs, path);
  1585. // deorphan if we haven't yet, needed at most once after poweron
  1586. int err = lfs_fs_forceconsistency(lfs);
  1587. if (err) {
  1588. LFS_TRACE("lfs_mkdir -> %d", err);
  1589. return err;
  1590. }
  1591. lfs_mdir_t cwd;
  1592. uint16_t id;
  1593. err = lfs_dir_find(lfs, &cwd, &path, &id);
  1594. if (!(err == LFS_ERR_NOENT && id != 0x3ff)) {
  1595. LFS_TRACE("lfs_mkdir -> %d", (err < 0) ? err : LFS_ERR_EXIST);
  1596. return (err < 0) ? err : LFS_ERR_EXIST;
  1597. }
  1598. // check that name fits
  1599. lfs_size_t nlen = strlen(path);
  1600. if (nlen > lfs->name_max) {
  1601. LFS_TRACE("lfs_mkdir -> %d", LFS_ERR_NAMETOOLONG);
  1602. return LFS_ERR_NAMETOOLONG;
  1603. }
  1604. // build up new directory
  1605. lfs_alloc_ack(lfs);
  1606. lfs_mdir_t dir;
  1607. err = lfs_dir_alloc(lfs, &dir);
  1608. if (err) {
  1609. LFS_TRACE("lfs_mkdir -> %d", err);
  1610. return err;
  1611. }
  1612. // find end of list
  1613. lfs_mdir_t pred = cwd;
  1614. while (pred.split) {
  1615. err = lfs_dir_fetch(lfs, &pred, pred.tail);
  1616. if (err) {
  1617. LFS_TRACE("lfs_mkdir -> %d", err);
  1618. return err;
  1619. }
  1620. }
  1621. // setup dir
  1622. lfs_pair_tole32(pred.tail);
  1623. err = lfs_dir_commit(lfs, &dir, LFS_MKATTRS(
  1624. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), pred.tail}));
  1625. lfs_pair_fromle32(pred.tail);
  1626. if (err) {
  1627. LFS_TRACE("lfs_mkdir -> %d", err);
  1628. return err;
  1629. }
  1630. // current block end of list?
  1631. if (cwd.split) {
  1632. // update tails, this creates a desync
  1633. lfs_fs_preporphans(lfs, +1);
  1634. lfs_pair_tole32(dir.pair);
  1635. err = lfs_dir_commit(lfs, &pred, LFS_MKATTRS(
  1636. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), dir.pair}));
  1637. lfs_pair_fromle32(dir.pair);
  1638. if (err) {
  1639. LFS_TRACE("lfs_mkdir -> %d", err);
  1640. return err;
  1641. }
  1642. lfs_fs_preporphans(lfs, -1);
  1643. }
  1644. // now insert into our parent block
  1645. lfs_pair_tole32(dir.pair);
  1646. err = lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
  1647. {LFS_MKTAG(LFS_TYPE_CREATE, id, 0), NULL},
  1648. {LFS_MKTAG(LFS_TYPE_DIR, id, nlen), path},
  1649. {LFS_MKTAG(LFS_TYPE_DIRSTRUCT, id, 8), dir.pair},
  1650. {!cwd.split
  1651. ? LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8)
  1652. : LFS_MKTAG(LFS_FROM_NOOP, 0, 0), dir.pair}));
  1653. lfs_pair_fromle32(dir.pair);
  1654. if (err) {
  1655. LFS_TRACE("lfs_mkdir -> %d", err);
  1656. return err;
  1657. }
  1658. LFS_TRACE("lfs_mkdir -> %d", 0);
  1659. return 0;
  1660. }
  1661. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1662. LFS_TRACE("lfs_dir_open(%p, %p, \"%s\")", (void*)lfs, (void*)dir, path);
  1663. lfs_stag_t tag = lfs_dir_find(lfs, &dir->m, &path, NULL);
  1664. if (tag < 0) {
  1665. LFS_TRACE("lfs_dir_open -> %d", tag);
  1666. return tag;
  1667. }
  1668. if (lfs_tag_type3(tag) != LFS_TYPE_DIR) {
  1669. LFS_TRACE("lfs_dir_open -> %d", LFS_ERR_NOTDIR);
  1670. return LFS_ERR_NOTDIR;
  1671. }
  1672. lfs_block_t pair[2];
  1673. if (lfs_tag_id(tag) == 0x3ff) {
  1674. // handle root dir separately
  1675. pair[0] = lfs->root[0];
  1676. pair[1] = lfs->root[1];
  1677. } else {
  1678. // get dir pair from parent
  1679. lfs_stag_t res = lfs_dir_get(lfs, &dir->m, LFS_MKTAG(0x700, 0x3ff, 0),
  1680. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  1681. if (res < 0) {
  1682. LFS_TRACE("lfs_dir_open -> %d", res);
  1683. return res;
  1684. }
  1685. lfs_pair_fromle32(pair);
  1686. }
  1687. // fetch first pair
  1688. int err = lfs_dir_fetch(lfs, &dir->m, pair);
  1689. if (err) {
  1690. LFS_TRACE("lfs_dir_open -> %d", err);
  1691. return err;
  1692. }
  1693. // setup entry
  1694. dir->head[0] = dir->m.pair[0];
  1695. dir->head[1] = dir->m.pair[1];
  1696. dir->id = 0;
  1697. dir->pos = 0;
  1698. // add to list of mdirs
  1699. dir->type = LFS_TYPE_DIR;
  1700. dir->next = (lfs_dir_t*)lfs->mlist;
  1701. lfs->mlist = (struct lfs_mlist*)dir;
  1702. LFS_TRACE("lfs_dir_open -> %d", 0);
  1703. return 0;
  1704. }
  1705. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1706. LFS_TRACE("lfs_dir_close(%p, %p)", (void*)lfs, (void*)dir);
  1707. // remove from list of mdirs
  1708. for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
  1709. if (*p == (struct lfs_mlist*)dir) {
  1710. *p = (*p)->next;
  1711. break;
  1712. }
  1713. }
  1714. LFS_TRACE("lfs_dir_close -> %d", 0);
  1715. return 0;
  1716. }
  1717. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1718. LFS_TRACE("lfs_dir_read(%p, %p, %p)",
  1719. (void*)lfs, (void*)dir, (void*)info);
  1720. memset(info, 0, sizeof(*info));
  1721. // special offset for '.' and '..'
  1722. if (dir->pos == 0) {
  1723. info->type = LFS_TYPE_DIR;
  1724. strcpy(info->name, ".");
  1725. dir->pos += 1;
  1726. LFS_TRACE("lfs_dir_read -> %d", true);
  1727. return true;
  1728. } else if (dir->pos == 1) {
  1729. info->type = LFS_TYPE_DIR;
  1730. strcpy(info->name, "..");
  1731. dir->pos += 1;
  1732. LFS_TRACE("lfs_dir_read -> %d", true);
  1733. return true;
  1734. }
  1735. while (true) {
  1736. if (dir->id == dir->m.count) {
  1737. if (!dir->m.split) {
  1738. LFS_TRACE("lfs_dir_read -> %d", false);
  1739. return false;
  1740. }
  1741. int err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1742. if (err) {
  1743. LFS_TRACE("lfs_dir_read -> %d", err);
  1744. return err;
  1745. }
  1746. dir->id = 0;
  1747. }
  1748. int err = lfs_dir_getinfo(lfs, &dir->m, dir->id, info);
  1749. if (err && err != LFS_ERR_NOENT) {
  1750. LFS_TRACE("lfs_dir_read -> %d", err);
  1751. return err;
  1752. }
  1753. dir->id += 1;
  1754. if (err != LFS_ERR_NOENT) {
  1755. break;
  1756. }
  1757. }
  1758. dir->pos += 1;
  1759. LFS_TRACE("lfs_dir_read -> %d", true);
  1760. return true;
  1761. }
  1762. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1763. LFS_TRACE("lfs_dir_seek(%p, %p, %"PRIu32")",
  1764. (void*)lfs, (void*)dir, off);
  1765. // simply walk from head dir
  1766. int err = lfs_dir_rewind(lfs, dir);
  1767. if (err) {
  1768. LFS_TRACE("lfs_dir_seek -> %d", err);
  1769. return err;
  1770. }
  1771. // first two for ./..
  1772. dir->pos = lfs_min(2, off);
  1773. off -= dir->pos;
  1774. while (off != 0) {
  1775. dir->id = lfs_min(dir->m.count, off);
  1776. dir->pos += dir->id;
  1777. off -= dir->id;
  1778. if (dir->id == dir->m.count) {
  1779. if (!dir->m.split) {
  1780. LFS_TRACE("lfs_dir_seek -> %d", LFS_ERR_INVAL);
  1781. return LFS_ERR_INVAL;
  1782. }
  1783. err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1784. if (err) {
  1785. LFS_TRACE("lfs_dir_seek -> %d", err);
  1786. return err;
  1787. }
  1788. }
  1789. }
  1790. LFS_TRACE("lfs_dir_seek -> %d", 0);
  1791. return 0;
  1792. }
  1793. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1794. LFS_TRACE("lfs_dir_tell(%p, %p)", (void*)lfs, (void*)dir);
  1795. (void)lfs;
  1796. LFS_TRACE("lfs_dir_tell -> %"PRId32, dir->pos);
  1797. return dir->pos;
  1798. }
  1799. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1800. LFS_TRACE("lfs_dir_rewind(%p, %p)", (void*)lfs, (void*)dir);
  1801. // reload the head dir
  1802. int err = lfs_dir_fetch(lfs, &dir->m, dir->head);
  1803. if (err) {
  1804. LFS_TRACE("lfs_dir_rewind -> %d", err);
  1805. return err;
  1806. }
  1807. dir->m.pair[0] = dir->head[0];
  1808. dir->m.pair[1] = dir->head[1];
  1809. dir->id = 0;
  1810. dir->pos = 0;
  1811. LFS_TRACE("lfs_dir_rewind -> %d", 0);
  1812. return 0;
  1813. }
  1814. /// File index list operations ///
  1815. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1816. lfs_off_t size = *off;
  1817. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1818. lfs_off_t i = size / b;
  1819. if (i == 0) {
  1820. return 0;
  1821. }
  1822. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1823. *off = size - b*i - 4*lfs_popc(i);
  1824. return i;
  1825. }
  1826. static int lfs_ctz_find(lfs_t *lfs,
  1827. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1828. lfs_block_t head, lfs_size_t size,
  1829. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1830. if (size == 0) {
  1831. *block = 0xffffffff;
  1832. *off = 0;
  1833. return 0;
  1834. }
  1835. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1836. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1837. while (current > target) {
  1838. lfs_size_t skip = lfs_min(
  1839. lfs_npw2(current-target+1) - 1,
  1840. lfs_ctz(current));
  1841. int err = lfs_bd_read(lfs,
  1842. pcache, rcache, sizeof(head),
  1843. head, 4*skip, &head, sizeof(head));
  1844. head = lfs_fromle32(head);
  1845. if (err) {
  1846. return err;
  1847. }
  1848. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1849. current -= 1 << skip;
  1850. }
  1851. *block = head;
  1852. *off = pos;
  1853. return 0;
  1854. }
  1855. static int lfs_ctz_extend(lfs_t *lfs,
  1856. lfs_cache_t *pcache, lfs_cache_t *rcache,
  1857. lfs_block_t head, lfs_size_t size,
  1858. lfs_block_t *block, lfs_off_t *off) {
  1859. while (true) {
  1860. // go ahead and grab a block
  1861. lfs_block_t nblock;
  1862. int err = lfs_alloc(lfs, &nblock);
  1863. if (err) {
  1864. return err;
  1865. }
  1866. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1867. {
  1868. err = lfs_bd_erase(lfs, nblock);
  1869. if (err) {
  1870. if (err == LFS_ERR_CORRUPT) {
  1871. goto relocate;
  1872. }
  1873. return err;
  1874. }
  1875. if (size == 0) {
  1876. *block = nblock;
  1877. *off = 0;
  1878. return 0;
  1879. }
  1880. size -= 1;
  1881. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1882. size += 1;
  1883. // just copy out the last block if it is incomplete
  1884. if (size != lfs->cfg->block_size) {
  1885. for (lfs_off_t i = 0; i < size; i++) {
  1886. uint8_t data;
  1887. err = lfs_bd_read(lfs,
  1888. NULL, rcache, size-i,
  1889. head, i, &data, 1);
  1890. if (err) {
  1891. return err;
  1892. }
  1893. err = lfs_bd_prog(lfs,
  1894. pcache, rcache, true,
  1895. nblock, i, &data, 1);
  1896. if (err) {
  1897. if (err == LFS_ERR_CORRUPT) {
  1898. goto relocate;
  1899. }
  1900. return err;
  1901. }
  1902. }
  1903. *block = nblock;
  1904. *off = size;
  1905. return 0;
  1906. }
  1907. // append block
  1908. index += 1;
  1909. lfs_size_t skips = lfs_ctz(index) + 1;
  1910. for (lfs_off_t i = 0; i < skips; i++) {
  1911. head = lfs_tole32(head);
  1912. err = lfs_bd_prog(lfs, pcache, rcache, true,
  1913. nblock, 4*i, &head, 4);
  1914. head = lfs_fromle32(head);
  1915. if (err) {
  1916. if (err == LFS_ERR_CORRUPT) {
  1917. goto relocate;
  1918. }
  1919. return err;
  1920. }
  1921. if (i != skips-1) {
  1922. err = lfs_bd_read(lfs,
  1923. NULL, rcache, sizeof(head),
  1924. head, 4*i, &head, sizeof(head));
  1925. head = lfs_fromle32(head);
  1926. if (err) {
  1927. return err;
  1928. }
  1929. }
  1930. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1931. }
  1932. *block = nblock;
  1933. *off = 4*skips;
  1934. return 0;
  1935. }
  1936. relocate:
  1937. LFS_DEBUG("Bad block at %"PRIx32, nblock);
  1938. // just clear cache and try a new block
  1939. lfs_cache_drop(lfs, pcache);
  1940. }
  1941. }
  1942. static int lfs_ctz_traverse(lfs_t *lfs,
  1943. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1944. lfs_block_t head, lfs_size_t size,
  1945. int (*cb)(void*, lfs_block_t), void *data) {
  1946. if (size == 0) {
  1947. return 0;
  1948. }
  1949. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1950. while (true) {
  1951. int err = cb(data, head);
  1952. if (err) {
  1953. return err;
  1954. }
  1955. if (index == 0) {
  1956. return 0;
  1957. }
  1958. lfs_block_t heads[2];
  1959. int count = 2 - (index & 1);
  1960. err = lfs_bd_read(lfs,
  1961. pcache, rcache, count*sizeof(head),
  1962. head, 0, &heads, count*sizeof(head));
  1963. heads[0] = lfs_fromle32(heads[0]);
  1964. heads[1] = lfs_fromle32(heads[1]);
  1965. if (err) {
  1966. return err;
  1967. }
  1968. for (int i = 0; i < count-1; i++) {
  1969. err = cb(data, heads[i]);
  1970. if (err) {
  1971. return err;
  1972. }
  1973. }
  1974. head = heads[count-1];
  1975. index -= count;
  1976. }
  1977. }
  1978. /// Top level file operations ///
  1979. int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
  1980. const char *path, int flags,
  1981. const struct lfs_file_config *cfg) {
  1982. LFS_TRACE("lfs_file_opencfg(%p, %p, \"%s\", %x, %p {"
  1983. ".buffer=%p, .attrs=%p, .attr_count=%"PRIu32"})",
  1984. (void*)lfs, (void*)file, path, flags,
  1985. (void*)cfg, cfg->buffer, (void*)cfg->attrs, cfg->attr_count);
  1986. // deorphan if we haven't yet, needed at most once after poweron
  1987. if ((flags & 3) != LFS_O_RDONLY) {
  1988. int err = lfs_fs_forceconsistency(lfs);
  1989. if (err) {
  1990. LFS_TRACE("lfs_file_opencfg -> %d", err);
  1991. return err;
  1992. }
  1993. }
  1994. // setup simple file details
  1995. int err;
  1996. file->cfg = cfg;
  1997. file->flags = flags | LFS_F_OPENED;
  1998. file->pos = 0;
  1999. file->cache.buffer = NULL;
  2000. // allocate entry for file if it doesn't exist
  2001. lfs_stag_t tag = lfs_dir_find(lfs, &file->m, &path, &file->id);
  2002. if (tag < 0 && !(tag == LFS_ERR_NOENT && file->id != 0x3ff)) {
  2003. err = tag;
  2004. goto cleanup;
  2005. }
  2006. // get id, add to list of mdirs to catch update changes
  2007. file->type = LFS_TYPE_REG;
  2008. file->next = (lfs_file_t*)lfs->mlist;
  2009. lfs->mlist = (struct lfs_mlist*)file;
  2010. if (tag == LFS_ERR_NOENT) {
  2011. if (!(flags & LFS_O_CREAT)) {
  2012. err = LFS_ERR_NOENT;
  2013. goto cleanup;
  2014. }
  2015. // check that name fits
  2016. lfs_size_t nlen = strlen(path);
  2017. if (nlen > lfs->name_max) {
  2018. err = LFS_ERR_NAMETOOLONG;
  2019. goto cleanup;
  2020. }
  2021. // get next slot and create entry to remember name
  2022. err = lfs_dir_commit(lfs, &file->m, LFS_MKATTRS(
  2023. {LFS_MKTAG(LFS_TYPE_CREATE, file->id, 0), NULL},
  2024. {LFS_MKTAG(LFS_TYPE_REG, file->id, nlen), path},
  2025. {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0), NULL}));
  2026. if (err) {
  2027. err = LFS_ERR_NAMETOOLONG;
  2028. goto cleanup;
  2029. }
  2030. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, 0);
  2031. } else if (flags & LFS_O_EXCL) {
  2032. err = LFS_ERR_EXIST;
  2033. goto cleanup;
  2034. } else if (lfs_tag_type3(tag) != LFS_TYPE_REG) {
  2035. err = LFS_ERR_ISDIR;
  2036. goto cleanup;
  2037. } else if (flags & LFS_O_TRUNC) {
  2038. // truncate if requested
  2039. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0);
  2040. file->flags |= LFS_F_DIRTY;
  2041. } else {
  2042. // try to load what's on disk, if it's inlined we'll fix it later
  2043. tag = lfs_dir_get(lfs, &file->m, LFS_MKTAG(0x700, 0x3ff, 0),
  2044. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, 8), &file->ctz);
  2045. if (tag < 0) {
  2046. err = tag;
  2047. goto cleanup;
  2048. }
  2049. lfs_ctz_fromle32(&file->ctz);
  2050. }
  2051. // fetch attrs
  2052. for (unsigned i = 0; i < file->cfg->attr_count; i++) {
  2053. if ((file->flags & 3) != LFS_O_WRONLY) {
  2054. lfs_stag_t res = lfs_dir_get(lfs, &file->m,
  2055. LFS_MKTAG(0x7ff, 0x3ff, 0),
  2056. LFS_MKTAG(LFS_TYPE_USERATTR + file->cfg->attrs[i].type,
  2057. file->id, file->cfg->attrs[i].size),
  2058. file->cfg->attrs[i].buffer);
  2059. if (res < 0 && res != LFS_ERR_NOENT) {
  2060. err = res;
  2061. goto cleanup;
  2062. }
  2063. }
  2064. if ((file->flags & 3) != LFS_O_RDONLY) {
  2065. if (file->cfg->attrs[i].size > lfs->attr_max) {
  2066. err = LFS_ERR_NOSPC;
  2067. goto cleanup;
  2068. }
  2069. file->flags |= LFS_F_DIRTY;
  2070. }
  2071. }
  2072. // allocate buffer if needed
  2073. if (file->cfg->buffer) {
  2074. file->cache.buffer = file->cfg->buffer;
  2075. } else {
  2076. file->cache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2077. if (!file->cache.buffer) {
  2078. err = LFS_ERR_NOMEM;
  2079. goto cleanup;
  2080. }
  2081. }
  2082. // zero to avoid information leak
  2083. lfs_cache_zero(lfs, &file->cache);
  2084. if (lfs_tag_type3(tag) == LFS_TYPE_INLINESTRUCT) {
  2085. // load inline files
  2086. file->ctz.head = 0xfffffffe;
  2087. file->ctz.size = lfs_tag_size(tag);
  2088. file->flags |= LFS_F_INLINE;
  2089. file->cache.block = file->ctz.head;
  2090. file->cache.off = 0;
  2091. file->cache.size = lfs->cfg->cache_size;
  2092. // don't always read (may be new/trunc file)
  2093. if (file->ctz.size > 0) {
  2094. lfs_stag_t res = lfs_dir_get(lfs, &file->m,
  2095. LFS_MKTAG(0x700, 0x3ff, 0),
  2096. LFS_MKTAG(LFS_TYPE_STRUCT, file->id,
  2097. lfs_min(file->cache.size, 0x3fe)),
  2098. file->cache.buffer);
  2099. if (res < 0) {
  2100. err = res;
  2101. goto cleanup;
  2102. }
  2103. }
  2104. }
  2105. LFS_TRACE("lfs_file_opencfg -> %d", 0);
  2106. return 0;
  2107. cleanup:
  2108. // clean up lingering resources
  2109. file->flags |= LFS_F_ERRED;
  2110. lfs_file_close(lfs, file);
  2111. LFS_TRACE("lfs_file_opencfg -> %d", err);
  2112. return err;
  2113. }
  2114. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  2115. const char *path, int flags) {
  2116. LFS_TRACE("lfs_file_open(%p, %p, \"%s\", %x)",
  2117. (void*)lfs, (void*)file, path, flags);
  2118. static const struct lfs_file_config defaults = {0};
  2119. int err = lfs_file_opencfg(lfs, file, path, flags, &defaults);
  2120. LFS_TRACE("lfs_file_open -> %d", err);
  2121. return err;
  2122. }
  2123. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  2124. LFS_TRACE("lfs_file_close(%p, %p)", (void*)lfs, (void*)file);
  2125. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2126. int err = lfs_file_sync(lfs, file);
  2127. // remove from list of mdirs
  2128. for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
  2129. if (*p == (struct lfs_mlist*)file) {
  2130. *p = (*p)->next;
  2131. break;
  2132. }
  2133. }
  2134. // clean up memory
  2135. if (!file->cfg->buffer) {
  2136. lfs_free(file->cache.buffer);
  2137. }
  2138. file->flags &= ~LFS_F_OPENED;
  2139. LFS_TRACE("lfs_file_close -> %d", err);
  2140. return err;
  2141. }
  2142. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  2143. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2144. while (true) {
  2145. // just relocate what exists into new block
  2146. lfs_block_t nblock;
  2147. int err = lfs_alloc(lfs, &nblock);
  2148. if (err) {
  2149. return err;
  2150. }
  2151. err = lfs_bd_erase(lfs, nblock);
  2152. if (err) {
  2153. if (err == LFS_ERR_CORRUPT) {
  2154. goto relocate;
  2155. }
  2156. return err;
  2157. }
  2158. // either read from dirty cache or disk
  2159. for (lfs_off_t i = 0; i < file->off; i++) {
  2160. uint8_t data;
  2161. if (file->flags & LFS_F_INLINE) {
  2162. err = lfs_dir_getread(lfs, &file->m,
  2163. // note we evict inline files before they can be dirty
  2164. NULL, &file->cache, file->off-i,
  2165. LFS_MKTAG(0xfff, 0x1ff, 0),
  2166. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0),
  2167. i, &data, 1);
  2168. if (err) {
  2169. return err;
  2170. }
  2171. } else {
  2172. err = lfs_bd_read(lfs,
  2173. &file->cache, &lfs->rcache, file->off-i,
  2174. file->block, i, &data, 1);
  2175. if (err) {
  2176. return err;
  2177. }
  2178. }
  2179. err = lfs_bd_prog(lfs,
  2180. &lfs->pcache, &lfs->rcache, true,
  2181. nblock, i, &data, 1);
  2182. if (err) {
  2183. if (err == LFS_ERR_CORRUPT) {
  2184. goto relocate;
  2185. }
  2186. return err;
  2187. }
  2188. }
  2189. // copy over new state of file
  2190. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->cache_size);
  2191. file->cache.block = lfs->pcache.block;
  2192. file->cache.off = lfs->pcache.off;
  2193. file->cache.size = lfs->pcache.size;
  2194. lfs_cache_zero(lfs, &lfs->pcache);
  2195. file->block = nblock;
  2196. file->flags |= LFS_F_WRITING;
  2197. return 0;
  2198. relocate:
  2199. LFS_DEBUG("Bad block at %"PRIx32, nblock);
  2200. // just clear cache and try a new block
  2201. lfs_cache_drop(lfs, &lfs->pcache);
  2202. }
  2203. }
  2204. static int lfs_file_outline(lfs_t *lfs, lfs_file_t *file) {
  2205. file->off = file->pos;
  2206. lfs_alloc_ack(lfs);
  2207. int err = lfs_file_relocate(lfs, file);
  2208. if (err) {
  2209. return err;
  2210. }
  2211. file->flags &= ~LFS_F_INLINE;
  2212. return 0;
  2213. }
  2214. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  2215. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2216. if (file->flags & LFS_F_READING) {
  2217. if (!(file->flags & LFS_F_INLINE)) {
  2218. lfs_cache_drop(lfs, &file->cache);
  2219. }
  2220. file->flags &= ~LFS_F_READING;
  2221. }
  2222. if (file->flags & LFS_F_WRITING) {
  2223. lfs_off_t pos = file->pos;
  2224. if (!(file->flags & LFS_F_INLINE)) {
  2225. // copy over anything after current branch
  2226. lfs_file_t orig = {
  2227. .ctz.head = file->ctz.head,
  2228. .ctz.size = file->ctz.size,
  2229. .flags = LFS_O_RDONLY | LFS_F_OPENED,
  2230. .pos = file->pos,
  2231. .cache = lfs->rcache,
  2232. };
  2233. lfs_cache_drop(lfs, &lfs->rcache);
  2234. while (file->pos < file->ctz.size) {
  2235. // copy over a byte at a time, leave it up to caching
  2236. // to make this efficient
  2237. uint8_t data;
  2238. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  2239. if (res < 0) {
  2240. return res;
  2241. }
  2242. res = lfs_file_write(lfs, file, &data, 1);
  2243. if (res < 0) {
  2244. return res;
  2245. }
  2246. // keep our reference to the rcache in sync
  2247. if (lfs->rcache.block != 0xffffffff) {
  2248. lfs_cache_drop(lfs, &orig.cache);
  2249. lfs_cache_drop(lfs, &lfs->rcache);
  2250. }
  2251. }
  2252. // write out what we have
  2253. while (true) {
  2254. int err = lfs_bd_flush(lfs, &file->cache, &lfs->rcache, true);
  2255. if (err) {
  2256. if (err == LFS_ERR_CORRUPT) {
  2257. goto relocate;
  2258. }
  2259. return err;
  2260. }
  2261. break;
  2262. relocate:
  2263. LFS_DEBUG("Bad block at %"PRIx32, file->block);
  2264. err = lfs_file_relocate(lfs, file);
  2265. if (err) {
  2266. return err;
  2267. }
  2268. }
  2269. } else {
  2270. file->pos = lfs_max(file->pos, file->ctz.size);
  2271. }
  2272. // actual file updates
  2273. file->ctz.head = file->block;
  2274. file->ctz.size = file->pos;
  2275. file->flags &= ~LFS_F_WRITING;
  2276. file->flags |= LFS_F_DIRTY;
  2277. file->pos = pos;
  2278. }
  2279. return 0;
  2280. }
  2281. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  2282. LFS_TRACE("lfs_file_sync(%p, %p)", (void*)lfs, (void*)file);
  2283. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2284. while (true) {
  2285. int err = lfs_file_flush(lfs, file);
  2286. if (err) {
  2287. file->flags |= LFS_F_ERRED;
  2288. LFS_TRACE("lfs_file_sync -> %d", err);
  2289. return err;
  2290. }
  2291. if ((file->flags & LFS_F_DIRTY) &&
  2292. !(file->flags & LFS_F_ERRED) &&
  2293. !lfs_pair_isnull(file->m.pair)) {
  2294. // update dir entry
  2295. uint16_t type;
  2296. const void *buffer;
  2297. lfs_size_t size;
  2298. struct lfs_ctz ctz;
  2299. if (file->flags & LFS_F_INLINE) {
  2300. // inline the whole file
  2301. type = LFS_TYPE_INLINESTRUCT;
  2302. buffer = file->cache.buffer;
  2303. size = file->ctz.size;
  2304. } else {
  2305. // update the ctz reference
  2306. type = LFS_TYPE_CTZSTRUCT;
  2307. // copy ctz so alloc will work during a relocate
  2308. ctz = file->ctz;
  2309. lfs_ctz_tole32(&ctz);
  2310. buffer = &ctz;
  2311. size = sizeof(ctz);
  2312. }
  2313. // commit file data and attributes
  2314. err = lfs_dir_commit(lfs, &file->m, LFS_MKATTRS(
  2315. {LFS_MKTAG(type, file->id, size), buffer},
  2316. {LFS_MKTAG(LFS_FROM_USERATTRS, file->id,
  2317. file->cfg->attr_count), file->cfg->attrs}));
  2318. if (err) {
  2319. if (err == LFS_ERR_NOSPC && (file->flags & LFS_F_INLINE)) {
  2320. goto relocate;
  2321. }
  2322. file->flags |= LFS_F_ERRED;
  2323. LFS_TRACE("lfs_file_sync -> %d", err);
  2324. return err;
  2325. }
  2326. file->flags &= ~LFS_F_DIRTY;
  2327. }
  2328. LFS_TRACE("lfs_file_sync -> %d", 0);
  2329. return 0;
  2330. relocate:
  2331. // inline file doesn't fit anymore
  2332. err = lfs_file_outline(lfs, file);
  2333. if (err) {
  2334. file->flags |= LFS_F_ERRED;
  2335. LFS_TRACE("lfs_file_sync -> %d", err);
  2336. return err;
  2337. }
  2338. }
  2339. }
  2340. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  2341. void *buffer, lfs_size_t size) {
  2342. LFS_TRACE("lfs_file_read(%p, %p, %p, %"PRIu32")",
  2343. (void*)lfs, (void*)file, buffer, size);
  2344. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2345. LFS_ASSERT((file->flags & 3) != LFS_O_WRONLY);
  2346. uint8_t *data = buffer;
  2347. lfs_size_t nsize = size;
  2348. if (file->flags & LFS_F_WRITING) {
  2349. // flush out any writes
  2350. int err = lfs_file_flush(lfs, file);
  2351. if (err) {
  2352. LFS_TRACE("lfs_file_read -> %"PRId32, err);
  2353. return err;
  2354. }
  2355. }
  2356. if (file->pos >= file->ctz.size) {
  2357. // eof if past end
  2358. LFS_TRACE("lfs_file_read -> %"PRId32, 0);
  2359. return 0;
  2360. }
  2361. size = lfs_min(size, file->ctz.size - file->pos);
  2362. nsize = size;
  2363. while (nsize > 0) {
  2364. // check if we need a new block
  2365. if (!(file->flags & LFS_F_READING) ||
  2366. file->off == lfs->cfg->block_size) {
  2367. if (!(file->flags & LFS_F_INLINE)) {
  2368. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2369. file->ctz.head, file->ctz.size,
  2370. file->pos, &file->block, &file->off);
  2371. if (err) {
  2372. LFS_TRACE("lfs_file_read -> %"PRId32, err);
  2373. return err;
  2374. }
  2375. } else {
  2376. file->block = 0xfffffffe;
  2377. file->off = file->pos;
  2378. }
  2379. file->flags |= LFS_F_READING;
  2380. }
  2381. // read as much as we can in current block
  2382. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2383. if (file->flags & LFS_F_INLINE) {
  2384. int err = lfs_dir_getread(lfs, &file->m,
  2385. NULL, &file->cache, lfs->cfg->block_size,
  2386. LFS_MKTAG(0xfff, 0x1ff, 0),
  2387. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0),
  2388. file->off, data, diff);
  2389. if (err) {
  2390. LFS_TRACE("lfs_file_read -> %"PRId32, err);
  2391. return err;
  2392. }
  2393. } else {
  2394. int err = lfs_bd_read(lfs,
  2395. NULL, &file->cache, lfs->cfg->block_size,
  2396. file->block, file->off, data, diff);
  2397. if (err) {
  2398. LFS_TRACE("lfs_file_read -> %"PRId32, err);
  2399. return err;
  2400. }
  2401. }
  2402. file->pos += diff;
  2403. file->off += diff;
  2404. data += diff;
  2405. nsize -= diff;
  2406. }
  2407. LFS_TRACE("lfs_file_read -> %"PRId32, size);
  2408. return size;
  2409. }
  2410. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  2411. const void *buffer, lfs_size_t size) {
  2412. LFS_TRACE("lfs_file_write(%p, %p, %p, %"PRIu32")",
  2413. (void*)lfs, (void*)file, buffer, size);
  2414. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2415. LFS_ASSERT((file->flags & 3) != LFS_O_RDONLY);
  2416. const uint8_t *data = buffer;
  2417. lfs_size_t nsize = size;
  2418. if (file->flags & LFS_F_READING) {
  2419. // drop any reads
  2420. int err = lfs_file_flush(lfs, file);
  2421. if (err) {
  2422. LFS_TRACE("lfs_file_write -> %"PRId32, err);
  2423. return err;
  2424. }
  2425. }
  2426. if ((file->flags & LFS_O_APPEND) && file->pos < file->ctz.size) {
  2427. file->pos = file->ctz.size;
  2428. }
  2429. if (file->pos + size > lfs->file_max) {
  2430. // Larger than file limit?
  2431. LFS_TRACE("lfs_file_write -> %"PRId32, LFS_ERR_FBIG);
  2432. return LFS_ERR_FBIG;
  2433. }
  2434. if (!(file->flags & LFS_F_WRITING) && file->pos > file->ctz.size) {
  2435. // fill with zeros
  2436. lfs_off_t pos = file->pos;
  2437. file->pos = file->ctz.size;
  2438. while (file->pos < pos) {
  2439. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2440. if (res < 0) {
  2441. LFS_TRACE("lfs_file_write -> %"PRId32, res);
  2442. return res;
  2443. }
  2444. }
  2445. }
  2446. if ((file->flags & LFS_F_INLINE) &&
  2447. lfs_max(file->pos+nsize, file->ctz.size) >
  2448. lfs_min(0x3fe, lfs_min(
  2449. lfs->cfg->cache_size, lfs->cfg->block_size/8))) {
  2450. // inline file doesn't fit anymore
  2451. int err = lfs_file_outline(lfs, file);
  2452. if (err) {
  2453. file->flags |= LFS_F_ERRED;
  2454. LFS_TRACE("lfs_file_write -> %"PRId32, err);
  2455. return err;
  2456. }
  2457. }
  2458. while (nsize > 0) {
  2459. // check if we need a new block
  2460. if (!(file->flags & LFS_F_WRITING) ||
  2461. file->off == lfs->cfg->block_size) {
  2462. if (!(file->flags & LFS_F_INLINE)) {
  2463. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  2464. // find out which block we're extending from
  2465. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2466. file->ctz.head, file->ctz.size,
  2467. file->pos-1, &file->block, &file->off);
  2468. if (err) {
  2469. file->flags |= LFS_F_ERRED;
  2470. LFS_TRACE("lfs_file_write -> %"PRId32, err);
  2471. return err;
  2472. }
  2473. // mark cache as dirty since we may have read data into it
  2474. lfs_cache_zero(lfs, &file->cache);
  2475. }
  2476. // extend file with new blocks
  2477. lfs_alloc_ack(lfs);
  2478. int err = lfs_ctz_extend(lfs, &file->cache, &lfs->rcache,
  2479. file->block, file->pos,
  2480. &file->block, &file->off);
  2481. if (err) {
  2482. file->flags |= LFS_F_ERRED;
  2483. LFS_TRACE("lfs_file_write -> %"PRId32, err);
  2484. return err;
  2485. }
  2486. } else {
  2487. file->block = 0xfffffffe;
  2488. file->off = file->pos;
  2489. }
  2490. file->flags |= LFS_F_WRITING;
  2491. }
  2492. // program as much as we can in current block
  2493. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2494. while (true) {
  2495. int err = lfs_bd_prog(lfs, &file->cache, &lfs->rcache, true,
  2496. file->block, file->off, data, diff);
  2497. if (err) {
  2498. if (err == LFS_ERR_CORRUPT) {
  2499. goto relocate;
  2500. }
  2501. file->flags |= LFS_F_ERRED;
  2502. LFS_TRACE("lfs_file_write -> %"PRId32, err);
  2503. return err;
  2504. }
  2505. break;
  2506. relocate:
  2507. err = lfs_file_relocate(lfs, file);
  2508. if (err) {
  2509. file->flags |= LFS_F_ERRED;
  2510. LFS_TRACE("lfs_file_write -> %"PRId32, err);
  2511. return err;
  2512. }
  2513. }
  2514. file->pos += diff;
  2515. file->off += diff;
  2516. data += diff;
  2517. nsize -= diff;
  2518. lfs_alloc_ack(lfs);
  2519. }
  2520. file->flags &= ~LFS_F_ERRED;
  2521. LFS_TRACE("lfs_file_write -> %"PRId32, size);
  2522. return size;
  2523. }
  2524. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  2525. lfs_soff_t off, int whence) {
  2526. LFS_TRACE("lfs_file_seek(%p, %p, %"PRId32", %d)",
  2527. (void*)lfs, (void*)file, off, whence);
  2528. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2529. // write out everything beforehand, may be noop if rdonly
  2530. int err = lfs_file_flush(lfs, file);
  2531. if (err) {
  2532. LFS_TRACE("lfs_file_seek -> %"PRId32, err);
  2533. return err;
  2534. }
  2535. // find new pos
  2536. lfs_off_t npos = file->pos;
  2537. if (whence == LFS_SEEK_SET) {
  2538. npos = off;
  2539. } else if (whence == LFS_SEEK_CUR) {
  2540. npos = file->pos + off;
  2541. } else if (whence == LFS_SEEK_END) {
  2542. npos = file->ctz.size + off;
  2543. }
  2544. if (npos > lfs->file_max) {
  2545. // file position out of range
  2546. LFS_TRACE("lfs_file_seek -> %"PRId32, LFS_ERR_INVAL);
  2547. return LFS_ERR_INVAL;
  2548. }
  2549. // update pos
  2550. file->pos = npos;
  2551. LFS_TRACE("lfs_file_seek -> %"PRId32, npos);
  2552. return npos;
  2553. }
  2554. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  2555. LFS_TRACE("lfs_file_truncate(%p, %p, %"PRIu32")",
  2556. (void*)lfs, (void*)file, size);
  2557. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2558. LFS_ASSERT((file->flags & 3) != LFS_O_RDONLY);
  2559. if (size > LFS_FILE_MAX) {
  2560. LFS_TRACE("lfs_file_truncate -> %d", LFS_ERR_INVAL);
  2561. return LFS_ERR_INVAL;
  2562. }
  2563. lfs_off_t oldsize = lfs_file_size(lfs, file);
  2564. if (size < oldsize) {
  2565. // need to flush since directly changing metadata
  2566. int err = lfs_file_flush(lfs, file);
  2567. if (err) {
  2568. LFS_TRACE("lfs_file_truncate -> %d", err);
  2569. return err;
  2570. }
  2571. // lookup new head in ctz skip list
  2572. err = lfs_ctz_find(lfs, NULL, &file->cache,
  2573. file->ctz.head, file->ctz.size,
  2574. size, &file->block, &file->off);
  2575. if (err) {
  2576. LFS_TRACE("lfs_file_truncate -> %d", err);
  2577. return err;
  2578. }
  2579. file->ctz.head = file->block;
  2580. file->ctz.size = size;
  2581. file->flags |= LFS_F_DIRTY | LFS_F_READING;
  2582. } else if (size > oldsize) {
  2583. lfs_off_t pos = file->pos;
  2584. // flush+seek if not already at end
  2585. if (file->pos != oldsize) {
  2586. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  2587. if (err < 0) {
  2588. LFS_TRACE("lfs_file_truncate -> %d", err);
  2589. return err;
  2590. }
  2591. }
  2592. // fill with zeros
  2593. while (file->pos < size) {
  2594. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2595. if (res < 0) {
  2596. LFS_TRACE("lfs_file_truncate -> %d", res);
  2597. return res;
  2598. }
  2599. }
  2600. // restore pos
  2601. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  2602. if (err < 0) {
  2603. LFS_TRACE("lfs_file_truncate -> %d", err);
  2604. return err;
  2605. }
  2606. }
  2607. LFS_TRACE("lfs_file_truncate -> %d", 0);
  2608. return 0;
  2609. }
  2610. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  2611. LFS_TRACE("lfs_file_tell(%p, %p)", (void*)lfs, (void*)file);
  2612. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2613. (void)lfs;
  2614. LFS_TRACE("lfs_file_tell -> %"PRId32, file->pos);
  2615. return file->pos;
  2616. }
  2617. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  2618. LFS_TRACE("lfs_file_rewind(%p, %p)", (void*)lfs, (void*)file);
  2619. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  2620. if (res < 0) {
  2621. LFS_TRACE("lfs_file_rewind -> %d", res);
  2622. return res;
  2623. }
  2624. LFS_TRACE("lfs_file_rewind -> %d", 0);
  2625. return 0;
  2626. }
  2627. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  2628. LFS_TRACE("lfs_file_size(%p, %p)", (void*)lfs, (void*)file);
  2629. LFS_ASSERT(file->flags & LFS_F_OPENED);
  2630. (void)lfs;
  2631. if (file->flags & LFS_F_WRITING) {
  2632. LFS_TRACE("lfs_file_size -> %"PRId32,
  2633. lfs_max(file->pos, file->ctz.size));
  2634. return lfs_max(file->pos, file->ctz.size);
  2635. } else {
  2636. LFS_TRACE("lfs_file_size -> %"PRId32, file->ctz.size);
  2637. return file->ctz.size;
  2638. }
  2639. }
  2640. /// General fs operations ///
  2641. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  2642. LFS_TRACE("lfs_stat(%p, \"%s\", %p)", (void*)lfs, path, (void*)info);
  2643. lfs_mdir_t cwd;
  2644. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2645. if (tag < 0) {
  2646. LFS_TRACE("lfs_stat -> %d", tag);
  2647. return tag;
  2648. }
  2649. int err = lfs_dir_getinfo(lfs, &cwd, lfs_tag_id(tag), info);
  2650. LFS_TRACE("lfs_stat -> %d", err);
  2651. return err;
  2652. }
  2653. int lfs_remove(lfs_t *lfs, const char *path) {
  2654. LFS_TRACE("lfs_remove(%p, \"%s\")", (void*)lfs, path);
  2655. // deorphan if we haven't yet, needed at most once after poweron
  2656. int err = lfs_fs_forceconsistency(lfs);
  2657. if (err) {
  2658. LFS_TRACE("lfs_remove -> %d", err);
  2659. return err;
  2660. }
  2661. lfs_mdir_t cwd;
  2662. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2663. if (tag < 0 || lfs_tag_id(tag) == 0x3ff) {
  2664. LFS_TRACE("lfs_remove -> %d", (tag < 0) ? tag : LFS_ERR_INVAL);
  2665. return (tag < 0) ? tag : LFS_ERR_INVAL;
  2666. }
  2667. lfs_mdir_t dir;
  2668. if (lfs_tag_type3(tag) == LFS_TYPE_DIR) {
  2669. // must be empty before removal
  2670. lfs_block_t pair[2];
  2671. lfs_stag_t res = lfs_dir_get(lfs, &cwd, LFS_MKTAG(0x700, 0x3ff, 0),
  2672. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  2673. if (res < 0) {
  2674. LFS_TRACE("lfs_remove -> %d", res);
  2675. return res;
  2676. }
  2677. lfs_pair_fromle32(pair);
  2678. err = lfs_dir_fetch(lfs, &dir, pair);
  2679. if (err) {
  2680. LFS_TRACE("lfs_remove -> %d", err);
  2681. return err;
  2682. }
  2683. if (dir.count > 0 || dir.split) {
  2684. LFS_TRACE("lfs_remove -> %d", LFS_ERR_NOTEMPTY);
  2685. return LFS_ERR_NOTEMPTY;
  2686. }
  2687. // mark fs as orphaned
  2688. lfs_fs_preporphans(lfs, +1);
  2689. }
  2690. // delete the entry
  2691. err = lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
  2692. {LFS_MKTAG(LFS_TYPE_DELETE, lfs_tag_id(tag), 0), NULL}));
  2693. if (err) {
  2694. LFS_TRACE("lfs_remove -> %d", err);
  2695. return err;
  2696. }
  2697. if (lfs_tag_type3(tag) == LFS_TYPE_DIR) {
  2698. // fix orphan
  2699. lfs_fs_preporphans(lfs, -1);
  2700. err = lfs_fs_pred(lfs, dir.pair, &cwd);
  2701. if (err) {
  2702. LFS_TRACE("lfs_remove -> %d", err);
  2703. return err;
  2704. }
  2705. err = lfs_dir_drop(lfs, &cwd, &dir);
  2706. if (err) {
  2707. LFS_TRACE("lfs_remove -> %d", err);
  2708. return err;
  2709. }
  2710. }
  2711. LFS_TRACE("lfs_remove -> %d", 0);
  2712. return 0;
  2713. }
  2714. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  2715. LFS_TRACE("lfs_rename(%p, \"%s\", \"%s\")", (void*)lfs, oldpath, newpath);
  2716. // deorphan if we haven't yet, needed at most once after poweron
  2717. int err = lfs_fs_forceconsistency(lfs);
  2718. if (err) {
  2719. LFS_TRACE("lfs_rename -> %d", err);
  2720. return err;
  2721. }
  2722. // find old entry
  2723. lfs_mdir_t oldcwd;
  2724. lfs_stag_t oldtag = lfs_dir_find(lfs, &oldcwd, &oldpath, NULL);
  2725. if (oldtag < 0 || lfs_tag_id(oldtag) == 0x3ff) {
  2726. LFS_TRACE("lfs_rename -> %d", (oldtag < 0) ? oldtag : LFS_ERR_INVAL);
  2727. return (oldtag < 0) ? oldtag : LFS_ERR_INVAL;
  2728. }
  2729. // find new entry
  2730. lfs_mdir_t newcwd;
  2731. uint16_t newid;
  2732. lfs_stag_t prevtag = lfs_dir_find(lfs, &newcwd, &newpath, &newid);
  2733. if ((prevtag < 0 || lfs_tag_id(prevtag) == 0x3ff) &&
  2734. !(prevtag == LFS_ERR_NOENT && newid != 0x3ff)) {
  2735. LFS_TRACE("lfs_rename -> %d", (prevtag < 0) ? prevtag : LFS_ERR_INVAL);
  2736. return (prevtag < 0) ? prevtag : LFS_ERR_INVAL;
  2737. }
  2738. lfs_mdir_t prevdir;
  2739. if (prevtag == LFS_ERR_NOENT) {
  2740. // check that name fits
  2741. lfs_size_t nlen = strlen(newpath);
  2742. if (nlen > lfs->name_max) {
  2743. LFS_TRACE("lfs_rename -> %d", LFS_ERR_NAMETOOLONG);
  2744. return LFS_ERR_NAMETOOLONG;
  2745. }
  2746. } else if (lfs_tag_type3(prevtag) != lfs_tag_type3(oldtag)) {
  2747. LFS_TRACE("lfs_rename -> %d", LFS_ERR_ISDIR);
  2748. return LFS_ERR_ISDIR;
  2749. } else if (lfs_tag_type3(prevtag) == LFS_TYPE_DIR) {
  2750. // must be empty before removal
  2751. lfs_block_t prevpair[2];
  2752. lfs_stag_t res = lfs_dir_get(lfs, &newcwd, LFS_MKTAG(0x700, 0x3ff, 0),
  2753. LFS_MKTAG(LFS_TYPE_STRUCT, newid, 8), prevpair);
  2754. if (res < 0) {
  2755. LFS_TRACE("lfs_rename -> %d", res);
  2756. return res;
  2757. }
  2758. lfs_pair_fromle32(prevpair);
  2759. // must be empty before removal
  2760. err = lfs_dir_fetch(lfs, &prevdir, prevpair);
  2761. if (err) {
  2762. LFS_TRACE("lfs_rename -> %d", err);
  2763. return err;
  2764. }
  2765. if (prevdir.count > 0 || prevdir.split) {
  2766. LFS_TRACE("lfs_rename -> %d", LFS_ERR_NOTEMPTY);
  2767. return LFS_ERR_NOTEMPTY;
  2768. }
  2769. // mark fs as orphaned
  2770. lfs_fs_preporphans(lfs, +1);
  2771. }
  2772. // create move to fix later
  2773. uint16_t newoldtagid = lfs_tag_id(oldtag);
  2774. if (lfs_pair_cmp(oldcwd.pair, newcwd.pair) == 0 &&
  2775. prevtag == LFS_ERR_NOENT && newid <= newoldtagid) {
  2776. // there is a small chance we are being renamed in the same directory
  2777. // to an id less than our old id, the global update to handle this
  2778. // is a bit messy
  2779. newoldtagid += 1;
  2780. }
  2781. lfs_fs_prepmove(lfs, newoldtagid, oldcwd.pair);
  2782. // move over all attributes
  2783. err = lfs_dir_commit(lfs, &newcwd, LFS_MKATTRS(
  2784. {prevtag != LFS_ERR_NOENT
  2785. ? LFS_MKTAG(LFS_TYPE_DELETE, newid, 0)
  2786. : LFS_MKTAG(LFS_FROM_NOOP, 0, 0), NULL},
  2787. {LFS_MKTAG(LFS_TYPE_CREATE, newid, 0), NULL},
  2788. {LFS_MKTAG(lfs_tag_type3(oldtag), newid, strlen(newpath)),
  2789. newpath},
  2790. {LFS_MKTAG(LFS_FROM_MOVE, newid, lfs_tag_id(oldtag)), &oldcwd}));
  2791. if (err) {
  2792. LFS_TRACE("lfs_rename -> %d", err);
  2793. return err;
  2794. }
  2795. // let commit clean up after move (if we're different! otherwise move
  2796. // logic already fixed it for us)
  2797. if (lfs_pair_cmp(oldcwd.pair, newcwd.pair) != 0) {
  2798. err = lfs_dir_commit(lfs, &oldcwd, NULL, 0);
  2799. if (err) {
  2800. LFS_TRACE("lfs_rename -> %d", err);
  2801. return err;
  2802. }
  2803. }
  2804. if (prevtag != LFS_ERR_NOENT && lfs_tag_type3(prevtag) == LFS_TYPE_DIR) {
  2805. // fix orphan
  2806. lfs_fs_preporphans(lfs, -1);
  2807. err = lfs_fs_pred(lfs, prevdir.pair, &newcwd);
  2808. if (err) {
  2809. LFS_TRACE("lfs_rename -> %d", err);
  2810. return err;
  2811. }
  2812. err = lfs_dir_drop(lfs, &newcwd, &prevdir);
  2813. if (err) {
  2814. LFS_TRACE("lfs_rename -> %d", err);
  2815. return err;
  2816. }
  2817. }
  2818. LFS_TRACE("lfs_rename -> %d", 0);
  2819. return 0;
  2820. }
  2821. lfs_ssize_t lfs_getattr(lfs_t *lfs, const char *path,
  2822. uint8_t type, void *buffer, lfs_size_t size) {
  2823. LFS_TRACE("lfs_getattr(%p, \"%s\", %"PRIu8", %p, %"PRIu32")",
  2824. (void*)lfs, path, type, buffer, size);
  2825. lfs_mdir_t cwd;
  2826. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2827. if (tag < 0) {
  2828. LFS_TRACE("lfs_getattr -> %"PRId32, tag);
  2829. return tag;
  2830. }
  2831. uint16_t id = lfs_tag_id(tag);
  2832. if (id == 0x3ff) {
  2833. // special case for root
  2834. id = 0;
  2835. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2836. if (err) {
  2837. LFS_TRACE("lfs_getattr -> %"PRId32, err);
  2838. return err;
  2839. }
  2840. }
  2841. tag = lfs_dir_get(lfs, &cwd, LFS_MKTAG(0x7ff, 0x3ff, 0),
  2842. LFS_MKTAG(LFS_TYPE_USERATTR + type,
  2843. id, lfs_min(size, lfs->attr_max)),
  2844. buffer);
  2845. if (tag < 0) {
  2846. if (tag == LFS_ERR_NOENT) {
  2847. LFS_TRACE("lfs_getattr -> %"PRId32, LFS_ERR_NOATTR);
  2848. return LFS_ERR_NOATTR;
  2849. }
  2850. LFS_TRACE("lfs_getattr -> %"PRId32, tag);
  2851. return tag;
  2852. }
  2853. size = lfs_tag_size(tag);
  2854. LFS_TRACE("lfs_getattr -> %"PRId32, size);
  2855. return size;
  2856. }
  2857. static int lfs_commitattr(lfs_t *lfs, const char *path,
  2858. uint8_t type, const void *buffer, lfs_size_t size) {
  2859. lfs_mdir_t cwd;
  2860. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2861. if (tag < 0) {
  2862. return tag;
  2863. }
  2864. uint16_t id = lfs_tag_id(tag);
  2865. if (id == 0x3ff) {
  2866. // special case for root
  2867. id = 0;
  2868. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2869. if (err) {
  2870. return err;
  2871. }
  2872. }
  2873. return lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
  2874. {LFS_MKTAG(LFS_TYPE_USERATTR + type, id, size), buffer}));
  2875. }
  2876. int lfs_setattr(lfs_t *lfs, const char *path,
  2877. uint8_t type, const void *buffer, lfs_size_t size) {
  2878. LFS_TRACE("lfs_setattr(%p, \"%s\", %"PRIu8", %p, %"PRIu32")",
  2879. (void*)lfs, path, type, buffer, size);
  2880. if (size > lfs->attr_max) {
  2881. LFS_TRACE("lfs_setattr -> %d", LFS_ERR_NOSPC);
  2882. return LFS_ERR_NOSPC;
  2883. }
  2884. int err = lfs_commitattr(lfs, path, type, buffer, size);
  2885. LFS_TRACE("lfs_setattr -> %d", err);
  2886. return err;
  2887. }
  2888. int lfs_removeattr(lfs_t *lfs, const char *path, uint8_t type) {
  2889. LFS_TRACE("lfs_removeattr(%p, \"%s\", %"PRIu8")", (void*)lfs, path, type);
  2890. int err = lfs_commitattr(lfs, path, type, NULL, 0x3ff);
  2891. LFS_TRACE("lfs_removeattr -> %d", err);
  2892. return err;
  2893. }
  2894. /// Filesystem operations ///
  2895. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2896. lfs->cfg = cfg;
  2897. int err = 0;
  2898. // check that block size is a multiple of cache size is a multiple
  2899. // of prog and read sizes
  2900. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->read_size == 0);
  2901. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->prog_size == 0);
  2902. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->cache_size == 0);
  2903. // check that the block size is large enough to fit ctz pointers
  2904. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2905. <= lfs->cfg->block_size);
  2906. // block_cycles = 0 is no longer supported.
  2907. //
  2908. // block_cycles is the number of erase cycles before littlefs evicts
  2909. // metadata logs as a part of wear leveling. Suggested values are in the
  2910. // range of 100-1000, or set block_cycles to -1 to disable block-level
  2911. // wear-leveling.
  2912. LFS_ASSERT(lfs->cfg->block_cycles != 0);
  2913. // setup read cache
  2914. if (lfs->cfg->read_buffer) {
  2915. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2916. } else {
  2917. lfs->rcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2918. if (!lfs->rcache.buffer) {
  2919. err = LFS_ERR_NOMEM;
  2920. goto cleanup;
  2921. }
  2922. }
  2923. // setup program cache
  2924. if (lfs->cfg->prog_buffer) {
  2925. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2926. } else {
  2927. lfs->pcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2928. if (!lfs->pcache.buffer) {
  2929. err = LFS_ERR_NOMEM;
  2930. goto cleanup;
  2931. }
  2932. }
  2933. // zero to avoid information leaks
  2934. lfs_cache_zero(lfs, &lfs->rcache);
  2935. lfs_cache_zero(lfs, &lfs->pcache);
  2936. // setup lookahead, must be multiple of 64-bits
  2937. LFS_ASSERT(lfs->cfg->lookahead_size > 0);
  2938. LFS_ASSERT(lfs->cfg->lookahead_size % 8 == 0 &&
  2939. (uintptr_t)lfs->cfg->lookahead_buffer % 8 == 0);
  2940. if (lfs->cfg->lookahead_buffer) {
  2941. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2942. } else {
  2943. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead_size);
  2944. if (!lfs->free.buffer) {
  2945. err = LFS_ERR_NOMEM;
  2946. goto cleanup;
  2947. }
  2948. }
  2949. // check that the size limits are sane
  2950. LFS_ASSERT(lfs->cfg->name_max <= LFS_NAME_MAX);
  2951. lfs->name_max = lfs->cfg->name_max;
  2952. if (!lfs->name_max) {
  2953. lfs->name_max = LFS_NAME_MAX;
  2954. }
  2955. LFS_ASSERT(lfs->cfg->file_max <= LFS_FILE_MAX);
  2956. lfs->file_max = lfs->cfg->file_max;
  2957. if (!lfs->file_max) {
  2958. lfs->file_max = LFS_FILE_MAX;
  2959. }
  2960. LFS_ASSERT(lfs->cfg->attr_max <= LFS_ATTR_MAX);
  2961. lfs->attr_max = lfs->cfg->attr_max;
  2962. if (!lfs->attr_max) {
  2963. lfs->attr_max = LFS_ATTR_MAX;
  2964. }
  2965. // setup default state
  2966. lfs->root[0] = 0xffffffff;
  2967. lfs->root[1] = 0xffffffff;
  2968. lfs->mlist = NULL;
  2969. lfs->seed = 0;
  2970. lfs->gstate = (struct lfs_gstate){0};
  2971. lfs->gpending = (struct lfs_gstate){0};
  2972. lfs->gdelta = (struct lfs_gstate){0};
  2973. #ifdef LFS_MIGRATE
  2974. lfs->lfs1 = NULL;
  2975. #endif
  2976. return 0;
  2977. cleanup:
  2978. lfs_deinit(lfs);
  2979. return err;
  2980. }
  2981. static int lfs_deinit(lfs_t *lfs) {
  2982. // free allocated memory
  2983. if (!lfs->cfg->read_buffer) {
  2984. lfs_free(lfs->rcache.buffer);
  2985. }
  2986. if (!lfs->cfg->prog_buffer) {
  2987. lfs_free(lfs->pcache.buffer);
  2988. }
  2989. if (!lfs->cfg->lookahead_buffer) {
  2990. lfs_free(lfs->free.buffer);
  2991. }
  2992. return 0;
  2993. }
  2994. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2995. LFS_TRACE("lfs_format(%p, %p {.context=%p, "
  2996. ".read=%p, .prog=%p, .erase=%p, .sync=%p, "
  2997. ".read_size=%"PRIu32", .prog_size=%"PRIu32", "
  2998. ".block_size=%"PRIu32", .block_count=%"PRIu32", "
  2999. ".block_cycles=%"PRIu32", .cache_size=%"PRIu32", "
  3000. ".lookahead_size=%"PRIu32", .read_buffer=%p, "
  3001. ".prog_buffer=%p, .lookahead_buffer=%p, "
  3002. ".name_max=%"PRIu32", .file_max=%"PRIu32", "
  3003. ".attr_max=%"PRIu32"})",
  3004. (void*)lfs, (void*)cfg, cfg->context,
  3005. (void*)(uintptr_t)cfg->read, (void*)(uintptr_t)cfg->prog,
  3006. (void*)(uintptr_t)cfg->erase, (void*)(uintptr_t)cfg->sync,
  3007. cfg->read_size, cfg->prog_size, cfg->block_size, cfg->block_count,
  3008. cfg->block_cycles, cfg->cache_size, cfg->lookahead_size,
  3009. cfg->read_buffer, cfg->prog_buffer, cfg->lookahead_buffer,
  3010. cfg->name_max, cfg->file_max, cfg->attr_max);
  3011. int err = 0;
  3012. {
  3013. err = lfs_init(lfs, cfg);
  3014. if (err) {
  3015. LFS_TRACE("lfs_format -> %d", err);
  3016. return err;
  3017. }
  3018. // create free lookahead
  3019. memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
  3020. lfs->free.off = 0;
  3021. lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size,
  3022. lfs->cfg->block_count);
  3023. lfs->free.i = 0;
  3024. lfs_alloc_ack(lfs);
  3025. // create root dir
  3026. lfs_mdir_t root;
  3027. err = lfs_dir_alloc(lfs, &root);
  3028. if (err) {
  3029. goto cleanup;
  3030. }
  3031. // write one superblock
  3032. lfs_superblock_t superblock = {
  3033. .version = LFS_DISK_VERSION,
  3034. .block_size = lfs->cfg->block_size,
  3035. .block_count = lfs->cfg->block_count,
  3036. .name_max = lfs->name_max,
  3037. .file_max = lfs->file_max,
  3038. .attr_max = lfs->attr_max,
  3039. };
  3040. lfs_superblock_tole32(&superblock);
  3041. err = lfs_dir_commit(lfs, &root, LFS_MKATTRS(
  3042. {LFS_MKTAG(LFS_TYPE_CREATE, 0, 0), NULL},
  3043. {LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8), "littlefs"},
  3044. {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
  3045. &superblock}));
  3046. if (err) {
  3047. goto cleanup;
  3048. }
  3049. // sanity check that fetch works
  3050. err = lfs_dir_fetch(lfs, &root, (const lfs_block_t[2]){0, 1});
  3051. if (err) {
  3052. goto cleanup;
  3053. }
  3054. // force compaction to prevent accidentally mounting any
  3055. // older version of littlefs that may live on disk
  3056. root.erased = false;
  3057. err = lfs_dir_commit(lfs, &root, NULL, 0);
  3058. if (err) {
  3059. goto cleanup;
  3060. }
  3061. }
  3062. cleanup:
  3063. lfs_deinit(lfs);
  3064. LFS_TRACE("lfs_format -> %d", err);
  3065. return err;
  3066. }
  3067. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  3068. LFS_TRACE("lfs_mount(%p, %p {.context=%p, "
  3069. ".read=%p, .prog=%p, .erase=%p, .sync=%p, "
  3070. ".read_size=%"PRIu32", .prog_size=%"PRIu32", "
  3071. ".block_size=%"PRIu32", .block_count=%"PRIu32", "
  3072. ".block_cycles=%"PRIu32", .cache_size=%"PRIu32", "
  3073. ".lookahead_size=%"PRIu32", .read_buffer=%p, "
  3074. ".prog_buffer=%p, .lookahead_buffer=%p, "
  3075. ".name_max=%"PRIu32", .file_max=%"PRIu32", "
  3076. ".attr_max=%"PRIu32"})",
  3077. (void*)lfs, (void*)cfg, cfg->context,
  3078. (void*)(uintptr_t)cfg->read, (void*)(uintptr_t)cfg->prog,
  3079. (void*)(uintptr_t)cfg->erase, (void*)(uintptr_t)cfg->sync,
  3080. cfg->read_size, cfg->prog_size, cfg->block_size, cfg->block_count,
  3081. cfg->block_cycles, cfg->cache_size, cfg->lookahead_size,
  3082. cfg->read_buffer, cfg->prog_buffer, cfg->lookahead_buffer,
  3083. cfg->name_max, cfg->file_max, cfg->attr_max);
  3084. int err = lfs_init(lfs, cfg);
  3085. if (err) {
  3086. LFS_TRACE("lfs_mount -> %d", err);
  3087. return err;
  3088. }
  3089. // scan directory blocks for superblock and any global updates
  3090. lfs_mdir_t dir = {.tail = {0, 1}};
  3091. while (!lfs_pair_isnull(dir.tail)) {
  3092. // fetch next block in tail list
  3093. lfs_stag_t tag = lfs_dir_fetchmatch(lfs, &dir, dir.tail,
  3094. LFS_MKTAG(0x7ff, 0x3ff, 0),
  3095. LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8),
  3096. NULL,
  3097. lfs_dir_find_match, &(struct lfs_dir_find_match){
  3098. lfs, "littlefs", 8});
  3099. if (tag < 0) {
  3100. err = tag;
  3101. goto cleanup;
  3102. }
  3103. // has superblock?
  3104. if (tag && !lfs_tag_isdelete(tag)) {
  3105. // update root
  3106. lfs->root[0] = dir.pair[0];
  3107. lfs->root[1] = dir.pair[1];
  3108. // grab superblock
  3109. lfs_superblock_t superblock;
  3110. tag = lfs_dir_get(lfs, &dir, LFS_MKTAG(0x7ff, 0x3ff, 0),
  3111. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
  3112. &superblock);
  3113. if (tag < 0) {
  3114. err = tag;
  3115. goto cleanup;
  3116. }
  3117. lfs_superblock_fromle32(&superblock);
  3118. // check version
  3119. uint16_t major_version = (0xffff & (superblock.version >> 16));
  3120. uint16_t minor_version = (0xffff & (superblock.version >> 0));
  3121. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  3122. minor_version > LFS_DISK_VERSION_MINOR)) {
  3123. LFS_ERROR("Invalid version %"PRIu16".%"PRIu16,
  3124. major_version, minor_version);
  3125. err = LFS_ERR_INVAL;
  3126. goto cleanup;
  3127. }
  3128. // check superblock configuration
  3129. if (superblock.name_max) {
  3130. if (superblock.name_max > lfs->name_max) {
  3131. LFS_ERROR("Unsupported name_max (%"PRIu32" > %"PRIu32")",
  3132. superblock.name_max, lfs->name_max);
  3133. err = LFS_ERR_INVAL;
  3134. goto cleanup;
  3135. }
  3136. lfs->name_max = superblock.name_max;
  3137. }
  3138. if (superblock.file_max) {
  3139. if (superblock.file_max > lfs->file_max) {
  3140. LFS_ERROR("Unsupported file_max (%"PRIu32" > %"PRIu32")",
  3141. superblock.file_max, lfs->file_max);
  3142. err = LFS_ERR_INVAL;
  3143. goto cleanup;
  3144. }
  3145. lfs->file_max = superblock.file_max;
  3146. }
  3147. if (superblock.attr_max) {
  3148. if (superblock.attr_max > lfs->attr_max) {
  3149. LFS_ERROR("Unsupported attr_max (%"PRIu32" > %"PRIu32")",
  3150. superblock.attr_max, lfs->attr_max);
  3151. err = LFS_ERR_INVAL;
  3152. goto cleanup;
  3153. }
  3154. lfs->attr_max = superblock.attr_max;
  3155. }
  3156. }
  3157. // has gstate?
  3158. err = lfs_dir_getgstate(lfs, &dir, &lfs->gpending);
  3159. if (err) {
  3160. goto cleanup;
  3161. }
  3162. }
  3163. // found superblock?
  3164. if (lfs_pair_isnull(lfs->root)) {
  3165. err = LFS_ERR_INVAL;
  3166. goto cleanup;
  3167. }
  3168. // update littlefs with gstate
  3169. lfs->gpending.tag += !lfs_tag_isvalid(lfs->gpending.tag);
  3170. lfs->gstate = lfs->gpending;
  3171. if (lfs_gstate_hasmove(&lfs->gstate)) {
  3172. LFS_DEBUG("Found move %"PRIx32" %"PRIx32" %"PRIx16,
  3173. lfs->gstate.pair[0],
  3174. lfs->gstate.pair[1],
  3175. lfs_tag_id(lfs->gstate.tag));
  3176. }
  3177. // setup free lookahead
  3178. lfs->free.off = lfs->seed % lfs->cfg->block_size;
  3179. lfs->free.size = 0;
  3180. lfs->free.i = 0;
  3181. lfs_alloc_ack(lfs);
  3182. LFS_TRACE("lfs_mount -> %d", 0);
  3183. return 0;
  3184. cleanup:
  3185. lfs_unmount(lfs);
  3186. LFS_TRACE("lfs_mount -> %d", err);
  3187. return err;
  3188. }
  3189. int lfs_unmount(lfs_t *lfs) {
  3190. LFS_TRACE("lfs_unmount(%p)", (void*)lfs);
  3191. int err = lfs_deinit(lfs);
  3192. LFS_TRACE("lfs_unmount -> %d", err);
  3193. return err;
  3194. }
  3195. /// Filesystem filesystem operations ///
  3196. int lfs_fs_traverse(lfs_t *lfs,
  3197. int (*cb)(void *data, lfs_block_t block), void *data) {
  3198. LFS_TRACE("lfs_fs_traverse(%p, %p, %p)",
  3199. (void*)lfs, (void*)(uintptr_t)cb, data);
  3200. // iterate over metadata pairs
  3201. lfs_mdir_t dir = {.tail = {0, 1}};
  3202. #ifdef LFS_MIGRATE
  3203. // also consider v1 blocks during migration
  3204. if (lfs->lfs1) {
  3205. int err = lfs1_traverse(lfs, cb, data);
  3206. if (err) {
  3207. LFS_TRACE("lfs_fs_traverse -> %d", err);
  3208. return err;
  3209. }
  3210. dir.tail[0] = lfs->root[0];
  3211. dir.tail[1] = lfs->root[1];
  3212. }
  3213. #endif
  3214. while (!lfs_pair_isnull(dir.tail)) {
  3215. for (int i = 0; i < 2; i++) {
  3216. int err = cb(data, dir.tail[i]);
  3217. if (err) {
  3218. LFS_TRACE("lfs_fs_traverse -> %d", err);
  3219. return err;
  3220. }
  3221. }
  3222. // iterate through ids in directory
  3223. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  3224. if (err) {
  3225. LFS_TRACE("lfs_fs_traverse -> %d", err);
  3226. return err;
  3227. }
  3228. for (uint16_t id = 0; id < dir.count; id++) {
  3229. struct lfs_ctz ctz;
  3230. lfs_stag_t tag = lfs_dir_get(lfs, &dir, LFS_MKTAG(0x700, 0x3ff, 0),
  3231. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  3232. if (tag < 0) {
  3233. if (tag == LFS_ERR_NOENT) {
  3234. continue;
  3235. }
  3236. LFS_TRACE("lfs_fs_traverse -> %d", tag);
  3237. return tag;
  3238. }
  3239. lfs_ctz_fromle32(&ctz);
  3240. if (lfs_tag_type3(tag) == LFS_TYPE_CTZSTRUCT) {
  3241. err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
  3242. ctz.head, ctz.size, cb, data);
  3243. if (err) {
  3244. LFS_TRACE("lfs_fs_traverse -> %d", err);
  3245. return err;
  3246. }
  3247. }
  3248. }
  3249. }
  3250. // iterate over any open files
  3251. for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
  3252. if (f->type != LFS_TYPE_REG) {
  3253. continue;
  3254. }
  3255. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  3256. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  3257. f->ctz.head, f->ctz.size, cb, data);
  3258. if (err) {
  3259. LFS_TRACE("lfs_fs_traverse -> %d", err);
  3260. return err;
  3261. }
  3262. }
  3263. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  3264. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  3265. f->block, f->pos, cb, data);
  3266. if (err) {
  3267. LFS_TRACE("lfs_fs_traverse -> %d", err);
  3268. return err;
  3269. }
  3270. }
  3271. }
  3272. LFS_TRACE("lfs_fs_traverse -> %d", 0);
  3273. return 0;
  3274. }
  3275. static int lfs_fs_pred(lfs_t *lfs,
  3276. const lfs_block_t pair[2], lfs_mdir_t *pdir) {
  3277. // iterate over all directory directory entries
  3278. pdir->tail[0] = 0;
  3279. pdir->tail[1] = 1;
  3280. while (!lfs_pair_isnull(pdir->tail)) {
  3281. if (lfs_pair_cmp(pdir->tail, pair) == 0) {
  3282. return 0;
  3283. }
  3284. int err = lfs_dir_fetch(lfs, pdir, pdir->tail);
  3285. if (err) {
  3286. return err;
  3287. }
  3288. }
  3289. return LFS_ERR_NOENT;
  3290. }
  3291. struct lfs_fs_parent_match {
  3292. lfs_t *lfs;
  3293. const lfs_block_t pair[2];
  3294. };
  3295. static int lfs_fs_parent_match(void *data,
  3296. lfs_tag_t tag, const void *buffer) {
  3297. struct lfs_fs_parent_match *find = data;
  3298. lfs_t *lfs = find->lfs;
  3299. const struct lfs_diskoff *disk = buffer;
  3300. (void)tag;
  3301. lfs_block_t child[2];
  3302. int err = lfs_bd_read(lfs,
  3303. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  3304. disk->block, disk->off, &child, sizeof(child));
  3305. if (err) {
  3306. return err;
  3307. }
  3308. lfs_pair_fromle32(child);
  3309. return (lfs_pair_cmp(child, find->pair) == 0) ? LFS_CMP_EQ : LFS_CMP_LT;
  3310. }
  3311. static lfs_stag_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t pair[2],
  3312. lfs_mdir_t *parent) {
  3313. // use fetchmatch with callback to find pairs
  3314. parent->tail[0] = 0;
  3315. parent->tail[1] = 1;
  3316. while (!lfs_pair_isnull(parent->tail)) {
  3317. lfs_stag_t tag = lfs_dir_fetchmatch(lfs, parent, parent->tail,
  3318. LFS_MKTAG(0x7ff, 0, 0x3ff),
  3319. LFS_MKTAG(LFS_TYPE_DIRSTRUCT, 0, 8),
  3320. NULL,
  3321. lfs_fs_parent_match, &(struct lfs_fs_parent_match){
  3322. lfs, {pair[0], pair[1]}});
  3323. if (tag && tag != LFS_ERR_NOENT) {
  3324. return tag;
  3325. }
  3326. }
  3327. return LFS_ERR_NOENT;
  3328. }
  3329. static int lfs_fs_relocate(lfs_t *lfs,
  3330. const lfs_block_t oldpair[2], lfs_block_t newpair[2]) {
  3331. // update internal root
  3332. if (lfs_pair_cmp(oldpair, lfs->root) == 0) {
  3333. LFS_DEBUG("Relocating root %"PRIx32" %"PRIx32,
  3334. newpair[0], newpair[1]);
  3335. lfs->root[0] = newpair[0];
  3336. lfs->root[1] = newpair[1];
  3337. }
  3338. // update internally tracked dirs
  3339. for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
  3340. if (lfs_pair_cmp(oldpair, d->m.pair) == 0) {
  3341. d->m.pair[0] = newpair[0];
  3342. d->m.pair[1] = newpair[1];
  3343. }
  3344. }
  3345. // find parent
  3346. lfs_mdir_t parent;
  3347. lfs_stag_t tag = lfs_fs_parent(lfs, oldpair, &parent);
  3348. if (tag < 0 && tag != LFS_ERR_NOENT) {
  3349. return tag;
  3350. }
  3351. if (tag != LFS_ERR_NOENT) {
  3352. // update disk, this creates a desync
  3353. lfs_fs_preporphans(lfs, +1);
  3354. lfs_pair_tole32(newpair);
  3355. int err = lfs_dir_commit(lfs, &parent, LFS_MKATTRS({tag, newpair}));
  3356. lfs_pair_fromle32(newpair);
  3357. if (err) {
  3358. return err;
  3359. }
  3360. // next step, clean up orphans
  3361. lfs_fs_preporphans(lfs, -1);
  3362. }
  3363. // find pred
  3364. int err = lfs_fs_pred(lfs, oldpair, &parent);
  3365. if (err && err != LFS_ERR_NOENT) {
  3366. return err;
  3367. }
  3368. // if we can't find dir, it must be new
  3369. if (err != LFS_ERR_NOENT) {
  3370. // replace bad pair, either we clean up desync, or no desync occured
  3371. lfs_pair_tole32(newpair);
  3372. err = lfs_dir_commit(lfs, &parent, LFS_MKATTRS(
  3373. {LFS_MKTAG(LFS_TYPE_TAIL + parent.split, 0x3ff, 8), newpair}));
  3374. lfs_pair_fromle32(newpair);
  3375. if (err) {
  3376. return err;
  3377. }
  3378. }
  3379. return 0;
  3380. }
  3381. static void lfs_fs_preporphans(lfs_t *lfs, int8_t orphans) {
  3382. lfs->gpending.tag += orphans;
  3383. lfs_gstate_xororphans(&lfs->gdelta, &lfs->gpending,
  3384. lfs_gstate_hasorphans(&lfs->gpending));
  3385. lfs_gstate_xororphans(&lfs->gpending, &lfs->gpending,
  3386. lfs_gstate_hasorphans(&lfs->gpending));
  3387. }
  3388. static void lfs_fs_prepmove(lfs_t *lfs,
  3389. uint16_t id, const lfs_block_t pair[2]) {
  3390. lfs_gstate_xormove(&lfs->gdelta, &lfs->gpending, id, pair);
  3391. lfs_gstate_xormove(&lfs->gpending, &lfs->gpending, id, pair);
  3392. }
  3393. static int lfs_fs_demove(lfs_t *lfs) {
  3394. if (!lfs_gstate_hasmove(&lfs->gstate)) {
  3395. return 0;
  3396. }
  3397. // Fix bad moves
  3398. LFS_DEBUG("Fixing move %"PRIx32" %"PRIx32" %"PRIx16,
  3399. lfs->gstate.pair[0],
  3400. lfs->gstate.pair[1],
  3401. lfs_tag_id(lfs->gstate.tag));
  3402. // fetch and delete the moved entry
  3403. lfs_mdir_t movedir;
  3404. int err = lfs_dir_fetch(lfs, &movedir, lfs->gstate.pair);
  3405. if (err) {
  3406. return err;
  3407. }
  3408. // rely on cancel logic inside commit
  3409. err = lfs_dir_commit(lfs, &movedir, NULL, 0);
  3410. if (err) {
  3411. return err;
  3412. }
  3413. return 0;
  3414. }
  3415. static int lfs_fs_deorphan(lfs_t *lfs) {
  3416. if (!lfs_gstate_hasorphans(&lfs->gstate)) {
  3417. return 0;
  3418. }
  3419. // Fix any orphans
  3420. lfs_mdir_t pdir = {.split = true};
  3421. lfs_mdir_t dir = {.tail = {0, 1}};
  3422. // iterate over all directory directory entries
  3423. while (!lfs_pair_isnull(dir.tail)) {
  3424. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  3425. if (err) {
  3426. return err;
  3427. }
  3428. // check head blocks for orphans
  3429. if (!pdir.split) {
  3430. // check if we have a parent
  3431. lfs_mdir_t parent;
  3432. lfs_stag_t tag = lfs_fs_parent(lfs, pdir.tail, &parent);
  3433. if (tag < 0 && tag != LFS_ERR_NOENT) {
  3434. return tag;
  3435. }
  3436. if (tag == LFS_ERR_NOENT) {
  3437. // we are an orphan
  3438. LFS_DEBUG("Fixing orphan %"PRIx32" %"PRIx32,
  3439. pdir.tail[0], pdir.tail[1]);
  3440. err = lfs_dir_drop(lfs, &pdir, &dir);
  3441. if (err) {
  3442. return err;
  3443. }
  3444. break;
  3445. }
  3446. lfs_block_t pair[2];
  3447. lfs_stag_t res = lfs_dir_get(lfs, &parent,
  3448. LFS_MKTAG(0x7ff, 0x3ff, 0), tag, pair);
  3449. if (res < 0) {
  3450. return res;
  3451. }
  3452. lfs_pair_fromle32(pair);
  3453. if (!lfs_pair_sync(pair, pdir.tail)) {
  3454. // we have desynced
  3455. LFS_DEBUG("Fixing half-orphan %"PRIx32" %"PRIx32,
  3456. pair[0], pair[1]);
  3457. lfs_pair_tole32(pair);
  3458. err = lfs_dir_commit(lfs, &pdir, LFS_MKATTRS(
  3459. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), pair}));
  3460. lfs_pair_fromle32(pair);
  3461. if (err) {
  3462. return err;
  3463. }
  3464. break;
  3465. }
  3466. }
  3467. memcpy(&pdir, &dir, sizeof(pdir));
  3468. }
  3469. // mark orphans as fixed
  3470. lfs_fs_preporphans(lfs, -lfs_gstate_getorphans(&lfs->gstate));
  3471. lfs->gstate = lfs->gpending;
  3472. return 0;
  3473. }
  3474. static int lfs_fs_forceconsistency(lfs_t *lfs) {
  3475. int err = lfs_fs_demove(lfs);
  3476. if (err) {
  3477. return err;
  3478. }
  3479. err = lfs_fs_deorphan(lfs);
  3480. if (err) {
  3481. return err;
  3482. }
  3483. return 0;
  3484. }
  3485. static int lfs_fs_size_count(void *p, lfs_block_t block) {
  3486. (void)block;
  3487. lfs_size_t *size = p;
  3488. *size += 1;
  3489. return 0;
  3490. }
  3491. lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
  3492. LFS_TRACE("lfs_fs_size(%p)", (void*)lfs);
  3493. lfs_size_t size = 0;
  3494. int err = lfs_fs_traverse(lfs, lfs_fs_size_count, &size);
  3495. if (err) {
  3496. LFS_TRACE("lfs_fs_size -> %"PRId32, err);
  3497. return err;
  3498. }
  3499. LFS_TRACE("lfs_fs_size -> %"PRId32, err);
  3500. return size;
  3501. }
  3502. #ifdef LFS_MIGRATE
  3503. ////// Migration from littelfs v1 below this //////
  3504. /// Version info ///
  3505. // Software library version
  3506. // Major (top-nibble), incremented on backwards incompatible changes
  3507. // Minor (bottom-nibble), incremented on feature additions
  3508. #define LFS1_VERSION 0x00010007
  3509. #define LFS1_VERSION_MAJOR (0xffff & (LFS1_VERSION >> 16))
  3510. #define LFS1_VERSION_MINOR (0xffff & (LFS1_VERSION >> 0))
  3511. // Version of On-disk data structures
  3512. // Major (top-nibble), incremented on backwards incompatible changes
  3513. // Minor (bottom-nibble), incremented on feature additions
  3514. #define LFS1_DISK_VERSION 0x00010001
  3515. #define LFS1_DISK_VERSION_MAJOR (0xffff & (LFS1_DISK_VERSION >> 16))
  3516. #define LFS1_DISK_VERSION_MINOR (0xffff & (LFS1_DISK_VERSION >> 0))
  3517. /// v1 Definitions ///
  3518. // File types
  3519. enum lfs1_type {
  3520. LFS1_TYPE_REG = 0x11,
  3521. LFS1_TYPE_DIR = 0x22,
  3522. LFS1_TYPE_SUPERBLOCK = 0x2e,
  3523. };
  3524. typedef struct lfs1 {
  3525. lfs_block_t root[2];
  3526. } lfs1_t;
  3527. typedef struct lfs1_entry {
  3528. lfs_off_t off;
  3529. struct lfs1_disk_entry {
  3530. uint8_t type;
  3531. uint8_t elen;
  3532. uint8_t alen;
  3533. uint8_t nlen;
  3534. union {
  3535. struct {
  3536. lfs_block_t head;
  3537. lfs_size_t size;
  3538. } file;
  3539. lfs_block_t dir[2];
  3540. } u;
  3541. } d;
  3542. } lfs1_entry_t;
  3543. typedef struct lfs1_dir {
  3544. struct lfs1_dir *next;
  3545. lfs_block_t pair[2];
  3546. lfs_off_t off;
  3547. lfs_block_t head[2];
  3548. lfs_off_t pos;
  3549. struct lfs1_disk_dir {
  3550. uint32_t rev;
  3551. lfs_size_t size;
  3552. lfs_block_t tail[2];
  3553. } d;
  3554. } lfs1_dir_t;
  3555. typedef struct lfs1_superblock {
  3556. lfs_off_t off;
  3557. struct lfs1_disk_superblock {
  3558. uint8_t type;
  3559. uint8_t elen;
  3560. uint8_t alen;
  3561. uint8_t nlen;
  3562. lfs_block_t root[2];
  3563. uint32_t block_size;
  3564. uint32_t block_count;
  3565. uint32_t version;
  3566. char magic[8];
  3567. } d;
  3568. } lfs1_superblock_t;
  3569. /// Low-level wrappers v1->v2 ///
  3570. static void lfs1_crc(uint32_t *crc, const void *buffer, size_t size) {
  3571. *crc = lfs_crc(*crc, buffer, size);
  3572. }
  3573. static int lfs1_bd_read(lfs_t *lfs, lfs_block_t block,
  3574. lfs_off_t off, void *buffer, lfs_size_t size) {
  3575. // if we ever do more than writes to alternating pairs,
  3576. // this may need to consider pcache
  3577. return lfs_bd_read(lfs, &lfs->pcache, &lfs->rcache, size,
  3578. block, off, buffer, size);
  3579. }
  3580. static int lfs1_bd_crc(lfs_t *lfs, lfs_block_t block,
  3581. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  3582. for (lfs_off_t i = 0; i < size; i++) {
  3583. uint8_t c;
  3584. int err = lfs1_bd_read(lfs, block, off+i, &c, 1);
  3585. if (err) {
  3586. return err;
  3587. }
  3588. lfs1_crc(crc, &c, 1);
  3589. }
  3590. return 0;
  3591. }
  3592. /// Endian swapping functions ///
  3593. static void lfs1_dir_fromle32(struct lfs1_disk_dir *d) {
  3594. d->rev = lfs_fromle32(d->rev);
  3595. d->size = lfs_fromle32(d->size);
  3596. d->tail[0] = lfs_fromle32(d->tail[0]);
  3597. d->tail[1] = lfs_fromle32(d->tail[1]);
  3598. }
  3599. static void lfs1_dir_tole32(struct lfs1_disk_dir *d) {
  3600. d->rev = lfs_tole32(d->rev);
  3601. d->size = lfs_tole32(d->size);
  3602. d->tail[0] = lfs_tole32(d->tail[0]);
  3603. d->tail[1] = lfs_tole32(d->tail[1]);
  3604. }
  3605. static void lfs1_entry_fromle32(struct lfs1_disk_entry *d) {
  3606. d->u.dir[0] = lfs_fromle32(d->u.dir[0]);
  3607. d->u.dir[1] = lfs_fromle32(d->u.dir[1]);
  3608. }
  3609. static void lfs1_entry_tole32(struct lfs1_disk_entry *d) {
  3610. d->u.dir[0] = lfs_tole32(d->u.dir[0]);
  3611. d->u.dir[1] = lfs_tole32(d->u.dir[1]);
  3612. }
  3613. static void lfs1_superblock_fromle32(struct lfs1_disk_superblock *d) {
  3614. d->root[0] = lfs_fromle32(d->root[0]);
  3615. d->root[1] = lfs_fromle32(d->root[1]);
  3616. d->block_size = lfs_fromle32(d->block_size);
  3617. d->block_count = lfs_fromle32(d->block_count);
  3618. d->version = lfs_fromle32(d->version);
  3619. }
  3620. ///// Metadata pair and directory operations ///
  3621. static inline lfs_size_t lfs1_entry_size(const lfs1_entry_t *entry) {
  3622. return 4 + entry->d.elen + entry->d.alen + entry->d.nlen;
  3623. }
  3624. static int lfs1_dir_fetch(lfs_t *lfs,
  3625. lfs1_dir_t *dir, const lfs_block_t pair[2]) {
  3626. // copy out pair, otherwise may be aliasing dir
  3627. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  3628. bool valid = false;
  3629. // check both blocks for the most recent revision
  3630. for (int i = 0; i < 2; i++) {
  3631. struct lfs1_disk_dir test;
  3632. int err = lfs1_bd_read(lfs, tpair[i], 0, &test, sizeof(test));
  3633. lfs1_dir_fromle32(&test);
  3634. if (err) {
  3635. if (err == LFS_ERR_CORRUPT) {
  3636. continue;
  3637. }
  3638. return err;
  3639. }
  3640. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  3641. continue;
  3642. }
  3643. if ((0x7fffffff & test.size) < sizeof(test)+4 ||
  3644. (0x7fffffff & test.size) > lfs->cfg->block_size) {
  3645. continue;
  3646. }
  3647. uint32_t crc = 0xffffffff;
  3648. lfs1_dir_tole32(&test);
  3649. lfs1_crc(&crc, &test, sizeof(test));
  3650. lfs1_dir_fromle32(&test);
  3651. err = lfs1_bd_crc(lfs, tpair[i], sizeof(test),
  3652. (0x7fffffff & test.size) - sizeof(test), &crc);
  3653. if (err) {
  3654. if (err == LFS_ERR_CORRUPT) {
  3655. continue;
  3656. }
  3657. return err;
  3658. }
  3659. if (crc != 0) {
  3660. continue;
  3661. }
  3662. valid = true;
  3663. // setup dir in case it's valid
  3664. dir->pair[0] = tpair[(i+0) % 2];
  3665. dir->pair[1] = tpair[(i+1) % 2];
  3666. dir->off = sizeof(dir->d);
  3667. dir->d = test;
  3668. }
  3669. if (!valid) {
  3670. LFS_ERROR("Corrupted dir pair at %" PRIx32 " %" PRIx32 ,
  3671. tpair[0], tpair[1]);
  3672. return LFS_ERR_CORRUPT;
  3673. }
  3674. return 0;
  3675. }
  3676. static int lfs1_dir_next(lfs_t *lfs, lfs1_dir_t *dir, lfs1_entry_t *entry) {
  3677. while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)-4) {
  3678. if (!(0x80000000 & dir->d.size)) {
  3679. entry->off = dir->off;
  3680. return LFS_ERR_NOENT;
  3681. }
  3682. int err = lfs1_dir_fetch(lfs, dir, dir->d.tail);
  3683. if (err) {
  3684. return err;
  3685. }
  3686. dir->off = sizeof(dir->d);
  3687. dir->pos += sizeof(dir->d) + 4;
  3688. }
  3689. int err = lfs1_bd_read(lfs, dir->pair[0], dir->off,
  3690. &entry->d, sizeof(entry->d));
  3691. lfs1_entry_fromle32(&entry->d);
  3692. if (err) {
  3693. return err;
  3694. }
  3695. entry->off = dir->off;
  3696. dir->off += lfs1_entry_size(entry);
  3697. dir->pos += lfs1_entry_size(entry);
  3698. return 0;
  3699. }
  3700. /// littlefs v1 specific operations ///
  3701. int lfs1_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  3702. if (lfs_pair_isnull(lfs->lfs1->root)) {
  3703. return 0;
  3704. }
  3705. // iterate over metadata pairs
  3706. lfs1_dir_t dir;
  3707. lfs1_entry_t entry;
  3708. lfs_block_t cwd[2] = {0, 1};
  3709. while (true) {
  3710. for (int i = 0; i < 2; i++) {
  3711. int err = cb(data, cwd[i]);
  3712. if (err) {
  3713. return err;
  3714. }
  3715. }
  3716. int err = lfs1_dir_fetch(lfs, &dir, cwd);
  3717. if (err) {
  3718. return err;
  3719. }
  3720. // iterate over contents
  3721. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  3722. err = lfs1_bd_read(lfs, dir.pair[0], dir.off,
  3723. &entry.d, sizeof(entry.d));
  3724. lfs1_entry_fromle32(&entry.d);
  3725. if (err) {
  3726. return err;
  3727. }
  3728. dir.off += lfs1_entry_size(&entry);
  3729. if ((0x70 & entry.d.type) == (0x70 & LFS1_TYPE_REG)) {
  3730. err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
  3731. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  3732. if (err) {
  3733. return err;
  3734. }
  3735. }
  3736. }
  3737. // we also need to check if we contain a threaded v2 directory
  3738. lfs_mdir_t dir2 = {.split=true, .tail={cwd[0], cwd[1]}};
  3739. while (dir2.split) {
  3740. err = lfs_dir_fetch(lfs, &dir2, dir2.tail);
  3741. if (err) {
  3742. break;
  3743. }
  3744. for (int i = 0; i < 2; i++) {
  3745. err = cb(data, dir2.pair[i]);
  3746. if (err) {
  3747. return err;
  3748. }
  3749. }
  3750. }
  3751. cwd[0] = dir.d.tail[0];
  3752. cwd[1] = dir.d.tail[1];
  3753. if (lfs_pair_isnull(cwd)) {
  3754. break;
  3755. }
  3756. }
  3757. return 0;
  3758. }
  3759. static int lfs1_moved(lfs_t *lfs, const void *e) {
  3760. if (lfs_pair_isnull(lfs->lfs1->root)) {
  3761. return 0;
  3762. }
  3763. // skip superblock
  3764. lfs1_dir_t cwd;
  3765. int err = lfs1_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
  3766. if (err) {
  3767. return err;
  3768. }
  3769. // iterate over all directory directory entries
  3770. lfs1_entry_t entry;
  3771. while (!lfs_pair_isnull(cwd.d.tail)) {
  3772. err = lfs1_dir_fetch(lfs, &cwd, cwd.d.tail);
  3773. if (err) {
  3774. return err;
  3775. }
  3776. while (true) {
  3777. err = lfs1_dir_next(lfs, &cwd, &entry);
  3778. if (err && err != LFS_ERR_NOENT) {
  3779. return err;
  3780. }
  3781. if (err == LFS_ERR_NOENT) {
  3782. break;
  3783. }
  3784. if (!(0x80 & entry.d.type) &&
  3785. memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
  3786. return true;
  3787. }
  3788. }
  3789. }
  3790. return false;
  3791. }
  3792. /// Filesystem operations ///
  3793. static int lfs1_mount(lfs_t *lfs, struct lfs1 *lfs1,
  3794. const struct lfs_config *cfg) {
  3795. int err = 0;
  3796. {
  3797. err = lfs_init(lfs, cfg);
  3798. if (err) {
  3799. return err;
  3800. }
  3801. lfs->lfs1 = lfs1;
  3802. lfs->lfs1->root[0] = 0xffffffff;
  3803. lfs->lfs1->root[1] = 0xffffffff;
  3804. // setup free lookahead
  3805. lfs->free.off = 0;
  3806. lfs->free.size = 0;
  3807. lfs->free.i = 0;
  3808. lfs_alloc_ack(lfs);
  3809. // load superblock
  3810. lfs1_dir_t dir;
  3811. lfs1_superblock_t superblock;
  3812. err = lfs1_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  3813. if (err && err != LFS_ERR_CORRUPT) {
  3814. goto cleanup;
  3815. }
  3816. if (!err) {
  3817. err = lfs1_bd_read(lfs, dir.pair[0], sizeof(dir.d),
  3818. &superblock.d, sizeof(superblock.d));
  3819. lfs1_superblock_fromle32(&superblock.d);
  3820. if (err) {
  3821. goto cleanup;
  3822. }
  3823. lfs->lfs1->root[0] = superblock.d.root[0];
  3824. lfs->lfs1->root[1] = superblock.d.root[1];
  3825. }
  3826. if (err || memcmp(superblock.d.magic, "littlefs", 8) != 0) {
  3827. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  3828. err = LFS_ERR_CORRUPT;
  3829. goto cleanup;
  3830. }
  3831. uint16_t major_version = (0xffff & (superblock.d.version >> 16));
  3832. uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
  3833. if ((major_version != LFS1_DISK_VERSION_MAJOR ||
  3834. minor_version > LFS1_DISK_VERSION_MINOR)) {
  3835. LFS_ERROR("Invalid version %d.%d", major_version, minor_version);
  3836. err = LFS_ERR_INVAL;
  3837. goto cleanup;
  3838. }
  3839. return 0;
  3840. }
  3841. cleanup:
  3842. lfs_deinit(lfs);
  3843. return err;
  3844. }
  3845. static int lfs1_unmount(lfs_t *lfs) {
  3846. return lfs_deinit(lfs);
  3847. }
  3848. /// v1 migration ///
  3849. int lfs_migrate(lfs_t *lfs, const struct lfs_config *cfg) {
  3850. LFS_TRACE("lfs_migrate(%p, %p {.context=%p, "
  3851. ".read=%p, .prog=%p, .erase=%p, .sync=%p, "
  3852. ".read_size=%"PRIu32", .prog_size=%"PRIu32", "
  3853. ".block_size=%"PRIu32", .block_count=%"PRIu32", "
  3854. ".block_cycles=%"PRIu32", .cache_size=%"PRIu32", "
  3855. ".lookahead_size=%"PRIu32", .read_buffer=%p, "
  3856. ".prog_buffer=%p, .lookahead_buffer=%p, "
  3857. ".name_max=%"PRIu32", .file_max=%"PRIu32", "
  3858. ".attr_max=%"PRIu32"})",
  3859. (void*)lfs, (void*)cfg, cfg->context,
  3860. (void*)(uintptr_t)cfg->read, (void*)(uintptr_t)cfg->prog,
  3861. (void*)(uintptr_t)cfg->erase, (void*)(uintptr_t)cfg->sync,
  3862. cfg->read_size, cfg->prog_size, cfg->block_size, cfg->block_count,
  3863. cfg->block_cycles, cfg->cache_size, cfg->lookahead_size,
  3864. cfg->read_buffer, cfg->prog_buffer, cfg->lookahead_buffer,
  3865. cfg->name_max, cfg->file_max, cfg->attr_max);
  3866. struct lfs1 lfs1;
  3867. int err = lfs1_mount(lfs, &lfs1, cfg);
  3868. if (err) {
  3869. LFS_TRACE("lfs_migrate -> %d", err);
  3870. return err;
  3871. }
  3872. {
  3873. // iterate through each directory, copying over entries
  3874. // into new directory
  3875. lfs1_dir_t dir1;
  3876. lfs_mdir_t dir2;
  3877. dir1.d.tail[0] = lfs->lfs1->root[0];
  3878. dir1.d.tail[1] = lfs->lfs1->root[1];
  3879. while (!lfs_pair_isnull(dir1.d.tail)) {
  3880. // iterate old dir
  3881. err = lfs1_dir_fetch(lfs, &dir1, dir1.d.tail);
  3882. if (err) {
  3883. goto cleanup;
  3884. }
  3885. // create new dir and bind as temporary pretend root
  3886. err = lfs_dir_alloc(lfs, &dir2);
  3887. if (err) {
  3888. goto cleanup;
  3889. }
  3890. dir2.rev = dir1.d.rev;
  3891. dir1.head[0] = dir1.pair[0];
  3892. dir1.head[1] = dir1.pair[1];
  3893. lfs->root[0] = dir2.pair[0];
  3894. lfs->root[1] = dir2.pair[1];
  3895. err = lfs_dir_commit(lfs, &dir2, NULL, 0);
  3896. if (err) {
  3897. goto cleanup;
  3898. }
  3899. while (true) {
  3900. lfs1_entry_t entry1;
  3901. err = lfs1_dir_next(lfs, &dir1, &entry1);
  3902. if (err && err != LFS_ERR_NOENT) {
  3903. goto cleanup;
  3904. }
  3905. if (err == LFS_ERR_NOENT) {
  3906. break;
  3907. }
  3908. // check that entry has not been moved
  3909. if (entry1.d.type & 0x80) {
  3910. int moved = lfs1_moved(lfs, &entry1.d.u);
  3911. if (moved < 0) {
  3912. err = moved;
  3913. goto cleanup;
  3914. }
  3915. if (moved) {
  3916. continue;
  3917. }
  3918. entry1.d.type &= ~0x80;
  3919. }
  3920. // also fetch name
  3921. char name[LFS_NAME_MAX+1];
  3922. memset(name, 0, sizeof(name));
  3923. err = lfs1_bd_read(lfs, dir1.pair[0],
  3924. entry1.off + 4+entry1.d.elen+entry1.d.alen,
  3925. name, entry1.d.nlen);
  3926. if (err) {
  3927. goto cleanup;
  3928. }
  3929. bool isdir = (entry1.d.type == LFS1_TYPE_DIR);
  3930. // create entry in new dir
  3931. err = lfs_dir_fetch(lfs, &dir2, lfs->root);
  3932. if (err) {
  3933. goto cleanup;
  3934. }
  3935. uint16_t id;
  3936. err = lfs_dir_find(lfs, &dir2, &(const char*){name}, &id);
  3937. if (!(err == LFS_ERR_NOENT && id != 0x3ff)) {
  3938. err = (err < 0) ? err : LFS_ERR_EXIST;
  3939. goto cleanup;
  3940. }
  3941. lfs1_entry_tole32(&entry1.d);
  3942. err = lfs_dir_commit(lfs, &dir2, LFS_MKATTRS(
  3943. {LFS_MKTAG(LFS_TYPE_CREATE, id, 0), NULL},
  3944. {LFS_MKTAG(
  3945. isdir ? LFS_TYPE_DIR : LFS_TYPE_REG,
  3946. id, entry1.d.nlen), name},
  3947. {LFS_MKTAG(
  3948. isdir ? LFS_TYPE_DIRSTRUCT : LFS_TYPE_CTZSTRUCT,
  3949. id, sizeof(&entry1.d.u)), &entry1.d.u}));
  3950. lfs1_entry_fromle32(&entry1.d);
  3951. if (err) {
  3952. goto cleanup;
  3953. }
  3954. }
  3955. if (!lfs_pair_isnull(dir1.d.tail)) {
  3956. // find last block and update tail to thread into fs
  3957. err = lfs_dir_fetch(lfs, &dir2, lfs->root);
  3958. if (err) {
  3959. goto cleanup;
  3960. }
  3961. while (dir2.split) {
  3962. err = lfs_dir_fetch(lfs, &dir2, dir2.tail);
  3963. if (err) {
  3964. goto cleanup;
  3965. }
  3966. }
  3967. lfs_pair_tole32(dir2.pair);
  3968. err = lfs_dir_commit(lfs, &dir2, LFS_MKATTRS(
  3969. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 0),
  3970. dir1.d.tail}));
  3971. lfs_pair_fromle32(dir2.pair);
  3972. if (err) {
  3973. goto cleanup;
  3974. }
  3975. }
  3976. // Copy over first block to thread into fs. Unfortunately
  3977. // if this fails there is not much we can do.
  3978. LFS_DEBUG("Migrating %"PRIx32" %"PRIx32" -> %"PRIx32" %"PRIx32,
  3979. lfs->root[0], lfs->root[1], dir1.head[0], dir1.head[1]);
  3980. err = lfs_bd_erase(lfs, dir1.head[1]);
  3981. if (err) {
  3982. goto cleanup;
  3983. }
  3984. err = lfs_dir_fetch(lfs, &dir2, lfs->root);
  3985. if (err) {
  3986. goto cleanup;
  3987. }
  3988. for (lfs_off_t i = 0; i < dir2.off; i++) {
  3989. uint8_t dat;
  3990. err = lfs_bd_read(lfs,
  3991. NULL, &lfs->rcache, dir2.off,
  3992. dir2.pair[0], i, &dat, 1);
  3993. if (err) {
  3994. goto cleanup;
  3995. }
  3996. err = lfs_bd_prog(lfs,
  3997. &lfs->pcache, &lfs->rcache, true,
  3998. dir1.head[1], i, &dat, 1);
  3999. if (err) {
  4000. goto cleanup;
  4001. }
  4002. }
  4003. err = lfs_bd_flush(lfs, &lfs->pcache, &lfs->rcache, true);
  4004. if (err) {
  4005. goto cleanup;
  4006. }
  4007. }
  4008. // Create new superblock. This marks a successful migration!
  4009. err = lfs1_dir_fetch(lfs, &dir1, (const lfs_block_t[2]){0, 1});
  4010. if (err) {
  4011. goto cleanup;
  4012. }
  4013. dir2.pair[0] = dir1.pair[0];
  4014. dir2.pair[1] = dir1.pair[1];
  4015. dir2.rev = dir1.d.rev;
  4016. dir2.off = sizeof(dir2.rev);
  4017. dir2.etag = 0xffffffff;
  4018. dir2.count = 0;
  4019. dir2.tail[0] = lfs->lfs1->root[0];
  4020. dir2.tail[1] = lfs->lfs1->root[1];
  4021. dir2.erased = false;
  4022. dir2.split = true;
  4023. lfs_superblock_t superblock = {
  4024. .version = LFS_DISK_VERSION,
  4025. .block_size = lfs->cfg->block_size,
  4026. .block_count = lfs->cfg->block_count,
  4027. .name_max = lfs->name_max,
  4028. .file_max = lfs->file_max,
  4029. .attr_max = lfs->attr_max,
  4030. };
  4031. lfs_superblock_tole32(&superblock);
  4032. err = lfs_dir_commit(lfs, &dir2, LFS_MKATTRS(
  4033. {LFS_MKTAG(LFS_TYPE_CREATE, 0, 0), NULL},
  4034. {LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8), "littlefs"},
  4035. {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
  4036. &superblock}));
  4037. if (err) {
  4038. goto cleanup;
  4039. }
  4040. // sanity check that fetch works
  4041. err = lfs_dir_fetch(lfs, &dir2, (const lfs_block_t[2]){0, 1});
  4042. if (err) {
  4043. goto cleanup;
  4044. }
  4045. // force compaction to prevent accidentally mounting v1
  4046. dir2.erased = false;
  4047. err = lfs_dir_commit(lfs, &dir2, NULL, 0);
  4048. if (err) {
  4049. goto cleanup;
  4050. }
  4051. }
  4052. cleanup:
  4053. lfs1_unmount(lfs);
  4054. LFS_TRACE("lfs_migrate -> %d", err);
  4055. return err;
  4056. }
  4057. #endif