lfs.c 147 KB

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