lfs.c 143 KB

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