lfs.c 157 KB

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