lfs.c 147 KB

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