lfs.c 149 KB

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