lfs.c 157 KB

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