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