lfs.c 148 KB

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