lfs.c 150 KB

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