lfs.c 144 KB

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