lfs.c 149 KB

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