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