lfs.c 143 KB

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