lfs.c 129 KB

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