lfs.c 142 KB

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