lfs.c 187 KB

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