lfs.c 170 KB

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