lfs.c 128 KB

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