lfs.c 130 KB

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