lfs.c 156 KB

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