lfs.c 149 KB

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