lfs.c 141 KB

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