lfs.c 193 KB

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