lfs.c 147 KB

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