123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820 |
- /*
- * The little filesystem
- *
- * Copyright (c) 2022, The littlefs authors.
- * Copyright (c) 2017, Arm Limited. All rights reserved.
- * SPDX-License-Identifier: BSD-3-Clause
- */
- #include "lfs.h"
- #include "lfs_util.h"
- // some constants used throughout the code
- #define LFS_BLOCK_NULL ((lfs_block_t)-1)
- #define LFS_BLOCK_INLINE ((lfs_block_t)-2)
- enum {
- LFS_OK_RELOCATED = 1,
- LFS_OK_DROPPED = 2,
- LFS_OK_ORPHANED = 3,
- };
- enum {
- LFS_CMP_EQ = 0,
- LFS_CMP_LT = 1,
- LFS_CMP_GT = 2,
- };
- /// Caching block device operations ///
- static inline void lfs_cache_drop(lfs_t *lfs, lfs_cache_t *rcache) {
- // do not zero, cheaper if cache is readonly or only going to be
- // written with identical data (during relocates)
- (void)lfs;
- rcache->block = LFS_BLOCK_NULL;
- }
- static inline void lfs_cache_zero(lfs_t *lfs, lfs_cache_t *pcache) {
- // zero to avoid information leak
- memset(pcache->buffer, 0xff, lfs->cfg->cache_size);
- pcache->block = LFS_BLOCK_NULL;
- }
- static int lfs_bd_read(lfs_t *lfs,
- const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
- lfs_block_t block, lfs_off_t off,
- void *buffer, lfs_size_t size) {
- uint8_t *data = buffer;
- if (block >= lfs->cfg->block_count ||
- off+size > lfs->cfg->block_size) {
- return LFS_ERR_CORRUPT;
- }
- while (size > 0) {
- lfs_size_t diff = size;
- if (pcache && block == pcache->block &&
- off < pcache->off + pcache->size) {
- if (off >= pcache->off) {
- // is already in pcache?
- diff = lfs_min(diff, pcache->size - (off-pcache->off));
- memcpy(data, &pcache->buffer[off-pcache->off], diff);
- data += diff;
- off += diff;
- size -= diff;
- continue;
- }
- // pcache takes priority
- diff = lfs_min(diff, pcache->off-off);
- }
- if (block == rcache->block &&
- off < rcache->off + rcache->size) {
- if (off >= rcache->off) {
- // is already in rcache?
- diff = lfs_min(diff, rcache->size - (off-rcache->off));
- memcpy(data, &rcache->buffer[off-rcache->off], diff);
- data += diff;
- off += diff;
- size -= diff;
- continue;
- }
- // rcache takes priority
- diff = lfs_min(diff, rcache->off-off);
- }
- if (size >= hint && off % lfs->cfg->read_size == 0 &&
- size >= lfs->cfg->read_size) {
- // bypass cache?
- diff = lfs_aligndown(diff, lfs->cfg->read_size);
- int err = lfs->cfg->read(lfs->cfg, block, off, data, diff);
- if (err) {
- return err;
- }
- data += diff;
- off += diff;
- size -= diff;
- continue;
- }
- // load to cache, first condition can no longer fail
- LFS_ASSERT(block < lfs->cfg->block_count);
- rcache->block = block;
- rcache->off = lfs_aligndown(off, lfs->cfg->read_size);
- rcache->size = lfs_min(
- lfs_min(
- lfs_alignup(off+hint, lfs->cfg->read_size),
- lfs->cfg->block_size)
- - rcache->off,
- lfs->cfg->cache_size);
- int err = lfs->cfg->read(lfs->cfg, rcache->block,
- rcache->off, rcache->buffer, rcache->size);
- LFS_ASSERT(err <= 0);
- if (err) {
- return err;
- }
- }
- return 0;
- }
- static int lfs_bd_cmp(lfs_t *lfs,
- const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
- lfs_block_t block, lfs_off_t off,
- const void *buffer, lfs_size_t size) {
- const uint8_t *data = buffer;
- lfs_size_t diff = 0;
- for (lfs_off_t i = 0; i < size; i += diff) {
- uint8_t dat[8];
- diff = lfs_min(size-i, sizeof(dat));
- int res = lfs_bd_read(lfs,
- pcache, rcache, hint-i,
- block, off+i, &dat, diff);
- if (res) {
- return res;
- }
- res = memcmp(dat, data + i, diff);
- if (res) {
- return res < 0 ? LFS_CMP_LT : LFS_CMP_GT;
- }
- }
- return LFS_CMP_EQ;
- }
- #ifndef LFS_READONLY
- static int lfs_bd_flush(lfs_t *lfs,
- lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate) {
- if (pcache->block != LFS_BLOCK_NULL && pcache->block != LFS_BLOCK_INLINE) {
- LFS_ASSERT(pcache->block < lfs->cfg->block_count);
- lfs_size_t diff = lfs_alignup(pcache->size, lfs->cfg->prog_size);
- int err = lfs->cfg->prog(lfs->cfg, pcache->block,
- pcache->off, pcache->buffer, diff);
- LFS_ASSERT(err <= 0);
- if (err) {
- return err;
- }
- if (validate) {
- // check data on disk
- lfs_cache_drop(lfs, rcache);
- int res = lfs_bd_cmp(lfs,
- NULL, rcache, diff,
- pcache->block, pcache->off, pcache->buffer, diff);
- if (res < 0) {
- return res;
- }
- if (res != LFS_CMP_EQ) {
- return LFS_ERR_CORRUPT;
- }
- }
- lfs_cache_zero(lfs, pcache);
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_bd_sync(lfs_t *lfs,
- lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate) {
- lfs_cache_drop(lfs, rcache);
- int err = lfs_bd_flush(lfs, pcache, rcache, validate);
- if (err) {
- return err;
- }
- err = lfs->cfg->sync(lfs->cfg);
- LFS_ASSERT(err <= 0);
- return err;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_bd_prog(lfs_t *lfs,
- lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate,
- lfs_block_t block, lfs_off_t off,
- const void *buffer, lfs_size_t size) {
- const uint8_t *data = buffer;
- LFS_ASSERT(block == LFS_BLOCK_INLINE || block < lfs->cfg->block_count);
- LFS_ASSERT(off + size <= lfs->cfg->block_size);
- while (size > 0) {
- if (block == pcache->block &&
- off >= pcache->off &&
- off < pcache->off + lfs->cfg->cache_size) {
- // already fits in pcache?
- lfs_size_t diff = lfs_min(size,
- lfs->cfg->cache_size - (off-pcache->off));
- memcpy(&pcache->buffer[off-pcache->off], data, diff);
- data += diff;
- off += diff;
- size -= diff;
- pcache->size = lfs_max(pcache->size, off - pcache->off);
- if (pcache->size == lfs->cfg->cache_size) {
- // eagerly flush out pcache if we fill up
- int err = lfs_bd_flush(lfs, pcache, rcache, validate);
- if (err) {
- return err;
- }
- }
- continue;
- }
- // pcache must have been flushed, either by programming and
- // entire block or manually flushing the pcache
- LFS_ASSERT(pcache->block == LFS_BLOCK_NULL);
- // prepare pcache, first condition can no longer fail
- pcache->block = block;
- pcache->off = lfs_aligndown(off, lfs->cfg->prog_size);
- pcache->size = 0;
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_bd_erase(lfs_t *lfs, lfs_block_t block) {
- LFS_ASSERT(block < lfs->cfg->block_count);
- int err = lfs->cfg->erase(lfs->cfg, block);
- LFS_ASSERT(err <= 0);
- return err;
- }
- #endif
- /// Small type-level utilities ///
- // operations on block pairs
- static inline void lfs_pair_swap(lfs_block_t pair[2]) {
- lfs_block_t t = pair[0];
- pair[0] = pair[1];
- pair[1] = t;
- }
- static inline bool lfs_pair_isnull(const lfs_block_t pair[2]) {
- return pair[0] == LFS_BLOCK_NULL || pair[1] == LFS_BLOCK_NULL;
- }
- static inline int lfs_pair_cmp(
- const lfs_block_t paira[2],
- const lfs_block_t pairb[2]) {
- return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
- paira[0] == pairb[1] || paira[1] == pairb[0]);
- }
- #ifndef LFS_READONLY
- static inline bool lfs_pair_sync(
- const lfs_block_t paira[2],
- const lfs_block_t pairb[2]) {
- return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
- (paira[0] == pairb[1] && paira[1] == pairb[0]);
- }
- #endif
- static inline void lfs_pair_fromle32(lfs_block_t pair[2]) {
- pair[0] = lfs_fromle32(pair[0]);
- pair[1] = lfs_fromle32(pair[1]);
- }
- #ifndef LFS_READONLY
- static inline void lfs_pair_tole32(lfs_block_t pair[2]) {
- pair[0] = lfs_tole32(pair[0]);
- pair[1] = lfs_tole32(pair[1]);
- }
- #endif
- // operations on 32-bit entry tags
- typedef uint32_t lfs_tag_t;
- typedef int32_t lfs_stag_t;
- #define LFS_MKTAG(type, id, size) \
- (((lfs_tag_t)(type) << 20) | ((lfs_tag_t)(id) << 10) | (lfs_tag_t)(size))
- #define LFS_MKTAG_IF(cond, type, id, size) \
- ((cond) ? LFS_MKTAG(type, id, size) : LFS_MKTAG(LFS_FROM_NOOP, 0, 0))
- #define LFS_MKTAG_IF_ELSE(cond, type1, id1, size1, type2, id2, size2) \
- ((cond) ? LFS_MKTAG(type1, id1, size1) : LFS_MKTAG(type2, id2, size2))
- static inline bool lfs_tag_isvalid(lfs_tag_t tag) {
- return !(tag & 0x80000000);
- }
- static inline bool lfs_tag_isdelete(lfs_tag_t tag) {
- return ((int32_t)(tag << 22) >> 22) == -1;
- }
- static inline uint16_t lfs_tag_type1(lfs_tag_t tag) {
- return (tag & 0x70000000) >> 20;
- }
- static inline uint16_t lfs_tag_type3(lfs_tag_t tag) {
- return (tag & 0x7ff00000) >> 20;
- }
- static inline uint8_t lfs_tag_chunk(lfs_tag_t tag) {
- return (tag & 0x0ff00000) >> 20;
- }
- static inline int8_t lfs_tag_splice(lfs_tag_t tag) {
- return (int8_t)lfs_tag_chunk(tag);
- }
- static inline uint16_t lfs_tag_id(lfs_tag_t tag) {
- return (tag & 0x000ffc00) >> 10;
- }
- static inline lfs_size_t lfs_tag_size(lfs_tag_t tag) {
- return tag & 0x000003ff;
- }
- static inline lfs_size_t lfs_tag_dsize(lfs_tag_t tag) {
- return sizeof(tag) + lfs_tag_size(tag + lfs_tag_isdelete(tag));
- }
- // operations on attributes in attribute lists
- struct lfs_mattr {
- lfs_tag_t tag;
- const void *buffer;
- };
- struct lfs_diskoff {
- lfs_block_t block;
- lfs_off_t off;
- };
- #define LFS_MKATTRS(...) \
- (struct lfs_mattr[]){__VA_ARGS__}, \
- sizeof((struct lfs_mattr[]){__VA_ARGS__}) / sizeof(struct lfs_mattr)
- // operations on global state
- static inline void lfs_gstate_xor(lfs_gstate_t *a, const lfs_gstate_t *b) {
- for (int i = 0; i < 3; i++) {
- ((uint32_t*)a)[i] ^= ((const uint32_t*)b)[i];
- }
- }
- static inline bool lfs_gstate_iszero(const lfs_gstate_t *a) {
- for (int i = 0; i < 3; i++) {
- if (((uint32_t*)a)[i] != 0) {
- return false;
- }
- }
- return true;
- }
- #ifndef LFS_READONLY
- static inline bool lfs_gstate_hasorphans(const lfs_gstate_t *a) {
- return lfs_tag_size(a->tag);
- }
- static inline uint8_t lfs_gstate_getorphans(const lfs_gstate_t *a) {
- return lfs_tag_size(a->tag);
- }
- static inline bool lfs_gstate_hasmove(const lfs_gstate_t *a) {
- return lfs_tag_type1(a->tag);
- }
- #endif
- static inline bool lfs_gstate_hasmovehere(const lfs_gstate_t *a,
- const lfs_block_t *pair) {
- return lfs_tag_type1(a->tag) && lfs_pair_cmp(a->pair, pair) == 0;
- }
- static inline void lfs_gstate_fromle32(lfs_gstate_t *a) {
- a->tag = lfs_fromle32(a->tag);
- a->pair[0] = lfs_fromle32(a->pair[0]);
- a->pair[1] = lfs_fromle32(a->pair[1]);
- }
- #ifndef LFS_READONLY
- static inline void lfs_gstate_tole32(lfs_gstate_t *a) {
- a->tag = lfs_tole32(a->tag);
- a->pair[0] = lfs_tole32(a->pair[0]);
- a->pair[1] = lfs_tole32(a->pair[1]);
- }
- #endif
- // other endianness operations
- static void lfs_ctz_fromle32(struct lfs_ctz *ctz) {
- ctz->head = lfs_fromle32(ctz->head);
- ctz->size = lfs_fromle32(ctz->size);
- }
- #ifndef LFS_READONLY
- static void lfs_ctz_tole32(struct lfs_ctz *ctz) {
- ctz->head = lfs_tole32(ctz->head);
- ctz->size = lfs_tole32(ctz->size);
- }
- #endif
- static inline void lfs_superblock_fromle32(lfs_superblock_t *superblock) {
- superblock->version = lfs_fromle32(superblock->version);
- superblock->block_size = lfs_fromle32(superblock->block_size);
- superblock->block_count = lfs_fromle32(superblock->block_count);
- superblock->name_max = lfs_fromle32(superblock->name_max);
- superblock->file_max = lfs_fromle32(superblock->file_max);
- superblock->attr_max = lfs_fromle32(superblock->attr_max);
- }
- #ifndef LFS_READONLY
- static inline void lfs_superblock_tole32(lfs_superblock_t *superblock) {
- superblock->version = lfs_tole32(superblock->version);
- superblock->block_size = lfs_tole32(superblock->block_size);
- superblock->block_count = lfs_tole32(superblock->block_count);
- superblock->name_max = lfs_tole32(superblock->name_max);
- superblock->file_max = lfs_tole32(superblock->file_max);
- superblock->attr_max = lfs_tole32(superblock->attr_max);
- }
- #endif
- #ifndef LFS_NO_ASSERT
- static bool lfs_mlist_isopen(struct lfs_mlist *head,
- struct lfs_mlist *node) {
- for (struct lfs_mlist **p = &head; *p; p = &(*p)->next) {
- if (*p == (struct lfs_mlist*)node) {
- return true;
- }
- }
- return false;
- }
- #endif
- static void lfs_mlist_remove(lfs_t *lfs, struct lfs_mlist *mlist) {
- for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
- if (*p == mlist) {
- *p = (*p)->next;
- break;
- }
- }
- }
- static void lfs_mlist_append(lfs_t *lfs, struct lfs_mlist *mlist) {
- mlist->next = lfs->mlist;
- lfs->mlist = mlist;
- }
- /// Internal operations predeclared here ///
- #ifndef LFS_READONLY
- static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
- const struct lfs_mattr *attrs, int attrcount);
- static int lfs_dir_compact(lfs_t *lfs,
- lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
- lfs_mdir_t *source, uint16_t begin, uint16_t end);
- static lfs_ssize_t lfs_file_flushedwrite(lfs_t *lfs, lfs_file_t *file,
- const void *buffer, lfs_size_t size);
- static lfs_ssize_t lfs_file_rawwrite(lfs_t *lfs, lfs_file_t *file,
- const void *buffer, lfs_size_t size);
- static int lfs_file_rawsync(lfs_t *lfs, lfs_file_t *file);
- static int lfs_file_outline(lfs_t *lfs, lfs_file_t *file);
- static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file);
- static int lfs_fs_deorphan(lfs_t *lfs, bool powerloss);
- static int lfs_fs_preporphans(lfs_t *lfs, int8_t orphans);
- static void lfs_fs_prepmove(lfs_t *lfs,
- uint16_t id, const lfs_block_t pair[2]);
- static int lfs_fs_pred(lfs_t *lfs, const lfs_block_t dir[2],
- lfs_mdir_t *pdir);
- static lfs_stag_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t dir[2],
- lfs_mdir_t *parent);
- static int lfs_fs_forceconsistency(lfs_t *lfs);
- #endif
- #ifdef LFS_MIGRATE
- static int lfs1_traverse(lfs_t *lfs,
- int (*cb)(void*, lfs_block_t), void *data);
- #endif
- static int lfs_dir_rawrewind(lfs_t *lfs, lfs_dir_t *dir);
- static lfs_ssize_t lfs_file_flushedread(lfs_t *lfs, lfs_file_t *file,
- void *buffer, lfs_size_t size);
- static lfs_ssize_t lfs_file_rawread(lfs_t *lfs, lfs_file_t *file,
- void *buffer, lfs_size_t size);
- static int lfs_file_rawclose(lfs_t *lfs, lfs_file_t *file);
- static lfs_soff_t lfs_file_rawsize(lfs_t *lfs, lfs_file_t *file);
- static lfs_ssize_t lfs_fs_rawsize(lfs_t *lfs);
- static int lfs_fs_rawtraverse(lfs_t *lfs,
- int (*cb)(void *data, lfs_block_t block), void *data,
- bool includeorphans);
- static int lfs_deinit(lfs_t *lfs);
- static int lfs_rawunmount(lfs_t *lfs);
- /// Block allocator ///
- #ifndef LFS_READONLY
- static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
- lfs_t *lfs = (lfs_t*)p;
- lfs_block_t off = ((block - lfs->free.off)
- + lfs->cfg->block_count) % lfs->cfg->block_count;
- if (off < lfs->free.size) {
- lfs->free.buffer[off / 32] |= 1U << (off % 32);
- }
- return 0;
- }
- #endif
- // indicate allocated blocks have been committed into the filesystem, this
- // is to prevent blocks from being garbage collected in the middle of a
- // commit operation
- static void lfs_alloc_ack(lfs_t *lfs) {
- lfs->free.ack = lfs->cfg->block_count;
- }
- // drop the lookahead buffer, this is done during mounting and failed
- // traversals in order to avoid invalid lookahead state
- static void lfs_alloc_drop(lfs_t *lfs) {
- lfs->free.size = 0;
- lfs->free.i = 0;
- lfs_alloc_ack(lfs);
- }
- #ifndef LFS_READONLY
- static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
- while (true) {
- while (lfs->free.i != lfs->free.size) {
- lfs_block_t off = lfs->free.i;
- lfs->free.i += 1;
- lfs->free.ack -= 1;
- if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
- // found a free block
- *block = (lfs->free.off + off) % lfs->cfg->block_count;
- // eagerly find next off so an alloc ack can
- // discredit old lookahead blocks
- while (lfs->free.i != lfs->free.size &&
- (lfs->free.buffer[lfs->free.i / 32]
- & (1U << (lfs->free.i % 32)))) {
- lfs->free.i += 1;
- lfs->free.ack -= 1;
- }
- return 0;
- }
- }
- // check if we have looked at all blocks since last ack
- if (lfs->free.ack == 0) {
- LFS_ERROR("No more free space %"PRIu32,
- lfs->free.i + lfs->free.off);
- return LFS_ERR_NOSPC;
- }
- lfs->free.off = (lfs->free.off + lfs->free.size)
- % lfs->cfg->block_count;
- lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size, lfs->free.ack);
- lfs->free.i = 0;
- // find mask of free blocks from tree
- memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
- int err = lfs_fs_rawtraverse(lfs, lfs_alloc_lookahead, lfs, true);
- if (err) {
- lfs_alloc_drop(lfs);
- return err;
- }
- }
- }
- #endif
- /// Metadata pair and directory operations ///
- static lfs_stag_t lfs_dir_getslice(lfs_t *lfs, const lfs_mdir_t *dir,
- lfs_tag_t gmask, lfs_tag_t gtag,
- lfs_off_t goff, void *gbuffer, lfs_size_t gsize) {
- lfs_off_t off = dir->off;
- lfs_tag_t ntag = dir->etag;
- lfs_stag_t gdiff = 0;
- if (lfs_gstate_hasmovehere(&lfs->gdisk, dir->pair) &&
- lfs_tag_id(gmask) != 0 &&
- lfs_tag_id(lfs->gdisk.tag) <= lfs_tag_id(gtag)) {
- // synthetic moves
- gdiff -= LFS_MKTAG(0, 1, 0);
- }
- // iterate over dir block backwards (for faster lookups)
- while (off >= sizeof(lfs_tag_t) + lfs_tag_dsize(ntag)) {
- off -= lfs_tag_dsize(ntag);
- lfs_tag_t tag = ntag;
- int err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, sizeof(ntag),
- dir->pair[0], off, &ntag, sizeof(ntag));
- if (err) {
- return err;
- }
- ntag = (lfs_frombe32(ntag) ^ tag) & 0x7fffffff;
- if (lfs_tag_id(gmask) != 0 &&
- lfs_tag_type1(tag) == LFS_TYPE_SPLICE &&
- lfs_tag_id(tag) <= lfs_tag_id(gtag - gdiff)) {
- if (tag == (LFS_MKTAG(LFS_TYPE_CREATE, 0, 0) |
- (LFS_MKTAG(0, 0x3ff, 0) & (gtag - gdiff)))) {
- // found where we were created
- return LFS_ERR_NOENT;
- }
- // move around splices
- gdiff += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
- }
- if ((gmask & tag) == (gmask & (gtag - gdiff))) {
- if (lfs_tag_isdelete(tag)) {
- return LFS_ERR_NOENT;
- }
- lfs_size_t diff = lfs_min(lfs_tag_size(tag), gsize);
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, diff,
- dir->pair[0], off+sizeof(tag)+goff, gbuffer, diff);
- if (err) {
- return err;
- }
- memset((uint8_t*)gbuffer + diff, 0, gsize - diff);
- return tag + gdiff;
- }
- }
- return LFS_ERR_NOENT;
- }
- static lfs_stag_t lfs_dir_get(lfs_t *lfs, const lfs_mdir_t *dir,
- lfs_tag_t gmask, lfs_tag_t gtag, void *buffer) {
- return lfs_dir_getslice(lfs, dir,
- gmask, gtag,
- 0, buffer, lfs_tag_size(gtag));
- }
- static int lfs_dir_getread(lfs_t *lfs, const lfs_mdir_t *dir,
- const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
- lfs_tag_t gmask, lfs_tag_t gtag,
- lfs_off_t off, void *buffer, lfs_size_t size) {
- uint8_t *data = buffer;
- if (off+size > lfs->cfg->block_size) {
- return LFS_ERR_CORRUPT;
- }
- while (size > 0) {
- lfs_size_t diff = size;
- if (pcache && pcache->block == LFS_BLOCK_INLINE &&
- off < pcache->off + pcache->size) {
- if (off >= pcache->off) {
- // is already in pcache?
- diff = lfs_min(diff, pcache->size - (off-pcache->off));
- memcpy(data, &pcache->buffer[off-pcache->off], diff);
- data += diff;
- off += diff;
- size -= diff;
- continue;
- }
- // pcache takes priority
- diff = lfs_min(diff, pcache->off-off);
- }
- if (rcache->block == LFS_BLOCK_INLINE &&
- off < rcache->off + rcache->size) {
- if (off >= rcache->off) {
- // is already in rcache?
- diff = lfs_min(diff, rcache->size - (off-rcache->off));
- memcpy(data, &rcache->buffer[off-rcache->off], diff);
- data += diff;
- off += diff;
- size -= diff;
- continue;
- }
- // rcache takes priority
- diff = lfs_min(diff, rcache->off-off);
- }
- // load to cache, first condition can no longer fail
- rcache->block = LFS_BLOCK_INLINE;
- rcache->off = lfs_aligndown(off, lfs->cfg->read_size);
- rcache->size = lfs_min(lfs_alignup(off+hint, lfs->cfg->read_size),
- lfs->cfg->cache_size);
- int err = lfs_dir_getslice(lfs, dir, gmask, gtag,
- rcache->off, rcache->buffer, rcache->size);
- if (err < 0) {
- return err;
- }
- }
- return 0;
- }
- #ifndef LFS_READONLY
- static int lfs_dir_traverse_filter(void *p,
- lfs_tag_t tag, const void *buffer) {
- lfs_tag_t *filtertag = p;
- (void)buffer;
- // which mask depends on unique bit in tag structure
- uint32_t mask = (tag & LFS_MKTAG(0x100, 0, 0))
- ? LFS_MKTAG(0x7ff, 0x3ff, 0)
- : LFS_MKTAG(0x700, 0x3ff, 0);
- // check for redundancy
- if ((mask & tag) == (mask & *filtertag) ||
- lfs_tag_isdelete(*filtertag) ||
- (LFS_MKTAG(0x7ff, 0x3ff, 0) & tag) == (
- LFS_MKTAG(LFS_TYPE_DELETE, 0, 0) |
- (LFS_MKTAG(0, 0x3ff, 0) & *filtertag))) {
- *filtertag = LFS_MKTAG(LFS_FROM_NOOP, 0, 0);
- return true;
- }
- // check if we need to adjust for created/deleted tags
- if (lfs_tag_type1(tag) == LFS_TYPE_SPLICE &&
- lfs_tag_id(tag) <= lfs_tag_id(*filtertag)) {
- *filtertag += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
- }
- return false;
- }
- #endif
- #ifndef LFS_READONLY
- // maximum recursive depth of lfs_dir_traverse, the deepest call:
- //
- // traverse with commit
- // '-> traverse with move
- // '-> traverse with filter
- //
- #define LFS_DIR_TRAVERSE_DEPTH 3
- struct lfs_dir_traverse {
- const lfs_mdir_t *dir;
- lfs_off_t off;
- lfs_tag_t ptag;
- const struct lfs_mattr *attrs;
- int attrcount;
- lfs_tag_t tmask;
- lfs_tag_t ttag;
- uint16_t begin;
- uint16_t end;
- int16_t diff;
- int (*cb)(void *data, lfs_tag_t tag, const void *buffer);
- void *data;
- lfs_tag_t tag;
- const void *buffer;
- struct lfs_diskoff disk;
- };
- static int lfs_dir_traverse(lfs_t *lfs,
- const lfs_mdir_t *dir, lfs_off_t off, lfs_tag_t ptag,
- const struct lfs_mattr *attrs, int attrcount,
- lfs_tag_t tmask, lfs_tag_t ttag,
- uint16_t begin, uint16_t end, int16_t diff,
- int (*cb)(void *data, lfs_tag_t tag, const void *buffer), void *data) {
- // This function in inherently recursive, but bounded. To allow tool-based
- // analysis without unnecessary code-cost we use an explicit stack
- struct lfs_dir_traverse stack[LFS_DIR_TRAVERSE_DEPTH-1];
- unsigned sp = 0;
- int res;
- // iterate over directory and attrs
- lfs_tag_t tag;
- const void *buffer;
- struct lfs_diskoff disk;
- while (true) {
- {
- if (off+lfs_tag_dsize(ptag) < dir->off) {
- off += lfs_tag_dsize(ptag);
- int err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, sizeof(tag),
- dir->pair[0], off, &tag, sizeof(tag));
- if (err) {
- return err;
- }
- tag = (lfs_frombe32(tag) ^ ptag) | 0x80000000;
- disk.block = dir->pair[0];
- disk.off = off+sizeof(lfs_tag_t);
- buffer = &disk;
- ptag = tag;
- } else if (attrcount > 0) {
- tag = attrs[0].tag;
- buffer = attrs[0].buffer;
- attrs += 1;
- attrcount -= 1;
- } else {
- // finished traversal, pop from stack?
- res = 0;
- break;
- }
- // do we need to filter?
- lfs_tag_t mask = LFS_MKTAG(0x7ff, 0, 0);
- if ((mask & tmask & tag) != (mask & tmask & ttag)) {
- continue;
- }
- if (lfs_tag_id(tmask) != 0) {
- LFS_ASSERT(sp < LFS_DIR_TRAVERSE_DEPTH);
- // recurse, scan for duplicates, and update tag based on
- // creates/deletes
- stack[sp] = (struct lfs_dir_traverse){
- .dir = dir,
- .off = off,
- .ptag = ptag,
- .attrs = attrs,
- .attrcount = attrcount,
- .tmask = tmask,
- .ttag = ttag,
- .begin = begin,
- .end = end,
- .diff = diff,
- .cb = cb,
- .data = data,
- .tag = tag,
- .buffer = buffer,
- .disk = disk,
- };
- sp += 1;
- dir = dir;
- off = off;
- ptag = ptag;
- attrs = attrs;
- attrcount = attrcount;
- tmask = 0;
- ttag = 0;
- begin = 0;
- end = 0;
- diff = 0;
- cb = lfs_dir_traverse_filter;
- data = &stack[sp-1].tag;
- continue;
- }
- }
- popped:
- // in filter range?
- if (lfs_tag_id(tmask) != 0 &&
- !(lfs_tag_id(tag) >= begin && lfs_tag_id(tag) < end)) {
- continue;
- }
- // handle special cases for mcu-side operations
- if (lfs_tag_type3(tag) == LFS_FROM_NOOP) {
- // do nothing
- } else if (lfs_tag_type3(tag) == LFS_FROM_MOVE) {
- // Without this condition, lfs_dir_traverse can exhibit an
- // extremely expensive O(n^3) of nested loops when renaming.
- // This happens because lfs_dir_traverse tries to filter tags by
- // the tags in the source directory, triggering a second
- // lfs_dir_traverse with its own filter operation.
- //
- // traverse with commit
- // '-> traverse with filter
- // '-> traverse with move
- // '-> traverse with filter
- //
- // However we don't actually care about filtering the second set of
- // tags, since duplicate tags have no effect when filtering.
- //
- // This check skips this unnecessary recursive filtering explicitly,
- // reducing this runtime from O(n^3) to O(n^2).
- if (cb == lfs_dir_traverse_filter) {
- continue;
- }
- // recurse into move
- stack[sp] = (struct lfs_dir_traverse){
- .dir = dir,
- .off = off,
- .ptag = ptag,
- .attrs = attrs,
- .attrcount = attrcount,
- .tmask = tmask,
- .ttag = ttag,
- .begin = begin,
- .end = end,
- .diff = diff,
- .cb = cb,
- .data = data,
- .tag = LFS_MKTAG(LFS_FROM_NOOP, 0, 0),
- };
- sp += 1;
- uint16_t fromid = lfs_tag_size(tag);
- uint16_t toid = lfs_tag_id(tag);
- dir = buffer;
- off = 0;
- ptag = 0xffffffff;
- attrs = NULL;
- attrcount = 0;
- tmask = LFS_MKTAG(0x600, 0x3ff, 0);
- ttag = LFS_MKTAG(LFS_TYPE_STRUCT, 0, 0);
- begin = fromid;
- end = fromid+1;
- diff = toid-fromid+diff;
- } else if (lfs_tag_type3(tag) == LFS_FROM_USERATTRS) {
- for (unsigned i = 0; i < lfs_tag_size(tag); i++) {
- const struct lfs_attr *a = buffer;
- res = cb(data, LFS_MKTAG(LFS_TYPE_USERATTR + a[i].type,
- lfs_tag_id(tag) + diff, a[i].size), a[i].buffer);
- if (res < 0) {
- return res;
- }
- if (res) {
- break;
- }
- }
- } else {
- res = cb(data, tag + LFS_MKTAG(0, diff, 0), buffer);
- if (res < 0) {
- return res;
- }
- if (res) {
- break;
- }
- }
- }
- if (sp > 0) {
- // pop from the stack and return, fortunately all pops share
- // a destination
- dir = stack[sp-1].dir;
- off = stack[sp-1].off;
- ptag = stack[sp-1].ptag;
- attrs = stack[sp-1].attrs;
- attrcount = stack[sp-1].attrcount;
- tmask = stack[sp-1].tmask;
- ttag = stack[sp-1].ttag;
- begin = stack[sp-1].begin;
- end = stack[sp-1].end;
- diff = stack[sp-1].diff;
- cb = stack[sp-1].cb;
- data = stack[sp-1].data;
- tag = stack[sp-1].tag;
- buffer = stack[sp-1].buffer;
- disk = stack[sp-1].disk;
- sp -= 1;
- goto popped;
- } else {
- return res;
- }
- }
- #endif
- static lfs_stag_t lfs_dir_fetchmatch(lfs_t *lfs,
- lfs_mdir_t *dir, const lfs_block_t pair[2],
- lfs_tag_t fmask, lfs_tag_t ftag, uint16_t *id,
- int (*cb)(void *data, lfs_tag_t tag, const void *buffer), void *data) {
- // we can find tag very efficiently during a fetch, since we're already
- // scanning the entire directory
- lfs_stag_t besttag = -1;
- // if either block address is invalid we return LFS_ERR_CORRUPT here,
- // otherwise later writes to the pair could fail
- if (pair[0] >= lfs->cfg->block_count || pair[1] >= lfs->cfg->block_count) {
- return LFS_ERR_CORRUPT;
- }
- // find the block with the most recent revision
- uint32_t revs[2] = {0, 0};
- int r = 0;
- for (int i = 0; i < 2; i++) {
- int err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, sizeof(revs[i]),
- pair[i], 0, &revs[i], sizeof(revs[i]));
- revs[i] = lfs_fromle32(revs[i]);
- if (err && err != LFS_ERR_CORRUPT) {
- return err;
- }
- if (err != LFS_ERR_CORRUPT &&
- lfs_scmp(revs[i], revs[(i+1)%2]) > 0) {
- r = i;
- }
- }
- dir->pair[0] = pair[(r+0)%2];
- dir->pair[1] = pair[(r+1)%2];
- dir->rev = revs[(r+0)%2];
- dir->off = 0; // nonzero = found some commits
- // now scan tags to fetch the actual dir and find possible match
- for (int i = 0; i < 2; i++) {
- lfs_off_t off = 0;
- lfs_tag_t ptag = 0xffffffff;
- uint16_t tempcount = 0;
- lfs_block_t temptail[2] = {LFS_BLOCK_NULL, LFS_BLOCK_NULL};
- bool tempsplit = false;
- lfs_stag_t tempbesttag = besttag;
- dir->rev = lfs_tole32(dir->rev);
- uint32_t crc = lfs_crc(0xffffffff, &dir->rev, sizeof(dir->rev));
- dir->rev = lfs_fromle32(dir->rev);
- while (true) {
- // extract next tag
- lfs_tag_t tag;
- off += lfs_tag_dsize(ptag);
- int err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, lfs->cfg->block_size,
- dir->pair[0], off, &tag, sizeof(tag));
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- // can't continue?
- dir->erased = false;
- break;
- }
- return err;
- }
- crc = lfs_crc(crc, &tag, sizeof(tag));
- tag = lfs_frombe32(tag) ^ ptag;
- // next commit not yet programmed or we're not in valid range
- if (!lfs_tag_isvalid(tag)) {
- dir->erased = (lfs_tag_type1(ptag) == LFS_TYPE_CRC &&
- dir->off % lfs->cfg->prog_size == 0);
- break;
- } else if (off + lfs_tag_dsize(tag) > lfs->cfg->block_size) {
- dir->erased = false;
- break;
- }
- ptag = tag;
- if (lfs_tag_type1(tag) == LFS_TYPE_CRC) {
- // check the crc attr
- uint32_t dcrc;
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, lfs->cfg->block_size,
- dir->pair[0], off+sizeof(tag), &dcrc, sizeof(dcrc));
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- dir->erased = false;
- break;
- }
- return err;
- }
- dcrc = lfs_fromle32(dcrc);
- if (crc != dcrc) {
- dir->erased = false;
- break;
- }
- // reset the next bit if we need to
- ptag ^= (lfs_tag_t)(lfs_tag_chunk(tag) & 1U) << 31;
- // toss our crc into the filesystem seed for
- // pseudorandom numbers, note we use another crc here
- // as a collection function because it is sufficiently
- // random and convenient
- lfs->seed = lfs_crc(lfs->seed, &crc, sizeof(crc));
- // update with what's found so far
- besttag = tempbesttag;
- dir->off = off + lfs_tag_dsize(tag);
- dir->etag = ptag;
- dir->count = tempcount;
- dir->tail[0] = temptail[0];
- dir->tail[1] = temptail[1];
- dir->split = tempsplit;
- // reset crc
- crc = 0xffffffff;
- continue;
- }
- // crc the entry first, hopefully leaving it in the cache
- for (lfs_off_t j = sizeof(tag); j < lfs_tag_dsize(tag); j++) {
- uint8_t dat;
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, lfs->cfg->block_size,
- dir->pair[0], off+j, &dat, 1);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- dir->erased = false;
- break;
- }
- return err;
- }
- crc = lfs_crc(crc, &dat, 1);
- }
- // directory modification tags?
- if (lfs_tag_type1(tag) == LFS_TYPE_NAME) {
- // increase count of files if necessary
- if (lfs_tag_id(tag) >= tempcount) {
- tempcount = lfs_tag_id(tag) + 1;
- }
- } else if (lfs_tag_type1(tag) == LFS_TYPE_SPLICE) {
- tempcount += lfs_tag_splice(tag);
- if (tag == (LFS_MKTAG(LFS_TYPE_DELETE, 0, 0) |
- (LFS_MKTAG(0, 0x3ff, 0) & tempbesttag))) {
- tempbesttag |= 0x80000000;
- } else if (tempbesttag != -1 &&
- lfs_tag_id(tag) <= lfs_tag_id(tempbesttag)) {
- tempbesttag += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
- }
- } else if (lfs_tag_type1(tag) == LFS_TYPE_TAIL) {
- tempsplit = (lfs_tag_chunk(tag) & 1);
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, lfs->cfg->block_size,
- dir->pair[0], off+sizeof(tag), &temptail, 8);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- dir->erased = false;
- break;
- }
- }
- lfs_pair_fromle32(temptail);
- }
- // found a match for our fetcher?
- if ((fmask & tag) == (fmask & ftag)) {
- int res = cb(data, tag, &(struct lfs_diskoff){
- dir->pair[0], off+sizeof(tag)});
- if (res < 0) {
- if (res == LFS_ERR_CORRUPT) {
- dir->erased = false;
- break;
- }
- return res;
- }
- if (res == LFS_CMP_EQ) {
- // found a match
- tempbesttag = tag;
- } else if ((LFS_MKTAG(0x7ff, 0x3ff, 0) & tag) ==
- (LFS_MKTAG(0x7ff, 0x3ff, 0) & tempbesttag)) {
- // found an identical tag, but contents didn't match
- // this must mean that our besttag has been overwritten
- tempbesttag = -1;
- } else if (res == LFS_CMP_GT &&
- lfs_tag_id(tag) <= lfs_tag_id(tempbesttag)) {
- // found a greater match, keep track to keep things sorted
- tempbesttag = tag | 0x80000000;
- }
- }
- }
- // consider what we have good enough
- if (dir->off > 0) {
- // synthetic move
- if (lfs_gstate_hasmovehere(&lfs->gdisk, dir->pair)) {
- if (lfs_tag_id(lfs->gdisk.tag) == lfs_tag_id(besttag)) {
- besttag |= 0x80000000;
- } else if (besttag != -1 &&
- lfs_tag_id(lfs->gdisk.tag) < lfs_tag_id(besttag)) {
- besttag -= LFS_MKTAG(0, 1, 0);
- }
- }
- // found tag? or found best id?
- if (id) {
- *id = lfs_min(lfs_tag_id(besttag), dir->count);
- }
- if (lfs_tag_isvalid(besttag)) {
- return besttag;
- } else if (lfs_tag_id(besttag) < dir->count) {
- return LFS_ERR_NOENT;
- } else {
- return 0;
- }
- }
- // failed, try the other block?
- lfs_pair_swap(dir->pair);
- dir->rev = revs[(r+1)%2];
- }
- LFS_ERROR("Corrupted dir pair at {0x%"PRIx32", 0x%"PRIx32"}",
- dir->pair[0], dir->pair[1]);
- return LFS_ERR_CORRUPT;
- }
- static int lfs_dir_fetch(lfs_t *lfs,
- lfs_mdir_t *dir, const lfs_block_t pair[2]) {
- // note, mask=-1, tag=-1 can never match a tag since this
- // pattern has the invalid bit set
- return (int)lfs_dir_fetchmatch(lfs, dir, pair,
- (lfs_tag_t)-1, (lfs_tag_t)-1, NULL, NULL, NULL);
- }
- static int lfs_dir_getgstate(lfs_t *lfs, const lfs_mdir_t *dir,
- lfs_gstate_t *gstate) {
- lfs_gstate_t temp;
- lfs_stag_t res = lfs_dir_get(lfs, dir, LFS_MKTAG(0x7ff, 0, 0),
- LFS_MKTAG(LFS_TYPE_MOVESTATE, 0, sizeof(temp)), &temp);
- if (res < 0 && res != LFS_ERR_NOENT) {
- return res;
- }
- if (res != LFS_ERR_NOENT) {
- // xor together to find resulting gstate
- lfs_gstate_fromle32(&temp);
- lfs_gstate_xor(gstate, &temp);
- }
- return 0;
- }
- static int lfs_dir_getinfo(lfs_t *lfs, lfs_mdir_t *dir,
- uint16_t id, struct lfs_info *info) {
- if (id == 0x3ff) {
- // special case for root
- strcpy(info->name, "/");
- info->type = LFS_TYPE_DIR;
- return 0;
- }
- lfs_stag_t tag = lfs_dir_get(lfs, dir, LFS_MKTAG(0x780, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_NAME, id, lfs->name_max+1), info->name);
- if (tag < 0) {
- return (int)tag;
- }
- info->type = lfs_tag_type3(tag);
- struct lfs_ctz ctz;
- tag = lfs_dir_get(lfs, dir, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
- if (tag < 0) {
- return (int)tag;
- }
- lfs_ctz_fromle32(&ctz);
- if (lfs_tag_type3(tag) == LFS_TYPE_CTZSTRUCT) {
- info->size = ctz.size;
- } else if (lfs_tag_type3(tag) == LFS_TYPE_INLINESTRUCT) {
- info->size = lfs_tag_size(tag);
- }
- return 0;
- }
- struct lfs_dir_find_match {
- lfs_t *lfs;
- const void *name;
- lfs_size_t size;
- };
- static int lfs_dir_find_match(void *data,
- lfs_tag_t tag, const void *buffer) {
- struct lfs_dir_find_match *name = data;
- lfs_t *lfs = name->lfs;
- const struct lfs_diskoff *disk = buffer;
- // compare with disk
- lfs_size_t diff = lfs_min(name->size, lfs_tag_size(tag));
- int res = lfs_bd_cmp(lfs,
- NULL, &lfs->rcache, diff,
- disk->block, disk->off, name->name, diff);
- if (res != LFS_CMP_EQ) {
- return res;
- }
- // only equal if our size is still the same
- if (name->size != lfs_tag_size(tag)) {
- return (name->size < lfs_tag_size(tag)) ? LFS_CMP_LT : LFS_CMP_GT;
- }
- // found a match!
- return LFS_CMP_EQ;
- }
- static lfs_stag_t lfs_dir_find(lfs_t *lfs, lfs_mdir_t *dir,
- const char **path, uint16_t *id) {
- // we reduce path to a single name if we can find it
- const char *name = *path;
- if (id) {
- *id = 0x3ff;
- }
- // default to root dir
- lfs_stag_t tag = LFS_MKTAG(LFS_TYPE_DIR, 0x3ff, 0);
- dir->tail[0] = lfs->root[0];
- dir->tail[1] = lfs->root[1];
- while (true) {
- nextname:
- // skip slashes
- name += strspn(name, "/");
- lfs_size_t namelen = strcspn(name, "/");
- // skip '.' and root '..'
- if ((namelen == 1 && memcmp(name, ".", 1) == 0) ||
- (namelen == 2 && memcmp(name, "..", 2) == 0)) {
- name += namelen;
- goto nextname;
- }
- // skip if matched by '..' in name
- const char *suffix = name + namelen;
- lfs_size_t sufflen;
- int depth = 1;
- while (true) {
- suffix += strspn(suffix, "/");
- sufflen = strcspn(suffix, "/");
- if (sufflen == 0) {
- break;
- }
- if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
- depth -= 1;
- if (depth == 0) {
- name = suffix + sufflen;
- goto nextname;
- }
- } else {
- depth += 1;
- }
- suffix += sufflen;
- }
- // found path
- if (name[0] == '\0') {
- return tag;
- }
- // update what we've found so far
- *path = name;
- // only continue if we hit a directory
- if (lfs_tag_type3(tag) != LFS_TYPE_DIR) {
- return LFS_ERR_NOTDIR;
- }
- // grab the entry data
- if (lfs_tag_id(tag) != 0x3ff) {
- lfs_stag_t res = lfs_dir_get(lfs, dir, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), dir->tail);
- if (res < 0) {
- return res;
- }
- lfs_pair_fromle32(dir->tail);
- }
- // find entry matching name
- while (true) {
- tag = lfs_dir_fetchmatch(lfs, dir, dir->tail,
- LFS_MKTAG(0x780, 0, 0),
- LFS_MKTAG(LFS_TYPE_NAME, 0, namelen),
- // are we last name?
- (strchr(name, '/') == NULL) ? id : NULL,
- lfs_dir_find_match, &(struct lfs_dir_find_match){
- lfs, name, namelen});
- if (tag < 0) {
- return tag;
- }
- if (tag) {
- break;
- }
- if (!dir->split) {
- return LFS_ERR_NOENT;
- }
- }
- // to next name
- name += namelen;
- }
- }
- // commit logic
- struct lfs_commit {
- lfs_block_t block;
- lfs_off_t off;
- lfs_tag_t ptag;
- uint32_t crc;
- lfs_off_t begin;
- lfs_off_t end;
- };
- #ifndef LFS_READONLY
- static int lfs_dir_commitprog(lfs_t *lfs, struct lfs_commit *commit,
- const void *buffer, lfs_size_t size) {
- int err = lfs_bd_prog(lfs,
- &lfs->pcache, &lfs->rcache, false,
- commit->block, commit->off ,
- (const uint8_t*)buffer, size);
- if (err) {
- return err;
- }
- commit->crc = lfs_crc(commit->crc, buffer, size);
- commit->off += size;
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_commitattr(lfs_t *lfs, struct lfs_commit *commit,
- lfs_tag_t tag, const void *buffer) {
- // check if we fit
- lfs_size_t dsize = lfs_tag_dsize(tag);
- if (commit->off + dsize > commit->end) {
- return LFS_ERR_NOSPC;
- }
- // write out tag
- lfs_tag_t ntag = lfs_tobe32((tag & 0x7fffffff) ^ commit->ptag);
- int err = lfs_dir_commitprog(lfs, commit, &ntag, sizeof(ntag));
- if (err) {
- return err;
- }
- if (!(tag & 0x80000000)) {
- // from memory
- err = lfs_dir_commitprog(lfs, commit, buffer, dsize-sizeof(tag));
- if (err) {
- return err;
- }
- } else {
- // from disk
- const struct lfs_diskoff *disk = buffer;
- for (lfs_off_t i = 0; i < dsize-sizeof(tag); i++) {
- // rely on caching to make this efficient
- uint8_t dat;
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, dsize-sizeof(tag)-i,
- disk->block, disk->off+i, &dat, 1);
- if (err) {
- return err;
- }
- err = lfs_dir_commitprog(lfs, commit, &dat, 1);
- if (err) {
- return err;
- }
- }
- }
- commit->ptag = tag & 0x7fffffff;
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_commitcrc(lfs_t *lfs, struct lfs_commit *commit) {
- // align to program units
- const lfs_off_t end = lfs_alignup(commit->off + 2*sizeof(uint32_t),
- lfs->cfg->prog_size);
- lfs_off_t off1 = 0;
- uint32_t crc1 = 0;
- // create crc tags to fill up remainder of commit, note that
- // padding is not crced, which lets fetches skip padding but
- // makes committing a bit more complicated
- while (commit->off < end) {
- lfs_off_t off = commit->off + sizeof(lfs_tag_t);
- lfs_off_t noff = lfs_min(end - off, 0x3fe) + off;
- if (noff < end) {
- noff = lfs_min(noff, end - 2*sizeof(uint32_t));
- }
- // read erased state from next program unit
- lfs_tag_t tag = 0xffffffff;
- int err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, sizeof(tag),
- commit->block, noff, &tag, sizeof(tag));
- if (err && err != LFS_ERR_CORRUPT) {
- return err;
- }
- // build crc tag
- bool reset = ~lfs_frombe32(tag) >> 31;
- tag = LFS_MKTAG(LFS_TYPE_CRC + reset, 0x3ff, noff - off);
- // write out crc
- uint32_t footer[2];
- footer[0] = lfs_tobe32(tag ^ commit->ptag);
- commit->crc = lfs_crc(commit->crc, &footer[0], sizeof(footer[0]));
- footer[1] = lfs_tole32(commit->crc);
- err = lfs_bd_prog(lfs,
- &lfs->pcache, &lfs->rcache, false,
- commit->block, commit->off, &footer, sizeof(footer));
- if (err) {
- return err;
- }
- // keep track of non-padding checksum to verify
- if (off1 == 0) {
- off1 = commit->off + sizeof(uint32_t);
- crc1 = commit->crc;
- }
- commit->off += sizeof(tag)+lfs_tag_size(tag);
- commit->ptag = tag ^ ((lfs_tag_t)reset << 31);
- commit->crc = 0xffffffff; // reset crc for next "commit"
- }
- // flush buffers
- int err = lfs_bd_sync(lfs, &lfs->pcache, &lfs->rcache, false);
- if (err) {
- return err;
- }
- // successful commit, check checksums to make sure
- lfs_off_t off = commit->begin;
- lfs_off_t noff = off1;
- while (off < end) {
- uint32_t crc = 0xffffffff;
- for (lfs_off_t i = off; i < noff+sizeof(uint32_t); i++) {
- // check against written crc, may catch blocks that
- // become readonly and match our commit size exactly
- if (i == off1 && crc != crc1) {
- return LFS_ERR_CORRUPT;
- }
- // leave it up to caching to make this efficient
- uint8_t dat;
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, noff+sizeof(uint32_t)-i,
- commit->block, i, &dat, 1);
- if (err) {
- return err;
- }
- crc = lfs_crc(crc, &dat, 1);
- }
- // detected write error?
- if (crc != 0) {
- return LFS_ERR_CORRUPT;
- }
- // skip padding
- off = lfs_min(end - noff, 0x3fe) + noff;
- if (off < end) {
- off = lfs_min(off, end - 2*sizeof(uint32_t));
- }
- noff = off + sizeof(uint32_t);
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_alloc(lfs_t *lfs, lfs_mdir_t *dir) {
- // allocate pair of dir blocks (backwards, so we write block 1 first)
- for (int i = 0; i < 2; i++) {
- int err = lfs_alloc(lfs, &dir->pair[(i+1)%2]);
- if (err) {
- return err;
- }
- }
- // zero for reproducibility in case initial block is unreadable
- dir->rev = 0;
- // rather than clobbering one of the blocks we just pretend
- // the revision may be valid
- int err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, sizeof(dir->rev),
- dir->pair[0], 0, &dir->rev, sizeof(dir->rev));
- dir->rev = lfs_fromle32(dir->rev);
- if (err && err != LFS_ERR_CORRUPT) {
- return err;
- }
- // to make sure we don't immediately evict, align the new revision count
- // to our block_cycles modulus, see lfs_dir_compact for why our modulus
- // is tweaked this way
- if (lfs->cfg->block_cycles > 0) {
- dir->rev = lfs_alignup(dir->rev, ((lfs->cfg->block_cycles+1)|1));
- }
- // set defaults
- dir->off = sizeof(dir->rev);
- dir->etag = 0xffffffff;
- dir->count = 0;
- dir->tail[0] = LFS_BLOCK_NULL;
- dir->tail[1] = LFS_BLOCK_NULL;
- dir->erased = false;
- dir->split = false;
- // don't write out yet, let caller take care of that
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_drop(lfs_t *lfs, lfs_mdir_t *dir, lfs_mdir_t *tail) {
- // steal state
- int err = lfs_dir_getgstate(lfs, tail, &lfs->gdelta);
- if (err) {
- return err;
- }
- // steal tail
- lfs_pair_tole32(tail->tail);
- err = lfs_dir_commit(lfs, dir, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_TAIL + tail->split, 0x3ff, 8), tail->tail}));
- lfs_pair_fromle32(tail->tail);
- if (err) {
- return err;
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_split(lfs_t *lfs,
- lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
- lfs_mdir_t *source, uint16_t split, uint16_t end) {
- // create tail metadata pair
- lfs_mdir_t tail;
- int err = lfs_dir_alloc(lfs, &tail);
- if (err) {
- return err;
- }
- tail.split = dir->split;
- tail.tail[0] = dir->tail[0];
- tail.tail[1] = dir->tail[1];
- // note we don't care about LFS_OK_RELOCATED
- int res = lfs_dir_compact(lfs, &tail, attrs, attrcount, source, split, end);
- if (res < 0) {
- return res;
- }
- dir->tail[0] = tail.pair[0];
- dir->tail[1] = tail.pair[1];
- dir->split = true;
- // update root if needed
- if (lfs_pair_cmp(dir->pair, lfs->root) == 0 && split == 0) {
- lfs->root[0] = tail.pair[0];
- lfs->root[1] = tail.pair[1];
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_commit_size(void *p, lfs_tag_t tag, const void *buffer) {
- lfs_size_t *size = p;
- (void)buffer;
- *size += lfs_tag_dsize(tag);
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- struct lfs_dir_commit_commit {
- lfs_t *lfs;
- struct lfs_commit *commit;
- };
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_commit_commit(void *p, lfs_tag_t tag, const void *buffer) {
- struct lfs_dir_commit_commit *commit = p;
- return lfs_dir_commitattr(commit->lfs, commit->commit, tag, buffer);
- }
- #endif
- #ifndef LFS_READONLY
- static bool lfs_dir_needsrelocation(lfs_t *lfs, lfs_mdir_t *dir) {
- // If our revision count == n * block_cycles, we should force a relocation,
- // this is how littlefs wear-levels at the metadata-pair level. Note that we
- // actually use (block_cycles+1)|1, this is to avoid two corner cases:
- // 1. block_cycles = 1, which would prevent relocations from terminating
- // 2. block_cycles = 2n, which, due to aliasing, would only ever relocate
- // one metadata block in the pair, effectively making this useless
- return (lfs->cfg->block_cycles > 0
- && ((dir->rev + 1) % ((lfs->cfg->block_cycles+1)|1) == 0));
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_compact(lfs_t *lfs,
- lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
- lfs_mdir_t *source, uint16_t begin, uint16_t end) {
- // save some state in case block is bad
- bool relocated = false;
- bool tired = lfs_dir_needsrelocation(lfs, dir);
- // increment revision count
- dir->rev += 1;
- // do not proactively relocate blocks during migrations, this
- // can cause a number of failure states such: clobbering the
- // v1 superblock if we relocate root, and invalidating directory
- // pointers if we relocate the head of a directory. On top of
- // this, relocations increase the overall complexity of
- // lfs_migration, which is already a delicate operation.
- #ifdef LFS_MIGRATE
- if (lfs->lfs1) {
- tired = false;
- }
- #endif
- if (tired && lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) != 0) {
- // we're writing too much, time to relocate
- goto relocate;
- }
- // begin loop to commit compaction to blocks until a compact sticks
- while (true) {
- {
- // setup commit state
- struct lfs_commit commit = {
- .block = dir->pair[1],
- .off = 0,
- .ptag = 0xffffffff,
- .crc = 0xffffffff,
- .begin = 0,
- .end = (lfs->cfg->metadata_max ?
- lfs->cfg->metadata_max : lfs->cfg->block_size) - 8,
- };
- // erase block to write to
- int err = lfs_bd_erase(lfs, dir->pair[1]);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- // write out header
- dir->rev = lfs_tole32(dir->rev);
- err = lfs_dir_commitprog(lfs, &commit,
- &dir->rev, sizeof(dir->rev));
- dir->rev = lfs_fromle32(dir->rev);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- // traverse the directory, this time writing out all unique tags
- err = lfs_dir_traverse(lfs,
- source, 0, 0xffffffff, attrs, attrcount,
- LFS_MKTAG(0x400, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_NAME, 0, 0),
- begin, end, -begin,
- lfs_dir_commit_commit, &(struct lfs_dir_commit_commit){
- lfs, &commit});
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- // commit tail, which may be new after last size check
- if (!lfs_pair_isnull(dir->tail)) {
- lfs_pair_tole32(dir->tail);
- err = lfs_dir_commitattr(lfs, &commit,
- LFS_MKTAG(LFS_TYPE_TAIL + dir->split, 0x3ff, 8),
- dir->tail);
- lfs_pair_fromle32(dir->tail);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- }
- // bring over gstate?
- lfs_gstate_t delta = {0};
- if (!relocated) {
- lfs_gstate_xor(&delta, &lfs->gdisk);
- lfs_gstate_xor(&delta, &lfs->gstate);
- }
- lfs_gstate_xor(&delta, &lfs->gdelta);
- delta.tag &= ~LFS_MKTAG(0, 0, 0x3ff);
- err = lfs_dir_getgstate(lfs, dir, &delta);
- if (err) {
- return err;
- }
- if (!lfs_gstate_iszero(&delta)) {
- lfs_gstate_tole32(&delta);
- err = lfs_dir_commitattr(lfs, &commit,
- LFS_MKTAG(LFS_TYPE_MOVESTATE, 0x3ff,
- sizeof(delta)), &delta);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- }
- // complete commit with crc
- err = lfs_dir_commitcrc(lfs, &commit);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- // successful compaction, swap dir pair to indicate most recent
- LFS_ASSERT(commit.off % lfs->cfg->prog_size == 0);
- lfs_pair_swap(dir->pair);
- dir->count = end - begin;
- dir->off = commit.off;
- dir->etag = commit.ptag;
- // update gstate
- lfs->gdelta = (lfs_gstate_t){0};
- if (!relocated) {
- lfs->gdisk = lfs->gstate;
- }
- }
- break;
- relocate:
- // commit was corrupted, drop caches and prepare to relocate block
- relocated = true;
- lfs_cache_drop(lfs, &lfs->pcache);
- if (!tired) {
- LFS_DEBUG("Bad block at 0x%"PRIx32, dir->pair[1]);
- }
- // can't relocate superblock, filesystem is now frozen
- if (lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) == 0) {
- LFS_WARN("Superblock 0x%"PRIx32" has become unwritable",
- dir->pair[1]);
- return LFS_ERR_NOSPC;
- }
- // relocate half of pair
- int err = lfs_alloc(lfs, &dir->pair[1]);
- if (err && (err != LFS_ERR_NOSPC || !tired)) {
- return err;
- }
- tired = false;
- continue;
- }
- return relocated ? LFS_OK_RELOCATED : 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_splittingcompact(lfs_t *lfs, lfs_mdir_t *dir,
- const struct lfs_mattr *attrs, int attrcount,
- lfs_mdir_t *source, uint16_t begin, uint16_t end) {
- while (true) {
- // find size of first split, we do this by halving the split until
- // the metadata is guaranteed to fit
- //
- // Note that this isn't a true binary search, we never increase the
- // split size. This may result in poorly distributed metadata but isn't
- // worth the extra code size or performance hit to fix.
- lfs_size_t split = begin;
- while (end - split > 1) {
- lfs_size_t size = 0;
- int err = lfs_dir_traverse(lfs,
- source, 0, 0xffffffff, attrs, attrcount,
- LFS_MKTAG(0x400, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_NAME, 0, 0),
- split, end, -split,
- lfs_dir_commit_size, &size);
- if (err) {
- return err;
- }
- // space is complicated, we need room for tail, crc, gstate,
- // cleanup delete, and we cap at half a block to give room
- // for metadata updates.
- if (end - split < 0xff
- && size <= lfs_min(lfs->cfg->block_size - 36,
- lfs_alignup(
- (lfs->cfg->metadata_max
- ? lfs->cfg->metadata_max
- : lfs->cfg->block_size)/2,
- lfs->cfg->prog_size))) {
- break;
- }
- split = split + ((end - split) / 2);
- }
- if (split == begin) {
- // no split needed
- break;
- }
- // split into two metadata pairs and continue
- int err = lfs_dir_split(lfs, dir, attrs, attrcount,
- source, split, end);
- if (err && err != LFS_ERR_NOSPC) {
- return err;
- }
- if (err) {
- // we can't allocate a new block, try to compact with degraded
- // performance
- LFS_WARN("Unable to split {0x%"PRIx32", 0x%"PRIx32"}",
- dir->pair[0], dir->pair[1]);
- break;
- } else {
- end = split;
- }
- }
- if (lfs_dir_needsrelocation(lfs, dir)
- && lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) == 0) {
- // oh no! we're writing too much to the superblock,
- // should we expand?
- lfs_ssize_t size = lfs_fs_rawsize(lfs);
- if (size < 0) {
- return size;
- }
- // do we have extra space? littlefs can't reclaim this space
- // by itself, so expand cautiously
- if ((lfs_size_t)size < lfs->cfg->block_count/2) {
- LFS_DEBUG("Expanding superblock at rev %"PRIu32, dir->rev);
- int err = lfs_dir_split(lfs, dir, attrs, attrcount,
- source, begin, end);
- if (err && err != LFS_ERR_NOSPC) {
- return err;
- }
- if (err) {
- // welp, we tried, if we ran out of space there's not much
- // we can do, we'll error later if we've become frozen
- LFS_WARN("Unable to expand superblock");
- } else {
- end = begin;
- }
- }
- }
- return lfs_dir_compact(lfs, dir, attrs, attrcount, source, begin, end);
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_relocatingcommit(lfs_t *lfs, lfs_mdir_t *dir,
- const lfs_block_t pair[2],
- const struct lfs_mattr *attrs, int attrcount,
- lfs_mdir_t *pdir) {
- int state = 0;
- // calculate changes to the directory
- bool hasdelete = false;
- for (int i = 0; i < attrcount; i++) {
- if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_CREATE) {
- dir->count += 1;
- } else if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_DELETE) {
- LFS_ASSERT(dir->count > 0);
- dir->count -= 1;
- hasdelete = true;
- } else if (lfs_tag_type1(attrs[i].tag) == LFS_TYPE_TAIL) {
- dir->tail[0] = ((lfs_block_t*)attrs[i].buffer)[0];
- dir->tail[1] = ((lfs_block_t*)attrs[i].buffer)[1];
- dir->split = (lfs_tag_chunk(attrs[i].tag) & 1);
- lfs_pair_fromle32(dir->tail);
- }
- }
- // should we actually drop the directory block?
- if (hasdelete && dir->count == 0) {
- LFS_ASSERT(pdir);
- int err = lfs_fs_pred(lfs, dir->pair, pdir);
- if (err && err != LFS_ERR_NOENT) {
- return err;
- }
- if (err != LFS_ERR_NOENT && pdir->split) {
- state = LFS_OK_DROPPED;
- goto fixmlist;
- }
- }
- if (dir->erased) {
- // try to commit
- struct lfs_commit commit = {
- .block = dir->pair[0],
- .off = dir->off,
- .ptag = dir->etag,
- .crc = 0xffffffff,
- .begin = dir->off,
- .end = (lfs->cfg->metadata_max ?
- lfs->cfg->metadata_max : lfs->cfg->block_size) - 8,
- };
- // traverse attrs that need to be written out
- lfs_pair_tole32(dir->tail);
- int err = lfs_dir_traverse(lfs,
- dir, dir->off, dir->etag, attrs, attrcount,
- 0, 0, 0, 0, 0,
- lfs_dir_commit_commit, &(struct lfs_dir_commit_commit){
- lfs, &commit});
- lfs_pair_fromle32(dir->tail);
- if (err) {
- if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
- goto compact;
- }
- return err;
- }
- // commit any global diffs if we have any
- lfs_gstate_t delta = {0};
- lfs_gstate_xor(&delta, &lfs->gstate);
- lfs_gstate_xor(&delta, &lfs->gdisk);
- lfs_gstate_xor(&delta, &lfs->gdelta);
- delta.tag &= ~LFS_MKTAG(0, 0, 0x3ff);
- if (!lfs_gstate_iszero(&delta)) {
- err = lfs_dir_getgstate(lfs, dir, &delta);
- if (err) {
- return err;
- }
- lfs_gstate_tole32(&delta);
- err = lfs_dir_commitattr(lfs, &commit,
- LFS_MKTAG(LFS_TYPE_MOVESTATE, 0x3ff,
- sizeof(delta)), &delta);
- if (err) {
- if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
- goto compact;
- }
- return err;
- }
- }
- // finalize commit with the crc
- err = lfs_dir_commitcrc(lfs, &commit);
- if (err) {
- if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
- goto compact;
- }
- return err;
- }
- // successful commit, update dir
- LFS_ASSERT(commit.off % lfs->cfg->prog_size == 0);
- dir->off = commit.off;
- dir->etag = commit.ptag;
- // and update gstate
- lfs->gdisk = lfs->gstate;
- lfs->gdelta = (lfs_gstate_t){0};
- goto fixmlist;
- }
- compact:
- // fall back to compaction
- lfs_cache_drop(lfs, &lfs->pcache);
- state = lfs_dir_splittingcompact(lfs, dir, attrs, attrcount,
- dir, 0, dir->count);
- if (state < 0) {
- return state;
- }
- goto fixmlist;
- fixmlist:;
- // this complicated bit of logic is for fixing up any active
- // metadata-pairs that we may have affected
- //
- // note we have to make two passes since the mdir passed to
- // lfs_dir_commit could also be in this list, and even then
- // we need to copy the pair so they don't get clobbered if we refetch
- // our mdir.
- lfs_block_t oldpair[2] = {pair[0], pair[1]};
- for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
- if (lfs_pair_cmp(d->m.pair, oldpair) == 0) {
- d->m = *dir;
- if (d->m.pair != pair) {
- for (int i = 0; i < attrcount; i++) {
- if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_DELETE &&
- d->id == lfs_tag_id(attrs[i].tag)) {
- d->m.pair[0] = LFS_BLOCK_NULL;
- d->m.pair[1] = LFS_BLOCK_NULL;
- } else if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_DELETE &&
- d->id > lfs_tag_id(attrs[i].tag)) {
- d->id -= 1;
- if (d->type == LFS_TYPE_DIR) {
- ((lfs_dir_t*)d)->pos -= 1;
- }
- } else if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_CREATE &&
- d->id >= lfs_tag_id(attrs[i].tag)) {
- d->id += 1;
- if (d->type == LFS_TYPE_DIR) {
- ((lfs_dir_t*)d)->pos += 1;
- }
- }
- }
- }
- while (d->id >= d->m.count && d->m.split) {
- // we split and id is on tail now
- d->id -= d->m.count;
- int err = lfs_dir_fetch(lfs, &d->m, d->m.tail);
- if (err) {
- return err;
- }
- }
- }
- }
- return state;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_orphaningcommit(lfs_t *lfs, lfs_mdir_t *dir,
- const struct lfs_mattr *attrs, int attrcount) {
- // check for any inline files that aren't RAM backed and
- // forcefully evict them, needed for filesystem consistency
- for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
- if (dir != &f->m && lfs_pair_cmp(f->m.pair, dir->pair) == 0 &&
- f->type == LFS_TYPE_REG && (f->flags & LFS_F_INLINE) &&
- f->ctz.size > lfs->cfg->cache_size) {
- int err = lfs_file_outline(lfs, f);
- if (err) {
- return err;
- }
- err = lfs_file_flush(lfs, f);
- if (err) {
- return err;
- }
- }
- }
- lfs_block_t lpair[2] = {dir->pair[0], dir->pair[1]};
- lfs_mdir_t ldir = *dir;
- lfs_mdir_t pdir;
- int state = lfs_dir_relocatingcommit(lfs, &ldir, dir->pair,
- attrs, attrcount, &pdir);
- if (state < 0) {
- return state;
- }
- // update if we're not in mlist, note we may have already been
- // updated if we are in mlist
- if (lfs_pair_cmp(dir->pair, lpair) == 0) {
- *dir = ldir;
- }
- // commit was successful, but may require other changes in the
- // filesystem, these would normally be tail recursive, but we have
- // flattened them here avoid unbounded stack usage
- // need to drop?
- if (state == LFS_OK_DROPPED) {
- // steal state
- int err = lfs_dir_getgstate(lfs, dir, &lfs->gdelta);
- if (err) {
- return err;
- }
- // steal tail, note that this can't create a recursive drop
- lpair[0] = pdir.pair[0];
- lpair[1] = pdir.pair[1];
- lfs_pair_tole32(dir->tail);
- state = lfs_dir_relocatingcommit(lfs, &pdir, lpair, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_TAIL + dir->split, 0x3ff, 8),
- dir->tail}),
- NULL);
- lfs_pair_fromle32(dir->tail);
- if (state < 0) {
- return state;
- }
- ldir = pdir;
- }
- // need to relocate?
- bool orphans = false;
- while (state == LFS_OK_RELOCATED) {
- LFS_DEBUG("Relocating {0x%"PRIx32", 0x%"PRIx32"} "
- "-> {0x%"PRIx32", 0x%"PRIx32"}",
- lpair[0], lpair[1], ldir.pair[0], ldir.pair[1]);
- state = 0;
- // update internal root
- if (lfs_pair_cmp(lpair, lfs->root) == 0) {
- lfs->root[0] = ldir.pair[0];
- lfs->root[1] = ldir.pair[1];
- }
- // update internally tracked dirs
- for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
- if (lfs_pair_cmp(lpair, d->m.pair) == 0) {
- d->m.pair[0] = ldir.pair[0];
- d->m.pair[1] = ldir.pair[1];
- }
- if (d->type == LFS_TYPE_DIR &&
- lfs_pair_cmp(lpair, ((lfs_dir_t*)d)->head) == 0) {
- ((lfs_dir_t*)d)->head[0] = ldir.pair[0];
- ((lfs_dir_t*)d)->head[1] = ldir.pair[1];
- }
- }
- // find parent
- lfs_stag_t tag = lfs_fs_parent(lfs, lpair, &pdir);
- if (tag < 0 && tag != LFS_ERR_NOENT) {
- return tag;
- }
- bool hasparent = (tag != LFS_ERR_NOENT);
- if (tag != LFS_ERR_NOENT) {
- // note that if we have a parent, we must have a pred, so this will
- // always create an orphan
- int err = lfs_fs_preporphans(lfs, +1);
- if (err) {
- return err;
- }
- // fix pending move in this pair? this looks like an optimization but
- // is in fact _required_ since relocating may outdate the move.
- uint16_t moveid = 0x3ff;
- if (lfs_gstate_hasmovehere(&lfs->gstate, pdir.pair)) {
- moveid = lfs_tag_id(lfs->gstate.tag);
- LFS_DEBUG("Fixing move while relocating "
- "{0x%"PRIx32", 0x%"PRIx32"} 0x%"PRIx16"\n",
- pdir.pair[0], pdir.pair[1], moveid);
- lfs_fs_prepmove(lfs, 0x3ff, NULL);
- if (moveid < lfs_tag_id(tag)) {
- tag -= LFS_MKTAG(0, 1, 0);
- }
- }
- lfs_block_t ppair[2] = {pdir.pair[0], pdir.pair[1]};
- lfs_pair_tole32(ldir.pair);
- state = lfs_dir_relocatingcommit(lfs, &pdir, ppair, LFS_MKATTRS(
- {LFS_MKTAG_IF(moveid != 0x3ff,
- LFS_TYPE_DELETE, moveid, 0), NULL},
- {tag, ldir.pair}),
- NULL);
- lfs_pair_fromle32(ldir.pair);
- if (state < 0) {
- return state;
- }
- if (state == LFS_OK_RELOCATED) {
- lpair[0] = ppair[0];
- lpair[1] = ppair[1];
- ldir = pdir;
- orphans = true;
- continue;
- }
- }
- // find pred
- int err = lfs_fs_pred(lfs, lpair, &pdir);
- if (err && err != LFS_ERR_NOENT) {
- return err;
- }
- LFS_ASSERT(!(hasparent && err == LFS_ERR_NOENT));
- // if we can't find dir, it must be new
- if (err != LFS_ERR_NOENT) {
- if (lfs_gstate_hasorphans(&lfs->gstate)) {
- // next step, clean up orphans
- err = lfs_fs_preporphans(lfs, -hasparent);
- if (err) {
- return err;
- }
- }
- // fix pending move in this pair? this looks like an optimization
- // but is in fact _required_ since relocating may outdate the move.
- uint16_t moveid = 0x3ff;
- if (lfs_gstate_hasmovehere(&lfs->gstate, pdir.pair)) {
- moveid = lfs_tag_id(lfs->gstate.tag);
- LFS_DEBUG("Fixing move while relocating "
- "{0x%"PRIx32", 0x%"PRIx32"} 0x%"PRIx16"\n",
- pdir.pair[0], pdir.pair[1], moveid);
- lfs_fs_prepmove(lfs, 0x3ff, NULL);
- }
- // replace bad pair, either we clean up desync, or no desync occured
- lpair[0] = pdir.pair[0];
- lpair[1] = pdir.pair[1];
- lfs_pair_tole32(ldir.pair);
- state = lfs_dir_relocatingcommit(lfs, &pdir, lpair, LFS_MKATTRS(
- {LFS_MKTAG_IF(moveid != 0x3ff,
- LFS_TYPE_DELETE, moveid, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_TAIL + pdir.split, 0x3ff, 8),
- ldir.pair}),
- NULL);
- lfs_pair_fromle32(ldir.pair);
- if (state < 0) {
- return state;
- }
- ldir = pdir;
- }
- }
- return orphans ? LFS_OK_ORPHANED : 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
- const struct lfs_mattr *attrs, int attrcount) {
- int orphans = lfs_dir_orphaningcommit(lfs, dir, attrs, attrcount);
- if (orphans < 0) {
- return orphans;
- }
- if (orphans) {
- // make sure we've removed all orphans, this is a noop if there
- // are none, but if we had nested blocks failures we may have
- // created some
- int err = lfs_fs_deorphan(lfs, false);
- if (err) {
- return err;
- }
- }
- return 0;
- }
- #endif
- /// Top level directory operations ///
- #ifndef LFS_READONLY
- static int lfs_rawmkdir(lfs_t *lfs, const char *path) {
- // deorphan if we haven't yet, needed at most once after poweron
- int err = lfs_fs_forceconsistency(lfs);
- if (err) {
- return err;
- }
- struct lfs_mlist cwd;
- cwd.next = lfs->mlist;
- uint16_t id;
- err = lfs_dir_find(lfs, &cwd.m, &path, &id);
- if (!(err == LFS_ERR_NOENT && id != 0x3ff)) {
- return (err < 0) ? err : LFS_ERR_EXIST;
- }
- // check that name fits
- lfs_size_t nlen = strlen(path);
- if (nlen > lfs->name_max) {
- return LFS_ERR_NAMETOOLONG;
- }
- // build up new directory
- lfs_alloc_ack(lfs);
- lfs_mdir_t dir;
- err = lfs_dir_alloc(lfs, &dir);
- if (err) {
- return err;
- }
- // find end of list
- lfs_mdir_t pred = cwd.m;
- while (pred.split) {
- err = lfs_dir_fetch(lfs, &pred, pred.tail);
- if (err) {
- return err;
- }
- }
- // setup dir
- lfs_pair_tole32(pred.tail);
- err = lfs_dir_commit(lfs, &dir, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), pred.tail}));
- lfs_pair_fromle32(pred.tail);
- if (err) {
- return err;
- }
- // current block not end of list?
- if (cwd.m.split) {
- // update tails, this creates a desync
- err = lfs_fs_preporphans(lfs, +1);
- if (err) {
- return err;
- }
- // it's possible our predecessor has to be relocated, and if
- // our parent is our predecessor's predecessor, this could have
- // caused our parent to go out of date, fortunately we can hook
- // ourselves into littlefs to catch this
- cwd.type = 0;
- cwd.id = 0;
- lfs->mlist = &cwd;
- lfs_pair_tole32(dir.pair);
- err = lfs_dir_commit(lfs, &pred, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), dir.pair}));
- lfs_pair_fromle32(dir.pair);
- if (err) {
- lfs->mlist = cwd.next;
- return err;
- }
- lfs->mlist = cwd.next;
- err = lfs_fs_preporphans(lfs, -1);
- if (err) {
- return err;
- }
- }
- // now insert into our parent block
- lfs_pair_tole32(dir.pair);
- err = lfs_dir_commit(lfs, &cwd.m, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_CREATE, id, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_DIR, id, nlen), path},
- {LFS_MKTAG(LFS_TYPE_DIRSTRUCT, id, 8), dir.pair},
- {LFS_MKTAG_IF(!cwd.m.split,
- LFS_TYPE_SOFTTAIL, 0x3ff, 8), dir.pair}));
- lfs_pair_fromle32(dir.pair);
- if (err) {
- return err;
- }
- return 0;
- }
- #endif
- static int lfs_dir_rawopen(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
- lfs_stag_t tag = lfs_dir_find(lfs, &dir->m, &path, NULL);
- if (tag < 0) {
- return tag;
- }
- if (lfs_tag_type3(tag) != LFS_TYPE_DIR) {
- return LFS_ERR_NOTDIR;
- }
- lfs_block_t pair[2];
- if (lfs_tag_id(tag) == 0x3ff) {
- // handle root dir separately
- pair[0] = lfs->root[0];
- pair[1] = lfs->root[1];
- } else {
- // get dir pair from parent
- lfs_stag_t res = lfs_dir_get(lfs, &dir->m, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
- if (res < 0) {
- return res;
- }
- lfs_pair_fromle32(pair);
- }
- // fetch first pair
- int err = lfs_dir_fetch(lfs, &dir->m, pair);
- if (err) {
- return err;
- }
- // setup entry
- dir->head[0] = dir->m.pair[0];
- dir->head[1] = dir->m.pair[1];
- dir->id = 0;
- dir->pos = 0;
- // add to list of mdirs
- dir->type = LFS_TYPE_DIR;
- lfs_mlist_append(lfs, (struct lfs_mlist *)dir);
- return 0;
- }
- static int lfs_dir_rawclose(lfs_t *lfs, lfs_dir_t *dir) {
- // remove from list of mdirs
- lfs_mlist_remove(lfs, (struct lfs_mlist *)dir);
- return 0;
- }
- static int lfs_dir_rawread(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
- memset(info, 0, sizeof(*info));
- // special offset for '.' and '..'
- if (dir->pos == 0) {
- info->type = LFS_TYPE_DIR;
- strcpy(info->name, ".");
- dir->pos += 1;
- return true;
- } else if (dir->pos == 1) {
- info->type = LFS_TYPE_DIR;
- strcpy(info->name, "..");
- dir->pos += 1;
- return true;
- }
- while (true) {
- if (dir->id == dir->m.count) {
- if (!dir->m.split) {
- return false;
- }
- int err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
- if (err) {
- return err;
- }
- dir->id = 0;
- }
- int err = lfs_dir_getinfo(lfs, &dir->m, dir->id, info);
- if (err && err != LFS_ERR_NOENT) {
- return err;
- }
- dir->id += 1;
- if (err != LFS_ERR_NOENT) {
- break;
- }
- }
- dir->pos += 1;
- return true;
- }
- static int lfs_dir_rawseek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
- // simply walk from head dir
- int err = lfs_dir_rawrewind(lfs, dir);
- if (err) {
- return err;
- }
- // first two for ./..
- dir->pos = lfs_min(2, off);
- off -= dir->pos;
- // skip superblock entry
- dir->id = (off > 0 && lfs_pair_cmp(dir->head, lfs->root) == 0);
- while (off > 0) {
- int diff = lfs_min(dir->m.count - dir->id, off);
- dir->id += diff;
- dir->pos += diff;
- off -= diff;
- if (dir->id == dir->m.count) {
- if (!dir->m.split) {
- return LFS_ERR_INVAL;
- }
- err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
- if (err) {
- return err;
- }
- dir->id = 0;
- }
- }
- return 0;
- }
- static lfs_soff_t lfs_dir_rawtell(lfs_t *lfs, lfs_dir_t *dir) {
- (void)lfs;
- return dir->pos;
- }
- static int lfs_dir_rawrewind(lfs_t *lfs, lfs_dir_t *dir) {
- // reload the head dir
- int err = lfs_dir_fetch(lfs, &dir->m, dir->head);
- if (err) {
- return err;
- }
- dir->id = 0;
- dir->pos = 0;
- return 0;
- }
- /// File index list operations ///
- static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
- lfs_off_t size = *off;
- lfs_off_t b = lfs->cfg->block_size - 2*4;
- lfs_off_t i = size / b;
- if (i == 0) {
- return 0;
- }
- i = (size - 4*(lfs_popc(i-1)+2)) / b;
- *off = size - b*i - 4*lfs_popc(i);
- return i;
- }
- static int lfs_ctz_find(lfs_t *lfs,
- const lfs_cache_t *pcache, lfs_cache_t *rcache,
- lfs_block_t head, lfs_size_t size,
- lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
- if (size == 0) {
- *block = LFS_BLOCK_NULL;
- *off = 0;
- return 0;
- }
- lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
- lfs_off_t target = lfs_ctz_index(lfs, &pos);
- while (current > target) {
- lfs_size_t skip = lfs_min(
- lfs_npw2(current-target+1) - 1,
- lfs_ctz(current));
- int err = lfs_bd_read(lfs,
- pcache, rcache, sizeof(head),
- head, 4*skip, &head, sizeof(head));
- head = lfs_fromle32(head);
- if (err) {
- return err;
- }
- current -= 1 << skip;
- }
- *block = head;
- *off = pos;
- return 0;
- }
- #ifndef LFS_READONLY
- static int lfs_ctz_extend(lfs_t *lfs,
- lfs_cache_t *pcache, lfs_cache_t *rcache,
- lfs_block_t head, lfs_size_t size,
- lfs_block_t *block, lfs_off_t *off) {
- while (true) {
- // go ahead and grab a block
- lfs_block_t nblock;
- int err = lfs_alloc(lfs, &nblock);
- if (err) {
- return err;
- }
- {
- err = lfs_bd_erase(lfs, nblock);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- if (size == 0) {
- *block = nblock;
- *off = 0;
- return 0;
- }
- lfs_size_t noff = size - 1;
- lfs_off_t index = lfs_ctz_index(lfs, &noff);
- noff = noff + 1;
- // just copy out the last block if it is incomplete
- if (noff != lfs->cfg->block_size) {
- for (lfs_off_t i = 0; i < noff; i++) {
- uint8_t data;
- err = lfs_bd_read(lfs,
- NULL, rcache, noff-i,
- head, i, &data, 1);
- if (err) {
- return err;
- }
- err = lfs_bd_prog(lfs,
- pcache, rcache, true,
- nblock, i, &data, 1);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- }
- *block = nblock;
- *off = noff;
- return 0;
- }
- // append block
- index += 1;
- lfs_size_t skips = lfs_ctz(index) + 1;
- lfs_block_t nhead = head;
- for (lfs_off_t i = 0; i < skips; i++) {
- nhead = lfs_tole32(nhead);
- err = lfs_bd_prog(lfs, pcache, rcache, true,
- nblock, 4*i, &nhead, 4);
- nhead = lfs_fromle32(nhead);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- if (i != skips-1) {
- err = lfs_bd_read(lfs,
- NULL, rcache, sizeof(nhead),
- nhead, 4*i, &nhead, sizeof(nhead));
- nhead = lfs_fromle32(nhead);
- if (err) {
- return err;
- }
- }
- }
- *block = nblock;
- *off = 4*skips;
- return 0;
- }
- relocate:
- LFS_DEBUG("Bad block at 0x%"PRIx32, nblock);
- // just clear cache and try a new block
- lfs_cache_drop(lfs, pcache);
- }
- }
- #endif
- static int lfs_ctz_traverse(lfs_t *lfs,
- const lfs_cache_t *pcache, lfs_cache_t *rcache,
- lfs_block_t head, lfs_size_t size,
- int (*cb)(void*, lfs_block_t), void *data) {
- if (size == 0) {
- return 0;
- }
- lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
- while (true) {
- int err = cb(data, head);
- if (err) {
- return err;
- }
- if (index == 0) {
- return 0;
- }
- lfs_block_t heads[2];
- int count = 2 - (index & 1);
- err = lfs_bd_read(lfs,
- pcache, rcache, count*sizeof(head),
- head, 0, &heads, count*sizeof(head));
- heads[0] = lfs_fromle32(heads[0]);
- heads[1] = lfs_fromle32(heads[1]);
- if (err) {
- return err;
- }
- for (int i = 0; i < count-1; i++) {
- err = cb(data, heads[i]);
- if (err) {
- return err;
- }
- }
- head = heads[count-1];
- index -= count;
- }
- }
- /// Top level file operations ///
- static int lfs_file_rawopencfg(lfs_t *lfs, lfs_file_t *file,
- const char *path, int flags,
- const struct lfs_file_config *cfg) {
- #ifndef LFS_READONLY
- // deorphan if we haven't yet, needed at most once after poweron
- if ((flags & LFS_O_WRONLY) == LFS_O_WRONLY) {
- int err = lfs_fs_forceconsistency(lfs);
- if (err) {
- return err;
- }
- }
- #else
- LFS_ASSERT((flags & LFS_O_RDONLY) == LFS_O_RDONLY);
- #endif
- // setup simple file details
- int err;
- file->cfg = cfg;
- file->flags = flags;
- file->pos = 0;
- file->off = 0;
- file->cache.buffer = NULL;
- // allocate entry for file if it doesn't exist
- lfs_stag_t tag = lfs_dir_find(lfs, &file->m, &path, &file->id);
- if (tag < 0 && !(tag == LFS_ERR_NOENT && file->id != 0x3ff)) {
- err = tag;
- goto cleanup;
- }
- // get id, add to list of mdirs to catch update changes
- file->type = LFS_TYPE_REG;
- lfs_mlist_append(lfs, (struct lfs_mlist *)file);
- #ifdef LFS_READONLY
- if (tag == LFS_ERR_NOENT) {
- err = LFS_ERR_NOENT;
- goto cleanup;
- #else
- if (tag == LFS_ERR_NOENT) {
- if (!(flags & LFS_O_CREAT)) {
- err = LFS_ERR_NOENT;
- goto cleanup;
- }
- // check that name fits
- lfs_size_t nlen = strlen(path);
- if (nlen > lfs->name_max) {
- err = LFS_ERR_NAMETOOLONG;
- goto cleanup;
- }
- // get next slot and create entry to remember name
- err = lfs_dir_commit(lfs, &file->m, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_CREATE, file->id, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_REG, file->id, nlen), path},
- {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0), NULL}));
- // it may happen that the file name doesn't fit in the metadata blocks, e.g., a 256 byte file name will
- // not fit in a 128 byte block.
- err = (err == LFS_ERR_NOSPC) ? LFS_ERR_NAMETOOLONG : err;
- if (err) {
- goto cleanup;
- }
- tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, 0);
- } else if (flags & LFS_O_EXCL) {
- err = LFS_ERR_EXIST;
- goto cleanup;
- #endif
- } else if (lfs_tag_type3(tag) != LFS_TYPE_REG) {
- err = LFS_ERR_ISDIR;
- goto cleanup;
- #ifndef LFS_READONLY
- } else if (flags & LFS_O_TRUNC) {
- // truncate if requested
- tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0);
- file->flags |= LFS_F_DIRTY;
- #endif
- } else {
- // try to load what's on disk, if it's inlined we'll fix it later
- tag = lfs_dir_get(lfs, &file->m, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, file->id, 8), &file->ctz);
- if (tag < 0) {
- err = tag;
- goto cleanup;
- }
- lfs_ctz_fromle32(&file->ctz);
- }
- // fetch attrs
- for (unsigned i = 0; i < file->cfg->attr_count; i++) {
- // if opened for read / read-write operations
- if ((file->flags & LFS_O_RDONLY) == LFS_O_RDONLY) {
- lfs_stag_t res = lfs_dir_get(lfs, &file->m,
- LFS_MKTAG(0x7ff, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_USERATTR + file->cfg->attrs[i].type,
- file->id, file->cfg->attrs[i].size),
- file->cfg->attrs[i].buffer);
- if (res < 0 && res != LFS_ERR_NOENT) {
- err = res;
- goto cleanup;
- }
- }
- #ifndef LFS_READONLY
- // if opened for write / read-write operations
- if ((file->flags & LFS_O_WRONLY) == LFS_O_WRONLY) {
- if (file->cfg->attrs[i].size > lfs->attr_max) {
- err = LFS_ERR_NOSPC;
- goto cleanup;
- }
- file->flags |= LFS_F_DIRTY;
- }
- #endif
- }
- // allocate buffer if needed
- if (file->cfg->buffer) {
- file->cache.buffer = file->cfg->buffer;
- } else {
- file->cache.buffer = lfs_malloc(lfs->cfg->cache_size);
- if (!file->cache.buffer) {
- err = LFS_ERR_NOMEM;
- goto cleanup;
- }
- }
- // zero to avoid information leak
- lfs_cache_zero(lfs, &file->cache);
- if (lfs_tag_type3(tag) == LFS_TYPE_INLINESTRUCT) {
- // load inline files
- file->ctz.head = LFS_BLOCK_INLINE;
- file->ctz.size = lfs_tag_size(tag);
- file->flags |= LFS_F_INLINE;
- file->cache.block = file->ctz.head;
- file->cache.off = 0;
- file->cache.size = lfs->cfg->cache_size;
- // don't always read (may be new/trunc file)
- if (file->ctz.size > 0) {
- lfs_stag_t res = lfs_dir_get(lfs, &file->m,
- LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, file->id,
- lfs_min(file->cache.size, 0x3fe)),
- file->cache.buffer);
- if (res < 0) {
- err = res;
- goto cleanup;
- }
- }
- }
- return 0;
- cleanup:
- // clean up lingering resources
- #ifndef LFS_READONLY
- file->flags |= LFS_F_ERRED;
- #endif
- lfs_file_rawclose(lfs, file);
- return err;
- }
- static int lfs_file_rawopen(lfs_t *lfs, lfs_file_t *file,
- const char *path, int flags) {
- static const struct lfs_file_config defaults = {0};
- int err = lfs_file_rawopencfg(lfs, file, path, flags, &defaults);
- return err;
- }
- static int lfs_file_rawclose(lfs_t *lfs, lfs_file_t *file) {
- #ifndef LFS_READONLY
- int err = lfs_file_rawsync(lfs, file);
- #else
- int err = 0;
- #endif
- // remove from list of mdirs
- lfs_mlist_remove(lfs, (struct lfs_mlist*)file);
- // clean up memory
- if (!file->cfg->buffer) {
- lfs_free(file->cache.buffer);
- }
- return err;
- }
- #ifndef LFS_READONLY
- static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
- while (true) {
- // just relocate what exists into new block
- lfs_block_t nblock;
- int err = lfs_alloc(lfs, &nblock);
- if (err) {
- return err;
- }
- err = lfs_bd_erase(lfs, nblock);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- // either read from dirty cache or disk
- for (lfs_off_t i = 0; i < file->off; i++) {
- uint8_t data;
- if (file->flags & LFS_F_INLINE) {
- err = lfs_dir_getread(lfs, &file->m,
- // note we evict inline files before they can be dirty
- NULL, &file->cache, file->off-i,
- LFS_MKTAG(0xfff, 0x1ff, 0),
- LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0),
- i, &data, 1);
- if (err) {
- return err;
- }
- } else {
- err = lfs_bd_read(lfs,
- &file->cache, &lfs->rcache, file->off-i,
- file->block, i, &data, 1);
- if (err) {
- return err;
- }
- }
- err = lfs_bd_prog(lfs,
- &lfs->pcache, &lfs->rcache, true,
- nblock, i, &data, 1);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- }
- // copy over new state of file
- memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->cache_size);
- file->cache.block = lfs->pcache.block;
- file->cache.off = lfs->pcache.off;
- file->cache.size = lfs->pcache.size;
- lfs_cache_zero(lfs, &lfs->pcache);
- file->block = nblock;
- file->flags |= LFS_F_WRITING;
- return 0;
- relocate:
- LFS_DEBUG("Bad block at 0x%"PRIx32, nblock);
- // just clear cache and try a new block
- lfs_cache_drop(lfs, &lfs->pcache);
- }
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_file_outline(lfs_t *lfs, lfs_file_t *file) {
- file->off = file->pos;
- lfs_alloc_ack(lfs);
- int err = lfs_file_relocate(lfs, file);
- if (err) {
- return err;
- }
- file->flags &= ~LFS_F_INLINE;
- return 0;
- }
- #endif
- static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
- if (file->flags & LFS_F_READING) {
- if (!(file->flags & LFS_F_INLINE)) {
- lfs_cache_drop(lfs, &file->cache);
- }
- file->flags &= ~LFS_F_READING;
- }
- #ifndef LFS_READONLY
- if (file->flags & LFS_F_WRITING) {
- lfs_off_t pos = file->pos;
- if (!(file->flags & LFS_F_INLINE)) {
- // copy over anything after current branch
- lfs_file_t orig = {
- .ctz.head = file->ctz.head,
- .ctz.size = file->ctz.size,
- .flags = LFS_O_RDONLY,
- .pos = file->pos,
- .cache = lfs->rcache,
- };
- lfs_cache_drop(lfs, &lfs->rcache);
- while (file->pos < file->ctz.size) {
- // copy over a byte at a time, leave it up to caching
- // to make this efficient
- uint8_t data;
- lfs_ssize_t res = lfs_file_flushedread(lfs, &orig, &data, 1);
- if (res < 0) {
- return res;
- }
- res = lfs_file_flushedwrite(lfs, file, &data, 1);
- if (res < 0) {
- return res;
- }
- // keep our reference to the rcache in sync
- if (lfs->rcache.block != LFS_BLOCK_NULL) {
- lfs_cache_drop(lfs, &orig.cache);
- lfs_cache_drop(lfs, &lfs->rcache);
- }
- }
- // write out what we have
- while (true) {
- int err = lfs_bd_flush(lfs, &file->cache, &lfs->rcache, true);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- return err;
- }
- break;
- relocate:
- LFS_DEBUG("Bad block at 0x%"PRIx32, file->block);
- err = lfs_file_relocate(lfs, file);
- if (err) {
- return err;
- }
- }
- } else {
- file->pos = lfs_max(file->pos, file->ctz.size);
- }
- // actual file updates
- file->ctz.head = file->block;
- file->ctz.size = file->pos;
- file->flags &= ~LFS_F_WRITING;
- file->flags |= LFS_F_DIRTY;
- file->pos = pos;
- }
- #endif
- return 0;
- }
- #ifndef LFS_READONLY
- static int lfs_file_rawsync(lfs_t *lfs, lfs_file_t *file) {
- if (file->flags & LFS_F_ERRED) {
- // it's not safe to do anything if our file errored
- return 0;
- }
- int err = lfs_file_flush(lfs, file);
- if (err) {
- file->flags |= LFS_F_ERRED;
- return err;
- }
- if ((file->flags & LFS_F_DIRTY) &&
- !lfs_pair_isnull(file->m.pair)) {
- // update dir entry
- uint16_t type;
- const void *buffer;
- lfs_size_t size;
- struct lfs_ctz ctz;
- if (file->flags & LFS_F_INLINE) {
- // inline the whole file
- type = LFS_TYPE_INLINESTRUCT;
- buffer = file->cache.buffer;
- size = file->ctz.size;
- } else {
- // update the ctz reference
- type = LFS_TYPE_CTZSTRUCT;
- // copy ctz so alloc will work during a relocate
- ctz = file->ctz;
- lfs_ctz_tole32(&ctz);
- buffer = &ctz;
- size = sizeof(ctz);
- }
- // commit file data and attributes
- err = lfs_dir_commit(lfs, &file->m, LFS_MKATTRS(
- {LFS_MKTAG(type, file->id, size), buffer},
- {LFS_MKTAG(LFS_FROM_USERATTRS, file->id,
- file->cfg->attr_count), file->cfg->attrs}));
- if (err) {
- file->flags |= LFS_F_ERRED;
- return err;
- }
- file->flags &= ~LFS_F_DIRTY;
- }
- return 0;
- }
- #endif
- static lfs_ssize_t lfs_file_flushedread(lfs_t *lfs, lfs_file_t *file,
- void *buffer, lfs_size_t size) {
- uint8_t *data = buffer;
- lfs_size_t nsize = size;
- if (file->pos >= file->ctz.size) {
- // eof if past end
- return 0;
- }
- size = lfs_min(size, file->ctz.size - file->pos);
- nsize = size;
- while (nsize > 0) {
- // check if we need a new block
- if (!(file->flags & LFS_F_READING) ||
- file->off == lfs->cfg->block_size) {
- if (!(file->flags & LFS_F_INLINE)) {
- int err = lfs_ctz_find(lfs, NULL, &file->cache,
- file->ctz.head, file->ctz.size,
- file->pos, &file->block, &file->off);
- if (err) {
- return err;
- }
- } else {
- file->block = LFS_BLOCK_INLINE;
- file->off = file->pos;
- }
- file->flags |= LFS_F_READING;
- }
- // read as much as we can in current block
- lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
- if (file->flags & LFS_F_INLINE) {
- int err = lfs_dir_getread(lfs, &file->m,
- NULL, &file->cache, lfs->cfg->block_size,
- LFS_MKTAG(0xfff, 0x1ff, 0),
- LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0),
- file->off, data, diff);
- if (err) {
- return err;
- }
- } else {
- int err = lfs_bd_read(lfs,
- NULL, &file->cache, lfs->cfg->block_size,
- file->block, file->off, data, diff);
- if (err) {
- return err;
- }
- }
- file->pos += diff;
- file->off += diff;
- data += diff;
- nsize -= diff;
- }
- return size;
- }
- static lfs_ssize_t lfs_file_rawread(lfs_t *lfs, lfs_file_t *file,
- void *buffer, lfs_size_t size) {
- LFS_ASSERT((file->flags & LFS_O_RDONLY) == LFS_O_RDONLY);
- #ifndef LFS_READONLY
- if (file->flags & LFS_F_WRITING) {
- // flush out any writes
- int err = lfs_file_flush(lfs, file);
- if (err) {
- return err;
- }
- }
- #endif
- return lfs_file_flushedread(lfs, file, buffer, size);
- }
- #ifndef LFS_READONLY
- static lfs_ssize_t lfs_file_flushedwrite(lfs_t *lfs, lfs_file_t *file,
- const void *buffer, lfs_size_t size) {
- const uint8_t *data = buffer;
- lfs_size_t nsize = size;
- if ((file->flags & LFS_F_INLINE) &&
- lfs_max(file->pos+nsize, file->ctz.size) >
- lfs_min(0x3fe, lfs_min(
- lfs->cfg->cache_size,
- (lfs->cfg->metadata_max ?
- lfs->cfg->metadata_max : lfs->cfg->block_size) / 8))) {
- // inline file doesn't fit anymore
- int err = lfs_file_outline(lfs, file);
- if (err) {
- file->flags |= LFS_F_ERRED;
- return err;
- }
- }
- while (nsize > 0) {
- // check if we need a new block
- if (!(file->flags & LFS_F_WRITING) ||
- file->off == lfs->cfg->block_size) {
- if (!(file->flags & LFS_F_INLINE)) {
- if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
- // find out which block we're extending from
- int err = lfs_ctz_find(lfs, NULL, &file->cache,
- file->ctz.head, file->ctz.size,
- file->pos-1, &file->block, &file->off);
- if (err) {
- file->flags |= LFS_F_ERRED;
- return err;
- }
- // mark cache as dirty since we may have read data into it
- lfs_cache_zero(lfs, &file->cache);
- }
- // extend file with new blocks
- lfs_alloc_ack(lfs);
- int err = lfs_ctz_extend(lfs, &file->cache, &lfs->rcache,
- file->block, file->pos,
- &file->block, &file->off);
- if (err) {
- file->flags |= LFS_F_ERRED;
- return err;
- }
- } else {
- file->block = LFS_BLOCK_INLINE;
- file->off = file->pos;
- }
- file->flags |= LFS_F_WRITING;
- }
- // program as much as we can in current block
- lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
- while (true) {
- int err = lfs_bd_prog(lfs, &file->cache, &lfs->rcache, true,
- file->block, file->off, data, diff);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- goto relocate;
- }
- file->flags |= LFS_F_ERRED;
- return err;
- }
- break;
- relocate:
- err = lfs_file_relocate(lfs, file);
- if (err) {
- file->flags |= LFS_F_ERRED;
- return err;
- }
- }
- file->pos += diff;
- file->off += diff;
- data += diff;
- nsize -= diff;
- lfs_alloc_ack(lfs);
- }
- return size;
- }
- static lfs_ssize_t lfs_file_rawwrite(lfs_t *lfs, lfs_file_t *file,
- const void *buffer, lfs_size_t size) {
- LFS_ASSERT((file->flags & LFS_O_WRONLY) == LFS_O_WRONLY);
- if (file->flags & LFS_F_READING) {
- // drop any reads
- int err = lfs_file_flush(lfs, file);
- if (err) {
- return err;
- }
- }
- if ((file->flags & LFS_O_APPEND) && file->pos < file->ctz.size) {
- file->pos = file->ctz.size;
- }
- if (file->pos + size > lfs->file_max) {
- // Larger than file limit?
- return LFS_ERR_FBIG;
- }
- if (!(file->flags & LFS_F_WRITING) && file->pos > file->ctz.size) {
- // fill with zeros
- lfs_off_t pos = file->pos;
- file->pos = file->ctz.size;
- while (file->pos < pos) {
- lfs_ssize_t res = lfs_file_flushedwrite(lfs, file, &(uint8_t){0}, 1);
- if (res < 0) {
- return res;
- }
- }
- }
- lfs_ssize_t nsize = lfs_file_flushedwrite(lfs, file, buffer, size);
- if (nsize < 0) {
- return nsize;
- }
- file->flags &= ~LFS_F_ERRED;
- return nsize;
- }
- #endif
- static lfs_soff_t lfs_file_rawseek(lfs_t *lfs, lfs_file_t *file,
- lfs_soff_t off, int whence) {
- // find new pos
- lfs_off_t npos = file->pos;
- if (whence == LFS_SEEK_SET) {
- npos = off;
- } else if (whence == LFS_SEEK_CUR) {
- if ((lfs_soff_t)file->pos + off < 0) {
- return LFS_ERR_INVAL;
- } else {
- npos = file->pos + off;
- }
- } else if (whence == LFS_SEEK_END) {
- lfs_soff_t res = lfs_file_rawsize(lfs, file) + off;
- if (res < 0) {
- return LFS_ERR_INVAL;
- } else {
- npos = res;
- }
- }
- if (npos > lfs->file_max) {
- // file position out of range
- return LFS_ERR_INVAL;
- }
- if (file->pos == npos) {
- // noop - position has not changed
- return npos;
- }
- // if we're only reading and our new offset is still in the file's cache
- // we can avoid flushing and needing to reread the data
- if (
- #ifndef LFS_READONLY
- !(file->flags & LFS_F_WRITING)
- #else
- true
- #endif
- ) {
- int oindex = lfs_ctz_index(lfs, &(lfs_off_t){file->pos});
- lfs_off_t noff = npos;
- int nindex = lfs_ctz_index(lfs, &noff);
- if (oindex == nindex
- && noff >= file->cache.off
- && noff < file->cache.off + file->cache.size) {
- file->pos = npos;
- file->off = noff;
- return npos;
- }
- }
- // write out everything beforehand, may be noop if rdonly
- int err = lfs_file_flush(lfs, file);
- if (err) {
- return err;
- }
- // update pos
- file->pos = npos;
- return npos;
- }
- #ifndef LFS_READONLY
- static int lfs_file_rawtruncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
- LFS_ASSERT((file->flags & LFS_O_WRONLY) == LFS_O_WRONLY);
- if (size > LFS_FILE_MAX) {
- return LFS_ERR_INVAL;
- }
- lfs_off_t pos = file->pos;
- lfs_off_t oldsize = lfs_file_rawsize(lfs, file);
- if (size < oldsize) {
- // need to flush since directly changing metadata
- int err = lfs_file_flush(lfs, file);
- if (err) {
- return err;
- }
- // lookup new head in ctz skip list
- err = lfs_ctz_find(lfs, NULL, &file->cache,
- file->ctz.head, file->ctz.size,
- size, &file->block, &file->off);
- if (err) {
- return err;
- }
- // need to set pos/block/off consistently so seeking back to
- // the old position does not get confused
- file->pos = size;
- file->ctz.head = file->block;
- file->ctz.size = size;
- file->flags |= LFS_F_DIRTY | LFS_F_READING;
- } else if (size > oldsize) {
- // flush+seek if not already at end
- lfs_soff_t res = lfs_file_rawseek(lfs, file, 0, LFS_SEEK_END);
- if (res < 0) {
- return (int)res;
- }
- // fill with zeros
- while (file->pos < size) {
- res = lfs_file_rawwrite(lfs, file, &(uint8_t){0}, 1);
- if (res < 0) {
- return (int)res;
- }
- }
- }
- // restore pos
- lfs_soff_t res = lfs_file_rawseek(lfs, file, pos, LFS_SEEK_SET);
- if (res < 0) {
- return (int)res;
- }
- return 0;
- }
- #endif
- static lfs_soff_t lfs_file_rawtell(lfs_t *lfs, lfs_file_t *file) {
- (void)lfs;
- return file->pos;
- }
- static int lfs_file_rawrewind(lfs_t *lfs, lfs_file_t *file) {
- lfs_soff_t res = lfs_file_rawseek(lfs, file, 0, LFS_SEEK_SET);
- if (res < 0) {
- return (int)res;
- }
- return 0;
- }
- static lfs_soff_t lfs_file_rawsize(lfs_t *lfs, lfs_file_t *file) {
- (void)lfs;
- #ifndef LFS_READONLY
- if (file->flags & LFS_F_WRITING) {
- return lfs_max(file->pos, file->ctz.size);
- }
- #endif
- return file->ctz.size;
- }
- /// General fs operations ///
- static int lfs_rawstat(lfs_t *lfs, const char *path, struct lfs_info *info) {
- lfs_mdir_t cwd;
- lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
- if (tag < 0) {
- return (int)tag;
- }
- return lfs_dir_getinfo(lfs, &cwd, lfs_tag_id(tag), info);
- }
- #ifndef LFS_READONLY
- static int lfs_rawremove(lfs_t *lfs, const char *path) {
- // deorphan if we haven't yet, needed at most once after poweron
- int err = lfs_fs_forceconsistency(lfs);
- if (err) {
- return err;
- }
- lfs_mdir_t cwd;
- lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
- if (tag < 0 || lfs_tag_id(tag) == 0x3ff) {
- return (tag < 0) ? (int)tag : LFS_ERR_INVAL;
- }
- struct lfs_mlist dir;
- dir.next = lfs->mlist;
- if (lfs_tag_type3(tag) == LFS_TYPE_DIR) {
- // must be empty before removal
- lfs_block_t pair[2];
- lfs_stag_t res = lfs_dir_get(lfs, &cwd, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
- if (res < 0) {
- return (int)res;
- }
- lfs_pair_fromle32(pair);
- err = lfs_dir_fetch(lfs, &dir.m, pair);
- if (err) {
- return err;
- }
- if (dir.m.count > 0 || dir.m.split) {
- return LFS_ERR_NOTEMPTY;
- }
- // mark fs as orphaned
- err = lfs_fs_preporphans(lfs, +1);
- if (err) {
- return err;
- }
- // I know it's crazy but yes, dir can be changed by our parent's
- // commit (if predecessor is child)
- dir.type = 0;
- dir.id = 0;
- lfs->mlist = &dir;
- }
- // delete the entry
- err = lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_DELETE, lfs_tag_id(tag), 0), NULL}));
- if (err) {
- lfs->mlist = dir.next;
- return err;
- }
- lfs->mlist = dir.next;
- if (lfs_tag_type3(tag) == LFS_TYPE_DIR) {
- // fix orphan
- err = lfs_fs_preporphans(lfs, -1);
- if (err) {
- return err;
- }
- err = lfs_fs_pred(lfs, dir.m.pair, &cwd);
- if (err) {
- return err;
- }
- err = lfs_dir_drop(lfs, &cwd, &dir.m);
- if (err) {
- return err;
- }
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_rawrename(lfs_t *lfs, const char *oldpath, const char *newpath) {
- // deorphan if we haven't yet, needed at most once after poweron
- int err = lfs_fs_forceconsistency(lfs);
- if (err) {
- return err;
- }
- // find old entry
- lfs_mdir_t oldcwd;
- lfs_stag_t oldtag = lfs_dir_find(lfs, &oldcwd, &oldpath, NULL);
- if (oldtag < 0 || lfs_tag_id(oldtag) == 0x3ff) {
- return (oldtag < 0) ? (int)oldtag : LFS_ERR_INVAL;
- }
- // find new entry
- lfs_mdir_t newcwd;
- uint16_t newid;
- lfs_stag_t prevtag = lfs_dir_find(lfs, &newcwd, &newpath, &newid);
- if ((prevtag < 0 || lfs_tag_id(prevtag) == 0x3ff) &&
- !(prevtag == LFS_ERR_NOENT && newid != 0x3ff)) {
- return (prevtag < 0) ? (int)prevtag : LFS_ERR_INVAL;
- }
- // if we're in the same pair there's a few special cases...
- bool samepair = (lfs_pair_cmp(oldcwd.pair, newcwd.pair) == 0);
- uint16_t newoldid = lfs_tag_id(oldtag);
- struct lfs_mlist prevdir;
- prevdir.next = lfs->mlist;
- if (prevtag == LFS_ERR_NOENT) {
- // check that name fits
- lfs_size_t nlen = strlen(newpath);
- if (nlen > lfs->name_max) {
- return LFS_ERR_NAMETOOLONG;
- }
- // there is a small chance we are being renamed in the same
- // directory/ to an id less than our old id, the global update
- // to handle this is a bit messy
- if (samepair && newid <= newoldid) {
- newoldid += 1;
- }
- } else if (lfs_tag_type3(prevtag) != lfs_tag_type3(oldtag)) {
- return LFS_ERR_ISDIR;
- } else if (samepair && newid == newoldid) {
- // we're renaming to ourselves??
- return 0;
- } else if (lfs_tag_type3(prevtag) == LFS_TYPE_DIR) {
- // must be empty before removal
- lfs_block_t prevpair[2];
- lfs_stag_t res = lfs_dir_get(lfs, &newcwd, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, newid, 8), prevpair);
- if (res < 0) {
- return (int)res;
- }
- lfs_pair_fromle32(prevpair);
- // must be empty before removal
- err = lfs_dir_fetch(lfs, &prevdir.m, prevpair);
- if (err) {
- return err;
- }
- if (prevdir.m.count > 0 || prevdir.m.split) {
- return LFS_ERR_NOTEMPTY;
- }
- // mark fs as orphaned
- err = lfs_fs_preporphans(lfs, +1);
- if (err) {
- return err;
- }
- // I know it's crazy but yes, dir can be changed by our parent's
- // commit (if predecessor is child)
- prevdir.type = 0;
- prevdir.id = 0;
- lfs->mlist = &prevdir;
- }
- if (!samepair) {
- lfs_fs_prepmove(lfs, newoldid, oldcwd.pair);
- }
- // move over all attributes
- err = lfs_dir_commit(lfs, &newcwd, LFS_MKATTRS(
- {LFS_MKTAG_IF(prevtag != LFS_ERR_NOENT,
- LFS_TYPE_DELETE, newid, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_CREATE, newid, 0), NULL},
- {LFS_MKTAG(lfs_tag_type3(oldtag), newid, strlen(newpath)), newpath},
- {LFS_MKTAG(LFS_FROM_MOVE, newid, lfs_tag_id(oldtag)), &oldcwd},
- {LFS_MKTAG_IF(samepair,
- LFS_TYPE_DELETE, newoldid, 0), NULL}));
- if (err) {
- lfs->mlist = prevdir.next;
- return err;
- }
- // let commit clean up after move (if we're different! otherwise move
- // logic already fixed it for us)
- if (!samepair && lfs_gstate_hasmove(&lfs->gstate)) {
- // prep gstate and delete move id
- lfs_fs_prepmove(lfs, 0x3ff, NULL);
- err = lfs_dir_commit(lfs, &oldcwd, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_DELETE, lfs_tag_id(oldtag), 0), NULL}));
- if (err) {
- lfs->mlist = prevdir.next;
- return err;
- }
- }
- lfs->mlist = prevdir.next;
- if (prevtag != LFS_ERR_NOENT
- && lfs_tag_type3(prevtag) == LFS_TYPE_DIR) {
- // fix orphan
- err = lfs_fs_preporphans(lfs, -1);
- if (err) {
- return err;
- }
- err = lfs_fs_pred(lfs, prevdir.m.pair, &newcwd);
- if (err) {
- return err;
- }
- err = lfs_dir_drop(lfs, &newcwd, &prevdir.m);
- if (err) {
- return err;
- }
- }
- return 0;
- }
- #endif
- static lfs_ssize_t lfs_rawgetattr(lfs_t *lfs, const char *path,
- uint8_t type, void *buffer, lfs_size_t size) {
- lfs_mdir_t cwd;
- lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
- if (tag < 0) {
- return tag;
- }
- uint16_t id = lfs_tag_id(tag);
- if (id == 0x3ff) {
- // special case for root
- id = 0;
- int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
- if (err) {
- return err;
- }
- }
- tag = lfs_dir_get(lfs, &cwd, LFS_MKTAG(0x7ff, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_USERATTR + type,
- id, lfs_min(size, lfs->attr_max)),
- buffer);
- if (tag < 0) {
- if (tag == LFS_ERR_NOENT) {
- return LFS_ERR_NOATTR;
- }
- return tag;
- }
- return lfs_tag_size(tag);
- }
- #ifndef LFS_READONLY
- static int lfs_commitattr(lfs_t *lfs, const char *path,
- uint8_t type, const void *buffer, lfs_size_t size) {
- lfs_mdir_t cwd;
- lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
- if (tag < 0) {
- return tag;
- }
- uint16_t id = lfs_tag_id(tag);
- if (id == 0x3ff) {
- // special case for root
- id = 0;
- int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
- if (err) {
- return err;
- }
- }
- return lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_USERATTR + type, id, size), buffer}));
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_rawsetattr(lfs_t *lfs, const char *path,
- uint8_t type, const void *buffer, lfs_size_t size) {
- if (size > lfs->attr_max) {
- return LFS_ERR_NOSPC;
- }
- return lfs_commitattr(lfs, path, type, buffer, size);
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_rawremoveattr(lfs_t *lfs, const char *path, uint8_t type) {
- return lfs_commitattr(lfs, path, type, NULL, 0x3ff);
- }
- #endif
- /// Filesystem operations ///
- static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
- lfs->cfg = cfg;
- int err = 0;
- // validate that the lfs-cfg sizes were initiated properly before
- // performing any arithmetic logics with them
- LFS_ASSERT(lfs->cfg->read_size != 0);
- LFS_ASSERT(lfs->cfg->prog_size != 0);
- LFS_ASSERT(lfs->cfg->cache_size != 0);
- // check that block size is a multiple of cache size is a multiple
- // of prog and read sizes
- LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->read_size == 0);
- LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->prog_size == 0);
- LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->cache_size == 0);
- // check that the block size is large enough to fit ctz pointers
- LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
- <= lfs->cfg->block_size);
- // block_cycles = 0 is no longer supported.
- //
- // block_cycles is the number of erase cycles before littlefs evicts
- // metadata logs as a part of wear leveling. Suggested values are in the
- // range of 100-1000, or set block_cycles to -1 to disable block-level
- // wear-leveling.
- LFS_ASSERT(lfs->cfg->block_cycles != 0);
- // setup read cache
- if (lfs->cfg->read_buffer) {
- lfs->rcache.buffer = lfs->cfg->read_buffer;
- } else {
- lfs->rcache.buffer = lfs_malloc(lfs->cfg->cache_size);
- if (!lfs->rcache.buffer) {
- err = LFS_ERR_NOMEM;
- goto cleanup;
- }
- }
- // setup program cache
- if (lfs->cfg->prog_buffer) {
- lfs->pcache.buffer = lfs->cfg->prog_buffer;
- } else {
- lfs->pcache.buffer = lfs_malloc(lfs->cfg->cache_size);
- if (!lfs->pcache.buffer) {
- err = LFS_ERR_NOMEM;
- goto cleanup;
- }
- }
- // zero to avoid information leaks
- lfs_cache_zero(lfs, &lfs->rcache);
- lfs_cache_zero(lfs, &lfs->pcache);
- // setup lookahead, must be multiple of 64-bits, 32-bit aligned
- LFS_ASSERT(lfs->cfg->lookahead_size > 0);
- LFS_ASSERT(lfs->cfg->lookahead_size % 8 == 0 &&
- (uintptr_t)lfs->cfg->lookahead_buffer % 4 == 0);
- if (lfs->cfg->lookahead_buffer) {
- lfs->free.buffer = lfs->cfg->lookahead_buffer;
- } else {
- lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead_size);
- if (!lfs->free.buffer) {
- err = LFS_ERR_NOMEM;
- goto cleanup;
- }
- }
- // check that the size limits are sane
- LFS_ASSERT(lfs->cfg->name_max <= LFS_NAME_MAX);
- lfs->name_max = lfs->cfg->name_max;
- if (!lfs->name_max) {
- lfs->name_max = LFS_NAME_MAX;
- }
- LFS_ASSERT(lfs->cfg->file_max <= LFS_FILE_MAX);
- lfs->file_max = lfs->cfg->file_max;
- if (!lfs->file_max) {
- lfs->file_max = LFS_FILE_MAX;
- }
- LFS_ASSERT(lfs->cfg->attr_max <= LFS_ATTR_MAX);
- lfs->attr_max = lfs->cfg->attr_max;
- if (!lfs->attr_max) {
- lfs->attr_max = LFS_ATTR_MAX;
- }
- LFS_ASSERT(lfs->cfg->metadata_max <= lfs->cfg->block_size);
- // setup default state
- lfs->root[0] = LFS_BLOCK_NULL;
- lfs->root[1] = LFS_BLOCK_NULL;
- lfs->mlist = NULL;
- lfs->seed = 0;
- lfs->gdisk = (lfs_gstate_t){0};
- lfs->gstate = (lfs_gstate_t){0};
- lfs->gdelta = (lfs_gstate_t){0};
- #ifdef LFS_MIGRATE
- lfs->lfs1 = NULL;
- #endif
- return 0;
- cleanup:
- lfs_deinit(lfs);
- return err;
- }
- static int lfs_deinit(lfs_t *lfs) {
- // free allocated memory
- if (!lfs->cfg->read_buffer) {
- lfs_free(lfs->rcache.buffer);
- }
- if (!lfs->cfg->prog_buffer) {
- lfs_free(lfs->pcache.buffer);
- }
- if (!lfs->cfg->lookahead_buffer) {
- lfs_free(lfs->free.buffer);
- }
- return 0;
- }
- #ifndef LFS_READONLY
- static int lfs_rawformat(lfs_t *lfs, const struct lfs_config *cfg) {
- int err = 0;
- {
- err = lfs_init(lfs, cfg);
- if (err) {
- return err;
- }
- // create free lookahead
- memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
- lfs->free.off = 0;
- lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size,
- lfs->cfg->block_count);
- lfs->free.i = 0;
- lfs_alloc_ack(lfs);
- // create root dir
- lfs_mdir_t root;
- err = lfs_dir_alloc(lfs, &root);
- if (err) {
- goto cleanup;
- }
- // write one superblock
- lfs_superblock_t superblock = {
- .version = LFS_DISK_VERSION,
- .block_size = lfs->cfg->block_size,
- .block_count = lfs->cfg->block_count,
- .name_max = lfs->name_max,
- .file_max = lfs->file_max,
- .attr_max = lfs->attr_max,
- };
- lfs_superblock_tole32(&superblock);
- err = lfs_dir_commit(lfs, &root, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_CREATE, 0, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8), "littlefs"},
- {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
- &superblock}));
- if (err) {
- goto cleanup;
- }
- // force compaction to prevent accidentally mounting any
- // older version of littlefs that may live on disk
- root.erased = false;
- err = lfs_dir_commit(lfs, &root, NULL, 0);
- if (err) {
- goto cleanup;
- }
- // sanity check that fetch works
- err = lfs_dir_fetch(lfs, &root, (const lfs_block_t[2]){0, 1});
- if (err) {
- goto cleanup;
- }
- }
- cleanup:
- lfs_deinit(lfs);
- return err;
- }
- #endif
- static int lfs_rawmount(lfs_t *lfs, const struct lfs_config *cfg) {
- int err = lfs_init(lfs, cfg);
- if (err) {
- return err;
- }
- // scan directory blocks for superblock and any global updates
- lfs_mdir_t dir = {.tail = {0, 1}};
- lfs_block_t cycle = 0;
- while (!lfs_pair_isnull(dir.tail)) {
- if (cycle >= lfs->cfg->block_count/2) {
- // loop detected
- err = LFS_ERR_CORRUPT;
- goto cleanup;
- }
- cycle += 1;
- // fetch next block in tail list
- lfs_stag_t tag = lfs_dir_fetchmatch(lfs, &dir, dir.tail,
- LFS_MKTAG(0x7ff, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8),
- NULL,
- lfs_dir_find_match, &(struct lfs_dir_find_match){
- lfs, "littlefs", 8});
- if (tag < 0) {
- err = tag;
- goto cleanup;
- }
- // has superblock?
- if (tag && !lfs_tag_isdelete(tag)) {
- // update root
- lfs->root[0] = dir.pair[0];
- lfs->root[1] = dir.pair[1];
- // grab superblock
- lfs_superblock_t superblock;
- tag = lfs_dir_get(lfs, &dir, LFS_MKTAG(0x7ff, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
- &superblock);
- if (tag < 0) {
- err = tag;
- goto cleanup;
- }
- lfs_superblock_fromle32(&superblock);
- // check version
- uint16_t major_version = (0xffff & (superblock.version >> 16));
- uint16_t minor_version = (0xffff & (superblock.version >> 0));
- if ((major_version != LFS_DISK_VERSION_MAJOR ||
- minor_version > LFS_DISK_VERSION_MINOR)) {
- LFS_ERROR("Invalid version v%"PRIu16".%"PRIu16,
- major_version, minor_version);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- // check superblock configuration
- if (superblock.name_max) {
- if (superblock.name_max > lfs->name_max) {
- LFS_ERROR("Unsupported name_max (%"PRIu32" > %"PRIu32")",
- superblock.name_max, lfs->name_max);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- lfs->name_max = superblock.name_max;
- }
- if (superblock.file_max) {
- if (superblock.file_max > lfs->file_max) {
- LFS_ERROR("Unsupported file_max (%"PRIu32" > %"PRIu32")",
- superblock.file_max, lfs->file_max);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- lfs->file_max = superblock.file_max;
- }
- if (superblock.attr_max) {
- if (superblock.attr_max > lfs->attr_max) {
- LFS_ERROR("Unsupported attr_max (%"PRIu32" > %"PRIu32")",
- superblock.attr_max, lfs->attr_max);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- lfs->attr_max = superblock.attr_max;
- }
- if (superblock.block_count != lfs->cfg->block_count) {
- LFS_ERROR("Invalid block count (%"PRIu32" != %"PRIu32")",
- superblock.block_count, lfs->cfg->block_count);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- if (superblock.block_size != lfs->cfg->block_size) {
- LFS_ERROR("Invalid block size (%"PRIu32" != %"PRIu32")",
- superblock.block_count, lfs->cfg->block_count);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- }
- // has gstate?
- err = lfs_dir_getgstate(lfs, &dir, &lfs->gstate);
- if (err) {
- goto cleanup;
- }
- }
- // found superblock?
- if (lfs_pair_isnull(lfs->root)) {
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- // update littlefs with gstate
- if (!lfs_gstate_iszero(&lfs->gstate)) {
- LFS_DEBUG("Found pending gstate 0x%08"PRIx32"%08"PRIx32"%08"PRIx32,
- lfs->gstate.tag,
- lfs->gstate.pair[0],
- lfs->gstate.pair[1]);
- }
- lfs->gstate.tag += !lfs_tag_isvalid(lfs->gstate.tag);
- lfs->gdisk = lfs->gstate;
- // setup free lookahead, to distribute allocations uniformly across
- // boots, we start the allocator at a random location
- lfs->free.off = lfs->seed % lfs->cfg->block_count;
- lfs_alloc_drop(lfs);
- return 0;
- cleanup:
- lfs_rawunmount(lfs);
- return err;
- }
- static int lfs_rawunmount(lfs_t *lfs) {
- return lfs_deinit(lfs);
- }
- /// Filesystem filesystem operations ///
- int lfs_fs_rawtraverse(lfs_t *lfs,
- int (*cb)(void *data, lfs_block_t block), void *data,
- bool includeorphans) {
- // iterate over metadata pairs
- lfs_mdir_t dir = {.tail = {0, 1}};
- #ifdef LFS_MIGRATE
- // also consider v1 blocks during migration
- if (lfs->lfs1) {
- int err = lfs1_traverse(lfs, cb, data);
- if (err) {
- return err;
- }
- dir.tail[0] = lfs->root[0];
- dir.tail[1] = lfs->root[1];
- }
- #endif
- lfs_block_t cycle = 0;
- while (!lfs_pair_isnull(dir.tail)) {
- if (cycle >= lfs->cfg->block_count/2) {
- // loop detected
- return LFS_ERR_CORRUPT;
- }
- cycle += 1;
- for (int i = 0; i < 2; i++) {
- int err = cb(data, dir.tail[i]);
- if (err) {
- return err;
- }
- }
- // iterate through ids in directory
- int err = lfs_dir_fetch(lfs, &dir, dir.tail);
- if (err) {
- return err;
- }
- for (uint16_t id = 0; id < dir.count; id++) {
- struct lfs_ctz ctz;
- lfs_stag_t tag = lfs_dir_get(lfs, &dir, LFS_MKTAG(0x700, 0x3ff, 0),
- LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
- if (tag < 0) {
- if (tag == LFS_ERR_NOENT) {
- continue;
- }
- return tag;
- }
- lfs_ctz_fromle32(&ctz);
- if (lfs_tag_type3(tag) == LFS_TYPE_CTZSTRUCT) {
- err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
- ctz.head, ctz.size, cb, data);
- if (err) {
- return err;
- }
- } else if (includeorphans &&
- lfs_tag_type3(tag) == LFS_TYPE_DIRSTRUCT) {
- for (int i = 0; i < 2; i++) {
- err = cb(data, (&ctz.head)[i]);
- if (err) {
- return err;
- }
- }
- }
- }
- }
- #ifndef LFS_READONLY
- // iterate over any open files
- for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
- if (f->type != LFS_TYPE_REG) {
- continue;
- }
- if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
- int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
- f->ctz.head, f->ctz.size, cb, data);
- if (err) {
- return err;
- }
- }
- if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
- int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
- f->block, f->pos, cb, data);
- if (err) {
- return err;
- }
- }
- }
- #endif
- return 0;
- }
- #ifndef LFS_READONLY
- static int lfs_fs_pred(lfs_t *lfs,
- const lfs_block_t pair[2], lfs_mdir_t *pdir) {
- // iterate over all directory directory entries
- pdir->tail[0] = 0;
- pdir->tail[1] = 1;
- lfs_block_t cycle = 0;
- while (!lfs_pair_isnull(pdir->tail)) {
- if (cycle >= lfs->cfg->block_count/2) {
- // loop detected
- return LFS_ERR_CORRUPT;
- }
- cycle += 1;
- if (lfs_pair_cmp(pdir->tail, pair) == 0) {
- return 0;
- }
- int err = lfs_dir_fetch(lfs, pdir, pdir->tail);
- if (err) {
- return err;
- }
- }
- return LFS_ERR_NOENT;
- }
- #endif
- #ifndef LFS_READONLY
- struct lfs_fs_parent_match {
- lfs_t *lfs;
- const lfs_block_t pair[2];
- };
- #endif
- #ifndef LFS_READONLY
- static int lfs_fs_parent_match(void *data,
- lfs_tag_t tag, const void *buffer) {
- struct lfs_fs_parent_match *find = data;
- lfs_t *lfs = find->lfs;
- const struct lfs_diskoff *disk = buffer;
- (void)tag;
- lfs_block_t child[2];
- int err = lfs_bd_read(lfs,
- &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
- disk->block, disk->off, &child, sizeof(child));
- if (err) {
- return err;
- }
- lfs_pair_fromle32(child);
- return (lfs_pair_cmp(child, find->pair) == 0) ? LFS_CMP_EQ : LFS_CMP_LT;
- }
- #endif
- #ifndef LFS_READONLY
- static lfs_stag_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t pair[2],
- lfs_mdir_t *parent) {
- // use fetchmatch with callback to find pairs
- parent->tail[0] = 0;
- parent->tail[1] = 1;
- lfs_block_t cycle = 0;
- while (!lfs_pair_isnull(parent->tail)) {
- if (cycle >= lfs->cfg->block_count/2) {
- // loop detected
- return LFS_ERR_CORRUPT;
- }
- cycle += 1;
- lfs_stag_t tag = lfs_dir_fetchmatch(lfs, parent, parent->tail,
- LFS_MKTAG(0x7ff, 0, 0x3ff),
- LFS_MKTAG(LFS_TYPE_DIRSTRUCT, 0, 8),
- NULL,
- lfs_fs_parent_match, &(struct lfs_fs_parent_match){
- lfs, {pair[0], pair[1]}});
- if (tag && tag != LFS_ERR_NOENT) {
- return tag;
- }
- }
- return LFS_ERR_NOENT;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_fs_preporphans(lfs_t *lfs, int8_t orphans) {
- LFS_ASSERT(lfs_tag_size(lfs->gstate.tag) > 0 || orphans >= 0);
- lfs->gstate.tag += orphans;
- lfs->gstate.tag = ((lfs->gstate.tag & ~LFS_MKTAG(0x800, 0, 0)) |
- ((uint32_t)lfs_gstate_hasorphans(&lfs->gstate) << 31));
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static void lfs_fs_prepmove(lfs_t *lfs,
- uint16_t id, const lfs_block_t pair[2]) {
- lfs->gstate.tag = ((lfs->gstate.tag & ~LFS_MKTAG(0x7ff, 0x3ff, 0)) |
- ((id != 0x3ff) ? LFS_MKTAG(LFS_TYPE_DELETE, id, 0) : 0));
- lfs->gstate.pair[0] = (id != 0x3ff) ? pair[0] : 0;
- lfs->gstate.pair[1] = (id != 0x3ff) ? pair[1] : 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_fs_demove(lfs_t *lfs) {
- if (!lfs_gstate_hasmove(&lfs->gdisk)) {
- return 0;
- }
- // Fix bad moves
- LFS_DEBUG("Fixing move {0x%"PRIx32", 0x%"PRIx32"} 0x%"PRIx16,
- lfs->gdisk.pair[0],
- lfs->gdisk.pair[1],
- lfs_tag_id(lfs->gdisk.tag));
- // fetch and delete the moved entry
- lfs_mdir_t movedir;
- int err = lfs_dir_fetch(lfs, &movedir, lfs->gdisk.pair);
- if (err) {
- return err;
- }
- // prep gstate and delete move id
- uint16_t moveid = lfs_tag_id(lfs->gdisk.tag);
- lfs_fs_prepmove(lfs, 0x3ff, NULL);
- err = lfs_dir_commit(lfs, &movedir, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_DELETE, moveid, 0), NULL}));
- if (err) {
- return err;
- }
- return 0;
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_fs_deorphan(lfs_t *lfs, bool powerloss) {
- if (!lfs_gstate_hasorphans(&lfs->gstate)) {
- return 0;
- }
- int8_t found = 0;
- restart:
- {
- // Fix any orphans
- lfs_mdir_t pdir = {.split = true, .tail = {0, 1}};
- lfs_mdir_t dir;
- // iterate over all directory directory entries
- while (!lfs_pair_isnull(pdir.tail)) {
- int err = lfs_dir_fetch(lfs, &dir, pdir.tail);
- if (err) {
- return err;
- }
- // check head blocks for orphans
- if (!pdir.split) {
- // check if we have a parent
- lfs_mdir_t parent;
- lfs_stag_t tag = lfs_fs_parent(lfs, pdir.tail, &parent);
- if (tag < 0 && tag != LFS_ERR_NOENT) {
- return tag;
- }
- // note we only check for full orphans if we may have had a
- // power-loss, otherwise orphans are created intentionally
- // during operations such as lfs_mkdir
- if (tag == LFS_ERR_NOENT && powerloss) {
- // we are an orphan
- LFS_DEBUG("Fixing orphan {0x%"PRIx32", 0x%"PRIx32"}",
- pdir.tail[0], pdir.tail[1]);
- // steal state
- err = lfs_dir_getgstate(lfs, &dir, &lfs->gdelta);
- if (err) {
- return err;
- }
- // steal tail
- lfs_pair_tole32(dir.tail);
- int state = lfs_dir_orphaningcommit(lfs, &pdir, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_TAIL + dir.split, 0x3ff, 8),
- dir.tail}));
- lfs_pair_fromle32(dir.tail);
- if (state < 0) {
- return state;
- }
- found += 1;
- // did our commit create more orphans?
- if (state == LFS_OK_ORPHANED) {
- goto restart;
- }
- // refetch tail
- continue;
- }
- if (tag != LFS_ERR_NOENT) {
- lfs_block_t pair[2];
- lfs_stag_t state = lfs_dir_get(lfs, &parent,
- LFS_MKTAG(0x7ff, 0x3ff, 0), tag, pair);
- if (state < 0) {
- return state;
- }
- lfs_pair_fromle32(pair);
- if (!lfs_pair_sync(pair, pdir.tail)) {
- // we have desynced
- LFS_DEBUG("Fixing half-orphan "
- "{0x%"PRIx32", 0x%"PRIx32"} "
- "-> {0x%"PRIx32", 0x%"PRIx32"}",
- pdir.tail[0], pdir.tail[1], pair[0], pair[1]);
- // fix pending move in this pair? this looks like an
- // optimization but is in fact _required_ since
- // relocating may outdate the move.
- uint16_t moveid = 0x3ff;
- if (lfs_gstate_hasmovehere(&lfs->gstate, pdir.pair)) {
- moveid = lfs_tag_id(lfs->gstate.tag);
- LFS_DEBUG("Fixing move while fixing orphans "
- "{0x%"PRIx32", 0x%"PRIx32"} 0x%"PRIx16"\n",
- pdir.pair[0], pdir.pair[1], moveid);
- lfs_fs_prepmove(lfs, 0x3ff, NULL);
- }
- lfs_pair_tole32(pair);
- state = lfs_dir_orphaningcommit(lfs, &pdir, LFS_MKATTRS(
- {LFS_MKTAG_IF(moveid != 0x3ff,
- LFS_TYPE_DELETE, moveid, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8),
- pair}));
- lfs_pair_fromle32(pair);
- if (state < 0) {
- return state;
- }
- found += 1;
- // did our commit create more orphans?
- if (state == LFS_OK_ORPHANED) {
- goto restart;
- }
- // refetch tail
- continue;
- }
- }
- }
- pdir = dir;
- }
- }
- // mark orphans as fixed
- return lfs_fs_preporphans(lfs, -lfs_min(
- lfs_gstate_getorphans(&lfs->gstate),
- found));
- }
- #endif
- #ifndef LFS_READONLY
- static int lfs_fs_forceconsistency(lfs_t *lfs) {
- int err = lfs_fs_demove(lfs);
- if (err) {
- return err;
- }
- err = lfs_fs_deorphan(lfs, true);
- if (err) {
- return err;
- }
- return 0;
- }
- #endif
- static int lfs_fs_size_count(void *p, lfs_block_t block) {
- (void)block;
- lfs_size_t *size = p;
- *size += 1;
- return 0;
- }
- static lfs_ssize_t lfs_fs_rawsize(lfs_t *lfs) {
- lfs_size_t size = 0;
- int err = lfs_fs_rawtraverse(lfs, lfs_fs_size_count, &size, false);
- if (err) {
- return err;
- }
- return size;
- }
- #ifdef LFS_MIGRATE
- ////// Migration from littelfs v1 below this //////
- /// Version info ///
- // Software library version
- // Major (top-nibble), incremented on backwards incompatible changes
- // Minor (bottom-nibble), incremented on feature additions
- #define LFS1_VERSION 0x00010007
- #define LFS1_VERSION_MAJOR (0xffff & (LFS1_VERSION >> 16))
- #define LFS1_VERSION_MINOR (0xffff & (LFS1_VERSION >> 0))
- // Version of On-disk data structures
- // Major (top-nibble), incremented on backwards incompatible changes
- // Minor (bottom-nibble), incremented on feature additions
- #define LFS1_DISK_VERSION 0x00010001
- #define LFS1_DISK_VERSION_MAJOR (0xffff & (LFS1_DISK_VERSION >> 16))
- #define LFS1_DISK_VERSION_MINOR (0xffff & (LFS1_DISK_VERSION >> 0))
- /// v1 Definitions ///
- // File types
- enum lfs1_type {
- LFS1_TYPE_REG = 0x11,
- LFS1_TYPE_DIR = 0x22,
- LFS1_TYPE_SUPERBLOCK = 0x2e,
- };
- typedef struct lfs1 {
- lfs_block_t root[2];
- } lfs1_t;
- typedef struct lfs1_entry {
- lfs_off_t off;
- struct lfs1_disk_entry {
- uint8_t type;
- uint8_t elen;
- uint8_t alen;
- uint8_t nlen;
- union {
- struct {
- lfs_block_t head;
- lfs_size_t size;
- } file;
- lfs_block_t dir[2];
- } u;
- } d;
- } lfs1_entry_t;
- typedef struct lfs1_dir {
- struct lfs1_dir *next;
- lfs_block_t pair[2];
- lfs_off_t off;
- lfs_block_t head[2];
- lfs_off_t pos;
- struct lfs1_disk_dir {
- uint32_t rev;
- lfs_size_t size;
- lfs_block_t tail[2];
- } d;
- } lfs1_dir_t;
- typedef struct lfs1_superblock {
- lfs_off_t off;
- struct lfs1_disk_superblock {
- uint8_t type;
- uint8_t elen;
- uint8_t alen;
- uint8_t nlen;
- lfs_block_t root[2];
- uint32_t block_size;
- uint32_t block_count;
- uint32_t version;
- char magic[8];
- } d;
- } lfs1_superblock_t;
- /// Low-level wrappers v1->v2 ///
- static void lfs1_crc(uint32_t *crc, const void *buffer, size_t size) {
- *crc = lfs_crc(*crc, buffer, size);
- }
- static int lfs1_bd_read(lfs_t *lfs, lfs_block_t block,
- lfs_off_t off, void *buffer, lfs_size_t size) {
- // if we ever do more than writes to alternating pairs,
- // this may need to consider pcache
- return lfs_bd_read(lfs, &lfs->pcache, &lfs->rcache, size,
- block, off, buffer, size);
- }
- static int lfs1_bd_crc(lfs_t *lfs, lfs_block_t block,
- lfs_off_t off, lfs_size_t size, uint32_t *crc) {
- for (lfs_off_t i = 0; i < size; i++) {
- uint8_t c;
- int err = lfs1_bd_read(lfs, block, off+i, &c, 1);
- if (err) {
- return err;
- }
- lfs1_crc(crc, &c, 1);
- }
- return 0;
- }
- /// Endian swapping functions ///
- static void lfs1_dir_fromle32(struct lfs1_disk_dir *d) {
- d->rev = lfs_fromle32(d->rev);
- d->size = lfs_fromle32(d->size);
- d->tail[0] = lfs_fromle32(d->tail[0]);
- d->tail[1] = lfs_fromle32(d->tail[1]);
- }
- static void lfs1_dir_tole32(struct lfs1_disk_dir *d) {
- d->rev = lfs_tole32(d->rev);
- d->size = lfs_tole32(d->size);
- d->tail[0] = lfs_tole32(d->tail[0]);
- d->tail[1] = lfs_tole32(d->tail[1]);
- }
- static void lfs1_entry_fromle32(struct lfs1_disk_entry *d) {
- d->u.dir[0] = lfs_fromle32(d->u.dir[0]);
- d->u.dir[1] = lfs_fromle32(d->u.dir[1]);
- }
- static void lfs1_entry_tole32(struct lfs1_disk_entry *d) {
- d->u.dir[0] = lfs_tole32(d->u.dir[0]);
- d->u.dir[1] = lfs_tole32(d->u.dir[1]);
- }
- static void lfs1_superblock_fromle32(struct lfs1_disk_superblock *d) {
- d->root[0] = lfs_fromle32(d->root[0]);
- d->root[1] = lfs_fromle32(d->root[1]);
- d->block_size = lfs_fromle32(d->block_size);
- d->block_count = lfs_fromle32(d->block_count);
- d->version = lfs_fromle32(d->version);
- }
- ///// Metadata pair and directory operations ///
- static inline lfs_size_t lfs1_entry_size(const lfs1_entry_t *entry) {
- return 4 + entry->d.elen + entry->d.alen + entry->d.nlen;
- }
- static int lfs1_dir_fetch(lfs_t *lfs,
- lfs1_dir_t *dir, const lfs_block_t pair[2]) {
- // copy out pair, otherwise may be aliasing dir
- const lfs_block_t tpair[2] = {pair[0], pair[1]};
- bool valid = false;
- // check both blocks for the most recent revision
- for (int i = 0; i < 2; i++) {
- struct lfs1_disk_dir test;
- int err = lfs1_bd_read(lfs, tpair[i], 0, &test, sizeof(test));
- lfs1_dir_fromle32(&test);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- continue;
- }
- return err;
- }
- if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
- continue;
- }
- if ((0x7fffffff & test.size) < sizeof(test)+4 ||
- (0x7fffffff & test.size) > lfs->cfg->block_size) {
- continue;
- }
- uint32_t crc = 0xffffffff;
- lfs1_dir_tole32(&test);
- lfs1_crc(&crc, &test, sizeof(test));
- lfs1_dir_fromle32(&test);
- err = lfs1_bd_crc(lfs, tpair[i], sizeof(test),
- (0x7fffffff & test.size) - sizeof(test), &crc);
- if (err) {
- if (err == LFS_ERR_CORRUPT) {
- continue;
- }
- return err;
- }
- if (crc != 0) {
- continue;
- }
- valid = true;
- // setup dir in case it's valid
- dir->pair[0] = tpair[(i+0) % 2];
- dir->pair[1] = tpair[(i+1) % 2];
- dir->off = sizeof(dir->d);
- dir->d = test;
- }
- if (!valid) {
- LFS_ERROR("Corrupted dir pair at {0x%"PRIx32", 0x%"PRIx32"}",
- tpair[0], tpair[1]);
- return LFS_ERR_CORRUPT;
- }
- return 0;
- }
- static int lfs1_dir_next(lfs_t *lfs, lfs1_dir_t *dir, lfs1_entry_t *entry) {
- while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)-4) {
- if (!(0x80000000 & dir->d.size)) {
- entry->off = dir->off;
- return LFS_ERR_NOENT;
- }
- int err = lfs1_dir_fetch(lfs, dir, dir->d.tail);
- if (err) {
- return err;
- }
- dir->off = sizeof(dir->d);
- dir->pos += sizeof(dir->d) + 4;
- }
- int err = lfs1_bd_read(lfs, dir->pair[0], dir->off,
- &entry->d, sizeof(entry->d));
- lfs1_entry_fromle32(&entry->d);
- if (err) {
- return err;
- }
- entry->off = dir->off;
- dir->off += lfs1_entry_size(entry);
- dir->pos += lfs1_entry_size(entry);
- return 0;
- }
- /// littlefs v1 specific operations ///
- int lfs1_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
- if (lfs_pair_isnull(lfs->lfs1->root)) {
- return 0;
- }
- // iterate over metadata pairs
- lfs1_dir_t dir;
- lfs1_entry_t entry;
- lfs_block_t cwd[2] = {0, 1};
- while (true) {
- for (int i = 0; i < 2; i++) {
- int err = cb(data, cwd[i]);
- if (err) {
- return err;
- }
- }
- int err = lfs1_dir_fetch(lfs, &dir, cwd);
- if (err) {
- return err;
- }
- // iterate over contents
- while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
- err = lfs1_bd_read(lfs, dir.pair[0], dir.off,
- &entry.d, sizeof(entry.d));
- lfs1_entry_fromle32(&entry.d);
- if (err) {
- return err;
- }
- dir.off += lfs1_entry_size(&entry);
- if ((0x70 & entry.d.type) == (0x70 & LFS1_TYPE_REG)) {
- err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
- entry.d.u.file.head, entry.d.u.file.size, cb, data);
- if (err) {
- return err;
- }
- }
- }
- // we also need to check if we contain a threaded v2 directory
- lfs_mdir_t dir2 = {.split=true, .tail={cwd[0], cwd[1]}};
- while (dir2.split) {
- err = lfs_dir_fetch(lfs, &dir2, dir2.tail);
- if (err) {
- break;
- }
- for (int i = 0; i < 2; i++) {
- err = cb(data, dir2.pair[i]);
- if (err) {
- return err;
- }
- }
- }
- cwd[0] = dir.d.tail[0];
- cwd[1] = dir.d.tail[1];
- if (lfs_pair_isnull(cwd)) {
- break;
- }
- }
- return 0;
- }
- static int lfs1_moved(lfs_t *lfs, const void *e) {
- if (lfs_pair_isnull(lfs->lfs1->root)) {
- return 0;
- }
- // skip superblock
- lfs1_dir_t cwd;
- int err = lfs1_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
- if (err) {
- return err;
- }
- // iterate over all directory directory entries
- lfs1_entry_t entry;
- while (!lfs_pair_isnull(cwd.d.tail)) {
- err = lfs1_dir_fetch(lfs, &cwd, cwd.d.tail);
- if (err) {
- return err;
- }
- while (true) {
- err = lfs1_dir_next(lfs, &cwd, &entry);
- if (err && err != LFS_ERR_NOENT) {
- return err;
- }
- if (err == LFS_ERR_NOENT) {
- break;
- }
- if (!(0x80 & entry.d.type) &&
- memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
- return true;
- }
- }
- }
- return false;
- }
- /// Filesystem operations ///
- static int lfs1_mount(lfs_t *lfs, struct lfs1 *lfs1,
- const struct lfs_config *cfg) {
- int err = 0;
- {
- err = lfs_init(lfs, cfg);
- if (err) {
- return err;
- }
- lfs->lfs1 = lfs1;
- lfs->lfs1->root[0] = LFS_BLOCK_NULL;
- lfs->lfs1->root[1] = LFS_BLOCK_NULL;
- // setup free lookahead
- lfs->free.off = 0;
- lfs->free.size = 0;
- lfs->free.i = 0;
- lfs_alloc_ack(lfs);
- // load superblock
- lfs1_dir_t dir;
- lfs1_superblock_t superblock;
- err = lfs1_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
- if (err && err != LFS_ERR_CORRUPT) {
- goto cleanup;
- }
- if (!err) {
- err = lfs1_bd_read(lfs, dir.pair[0], sizeof(dir.d),
- &superblock.d, sizeof(superblock.d));
- lfs1_superblock_fromle32(&superblock.d);
- if (err) {
- goto cleanup;
- }
- lfs->lfs1->root[0] = superblock.d.root[0];
- lfs->lfs1->root[1] = superblock.d.root[1];
- }
- if (err || memcmp(superblock.d.magic, "littlefs", 8) != 0) {
- LFS_ERROR("Invalid superblock at {0x%"PRIx32", 0x%"PRIx32"}",
- 0, 1);
- err = LFS_ERR_CORRUPT;
- goto cleanup;
- }
- uint16_t major_version = (0xffff & (superblock.d.version >> 16));
- uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
- if ((major_version != LFS1_DISK_VERSION_MAJOR ||
- minor_version > LFS1_DISK_VERSION_MINOR)) {
- LFS_ERROR("Invalid version v%d.%d", major_version, minor_version);
- err = LFS_ERR_INVAL;
- goto cleanup;
- }
- return 0;
- }
- cleanup:
- lfs_deinit(lfs);
- return err;
- }
- static int lfs1_unmount(lfs_t *lfs) {
- return lfs_deinit(lfs);
- }
- /// v1 migration ///
- static int lfs_rawmigrate(lfs_t *lfs, const struct lfs_config *cfg) {
- struct lfs1 lfs1;
- int err = lfs1_mount(lfs, &lfs1, cfg);
- if (err) {
- return err;
- }
- {
- // iterate through each directory, copying over entries
- // into new directory
- lfs1_dir_t dir1;
- lfs_mdir_t dir2;
- dir1.d.tail[0] = lfs->lfs1->root[0];
- dir1.d.tail[1] = lfs->lfs1->root[1];
- while (!lfs_pair_isnull(dir1.d.tail)) {
- // iterate old dir
- err = lfs1_dir_fetch(lfs, &dir1, dir1.d.tail);
- if (err) {
- goto cleanup;
- }
- // create new dir and bind as temporary pretend root
- err = lfs_dir_alloc(lfs, &dir2);
- if (err) {
- goto cleanup;
- }
- dir2.rev = dir1.d.rev;
- dir1.head[0] = dir1.pair[0];
- dir1.head[1] = dir1.pair[1];
- lfs->root[0] = dir2.pair[0];
- lfs->root[1] = dir2.pair[1];
- err = lfs_dir_commit(lfs, &dir2, NULL, 0);
- if (err) {
- goto cleanup;
- }
- while (true) {
- lfs1_entry_t entry1;
- err = lfs1_dir_next(lfs, &dir1, &entry1);
- if (err && err != LFS_ERR_NOENT) {
- goto cleanup;
- }
- if (err == LFS_ERR_NOENT) {
- break;
- }
- // check that entry has not been moved
- if (entry1.d.type & 0x80) {
- int moved = lfs1_moved(lfs, &entry1.d.u);
- if (moved < 0) {
- err = moved;
- goto cleanup;
- }
- if (moved) {
- continue;
- }
- entry1.d.type &= ~0x80;
- }
- // also fetch name
- char name[LFS_NAME_MAX+1];
- memset(name, 0, sizeof(name));
- err = lfs1_bd_read(lfs, dir1.pair[0],
- entry1.off + 4+entry1.d.elen+entry1.d.alen,
- name, entry1.d.nlen);
- if (err) {
- goto cleanup;
- }
- bool isdir = (entry1.d.type == LFS1_TYPE_DIR);
- // create entry in new dir
- err = lfs_dir_fetch(lfs, &dir2, lfs->root);
- if (err) {
- goto cleanup;
- }
- uint16_t id;
- err = lfs_dir_find(lfs, &dir2, &(const char*){name}, &id);
- if (!(err == LFS_ERR_NOENT && id != 0x3ff)) {
- err = (err < 0) ? err : LFS_ERR_EXIST;
- goto cleanup;
- }
- lfs1_entry_tole32(&entry1.d);
- err = lfs_dir_commit(lfs, &dir2, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_CREATE, id, 0), NULL},
- {LFS_MKTAG_IF_ELSE(isdir,
- LFS_TYPE_DIR, id, entry1.d.nlen,
- LFS_TYPE_REG, id, entry1.d.nlen),
- name},
- {LFS_MKTAG_IF_ELSE(isdir,
- LFS_TYPE_DIRSTRUCT, id, sizeof(entry1.d.u),
- LFS_TYPE_CTZSTRUCT, id, sizeof(entry1.d.u)),
- &entry1.d.u}));
- lfs1_entry_fromle32(&entry1.d);
- if (err) {
- goto cleanup;
- }
- }
- if (!lfs_pair_isnull(dir1.d.tail)) {
- // find last block and update tail to thread into fs
- err = lfs_dir_fetch(lfs, &dir2, lfs->root);
- if (err) {
- goto cleanup;
- }
- while (dir2.split) {
- err = lfs_dir_fetch(lfs, &dir2, dir2.tail);
- if (err) {
- goto cleanup;
- }
- }
- lfs_pair_tole32(dir2.pair);
- err = lfs_dir_commit(lfs, &dir2, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), dir1.d.tail}));
- lfs_pair_fromle32(dir2.pair);
- if (err) {
- goto cleanup;
- }
- }
- // Copy over first block to thread into fs. Unfortunately
- // if this fails there is not much we can do.
- LFS_DEBUG("Migrating {0x%"PRIx32", 0x%"PRIx32"} "
- "-> {0x%"PRIx32", 0x%"PRIx32"}",
- lfs->root[0], lfs->root[1], dir1.head[0], dir1.head[1]);
- err = lfs_bd_erase(lfs, dir1.head[1]);
- if (err) {
- goto cleanup;
- }
- err = lfs_dir_fetch(lfs, &dir2, lfs->root);
- if (err) {
- goto cleanup;
- }
- for (lfs_off_t i = 0; i < dir2.off; i++) {
- uint8_t dat;
- err = lfs_bd_read(lfs,
- NULL, &lfs->rcache, dir2.off,
- dir2.pair[0], i, &dat, 1);
- if (err) {
- goto cleanup;
- }
- err = lfs_bd_prog(lfs,
- &lfs->pcache, &lfs->rcache, true,
- dir1.head[1], i, &dat, 1);
- if (err) {
- goto cleanup;
- }
- }
- err = lfs_bd_flush(lfs, &lfs->pcache, &lfs->rcache, true);
- if (err) {
- goto cleanup;
- }
- }
- // Create new superblock. This marks a successful migration!
- err = lfs1_dir_fetch(lfs, &dir1, (const lfs_block_t[2]){0, 1});
- if (err) {
- goto cleanup;
- }
- dir2.pair[0] = dir1.pair[0];
- dir2.pair[1] = dir1.pair[1];
- dir2.rev = dir1.d.rev;
- dir2.off = sizeof(dir2.rev);
- dir2.etag = 0xffffffff;
- dir2.count = 0;
- dir2.tail[0] = lfs->lfs1->root[0];
- dir2.tail[1] = lfs->lfs1->root[1];
- dir2.erased = false;
- dir2.split = true;
- lfs_superblock_t superblock = {
- .version = LFS_DISK_VERSION,
- .block_size = lfs->cfg->block_size,
- .block_count = lfs->cfg->block_count,
- .name_max = lfs->name_max,
- .file_max = lfs->file_max,
- .attr_max = lfs->attr_max,
- };
- lfs_superblock_tole32(&superblock);
- err = lfs_dir_commit(lfs, &dir2, LFS_MKATTRS(
- {LFS_MKTAG(LFS_TYPE_CREATE, 0, 0), NULL},
- {LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8), "littlefs"},
- {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
- &superblock}));
- if (err) {
- goto cleanup;
- }
- // sanity check that fetch works
- err = lfs_dir_fetch(lfs, &dir2, (const lfs_block_t[2]){0, 1});
- if (err) {
- goto cleanup;
- }
- // force compaction to prevent accidentally mounting v1
- dir2.erased = false;
- err = lfs_dir_commit(lfs, &dir2, NULL, 0);
- if (err) {
- goto cleanup;
- }
- }
- cleanup:
- lfs1_unmount(lfs);
- return err;
- }
- #endif
- /// Public API wrappers ///
- // Here we can add tracing/thread safety easily
- // Thread-safe wrappers if enabled
- #ifdef LFS_THREADSAFE
- #define LFS_LOCK(cfg) cfg->lock(cfg)
- #define LFS_UNLOCK(cfg) cfg->unlock(cfg)
- #else
- #define LFS_LOCK(cfg) ((void)cfg, 0)
- #define LFS_UNLOCK(cfg) ((void)cfg)
- #endif
- // Public API
- #ifndef LFS_READONLY
- int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
- int err = LFS_LOCK(cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_format(%p, %p {.context=%p, "
- ".read=%p, .prog=%p, .erase=%p, .sync=%p, "
- ".read_size=%"PRIu32", .prog_size=%"PRIu32", "
- ".block_size=%"PRIu32", .block_count=%"PRIu32", "
- ".block_cycles=%"PRIu32", .cache_size=%"PRIu32", "
- ".lookahead_size=%"PRIu32", .read_buffer=%p, "
- ".prog_buffer=%p, .lookahead_buffer=%p, "
- ".name_max=%"PRIu32", .file_max=%"PRIu32", "
- ".attr_max=%"PRIu32"})",
- (void*)lfs, (void*)cfg, cfg->context,
- (void*)(uintptr_t)cfg->read, (void*)(uintptr_t)cfg->prog,
- (void*)(uintptr_t)cfg->erase, (void*)(uintptr_t)cfg->sync,
- cfg->read_size, cfg->prog_size, cfg->block_size, cfg->block_count,
- cfg->block_cycles, cfg->cache_size, cfg->lookahead_size,
- cfg->read_buffer, cfg->prog_buffer, cfg->lookahead_buffer,
- cfg->name_max, cfg->file_max, cfg->attr_max);
- err = lfs_rawformat(lfs, cfg);
- LFS_TRACE("lfs_format -> %d", err);
- LFS_UNLOCK(cfg);
- return err;
- }
- #endif
- int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
- int err = LFS_LOCK(cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_mount(%p, %p {.context=%p, "
- ".read=%p, .prog=%p, .erase=%p, .sync=%p, "
- ".read_size=%"PRIu32", .prog_size=%"PRIu32", "
- ".block_size=%"PRIu32", .block_count=%"PRIu32", "
- ".block_cycles=%"PRIu32", .cache_size=%"PRIu32", "
- ".lookahead_size=%"PRIu32", .read_buffer=%p, "
- ".prog_buffer=%p, .lookahead_buffer=%p, "
- ".name_max=%"PRIu32", .file_max=%"PRIu32", "
- ".attr_max=%"PRIu32"})",
- (void*)lfs, (void*)cfg, cfg->context,
- (void*)(uintptr_t)cfg->read, (void*)(uintptr_t)cfg->prog,
- (void*)(uintptr_t)cfg->erase, (void*)(uintptr_t)cfg->sync,
- cfg->read_size, cfg->prog_size, cfg->block_size, cfg->block_count,
- cfg->block_cycles, cfg->cache_size, cfg->lookahead_size,
- cfg->read_buffer, cfg->prog_buffer, cfg->lookahead_buffer,
- cfg->name_max, cfg->file_max, cfg->attr_max);
- err = lfs_rawmount(lfs, cfg);
- LFS_TRACE("lfs_mount -> %d", err);
- LFS_UNLOCK(cfg);
- return err;
- }
- int lfs_unmount(lfs_t *lfs) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_unmount(%p)", (void*)lfs);
- err = lfs_rawunmount(lfs);
- LFS_TRACE("lfs_unmount -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #ifndef LFS_READONLY
- int lfs_remove(lfs_t *lfs, const char *path) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_remove(%p, \"%s\")", (void*)lfs, path);
- err = lfs_rawremove(lfs, path);
- LFS_TRACE("lfs_remove -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- #ifndef LFS_READONLY
- int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_rename(%p, \"%s\", \"%s\")", (void*)lfs, oldpath, newpath);
- err = lfs_rawrename(lfs, oldpath, newpath);
- LFS_TRACE("lfs_rename -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_stat(%p, \"%s\", %p)", (void*)lfs, path, (void*)info);
- err = lfs_rawstat(lfs, path, info);
- LFS_TRACE("lfs_stat -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- lfs_ssize_t lfs_getattr(lfs_t *lfs, const char *path,
- uint8_t type, void *buffer, lfs_size_t size) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_getattr(%p, \"%s\", %"PRIu8", %p, %"PRIu32")",
- (void*)lfs, path, type, buffer, size);
- lfs_ssize_t res = lfs_rawgetattr(lfs, path, type, buffer, size);
- LFS_TRACE("lfs_getattr -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- #ifndef LFS_READONLY
- int lfs_setattr(lfs_t *lfs, const char *path,
- uint8_t type, const void *buffer, lfs_size_t size) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_setattr(%p, \"%s\", %"PRIu8", %p, %"PRIu32")",
- (void*)lfs, path, type, buffer, size);
- err = lfs_rawsetattr(lfs, path, type, buffer, size);
- LFS_TRACE("lfs_setattr -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- #ifndef LFS_READONLY
- int lfs_removeattr(lfs_t *lfs, const char *path, uint8_t type) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_removeattr(%p, \"%s\", %"PRIu8")", (void*)lfs, path, type);
- err = lfs_rawremoveattr(lfs, path, type);
- LFS_TRACE("lfs_removeattr -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- #ifndef LFS_NO_MALLOC
- int lfs_file_open(lfs_t *lfs, lfs_file_t *file, const char *path, int flags) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_open(%p, %p, \"%s\", %x)",
- (void*)lfs, (void*)file, path, flags);
- LFS_ASSERT(!lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- err = lfs_file_rawopen(lfs, file, path, flags);
- LFS_TRACE("lfs_file_open -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
- const char *path, int flags,
- const struct lfs_file_config *cfg) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_opencfg(%p, %p, \"%s\", %x, %p {"
- ".buffer=%p, .attrs=%p, .attr_count=%"PRIu32"})",
- (void*)lfs, (void*)file, path, flags,
- (void*)cfg, cfg->buffer, (void*)cfg->attrs, cfg->attr_count);
- LFS_ASSERT(!lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- err = lfs_file_rawopencfg(lfs, file, path, flags, cfg);
- LFS_TRACE("lfs_file_opencfg -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_close(%p, %p)", (void*)lfs, (void*)file);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- err = lfs_file_rawclose(lfs, file);
- LFS_TRACE("lfs_file_close -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #ifndef LFS_READONLY
- int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_sync(%p, %p)", (void*)lfs, (void*)file);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- err = lfs_file_rawsync(lfs, file);
- LFS_TRACE("lfs_file_sync -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
- void *buffer, lfs_size_t size) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_read(%p, %p, %p, %"PRIu32")",
- (void*)lfs, (void*)file, buffer, size);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- lfs_ssize_t res = lfs_file_rawread(lfs, file, buffer, size);
- LFS_TRACE("lfs_file_read -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- #ifndef LFS_READONLY
- lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
- const void *buffer, lfs_size_t size) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_write(%p, %p, %p, %"PRIu32")",
- (void*)lfs, (void*)file, buffer, size);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- lfs_ssize_t res = lfs_file_rawwrite(lfs, file, buffer, size);
- LFS_TRACE("lfs_file_write -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- #endif
- lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
- lfs_soff_t off, int whence) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_seek(%p, %p, %"PRId32", %d)",
- (void*)lfs, (void*)file, off, whence);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- lfs_soff_t res = lfs_file_rawseek(lfs, file, off, whence);
- LFS_TRACE("lfs_file_seek -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- #ifndef LFS_READONLY
- int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_truncate(%p, %p, %"PRIu32")",
- (void*)lfs, (void*)file, size);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- err = lfs_file_rawtruncate(lfs, file, size);
- LFS_TRACE("lfs_file_truncate -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_tell(%p, %p)", (void*)lfs, (void*)file);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- lfs_soff_t res = lfs_file_rawtell(lfs, file);
- LFS_TRACE("lfs_file_tell -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_rewind(%p, %p)", (void*)lfs, (void*)file);
- err = lfs_file_rawrewind(lfs, file);
- LFS_TRACE("lfs_file_rewind -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_file_size(%p, %p)", (void*)lfs, (void*)file);
- LFS_ASSERT(lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)file));
- lfs_soff_t res = lfs_file_rawsize(lfs, file);
- LFS_TRACE("lfs_file_size -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- #ifndef LFS_READONLY
- int lfs_mkdir(lfs_t *lfs, const char *path) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_mkdir(%p, \"%s\")", (void*)lfs, path);
- err = lfs_rawmkdir(lfs, path);
- LFS_TRACE("lfs_mkdir -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #endif
- int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_dir_open(%p, %p, \"%s\")", (void*)lfs, (void*)dir, path);
- LFS_ASSERT(!lfs_mlist_isopen(lfs->mlist, (struct lfs_mlist*)dir));
- err = lfs_dir_rawopen(lfs, dir, path);
- LFS_TRACE("lfs_dir_open -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_dir_close(%p, %p)", (void*)lfs, (void*)dir);
- err = lfs_dir_rawclose(lfs, dir);
- LFS_TRACE("lfs_dir_close -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_dir_read(%p, %p, %p)",
- (void*)lfs, (void*)dir, (void*)info);
- err = lfs_dir_rawread(lfs, dir, info);
- LFS_TRACE("lfs_dir_read -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_dir_seek(%p, %p, %"PRIu32")",
- (void*)lfs, (void*)dir, off);
- err = lfs_dir_rawseek(lfs, dir, off);
- LFS_TRACE("lfs_dir_seek -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_dir_tell(%p, %p)", (void*)lfs, (void*)dir);
- lfs_soff_t res = lfs_dir_rawtell(lfs, dir);
- LFS_TRACE("lfs_dir_tell -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_dir_rewind(%p, %p)", (void*)lfs, (void*)dir);
- err = lfs_dir_rawrewind(lfs, dir);
- LFS_TRACE("lfs_dir_rewind -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_fs_size(%p)", (void*)lfs);
- lfs_ssize_t res = lfs_fs_rawsize(lfs);
- LFS_TRACE("lfs_fs_size -> %"PRId32, res);
- LFS_UNLOCK(lfs->cfg);
- return res;
- }
- int lfs_fs_traverse(lfs_t *lfs, int (*cb)(void *, lfs_block_t), void *data) {
- int err = LFS_LOCK(lfs->cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_fs_traverse(%p, %p, %p)",
- (void*)lfs, (void*)(uintptr_t)cb, data);
- err = lfs_fs_rawtraverse(lfs, cb, data, true);
- LFS_TRACE("lfs_fs_traverse -> %d", err);
- LFS_UNLOCK(lfs->cfg);
- return err;
- }
- #ifdef LFS_MIGRATE
- int lfs_migrate(lfs_t *lfs, const struct lfs_config *cfg) {
- int err = LFS_LOCK(cfg);
- if (err) {
- return err;
- }
- LFS_TRACE("lfs_migrate(%p, %p {.context=%p, "
- ".read=%p, .prog=%p, .erase=%p, .sync=%p, "
- ".read_size=%"PRIu32", .prog_size=%"PRIu32", "
- ".block_size=%"PRIu32", .block_count=%"PRIu32", "
- ".block_cycles=%"PRIu32", .cache_size=%"PRIu32", "
- ".lookahead_size=%"PRIu32", .read_buffer=%p, "
- ".prog_buffer=%p, .lookahead_buffer=%p, "
- ".name_max=%"PRIu32", .file_max=%"PRIu32", "
- ".attr_max=%"PRIu32"})",
- (void*)lfs, (void*)cfg, cfg->context,
- (void*)(uintptr_t)cfg->read, (void*)(uintptr_t)cfg->prog,
- (void*)(uintptr_t)cfg->erase, (void*)(uintptr_t)cfg->sync,
- cfg->read_size, cfg->prog_size, cfg->block_size, cfg->block_count,
- cfg->block_cycles, cfg->cache_size, cfg->lookahead_size,
- cfg->read_buffer, cfg->prog_buffer, cfg->lookahead_buffer,
- cfg->name_max, cfg->file_max, cfg->attr_max);
- err = lfs_rawmigrate(lfs, cfg);
- LFS_TRACE("lfs_migrate -> %d", err);
- LFS_UNLOCK(cfg);
- return err;
- }
- #endif
|