lfs.c 156 KB

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