lfs.c 175 KB

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