lfs.c 143 KB

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