lfs.c 130 KB

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