lfs.c 152 KB

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