lfs.c 149 KB

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