lfs.c 163 KB

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