lfs.c 158 KB

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