lfs.c 148 KB

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