lfs.c 149 KB

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