lfs.c 148 KB

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