lfs.c 147 KB

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