lfs.c 146 KB

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