lfs.c 145 KB

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