lfs.c 152 KB

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