lfs.c 157 KB

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