lfs.c 170 KB

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