lfs.c 148 KB

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