lfs.c 174 KB

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