lfs.c 159 KB

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