lfs.c 143 KB

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