lfs.c 129 KB

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