lfs.c 186 KB

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