lfs.c 149 KB

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