lfs.c 144 KB

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