lfs.c 170 KB

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