lfs.c 111 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800
  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. /// Block allocator ///
  369. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  370. lfs_t *lfs = (lfs_t*)p;
  371. lfs_block_t off = ((block - lfs->free.off)
  372. + lfs->cfg->block_count) % lfs->cfg->block_count;
  373. if (off < lfs->free.size) {
  374. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  375. }
  376. return 0;
  377. }
  378. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  379. while (true) {
  380. while (lfs->free.i != lfs->free.size) {
  381. lfs_block_t off = lfs->free.i;
  382. lfs->free.i += 1;
  383. lfs->free.ack -= 1;
  384. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  385. // found a free block
  386. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  387. // eagerly find next off so an alloc ack can
  388. // discredit old lookahead blocks
  389. while (lfs->free.i != lfs->free.size &&
  390. (lfs->free.buffer[lfs->free.i / 32]
  391. & (1U << (lfs->free.i % 32)))) {
  392. lfs->free.i += 1;
  393. lfs->free.ack -= 1;
  394. }
  395. return 0;
  396. }
  397. }
  398. // check if we have looked at all blocks since last ack
  399. if (lfs->free.ack == 0) {
  400. LFS_WARN("No more free space %"PRIu32,
  401. lfs->free.i + lfs->free.off);
  402. return LFS_ERR_NOSPC;
  403. }
  404. lfs->free.off = (lfs->free.off + lfs->free.size)
  405. % lfs->cfg->block_count;
  406. lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size, lfs->free.ack);
  407. lfs->free.i = 0;
  408. // find mask of free blocks from tree
  409. memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
  410. int err = lfs_fs_traverse(lfs, lfs_alloc_lookahead, lfs);
  411. if (err) {
  412. return err;
  413. }
  414. }
  415. }
  416. static void lfs_alloc_ack(lfs_t *lfs) {
  417. lfs->free.ack = lfs->cfg->block_count;
  418. }
  419. /// Metadata pair and directory operations ///
  420. static lfs_stag_t lfs_dir_getslice(lfs_t *lfs, const lfs_mdir_t *dir,
  421. lfs_tag_t gmask, lfs_tag_t gtag,
  422. lfs_off_t goff, void *gbuffer, lfs_size_t gsize) {
  423. lfs_off_t off = dir->off;
  424. lfs_tag_t ntag = dir->etag;
  425. lfs_stag_t gdiff = 0;
  426. if (lfs_gstate_hasmovehere(&lfs->gstate, dir->pair) &&
  427. lfs_tag_id(gtag) <= lfs_tag_id(lfs->gstate.tag)) {
  428. // synthetic moves
  429. gdiff -= LFS_MKTAG(0, 1, 0);
  430. }
  431. // iterate over dir block backwards (for faster lookups)
  432. while (off >= sizeof(lfs_tag_t) + lfs_tag_dsize(ntag)) {
  433. off -= lfs_tag_dsize(ntag);
  434. lfs_tag_t tag = ntag;
  435. int err = lfs_bd_read(lfs,
  436. NULL, &lfs->rcache, sizeof(ntag),
  437. dir->pair[0], off, &ntag, sizeof(ntag));
  438. if (err) {
  439. return err;
  440. }
  441. ntag = (lfs_frombe32(ntag) ^ tag) & 0x7fffffff;
  442. if (lfs_tag_id(gmask) != 0 &&
  443. lfs_tag_type1(tag) == LFS_TYPE_SPLICE &&
  444. lfs_tag_id(tag) <= lfs_tag_id(gtag - gdiff)) {
  445. if (tag == (LFS_MKTAG(LFS_TYPE_CREATE, 0, 0) |
  446. (LFS_MKTAG(0, 0x3ff, 0) & (gtag - gdiff)))) {
  447. // found where we were created
  448. return LFS_ERR_NOENT;
  449. }
  450. // move around splices
  451. gdiff += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
  452. }
  453. if ((gmask & tag) == (gmask & (gtag - gdiff))) {
  454. if (lfs_tag_isdelete(tag)) {
  455. return LFS_ERR_NOENT;
  456. }
  457. lfs_size_t diff = lfs_min(lfs_tag_size(tag), gsize);
  458. err = lfs_bd_read(lfs,
  459. NULL, &lfs->rcache, diff,
  460. dir->pair[0], off+sizeof(tag)+goff, gbuffer, diff);
  461. if (err) {
  462. return err;
  463. }
  464. memset((uint8_t*)gbuffer + diff, 0, gsize - diff);
  465. return tag + gdiff;
  466. }
  467. }
  468. return LFS_ERR_NOENT;
  469. }
  470. static lfs_stag_t lfs_dir_get(lfs_t *lfs, const lfs_mdir_t *dir,
  471. lfs_tag_t gmask, lfs_tag_t gtag, void *buffer) {
  472. return lfs_dir_getslice(lfs, dir,
  473. gmask, gtag,
  474. 0, buffer, lfs_tag_size(gtag));
  475. }
  476. static int lfs_dir_getread(lfs_t *lfs, const lfs_mdir_t *dir,
  477. const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
  478. lfs_tag_t gmask, lfs_tag_t gtag,
  479. lfs_off_t off, void *buffer, lfs_size_t size) {
  480. uint8_t *data = buffer;
  481. if (off+size > lfs->cfg->block_size) {
  482. return LFS_ERR_CORRUPT;
  483. }
  484. while (size > 0) {
  485. lfs_size_t diff = size;
  486. if (pcache && pcache->block == 0xfffffffe &&
  487. off < pcache->off + pcache->size) {
  488. if (off >= pcache->off) {
  489. // is already in pcache?
  490. diff = lfs_min(diff, pcache->size - (off-pcache->off));
  491. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  492. data += diff;
  493. off += diff;
  494. size -= diff;
  495. continue;
  496. }
  497. // pcache takes priority
  498. diff = lfs_min(diff, pcache->off-off);
  499. }
  500. if (rcache->block == 0xfffffffe &&
  501. off < rcache->off + rcache->size) {
  502. if (off >= rcache->off) {
  503. // is already in rcache?
  504. diff = lfs_min(diff, rcache->size - (off-rcache->off));
  505. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  506. data += diff;
  507. off += diff;
  508. size -= diff;
  509. continue;
  510. }
  511. // rcache takes priority
  512. diff = lfs_min(diff, rcache->off-off);
  513. }
  514. // load to cache, first condition can no longer fail
  515. rcache->block = 0xfffffffe;
  516. rcache->off = lfs_aligndown(off, lfs->cfg->read_size);
  517. rcache->size = lfs_min(lfs_alignup(off+hint, lfs->cfg->read_size),
  518. lfs->cfg->cache_size);
  519. int err = lfs_dir_getslice(lfs, dir, gmask, gtag,
  520. rcache->off, rcache->buffer, rcache->size);
  521. if (err) {
  522. return err;
  523. }
  524. }
  525. return 0;
  526. }
  527. static int lfs_dir_traverse_filter(void *p,
  528. lfs_tag_t tag, const void *buffer) {
  529. lfs_tag_t *filtertag = p;
  530. (void)buffer;
  531. // check for redundancy
  532. uint32_t mask = LFS_MKTAG(0x7ff, 0x3ff, 0);
  533. if ((mask & tag) == (mask & *filtertag) ||
  534. (mask & tag) == (LFS_MKTAG(LFS_TYPE_DELETE, 0, 0) |
  535. (LFS_MKTAG(0, 0x3ff, 0) & *filtertag))) {
  536. return true;
  537. }
  538. // check if we need to adjust for created/deleted tags
  539. if (lfs_tag_type1(tag) == LFS_TYPE_SPLICE &&
  540. lfs_tag_id(tag) <= lfs_tag_id(*filtertag)) {
  541. *filtertag += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
  542. }
  543. return false;
  544. }
  545. static int lfs_dir_traverse(lfs_t *lfs,
  546. const lfs_mdir_t *dir, lfs_off_t off, lfs_tag_t ptag,
  547. const struct lfs_mattr *attrs, int attrcount, bool hasseenmove,
  548. lfs_tag_t tmask, lfs_tag_t ttag,
  549. uint16_t begin, uint16_t end, int16_t diff,
  550. int (*cb)(void *data, lfs_tag_t tag, const void *buffer), void *data) {
  551. // iterate over directory and attrs
  552. while (true) {
  553. lfs_tag_t tag;
  554. const void *buffer;
  555. struct lfs_diskoff disk;
  556. if (off+lfs_tag_dsize(ptag) < dir->off) {
  557. off += lfs_tag_dsize(ptag);
  558. int err = lfs_bd_read(lfs,
  559. NULL, &lfs->rcache, sizeof(tag),
  560. dir->pair[0], off, &tag, sizeof(tag));
  561. if (err) {
  562. return err;
  563. }
  564. tag = (lfs_frombe32(tag) ^ ptag) | 0x80000000;
  565. disk.block = dir->pair[0];
  566. disk.off = off+sizeof(lfs_tag_t);
  567. buffer = &disk;
  568. ptag = tag;
  569. } else if (attrcount > 0) {
  570. tag = attrs[0].tag;
  571. buffer = attrs[0].buffer;
  572. attrs += 1;
  573. attrcount -= 1;
  574. } else if (!hasseenmove &&
  575. lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  576. // Wait, we have pending move? Handle this here (we need to
  577. // or else we risk letting moves fall out of date)
  578. tag = lfs->gpending.tag & LFS_MKTAG(0x7ff, 0x3ff, 0);
  579. buffer = NULL;
  580. hasseenmove = true;
  581. } else {
  582. return 0;
  583. }
  584. lfs_tag_t mask = LFS_MKTAG(0x7ff, 0, 0);
  585. if ((mask & tmask & tag) != (mask & tmask & ttag)) {
  586. continue;
  587. }
  588. // do we need to filter? inlining the filtering logic here allows
  589. // for some minor optimizations
  590. if (lfs_tag_id(tmask) != 0) {
  591. // scan for duplicates and update tag based on creates/deletes
  592. int filter = lfs_dir_traverse(lfs,
  593. dir, off, ptag, attrs, attrcount, hasseenmove,
  594. 0, 0, 0, 0, 0,
  595. lfs_dir_traverse_filter, &tag);
  596. if (filter < 0) {
  597. return filter;
  598. }
  599. if (filter) {
  600. continue;
  601. }
  602. // in filter range?
  603. if (!(lfs_tag_id(tag) >= begin && lfs_tag_id(tag) < end)) {
  604. continue;
  605. }
  606. }
  607. // handle special cases for mcu-side operations
  608. if (lfs_tag_type3(tag) == LFS_FROM_NOOP) {
  609. // do nothing
  610. } else if (lfs_tag_type3(tag) == LFS_FROM_MOVE) {
  611. uint16_t fromid = lfs_tag_size(tag);
  612. uint16_t toid = lfs_tag_id(tag);
  613. int err = lfs_dir_traverse(lfs,
  614. buffer, 0, 0xffffffff, NULL, 0, true,
  615. LFS_MKTAG(0x600, 0x3ff, 0),
  616. LFS_MKTAG(LFS_TYPE_STRUCT, 0, 0),
  617. fromid, fromid+1, toid-fromid+diff,
  618. cb, data);
  619. if (err) {
  620. return err;
  621. }
  622. } else if (lfs_tag_type3(tag) == LFS_FROM_USERATTRS) {
  623. for (unsigned i = 0; i < lfs_tag_size(tag); i++) {
  624. const struct lfs_attr *a = buffer;
  625. int err = cb(data, LFS_MKTAG(LFS_TYPE_USERATTR + a[i].type,
  626. lfs_tag_id(tag) + diff, a[i].size), a[i].buffer);
  627. if (err) {
  628. return err;
  629. }
  630. }
  631. } else {
  632. int err = cb(data, tag + LFS_MKTAG(0, diff, 0), buffer);
  633. if (err) {
  634. return err;
  635. }
  636. }
  637. }
  638. }
  639. static lfs_stag_t lfs_dir_fetchmatch(lfs_t *lfs,
  640. lfs_mdir_t *dir, const lfs_block_t pair[2],
  641. lfs_tag_t fmask, lfs_tag_t ftag, uint16_t *id,
  642. int (*cb)(void *data, lfs_tag_t tag, const void *buffer), void *data) {
  643. // we can find tag very efficiently during a fetch, since we're already
  644. // scanning the entire directory
  645. lfs_stag_t besttag = -1;
  646. // find the block with the most recent revision
  647. uint32_t revs[2] = {0, 0};
  648. int r = 0;
  649. for (int i = 0; i < 2; i++) {
  650. int err = lfs_bd_read(lfs,
  651. NULL, &lfs->rcache, sizeof(revs[i]),
  652. pair[i], 0, &revs[i], sizeof(revs[i]));
  653. revs[i] = lfs_fromle32(revs[i]);
  654. if (err && err != LFS_ERR_CORRUPT) {
  655. return err;
  656. }
  657. if (err != LFS_ERR_CORRUPT &&
  658. lfs_scmp(revs[i], revs[(i+1)%2]) > 0) {
  659. r = i;
  660. }
  661. }
  662. dir->pair[0] = pair[(r+0)%2];
  663. dir->pair[1] = pair[(r+1)%2];
  664. dir->rev = revs[(r+0)%2];
  665. dir->off = 0; // nonzero = found some commits
  666. // now scan tags to fetch the actual dir and find possible match
  667. for (int i = 0; i < 2; i++) {
  668. lfs_off_t off = 0;
  669. lfs_tag_t ptag = 0xffffffff;
  670. uint16_t tempcount = 0;
  671. lfs_block_t temptail[2] = {0xffffffff, 0xffffffff};
  672. bool tempsplit = false;
  673. lfs_stag_t tempbesttag = besttag;
  674. dir->rev = lfs_tole32(dir->rev);
  675. uint32_t crc = lfs_crc(0xffffffff, &dir->rev, sizeof(dir->rev));
  676. dir->rev = lfs_fromle32(dir->rev);
  677. while (true) {
  678. // extract next tag
  679. lfs_tag_t tag;
  680. off += lfs_tag_dsize(ptag);
  681. int err = lfs_bd_read(lfs,
  682. NULL, &lfs->rcache, lfs->cfg->block_size,
  683. dir->pair[0], off, &tag, sizeof(tag));
  684. if (err) {
  685. if (err == LFS_ERR_CORRUPT) {
  686. // can't continue?
  687. dir->erased = false;
  688. break;
  689. }
  690. return err;
  691. }
  692. crc = lfs_crc(crc, &tag, sizeof(tag));
  693. tag = lfs_frombe32(tag) ^ ptag;
  694. // next commit not yet programmed or we're not in valid range
  695. if (!lfs_tag_isvalid(tag) ||
  696. off + lfs_tag_dsize(tag) > lfs->cfg->block_size) {
  697. dir->erased = (lfs_tag_type1(ptag) == LFS_TYPE_CRC);
  698. break;
  699. }
  700. ptag = tag;
  701. if (lfs_tag_type1(tag) == LFS_TYPE_CRC) {
  702. // check the crc attr
  703. uint32_t dcrc;
  704. err = lfs_bd_read(lfs,
  705. NULL, &lfs->rcache, lfs->cfg->block_size,
  706. dir->pair[0], off+sizeof(tag), &dcrc, sizeof(dcrc));
  707. if (err) {
  708. if (err == LFS_ERR_CORRUPT) {
  709. dir->erased = false;
  710. break;
  711. }
  712. return err;
  713. }
  714. dcrc = lfs_fromle32(dcrc);
  715. if (crc != dcrc) {
  716. dir->erased = false;
  717. break;
  718. }
  719. // reset the next bit if we need to
  720. ptag ^= (lfs_tag_chunk(tag) & 1) << 31;
  721. // toss our crc into the filesystem seed for
  722. // pseudorandom numbers
  723. lfs->seed ^= crc;
  724. // update with what's found so far
  725. besttag = tempbesttag;
  726. dir->off = off + lfs_tag_dsize(tag);
  727. dir->etag = ptag;
  728. dir->count = tempcount;
  729. dir->tail[0] = temptail[0];
  730. dir->tail[1] = temptail[1];
  731. dir->split = tempsplit;
  732. // reset crc
  733. crc = 0xffffffff;
  734. continue;
  735. }
  736. // crc the entry first, hopefully leaving it in the cache
  737. for (lfs_off_t j = sizeof(tag); j < lfs_tag_dsize(tag); j++) {
  738. uint8_t dat;
  739. err = lfs_bd_read(lfs,
  740. NULL, &lfs->rcache, lfs->cfg->block_size,
  741. dir->pair[0], off+j, &dat, 1);
  742. if (err) {
  743. if (err == LFS_ERR_CORRUPT) {
  744. dir->erased = false;
  745. break;
  746. }
  747. return err;
  748. }
  749. crc = lfs_crc(crc, &dat, 1);
  750. }
  751. // directory modification tags?
  752. if (lfs_tag_type1(tag) == LFS_TYPE_NAME) {
  753. // increase count of files if necessary
  754. if (lfs_tag_id(tag) >= tempcount) {
  755. tempcount = lfs_tag_id(tag) + 1;
  756. }
  757. } else if (lfs_tag_type1(tag) == LFS_TYPE_SPLICE) {
  758. tempcount += lfs_tag_splice(tag);
  759. if (tag == (LFS_MKTAG(LFS_TYPE_DELETE, 0, 0) |
  760. (LFS_MKTAG(0, 0x3ff, 0) & tempbesttag))) {
  761. tempbesttag |= 0x80000000;
  762. } else if (tempbesttag != -1 &&
  763. lfs_tag_id(tag) <= lfs_tag_id(tempbesttag)) {
  764. tempbesttag += LFS_MKTAG(0, lfs_tag_splice(tag), 0);
  765. }
  766. } else if (lfs_tag_type1(tag) == LFS_TYPE_TAIL) {
  767. tempsplit = (lfs_tag_chunk(tag) & 1);
  768. err = lfs_bd_read(lfs,
  769. NULL, &lfs->rcache, lfs->cfg->block_size,
  770. dir->pair[0], off+sizeof(tag), &temptail, 8);
  771. if (err) {
  772. if (err == LFS_ERR_CORRUPT) {
  773. dir->erased = false;
  774. break;
  775. }
  776. }
  777. lfs_pair_fromle32(temptail);
  778. }
  779. // found a match for our fetcher?
  780. if ((fmask & tag) == (fmask & ftag)) {
  781. int res = cb(data, tag, &(struct lfs_diskoff){
  782. dir->pair[0], off+sizeof(tag)});
  783. if (res < 0) {
  784. if (res == LFS_ERR_CORRUPT) {
  785. dir->erased = false;
  786. break;
  787. }
  788. return res;
  789. }
  790. if (res == LFS_CMP_EQ) {
  791. // found a match
  792. tempbesttag = tag;
  793. } else if (res == LFS_CMP_GT &&
  794. lfs_tag_id(tag) <= lfs_tag_id(tempbesttag)) {
  795. // found a greater match, keep track to keep things sorted
  796. tempbesttag = tag | 0x80000000;
  797. }
  798. }
  799. }
  800. // consider what we have good enough
  801. if (dir->off > 0) {
  802. // synthetic move
  803. if (lfs_gstate_hasmovehere(&lfs->gstate, dir->pair)) {
  804. if (lfs_tag_id(lfs->gstate.tag) == lfs_tag_id(besttag)) {
  805. besttag |= 0x80000000;
  806. } else if (besttag != -1 &&
  807. lfs_tag_id(lfs->gstate.tag) < lfs_tag_id(besttag)) {
  808. besttag -= LFS_MKTAG(0, 1, 0);
  809. }
  810. }
  811. // found tag? or found best id?
  812. if (id) {
  813. *id = lfs_min(lfs_tag_id(besttag), dir->count);
  814. }
  815. if (lfs_tag_isvalid(besttag)) {
  816. return besttag;
  817. } else if (lfs_tag_id(besttag) < dir->count) {
  818. return LFS_ERR_NOENT;
  819. } else {
  820. return 0;
  821. }
  822. }
  823. // failed, try the other block?
  824. lfs_pair_swap(dir->pair);
  825. dir->rev = revs[(r+1)%2];
  826. }
  827. LFS_ERROR("Corrupted dir pair at %"PRIu32" %"PRIu32,
  828. dir->pair[0], dir->pair[1]);
  829. return LFS_ERR_CORRUPT;
  830. }
  831. static int lfs_dir_fetch(lfs_t *lfs,
  832. lfs_mdir_t *dir, const lfs_block_t pair[2]) {
  833. // note, mask=-1, tag=0 can never match a tag since this
  834. // pattern has the invalid bit set
  835. return lfs_dir_fetchmatch(lfs, dir, pair, -1, 0, NULL, NULL, NULL);
  836. }
  837. static int lfs_dir_getgstate(lfs_t *lfs, const lfs_mdir_t *dir,
  838. struct lfs_gstate *gstate) {
  839. struct lfs_gstate temp;
  840. lfs_stag_t res = lfs_dir_get(lfs, dir, LFS_MKTAG(0x7ff, 0, 0),
  841. LFS_MKTAG(LFS_TYPE_MOVESTATE, 0, sizeof(temp)), &temp);
  842. if (res < 0 && res != LFS_ERR_NOENT) {
  843. return res;
  844. }
  845. if (res != LFS_ERR_NOENT) {
  846. // xor together to find resulting gstate
  847. lfs_gstate_fromle32(&temp);
  848. lfs_gstate_xor(gstate, &temp);
  849. }
  850. return 0;
  851. }
  852. static int lfs_dir_getinfo(lfs_t *lfs, lfs_mdir_t *dir,
  853. uint16_t id, struct lfs_info *info) {
  854. if (id == 0x3ff) {
  855. // special case for root
  856. strcpy(info->name, "/");
  857. info->type = LFS_TYPE_DIR;
  858. return 0;
  859. }
  860. lfs_stag_t tag = lfs_dir_get(lfs, dir, LFS_MKTAG(0x780, 0x3ff, 0),
  861. LFS_MKTAG(LFS_TYPE_NAME, id, lfs->name_max+1), info->name);
  862. if (tag < 0) {
  863. return tag;
  864. }
  865. info->type = lfs_tag_type3(tag);
  866. struct lfs_ctz ctz;
  867. tag = lfs_dir_get(lfs, dir, LFS_MKTAG(0x700, 0x3ff, 0),
  868. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  869. if (tag < 0) {
  870. return tag;
  871. }
  872. lfs_ctz_fromle32(&ctz);
  873. if (lfs_tag_type3(tag) == LFS_TYPE_CTZSTRUCT) {
  874. info->size = ctz.size;
  875. } else if (lfs_tag_type3(tag) == LFS_TYPE_INLINESTRUCT) {
  876. info->size = lfs_tag_size(tag);
  877. }
  878. return 0;
  879. }
  880. struct lfs_dir_find_match {
  881. lfs_t *lfs;
  882. const void *name;
  883. lfs_size_t size;
  884. };
  885. static int lfs_dir_find_match(void *data,
  886. lfs_tag_t tag, const void *buffer) {
  887. struct lfs_dir_find_match *name = data;
  888. lfs_t *lfs = name->lfs;
  889. const struct lfs_diskoff *disk = buffer;
  890. // compare with disk
  891. lfs_size_t diff = lfs_min(name->size, lfs_tag_size(tag));
  892. int res = lfs_bd_cmp(lfs,
  893. NULL, &lfs->rcache, diff,
  894. disk->block, disk->off, name->name, diff);
  895. if (res != LFS_CMP_EQ) {
  896. return res;
  897. }
  898. // only equal if our size is still the same
  899. if (name->size != lfs_tag_size(tag)) {
  900. return (name->size < lfs_tag_size(tag)) ? LFS_CMP_LT : LFS_CMP_GT;
  901. }
  902. // found a match!
  903. return LFS_CMP_EQ;
  904. }
  905. static int lfs_dir_find(lfs_t *lfs, lfs_mdir_t *dir,
  906. const char **path, uint16_t *id) {
  907. // we reduce path to a single name if we can find it
  908. const char *name = *path;
  909. if (id) {
  910. *id = 0x3ff;
  911. }
  912. // default to root dir
  913. lfs_stag_t tag = LFS_MKTAG(LFS_TYPE_DIR, 0x3ff, 0);
  914. dir->tail[0] = lfs->root[0];
  915. dir->tail[1] = lfs->root[1];
  916. while (true) {
  917. nextname:
  918. // skip slashes
  919. name += strspn(name, "/");
  920. lfs_size_t namelen = strcspn(name, "/");
  921. // skip '.' and root '..'
  922. if ((namelen == 1 && memcmp(name, ".", 1) == 0) ||
  923. (namelen == 2 && memcmp(name, "..", 2) == 0)) {
  924. name += namelen;
  925. goto nextname;
  926. }
  927. // skip if matched by '..' in name
  928. const char *suffix = name + namelen;
  929. lfs_size_t sufflen;
  930. int depth = 1;
  931. while (true) {
  932. suffix += strspn(suffix, "/");
  933. sufflen = strcspn(suffix, "/");
  934. if (sufflen == 0) {
  935. break;
  936. }
  937. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  938. depth -= 1;
  939. if (depth == 0) {
  940. name = suffix + sufflen;
  941. goto nextname;
  942. }
  943. } else {
  944. depth += 1;
  945. }
  946. suffix += sufflen;
  947. }
  948. // found path
  949. if (name[0] == '\0') {
  950. return tag;
  951. }
  952. // update what we've found so far
  953. *path = name;
  954. // only continue if we hit a directory
  955. if (lfs_tag_type3(tag) != LFS_TYPE_DIR) {
  956. return LFS_ERR_NOTDIR;
  957. }
  958. // grab the entry data
  959. if (lfs_tag_id(tag) != 0x3ff) {
  960. lfs_stag_t res = lfs_dir_get(lfs, dir, LFS_MKTAG(0x700, 0x3ff, 0),
  961. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), dir->tail);
  962. if (res < 0) {
  963. return res;
  964. }
  965. lfs_pair_fromle32(dir->tail);
  966. }
  967. // find entry matching name
  968. while (true) {
  969. tag = lfs_dir_fetchmatch(lfs, dir, dir->tail,
  970. LFS_MKTAG(0x780, 0, 0),
  971. LFS_MKTAG(LFS_TYPE_NAME, 0, namelen),
  972. // are we last name?
  973. (strchr(name, '/') == NULL) ? id : NULL,
  974. lfs_dir_find_match, &(struct lfs_dir_find_match){
  975. lfs, name, namelen});
  976. if (tag < 0) {
  977. return tag;
  978. }
  979. if (tag) {
  980. break;
  981. }
  982. if (!dir->split) {
  983. return LFS_ERR_NOENT;
  984. }
  985. }
  986. // to next name
  987. name += namelen;
  988. }
  989. }
  990. // commit logic
  991. struct lfs_commit {
  992. lfs_block_t block;
  993. lfs_off_t off;
  994. lfs_tag_t ptag;
  995. uint32_t crc;
  996. lfs_off_t begin;
  997. lfs_off_t end;
  998. };
  999. static int lfs_dir_commitprog(lfs_t *lfs, struct lfs_commit *commit,
  1000. const void *buffer, lfs_size_t size) {
  1001. int err = lfs_bd_prog(lfs,
  1002. &lfs->pcache, &lfs->rcache, false,
  1003. commit->block, commit->off ,
  1004. (const uint8_t*)buffer, size);
  1005. if (err) {
  1006. return err;
  1007. }
  1008. commit->crc = lfs_crc(commit->crc, buffer, size);
  1009. commit->off += size;
  1010. return 0;
  1011. }
  1012. static int lfs_dir_commitattr(lfs_t *lfs, struct lfs_commit *commit,
  1013. lfs_tag_t tag, const void *buffer) {
  1014. // check if we fit
  1015. lfs_size_t dsize = lfs_tag_dsize(tag);
  1016. if (commit->off + dsize > commit->end) {
  1017. return LFS_ERR_NOSPC;
  1018. }
  1019. // write out tag
  1020. lfs_tag_t ntag = lfs_tobe32((tag & 0x7fffffff) ^ commit->ptag);
  1021. int err = lfs_dir_commitprog(lfs, commit, &ntag, sizeof(ntag));
  1022. if (err) {
  1023. return err;
  1024. }
  1025. if (!(tag & 0x80000000)) {
  1026. // from memory
  1027. err = lfs_dir_commitprog(lfs, commit, buffer, dsize-sizeof(tag));
  1028. if (err) {
  1029. return err;
  1030. }
  1031. } else {
  1032. // from disk
  1033. const struct lfs_diskoff *disk = buffer;
  1034. for (lfs_off_t i = 0; i < dsize-sizeof(tag); i++) {
  1035. // rely on caching to make this efficient
  1036. uint8_t dat;
  1037. err = lfs_bd_read(lfs,
  1038. NULL, &lfs->rcache, dsize-sizeof(tag)-i,
  1039. disk->block, disk->off+i, &dat, 1);
  1040. if (err) {
  1041. return err;
  1042. }
  1043. err = lfs_dir_commitprog(lfs, commit, &dat, 1);
  1044. if (err) {
  1045. return err;
  1046. }
  1047. }
  1048. }
  1049. commit->ptag = tag & 0x7fffffff;
  1050. return 0;
  1051. }
  1052. static int lfs_dir_commitcrc(lfs_t *lfs, struct lfs_commit *commit) {
  1053. // align to program units
  1054. lfs_off_t off = lfs_alignup(commit->off + 2*sizeof(uint32_t),
  1055. lfs->cfg->prog_size);
  1056. // read erased state from next program unit
  1057. lfs_tag_t tag;
  1058. int err = lfs_bd_read(lfs,
  1059. NULL, &lfs->rcache, sizeof(tag),
  1060. commit->block, off, &tag, sizeof(tag));
  1061. if (err && err != LFS_ERR_CORRUPT) {
  1062. return err;
  1063. }
  1064. // build crc tag
  1065. bool reset = ~lfs_frombe32(tag) >> 31;
  1066. tag = LFS_MKTAG(LFS_TYPE_CRC + reset, 0x3ff,
  1067. off - (commit->off+sizeof(lfs_tag_t)));
  1068. // write out crc
  1069. uint32_t footer[2];
  1070. footer[0] = lfs_tobe32(tag ^ commit->ptag);
  1071. commit->crc = lfs_crc(commit->crc, &footer[0], sizeof(footer[0]));
  1072. footer[1] = lfs_tole32(commit->crc);
  1073. err = lfs_bd_prog(lfs,
  1074. &lfs->pcache, &lfs->rcache, false,
  1075. commit->block, commit->off, &footer, sizeof(footer));
  1076. if (err) {
  1077. return err;
  1078. }
  1079. commit->off += sizeof(tag)+lfs_tag_size(tag);
  1080. commit->ptag = tag ^ (reset << 31);
  1081. // flush buffers
  1082. err = lfs_bd_sync(lfs, &lfs->pcache, &lfs->rcache, false);
  1083. if (err) {
  1084. return err;
  1085. }
  1086. // successful commit, check checksum to make sure
  1087. uint32_t crc = 0xffffffff;
  1088. lfs_size_t size = commit->off - lfs_tag_size(tag) - commit->begin;
  1089. for (lfs_off_t i = 0; i < size; i++) {
  1090. // leave it up to caching to make this efficient
  1091. uint8_t dat;
  1092. err = lfs_bd_read(lfs,
  1093. NULL, &lfs->rcache, size-i,
  1094. commit->block, commit->begin+i, &dat, 1);
  1095. if (err) {
  1096. return err;
  1097. }
  1098. crc = lfs_crc(crc, &dat, 1);
  1099. }
  1100. if (err) {
  1101. return err;
  1102. }
  1103. if (crc != commit->crc) {
  1104. return LFS_ERR_CORRUPT;
  1105. }
  1106. return 0;
  1107. }
  1108. static int lfs_dir_alloc(lfs_t *lfs, lfs_mdir_t *dir) {
  1109. // allocate pair of dir blocks (backwards, so we write block 1 first)
  1110. for (int i = 0; i < 2; i++) {
  1111. int err = lfs_alloc(lfs, &dir->pair[(i+1)%2]);
  1112. if (err) {
  1113. return err;
  1114. }
  1115. }
  1116. // rather than clobbering one of the blocks we just pretend
  1117. // the revision may be valid
  1118. int err = lfs_bd_read(lfs,
  1119. NULL, &lfs->rcache, sizeof(dir->rev),
  1120. dir->pair[0], 0, &dir->rev, sizeof(dir->rev));
  1121. dir->rev = lfs_fromle32(dir->rev);
  1122. if (err && err != LFS_ERR_CORRUPT) {
  1123. return err;
  1124. }
  1125. // make sure we don't immediately evict
  1126. dir->rev += dir->rev & 1;
  1127. // set defaults
  1128. dir->off = sizeof(dir->rev);
  1129. dir->etag = 0xffffffff;
  1130. dir->count = 0;
  1131. dir->tail[0] = 0xffffffff;
  1132. dir->tail[1] = 0xffffffff;
  1133. dir->erased = false;
  1134. dir->split = false;
  1135. // don't write out yet, let caller take care of that
  1136. return 0;
  1137. }
  1138. static int lfs_dir_drop(lfs_t *lfs, lfs_mdir_t *dir, lfs_mdir_t *tail) {
  1139. // steal state
  1140. int err = lfs_dir_getgstate(lfs, tail, &lfs->gdelta);
  1141. if (err) {
  1142. return err;
  1143. }
  1144. // steal tail
  1145. lfs_pair_tole32(tail->tail);
  1146. err = lfs_dir_commit(lfs, dir, LFS_MKATTRS(
  1147. {LFS_MKTAG(LFS_TYPE_TAIL + tail->split, 0x3ff, 8), tail->tail}));
  1148. lfs_pair_fromle32(tail->tail);
  1149. if (err) {
  1150. return err;
  1151. }
  1152. return 0;
  1153. }
  1154. static int lfs_dir_split(lfs_t *lfs,
  1155. lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
  1156. lfs_mdir_t *source, uint16_t split, uint16_t end) {
  1157. // create tail directory
  1158. lfs_mdir_t tail;
  1159. int err = lfs_dir_alloc(lfs, &tail);
  1160. if (err) {
  1161. return err;
  1162. }
  1163. tail.split = dir->split;
  1164. tail.tail[0] = dir->tail[0];
  1165. tail.tail[1] = dir->tail[1];
  1166. err = lfs_dir_compact(lfs, &tail, attrs, attrcount, source, split, end);
  1167. if (err) {
  1168. return err;
  1169. }
  1170. dir->tail[0] = tail.pair[0];
  1171. dir->tail[1] = tail.pair[1];
  1172. dir->split = true;
  1173. // update root if needed
  1174. if (lfs_pair_cmp(dir->pair, lfs->root) == 0 && split == 0) {
  1175. lfs->root[0] = tail.pair[0];
  1176. lfs->root[1] = tail.pair[1];
  1177. }
  1178. return 0;
  1179. }
  1180. static int lfs_dir_commit_size(void *p, lfs_tag_t tag, const void *buffer) {
  1181. lfs_size_t *size = p;
  1182. (void)buffer;
  1183. *size += lfs_tag_dsize(tag);
  1184. return 0;
  1185. }
  1186. struct lfs_dir_commit_commit {
  1187. lfs_t *lfs;
  1188. struct lfs_commit *commit;
  1189. };
  1190. static int lfs_dir_commit_commit(void *p, lfs_tag_t tag, const void *buffer) {
  1191. struct lfs_dir_commit_commit *commit = p;
  1192. return lfs_dir_commitattr(commit->lfs, commit->commit, tag, buffer);
  1193. }
  1194. static int lfs_dir_compact(lfs_t *lfs,
  1195. lfs_mdir_t *dir, const struct lfs_mattr *attrs, int attrcount,
  1196. lfs_mdir_t *source, uint16_t begin, uint16_t end) {
  1197. // save some state in case block is bad
  1198. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  1199. bool relocated = false;
  1200. bool exhausted = false;
  1201. // should we split?
  1202. while (end - begin > 1) {
  1203. // find size
  1204. lfs_size_t size = 0;
  1205. int err = lfs_dir_traverse(lfs,
  1206. source, 0, 0xffffffff, attrs, attrcount, false,
  1207. LFS_MKTAG(0x400, 0x3ff, 0),
  1208. LFS_MKTAG(LFS_TYPE_NAME, 0, 0),
  1209. begin, end, -begin,
  1210. lfs_dir_commit_size, &size);
  1211. if (err) {
  1212. return err;
  1213. }
  1214. // space is complicated, we need room for tail, crc, gstate,
  1215. // cleanup delete, and we cap at half a block to give room
  1216. // for metadata updates.
  1217. if (size <= lfs_min(lfs->cfg->block_size - 36,
  1218. lfs_alignup(lfs->cfg->block_size/2, lfs->cfg->prog_size))) {
  1219. break;
  1220. }
  1221. // can't fit, need to split, we should really be finding the
  1222. // largest size that fits with a small binary search, but right now
  1223. // it's not worth the code size
  1224. uint16_t split = (end - begin) / 2;
  1225. err = lfs_dir_split(lfs, dir, attrs, attrcount,
  1226. source, begin+split, end);
  1227. if (err) {
  1228. // if we fail to split, we may be able to overcompact, unless
  1229. // we're too big for even the full block, in which case our
  1230. // only option is to error
  1231. if (err == LFS_ERR_NOSPC && size <= lfs->cfg->block_size - 36) {
  1232. break;
  1233. }
  1234. return err;
  1235. }
  1236. end = begin + split;
  1237. }
  1238. // increment revision count
  1239. dir->rev += 1;
  1240. if (lfs->cfg->block_cycles &&
  1241. (dir->rev % (lfs->cfg->block_cycles+1) == 0)) {
  1242. if (lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) == 0) {
  1243. // oh no! we're writing too much to the superblock,
  1244. // should we expand?
  1245. lfs_ssize_t res = lfs_fs_size(lfs);
  1246. if (res < 0) {
  1247. return res;
  1248. }
  1249. // do we have extra space? littlefs can't reclaim this space
  1250. // by itself, so expand cautiously
  1251. if ((lfs_size_t)res < lfs->cfg->block_count/2) {
  1252. LFS_DEBUG("Expanding superblock at rev %"PRIu32, dir->rev);
  1253. int err = lfs_dir_split(lfs, dir, attrs, attrcount,
  1254. source, begin, end);
  1255. if (err && err != LFS_ERR_NOSPC) {
  1256. return err;
  1257. }
  1258. // welp, we tried, if we ran out of space there's not much
  1259. // we can do, we'll error later if we've become frozen
  1260. if (!err) {
  1261. end = begin;
  1262. }
  1263. }
  1264. } else {
  1265. // we're writing too much, time to relocate
  1266. exhausted = true;
  1267. goto relocate;
  1268. }
  1269. }
  1270. // begin loop to commit compaction to blocks until a compact sticks
  1271. while (true) {
  1272. if (true) {
  1273. // There's nothing special about our global delta, so feed it into
  1274. // our local global delta
  1275. int err = lfs_dir_getgstate(lfs, dir, &lfs->gdelta);
  1276. if (err) {
  1277. return err;
  1278. }
  1279. // setup commit state
  1280. struct lfs_commit commit = {
  1281. .block = dir->pair[1],
  1282. .off = 0,
  1283. .ptag = 0xffffffff,
  1284. .crc = 0xffffffff,
  1285. .begin = 0,
  1286. .end = lfs->cfg->block_size - 8,
  1287. };
  1288. // erase block to write to
  1289. err = lfs_bd_erase(lfs, dir->pair[1]);
  1290. if (err) {
  1291. if (err == LFS_ERR_CORRUPT) {
  1292. goto relocate;
  1293. }
  1294. return err;
  1295. }
  1296. // write out header
  1297. dir->rev = lfs_tole32(dir->rev);
  1298. err = lfs_dir_commitprog(lfs, &commit,
  1299. &dir->rev, sizeof(dir->rev));
  1300. dir->rev = lfs_fromle32(dir->rev);
  1301. if (err) {
  1302. if (err == LFS_ERR_CORRUPT) {
  1303. goto relocate;
  1304. }
  1305. return err;
  1306. }
  1307. // traverse the directory, this time writing out all unique tags
  1308. err = lfs_dir_traverse(lfs,
  1309. source, 0, 0xffffffff, attrs, attrcount, false,
  1310. LFS_MKTAG(0x400, 0x3ff, 0),
  1311. LFS_MKTAG(LFS_TYPE_NAME, 0, 0),
  1312. begin, end, -begin,
  1313. lfs_dir_commit_commit, &(struct lfs_dir_commit_commit){
  1314. lfs, &commit});
  1315. if (err) {
  1316. if (err == LFS_ERR_CORRUPT) {
  1317. goto relocate;
  1318. }
  1319. return err;
  1320. }
  1321. // commit tail, which may be new after last size check
  1322. if (!lfs_pair_isnull(dir->tail)) {
  1323. lfs_pair_tole32(dir->tail);
  1324. err = lfs_dir_commitattr(lfs, &commit,
  1325. LFS_MKTAG(LFS_TYPE_TAIL + dir->split, 0x3ff, 8),
  1326. dir->tail);
  1327. lfs_pair_fromle32(dir->tail);
  1328. if (err) {
  1329. if (err == LFS_ERR_CORRUPT) {
  1330. goto relocate;
  1331. }
  1332. return err;
  1333. }
  1334. }
  1335. if (!relocated && !lfs_gstate_iszero(&lfs->gdelta)) {
  1336. // commit any globals, unless we're relocating,
  1337. // in which case our parent will steal our globals
  1338. lfs_gstate_tole32(&lfs->gdelta);
  1339. err = lfs_dir_commitattr(lfs, &commit,
  1340. LFS_MKTAG(LFS_TYPE_MOVESTATE, 0x3ff,
  1341. sizeof(lfs->gdelta)), &lfs->gdelta);
  1342. lfs_gstate_fromle32(&lfs->gdelta);
  1343. if (err) {
  1344. if (err == LFS_ERR_CORRUPT) {
  1345. goto relocate;
  1346. }
  1347. return err;
  1348. }
  1349. }
  1350. err = lfs_dir_commitcrc(lfs, &commit);
  1351. if (err) {
  1352. if (err == LFS_ERR_CORRUPT) {
  1353. goto relocate;
  1354. }
  1355. return err;
  1356. }
  1357. // successful compaction, swap dir pair to indicate most recent
  1358. lfs_pair_swap(dir->pair);
  1359. dir->count = end - begin;
  1360. dir->off = commit.off;
  1361. dir->etag = commit.ptag;
  1362. dir->erased = true;
  1363. // note we able to have already handled move here
  1364. if (lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  1365. lfs_gstate_xormove(&lfs->gpending,
  1366. &lfs->gpending, 0x3ff, NULL);
  1367. }
  1368. }
  1369. break;
  1370. relocate:
  1371. // commit was corrupted, drop caches and prepare to relocate block
  1372. relocated = true;
  1373. lfs_cache_drop(lfs, &lfs->pcache);
  1374. if (!exhausted) {
  1375. LFS_DEBUG("Bad block at %"PRIu32, dir->pair[1]);
  1376. }
  1377. // can't relocate superblock, filesystem is now frozen
  1378. if (lfs_pair_cmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  1379. LFS_WARN("Superblock %"PRIu32" has become unwritable", oldpair[1]);
  1380. return LFS_ERR_NOSPC;
  1381. }
  1382. // relocate half of pair
  1383. int err = lfs_alloc(lfs, &dir->pair[1]);
  1384. if (err && (err != LFS_ERR_NOSPC && !exhausted)) {
  1385. return err;
  1386. }
  1387. continue;
  1388. }
  1389. if (!relocated) {
  1390. lfs->gstate = lfs->gpending;
  1391. lfs->gdelta = (struct lfs_gstate){0};
  1392. } else {
  1393. // update references if we relocated
  1394. LFS_DEBUG("Relocating %"PRIu32" %"PRIu32" to %"PRIu32" %"PRIu32,
  1395. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  1396. int err = lfs_fs_relocate(lfs, oldpair, dir->pair);
  1397. if (err) {
  1398. return err;
  1399. }
  1400. }
  1401. return 0;
  1402. }
  1403. static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
  1404. const struct lfs_mattr *attrs, int attrcount) {
  1405. // check for any inline files that aren't RAM backed and
  1406. // forcefully evict them, needed for filesystem consistency
  1407. for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
  1408. if (dir != &f->m && lfs_pair_cmp(f->m.pair, dir->pair) == 0 &&
  1409. f->type == LFS_TYPE_REG && (f->flags & LFS_F_INLINE) &&
  1410. f->ctz.size > lfs->cfg->cache_size) {
  1411. f->flags &= ~LFS_F_READING;
  1412. f->off = 0;
  1413. lfs_alloc_ack(lfs);
  1414. int err = lfs_file_relocate(lfs, f);
  1415. if (err) {
  1416. return err;
  1417. }
  1418. err = lfs_file_flush(lfs, f);
  1419. if (err) {
  1420. return err;
  1421. }
  1422. }
  1423. }
  1424. // calculate changes to the directory
  1425. lfs_tag_t deletetag = 0xffffffff;
  1426. lfs_tag_t createtag = 0xffffffff;
  1427. for (int i = 0; i < attrcount; i++) {
  1428. if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_CREATE) {
  1429. createtag = attrs[i].tag;
  1430. dir->count += 1;
  1431. } else if (lfs_tag_type3(attrs[i].tag) == LFS_TYPE_DELETE) {
  1432. deletetag = attrs[i].tag;
  1433. LFS_ASSERT(dir->count > 0);
  1434. dir->count -= 1;
  1435. } else if (lfs_tag_type1(attrs[i].tag) == LFS_TYPE_TAIL) {
  1436. dir->tail[0] = ((lfs_block_t*)attrs[i].buffer)[0];
  1437. dir->tail[1] = ((lfs_block_t*)attrs[i].buffer)[1];
  1438. dir->split = (lfs_tag_chunk(attrs[i].tag) & 1);
  1439. lfs_pair_fromle32(dir->tail);
  1440. }
  1441. }
  1442. // do we have a pending move?
  1443. if (lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  1444. deletetag = lfs->gpending.tag & LFS_MKTAG(0x7ff, 0x3ff, 0);
  1445. LFS_ASSERT(dir->count > 0);
  1446. dir->count -= 1;
  1447. // mark gdelta so we reflect the move we will fix
  1448. lfs_gstate_xormove(&lfs->gdelta, &lfs->gpending, 0x3ff, NULL);
  1449. }
  1450. // should we actually drop the directory block?
  1451. if (lfs_tag_isvalid(deletetag) && dir->count == 0) {
  1452. lfs_mdir_t pdir;
  1453. int err = lfs_fs_pred(lfs, dir->pair, &pdir);
  1454. if (err && err != LFS_ERR_NOENT) {
  1455. return err;
  1456. }
  1457. if (err != LFS_ERR_NOENT && pdir.split) {
  1458. return lfs_dir_drop(lfs, &pdir, dir);
  1459. }
  1460. }
  1461. if (dir->erased) {
  1462. // try to commit
  1463. struct lfs_commit commit = {
  1464. .block = dir->pair[0],
  1465. .off = dir->off,
  1466. .ptag = dir->etag,
  1467. .crc = 0xffffffff,
  1468. .begin = dir->off,
  1469. .end = lfs->cfg->block_size - 8,
  1470. };
  1471. // traverse attrs that need to be written out
  1472. lfs_pair_tole32(dir->tail);
  1473. int err = lfs_dir_traverse(lfs,
  1474. dir, dir->off, dir->etag, attrs, attrcount, false,
  1475. 0, 0, 0, 0, 0,
  1476. lfs_dir_commit_commit, &(struct lfs_dir_commit_commit){
  1477. lfs, &commit});
  1478. lfs_pair_fromle32(dir->tail);
  1479. if (err) {
  1480. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1481. goto compact;
  1482. }
  1483. return err;
  1484. }
  1485. // commit any global diffs if we have any
  1486. if (!lfs_gstate_iszero(&lfs->gdelta)) {
  1487. err = lfs_dir_getgstate(lfs, dir, &lfs->gdelta);
  1488. if (err) {
  1489. return err;
  1490. }
  1491. lfs_gstate_tole32(&lfs->gdelta);
  1492. err = lfs_dir_commitattr(lfs, &commit,
  1493. LFS_MKTAG(LFS_TYPE_MOVESTATE, 0x3ff,
  1494. sizeof(lfs->gdelta)), &lfs->gdelta);
  1495. lfs_gstate_fromle32(&lfs->gdelta);
  1496. if (err) {
  1497. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1498. goto compact;
  1499. }
  1500. return err;
  1501. }
  1502. }
  1503. // finalize commit with the crc
  1504. err = lfs_dir_commitcrc(lfs, &commit);
  1505. if (err) {
  1506. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1507. goto compact;
  1508. }
  1509. return err;
  1510. }
  1511. // successful commit, update dir
  1512. dir->off = commit.off;
  1513. dir->etag = commit.ptag;
  1514. // note we able to have already handled move here
  1515. if (lfs_gstate_hasmovehere(&lfs->gpending, dir->pair)) {
  1516. lfs_gstate_xormove(&lfs->gpending, &lfs->gpending, 0x3ff, NULL);
  1517. }
  1518. // update gstate
  1519. lfs->gstate = lfs->gpending;
  1520. lfs->gdelta = (struct lfs_gstate){0};
  1521. } else {
  1522. compact:
  1523. // fall back to compaction
  1524. lfs_cache_drop(lfs, &lfs->pcache);
  1525. int err = lfs_dir_compact(lfs, dir, attrs, attrcount,
  1526. dir, 0, dir->count);
  1527. if (err) {
  1528. return err;
  1529. }
  1530. }
  1531. // update any directories that are affected
  1532. lfs_mdir_t copy = *dir;
  1533. // two passes, once for things that aren't us, and one
  1534. // for things that are
  1535. for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
  1536. if (lfs_pair_cmp(d->m.pair, copy.pair) == 0) {
  1537. d->m = *dir;
  1538. if (d->id == lfs_tag_id(deletetag)) {
  1539. d->m.pair[0] = 0xffffffff;
  1540. d->m.pair[1] = 0xffffffff;
  1541. } else if (d->id > lfs_tag_id(deletetag)) {
  1542. d->id -= 1;
  1543. if (d->type == LFS_TYPE_DIR) {
  1544. ((lfs_dir_t*)d)->pos -= 1;
  1545. }
  1546. } else if (&d->m != dir && d->id >= lfs_tag_id(createtag)) {
  1547. d->id += 1;
  1548. if (d->type == LFS_TYPE_DIR) {
  1549. ((lfs_dir_t*)d)->pos += 1;
  1550. }
  1551. }
  1552. while (d->id >= d->m.count && d->m.split) {
  1553. // we split and id is on tail now
  1554. d->id -= d->m.count;
  1555. int err = lfs_dir_fetch(lfs, &d->m, d->m.tail);
  1556. if (err) {
  1557. return err;
  1558. }
  1559. }
  1560. }
  1561. }
  1562. return 0;
  1563. }
  1564. /// Top level directory operations ///
  1565. int lfs_mkdir(lfs_t *lfs, const char *path) {
  1566. // deorphan if we haven't yet, needed at most once after poweron
  1567. int err = lfs_fs_forceconsistency(lfs);
  1568. if (err) {
  1569. return err;
  1570. }
  1571. lfs_mdir_t cwd;
  1572. uint16_t id;
  1573. err = lfs_dir_find(lfs, &cwd, &path, &id);
  1574. if (!(err == LFS_ERR_NOENT && id != 0x3ff)) {
  1575. return (err < 0) ? err : LFS_ERR_EXIST;
  1576. }
  1577. // check that name fits
  1578. lfs_size_t nlen = strlen(path);
  1579. if (nlen > lfs->name_max) {
  1580. return LFS_ERR_NAMETOOLONG;
  1581. }
  1582. // build up new directory
  1583. lfs_alloc_ack(lfs);
  1584. lfs_mdir_t dir;
  1585. err = lfs_dir_alloc(lfs, &dir);
  1586. if (err) {
  1587. return err;
  1588. }
  1589. // find end of list
  1590. lfs_mdir_t pred = cwd;
  1591. while (pred.split) {
  1592. err = lfs_dir_fetch(lfs, &pred, pred.tail);
  1593. if (err) {
  1594. return err;
  1595. }
  1596. }
  1597. // setup dir
  1598. lfs_pair_tole32(pred.tail);
  1599. err = lfs_dir_commit(lfs, &dir, LFS_MKATTRS(
  1600. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), pred.tail}));
  1601. lfs_pair_fromle32(pred.tail);
  1602. if (err) {
  1603. return err;
  1604. }
  1605. // current block end of list?
  1606. if (cwd.split) {
  1607. // update tails, this creates a desync
  1608. lfs_fs_preporphans(lfs, +1);
  1609. lfs_pair_tole32(dir.pair);
  1610. err = lfs_dir_commit(lfs, &pred, LFS_MKATTRS(
  1611. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), dir.pair}));
  1612. lfs_pair_fromle32(dir.pair);
  1613. if (err) {
  1614. return err;
  1615. }
  1616. lfs_fs_preporphans(lfs, -1);
  1617. }
  1618. // now insert into our parent block
  1619. lfs_pair_tole32(dir.pair);
  1620. err = lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
  1621. {LFS_MKTAG(LFS_TYPE_CREATE, id, 0), NULL},
  1622. {LFS_MKTAG(LFS_TYPE_DIR, id, nlen), path},
  1623. {LFS_MKTAG(LFS_TYPE_DIRSTRUCT, id, 8), dir.pair},
  1624. {!cwd.split
  1625. ? LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8)
  1626. : LFS_MKTAG(LFS_FROM_NOOP, 0, 0), dir.pair}));
  1627. lfs_pair_fromle32(dir.pair);
  1628. if (err) {
  1629. return err;
  1630. }
  1631. return 0;
  1632. }
  1633. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1634. lfs_stag_t tag = lfs_dir_find(lfs, &dir->m, &path, NULL);
  1635. if (tag < 0) {
  1636. return tag;
  1637. }
  1638. if (lfs_tag_type3(tag) != LFS_TYPE_DIR) {
  1639. return LFS_ERR_NOTDIR;
  1640. }
  1641. lfs_block_t pair[2];
  1642. if (lfs_tag_id(tag) == 0x3ff) {
  1643. // handle root dir separately
  1644. pair[0] = lfs->root[0];
  1645. pair[1] = lfs->root[1];
  1646. } else {
  1647. // get dir pair from parent
  1648. lfs_stag_t res = lfs_dir_get(lfs, &dir->m, LFS_MKTAG(0x700, 0x3ff, 0),
  1649. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  1650. if (res < 0) {
  1651. return res;
  1652. }
  1653. lfs_pair_fromle32(pair);
  1654. }
  1655. // fetch first pair
  1656. int err = lfs_dir_fetch(lfs, &dir->m, pair);
  1657. if (err) {
  1658. return err;
  1659. }
  1660. // setup entry
  1661. dir->head[0] = dir->m.pair[0];
  1662. dir->head[1] = dir->m.pair[1];
  1663. dir->id = 0;
  1664. dir->pos = 0;
  1665. // add to list of mdirs
  1666. dir->type = LFS_TYPE_DIR;
  1667. dir->next = (lfs_dir_t*)lfs->mlist;
  1668. lfs->mlist = (struct lfs_mlist*)dir;
  1669. return 0;
  1670. }
  1671. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1672. // remove from list of mdirs
  1673. for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
  1674. if (*p == (struct lfs_mlist*)dir) {
  1675. *p = (*p)->next;
  1676. break;
  1677. }
  1678. }
  1679. return 0;
  1680. }
  1681. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1682. memset(info, 0, sizeof(*info));
  1683. // special offset for '.' and '..'
  1684. if (dir->pos == 0) {
  1685. info->type = LFS_TYPE_DIR;
  1686. strcpy(info->name, ".");
  1687. dir->pos += 1;
  1688. return 1;
  1689. } else if (dir->pos == 1) {
  1690. info->type = LFS_TYPE_DIR;
  1691. strcpy(info->name, "..");
  1692. dir->pos += 1;
  1693. return 1;
  1694. }
  1695. while (true) {
  1696. if (dir->id == dir->m.count) {
  1697. if (!dir->m.split) {
  1698. return false;
  1699. }
  1700. int err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1701. if (err) {
  1702. return err;
  1703. }
  1704. dir->id = 0;
  1705. }
  1706. int err = lfs_dir_getinfo(lfs, &dir->m, dir->id, info);
  1707. if (err && err != LFS_ERR_NOENT) {
  1708. return err;
  1709. }
  1710. dir->id += 1;
  1711. if (err != LFS_ERR_NOENT) {
  1712. break;
  1713. }
  1714. }
  1715. dir->pos += 1;
  1716. return true;
  1717. }
  1718. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1719. // simply walk from head dir
  1720. int err = lfs_dir_rewind(lfs, dir);
  1721. if (err) {
  1722. return err;
  1723. }
  1724. // first two for ./..
  1725. dir->pos = lfs_min(2, off);
  1726. off -= dir->pos;
  1727. while (off != 0) {
  1728. dir->id = lfs_min(dir->m.count, off);
  1729. dir->pos += dir->id;
  1730. off -= dir->id;
  1731. if (dir->id == dir->m.count) {
  1732. if (!dir->m.split) {
  1733. return LFS_ERR_INVAL;
  1734. }
  1735. err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1736. if (err) {
  1737. return err;
  1738. }
  1739. }
  1740. }
  1741. return 0;
  1742. }
  1743. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1744. (void)lfs;
  1745. return dir->pos;
  1746. }
  1747. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1748. // reload the head dir
  1749. int err = lfs_dir_fetch(lfs, &dir->m, dir->head);
  1750. if (err) {
  1751. return err;
  1752. }
  1753. dir->m.pair[0] = dir->head[0];
  1754. dir->m.pair[1] = dir->head[1];
  1755. dir->id = 0;
  1756. dir->pos = 0;
  1757. return 0;
  1758. }
  1759. /// File index list operations ///
  1760. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1761. lfs_off_t size = *off;
  1762. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1763. lfs_off_t i = size / b;
  1764. if (i == 0) {
  1765. return 0;
  1766. }
  1767. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1768. *off = size - b*i - 4*lfs_popc(i);
  1769. return i;
  1770. }
  1771. static int lfs_ctz_find(lfs_t *lfs,
  1772. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1773. lfs_block_t head, lfs_size_t size,
  1774. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1775. if (size == 0) {
  1776. *block = 0xffffffff;
  1777. *off = 0;
  1778. return 0;
  1779. }
  1780. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1781. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1782. while (current > target) {
  1783. lfs_size_t skip = lfs_min(
  1784. lfs_npw2(current-target+1) - 1,
  1785. lfs_ctz(current));
  1786. int err = lfs_bd_read(lfs,
  1787. pcache, rcache, sizeof(head),
  1788. head, 4*skip, &head, sizeof(head));
  1789. head = lfs_fromle32(head);
  1790. if (err) {
  1791. return err;
  1792. }
  1793. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1794. current -= 1 << skip;
  1795. }
  1796. *block = head;
  1797. *off = pos;
  1798. return 0;
  1799. }
  1800. static int lfs_ctz_extend(lfs_t *lfs,
  1801. lfs_cache_t *pcache, lfs_cache_t *rcache,
  1802. lfs_block_t head, lfs_size_t size,
  1803. lfs_block_t *block, lfs_off_t *off) {
  1804. while (true) {
  1805. // go ahead and grab a block
  1806. lfs_block_t nblock;
  1807. int err = lfs_alloc(lfs, &nblock);
  1808. if (err) {
  1809. return err;
  1810. }
  1811. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1812. if (true) {
  1813. err = lfs_bd_erase(lfs, nblock);
  1814. if (err) {
  1815. if (err == LFS_ERR_CORRUPT) {
  1816. goto relocate;
  1817. }
  1818. return err;
  1819. }
  1820. if (size == 0) {
  1821. *block = nblock;
  1822. *off = 0;
  1823. return 0;
  1824. }
  1825. size -= 1;
  1826. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1827. size += 1;
  1828. // just copy out the last block if it is incomplete
  1829. if (size != lfs->cfg->block_size) {
  1830. for (lfs_off_t i = 0; i < size; i++) {
  1831. uint8_t data;
  1832. err = lfs_bd_read(lfs,
  1833. NULL, rcache, size-i,
  1834. head, i, &data, 1);
  1835. if (err) {
  1836. return err;
  1837. }
  1838. err = lfs_bd_prog(lfs,
  1839. pcache, rcache, true,
  1840. nblock, i, &data, 1);
  1841. if (err) {
  1842. if (err == LFS_ERR_CORRUPT) {
  1843. goto relocate;
  1844. }
  1845. return err;
  1846. }
  1847. }
  1848. *block = nblock;
  1849. *off = size;
  1850. return 0;
  1851. }
  1852. // append block
  1853. index += 1;
  1854. lfs_size_t skips = lfs_ctz(index) + 1;
  1855. for (lfs_off_t i = 0; i < skips; i++) {
  1856. head = lfs_tole32(head);
  1857. err = lfs_bd_prog(lfs, pcache, rcache, true,
  1858. nblock, 4*i, &head, 4);
  1859. head = lfs_fromle32(head);
  1860. if (err) {
  1861. if (err == LFS_ERR_CORRUPT) {
  1862. goto relocate;
  1863. }
  1864. return err;
  1865. }
  1866. if (i != skips-1) {
  1867. err = lfs_bd_read(lfs,
  1868. NULL, rcache, sizeof(head),
  1869. head, 4*i, &head, sizeof(head));
  1870. head = lfs_fromle32(head);
  1871. if (err) {
  1872. return err;
  1873. }
  1874. }
  1875. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1876. }
  1877. *block = nblock;
  1878. *off = 4*skips;
  1879. return 0;
  1880. }
  1881. relocate:
  1882. LFS_DEBUG("Bad block at %"PRIu32, nblock);
  1883. // just clear cache and try a new block
  1884. lfs_cache_drop(lfs, pcache);
  1885. }
  1886. }
  1887. static int lfs_ctz_traverse(lfs_t *lfs,
  1888. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1889. lfs_block_t head, lfs_size_t size,
  1890. int (*cb)(void*, lfs_block_t), void *data) {
  1891. if (size == 0) {
  1892. return 0;
  1893. }
  1894. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1895. while (true) {
  1896. int err = cb(data, head);
  1897. if (err) {
  1898. return err;
  1899. }
  1900. if (index == 0) {
  1901. return 0;
  1902. }
  1903. lfs_block_t heads[2];
  1904. int count = 2 - (index & 1);
  1905. err = lfs_bd_read(lfs,
  1906. pcache, rcache, count*sizeof(head),
  1907. head, 0, &heads, count*sizeof(head));
  1908. heads[0] = lfs_fromle32(heads[0]);
  1909. heads[1] = lfs_fromle32(heads[1]);
  1910. if (err) {
  1911. return err;
  1912. }
  1913. for (int i = 0; i < count-1; i++) {
  1914. err = cb(data, heads[i]);
  1915. if (err) {
  1916. return err;
  1917. }
  1918. }
  1919. head = heads[count-1];
  1920. index -= count;
  1921. }
  1922. }
  1923. /// Top level file operations ///
  1924. int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
  1925. const char *path, int flags,
  1926. const struct lfs_file_config *cfg) {
  1927. // deorphan if we haven't yet, needed at most once after poweron
  1928. if ((flags & 3) != LFS_O_RDONLY) {
  1929. int err = lfs_fs_forceconsistency(lfs);
  1930. if (err) {
  1931. return err;
  1932. }
  1933. }
  1934. // setup simple file details
  1935. int err;
  1936. file->cfg = cfg;
  1937. file->flags = flags;
  1938. file->pos = 0;
  1939. file->cache.buffer = NULL;
  1940. // allocate entry for file if it doesn't exist
  1941. lfs_stag_t tag = lfs_dir_find(lfs, &file->m, &path, &file->id);
  1942. if (tag < 0 && !(tag == LFS_ERR_NOENT && file->id != 0x3ff)) {
  1943. err = tag;
  1944. goto cleanup;
  1945. }
  1946. // get id, add to list of mdirs to catch update changes
  1947. file->type = LFS_TYPE_REG;
  1948. file->next = (lfs_file_t*)lfs->mlist;
  1949. lfs->mlist = (struct lfs_mlist*)file;
  1950. if (tag == LFS_ERR_NOENT) {
  1951. if (!(flags & LFS_O_CREAT)) {
  1952. err = LFS_ERR_NOENT;
  1953. goto cleanup;
  1954. }
  1955. // check that name fits
  1956. lfs_size_t nlen = strlen(path);
  1957. if (nlen > lfs->name_max) {
  1958. err = LFS_ERR_NAMETOOLONG;
  1959. goto cleanup;
  1960. }
  1961. // get next slot and create entry to remember name
  1962. err = lfs_dir_commit(lfs, &file->m, LFS_MKATTRS(
  1963. {LFS_MKTAG(LFS_TYPE_CREATE, file->id, 0), NULL},
  1964. {LFS_MKTAG(LFS_TYPE_REG, file->id, nlen), path},
  1965. {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0), NULL}));
  1966. if (err) {
  1967. err = LFS_ERR_NAMETOOLONG;
  1968. goto cleanup;
  1969. }
  1970. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, 0);
  1971. } else if (flags & LFS_O_EXCL) {
  1972. err = LFS_ERR_EXIST;
  1973. goto cleanup;
  1974. } else if (lfs_tag_type3(tag) != LFS_TYPE_REG) {
  1975. err = LFS_ERR_ISDIR;
  1976. goto cleanup;
  1977. } else if (flags & LFS_O_TRUNC) {
  1978. // truncate if requested
  1979. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0);
  1980. file->flags |= LFS_F_DIRTY;
  1981. } else {
  1982. // try to load what's on disk, if it's inlined we'll fix it later
  1983. tag = lfs_dir_get(lfs, &file->m, LFS_MKTAG(0x700, 0x3ff, 0),
  1984. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, 8), &file->ctz);
  1985. if (tag < 0) {
  1986. err = tag;
  1987. goto cleanup;
  1988. }
  1989. lfs_ctz_fromle32(&file->ctz);
  1990. }
  1991. // fetch attrs
  1992. for (unsigned i = 0; i < file->cfg->attr_count; i++) {
  1993. if ((file->flags & 3) != LFS_O_WRONLY) {
  1994. lfs_stag_t res = lfs_dir_get(lfs, &file->m,
  1995. LFS_MKTAG(0x7ff, 0x3ff, 0),
  1996. LFS_MKTAG(LFS_TYPE_USERATTR + file->cfg->attrs[i].type,
  1997. file->id, file->cfg->attrs[i].size),
  1998. file->cfg->attrs[i].buffer);
  1999. if (res < 0 && res != LFS_ERR_NOENT) {
  2000. err = res;
  2001. goto cleanup;
  2002. }
  2003. }
  2004. if ((file->flags & 3) != LFS_O_RDONLY) {
  2005. if (file->cfg->attrs[i].size > lfs->attr_max) {
  2006. err = LFS_ERR_NOSPC;
  2007. goto cleanup;
  2008. }
  2009. file->flags |= LFS_F_DIRTY;
  2010. }
  2011. }
  2012. // allocate buffer if needed
  2013. if (file->cfg->buffer) {
  2014. file->cache.buffer = file->cfg->buffer;
  2015. } else {
  2016. file->cache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2017. if (!file->cache.buffer) {
  2018. err = LFS_ERR_NOMEM;
  2019. goto cleanup;
  2020. }
  2021. }
  2022. // zero to avoid information leak
  2023. lfs_cache_zero(lfs, &file->cache);
  2024. if (lfs_tag_type3(tag) == LFS_TYPE_INLINESTRUCT) {
  2025. // load inline files
  2026. file->ctz.head = 0xfffffffe;
  2027. file->ctz.size = lfs_tag_size(tag);
  2028. file->flags |= LFS_F_INLINE;
  2029. file->cache.block = file->ctz.head;
  2030. file->cache.off = 0;
  2031. file->cache.size = lfs->cfg->cache_size;
  2032. // don't always read (may be new/trunc file)
  2033. if (file->ctz.size > 0) {
  2034. lfs_stag_t res = lfs_dir_get(lfs, &file->m,
  2035. LFS_MKTAG(0x700, 0x3ff, 0),
  2036. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, file->cache.size),
  2037. file->cache.buffer);
  2038. if (res < 0) {
  2039. err = res;
  2040. goto cleanup;
  2041. }
  2042. }
  2043. }
  2044. return 0;
  2045. cleanup:
  2046. // clean up lingering resources
  2047. file->flags |= LFS_F_ERRED;
  2048. lfs_file_close(lfs, file);
  2049. return err;
  2050. }
  2051. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  2052. const char *path, int flags) {
  2053. static const struct lfs_file_config defaults = {0};
  2054. return lfs_file_opencfg(lfs, file, path, flags, &defaults);
  2055. }
  2056. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  2057. int err = lfs_file_sync(lfs, file);
  2058. // remove from list of mdirs
  2059. for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
  2060. if (*p == (struct lfs_mlist*)file) {
  2061. *p = (*p)->next;
  2062. break;
  2063. }
  2064. }
  2065. // clean up memory
  2066. if (!file->cfg->buffer) {
  2067. lfs_free(file->cache.buffer);
  2068. }
  2069. return err;
  2070. }
  2071. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  2072. while (true) {
  2073. // just relocate what exists into new block
  2074. lfs_block_t nblock;
  2075. int err = lfs_alloc(lfs, &nblock);
  2076. if (err) {
  2077. return err;
  2078. }
  2079. err = lfs_bd_erase(lfs, nblock);
  2080. if (err) {
  2081. if (err == LFS_ERR_CORRUPT) {
  2082. goto relocate;
  2083. }
  2084. return err;
  2085. }
  2086. // either read from dirty cache or disk
  2087. for (lfs_off_t i = 0; i < file->off; i++) {
  2088. uint8_t data;
  2089. if (file->flags & LFS_F_INLINE) {
  2090. err = lfs_dir_getread(lfs, &file->m,
  2091. // note we evict inline files before they can be dirty
  2092. NULL, &file->cache, file->off-i,
  2093. LFS_MKTAG(0xfff, 0x1ff, 0),
  2094. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0),
  2095. i, &data, 1);
  2096. if (err) {
  2097. return err;
  2098. }
  2099. } else {
  2100. err = lfs_bd_read(lfs,
  2101. &file->cache, &lfs->rcache, file->off-i,
  2102. file->block, i, &data, 1);
  2103. if (err) {
  2104. return err;
  2105. }
  2106. }
  2107. err = lfs_bd_prog(lfs,
  2108. &lfs->pcache, &lfs->rcache, true,
  2109. nblock, i, &data, 1);
  2110. if (err) {
  2111. if (err == LFS_ERR_CORRUPT) {
  2112. goto relocate;
  2113. }
  2114. return err;
  2115. }
  2116. }
  2117. // copy over new state of file
  2118. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->cache_size);
  2119. file->cache.block = lfs->pcache.block;
  2120. file->cache.off = lfs->pcache.off;
  2121. file->cache.size = lfs->pcache.size;
  2122. lfs_cache_zero(lfs, &lfs->pcache);
  2123. file->block = nblock;
  2124. file->flags &= ~LFS_F_INLINE;
  2125. file->flags |= LFS_F_WRITING;
  2126. return 0;
  2127. relocate:
  2128. LFS_DEBUG("Bad block at %"PRIu32, nblock);
  2129. // just clear cache and try a new block
  2130. lfs_cache_drop(lfs, &lfs->pcache);
  2131. }
  2132. }
  2133. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  2134. if (file->flags & LFS_F_READING) {
  2135. if (!(file->flags & LFS_F_INLINE)) {
  2136. lfs_cache_drop(lfs, &file->cache);
  2137. }
  2138. file->flags &= ~LFS_F_READING;
  2139. }
  2140. if (file->flags & LFS_F_WRITING) {
  2141. lfs_off_t pos = file->pos;
  2142. if (!(file->flags & LFS_F_INLINE)) {
  2143. // copy over anything after current branch
  2144. lfs_file_t orig = {
  2145. .ctz.head = file->ctz.head,
  2146. .ctz.size = file->ctz.size,
  2147. .flags = LFS_O_RDONLY,
  2148. .pos = file->pos,
  2149. .cache = lfs->rcache,
  2150. };
  2151. lfs_cache_drop(lfs, &lfs->rcache);
  2152. while (file->pos < file->ctz.size) {
  2153. // copy over a byte at a time, leave it up to caching
  2154. // to make this efficient
  2155. uint8_t data;
  2156. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  2157. if (res < 0) {
  2158. return res;
  2159. }
  2160. res = lfs_file_write(lfs, file, &data, 1);
  2161. if (res < 0) {
  2162. return res;
  2163. }
  2164. // keep our reference to the rcache in sync
  2165. if (lfs->rcache.block != 0xffffffff) {
  2166. lfs_cache_drop(lfs, &orig.cache);
  2167. lfs_cache_drop(lfs, &lfs->rcache);
  2168. }
  2169. }
  2170. // write out what we have
  2171. while (true) {
  2172. int err = lfs_bd_flush(lfs, &file->cache, &lfs->rcache, true);
  2173. if (err) {
  2174. if (err == LFS_ERR_CORRUPT) {
  2175. goto relocate;
  2176. }
  2177. return err;
  2178. }
  2179. break;
  2180. relocate:
  2181. LFS_DEBUG("Bad block at %"PRIu32, file->block);
  2182. err = lfs_file_relocate(lfs, file);
  2183. if (err) {
  2184. return err;
  2185. }
  2186. }
  2187. } else {
  2188. file->ctz.size = lfs_max(file->pos, file->ctz.size);
  2189. }
  2190. // actual file updates
  2191. file->ctz.head = file->block;
  2192. file->ctz.size = file->pos;
  2193. file->flags &= ~LFS_F_WRITING;
  2194. file->flags |= LFS_F_DIRTY;
  2195. file->pos = pos;
  2196. }
  2197. return 0;
  2198. }
  2199. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  2200. while (true) {
  2201. int err = lfs_file_flush(lfs, file);
  2202. if (err) {
  2203. return err;
  2204. }
  2205. if ((file->flags & LFS_F_DIRTY) &&
  2206. !(file->flags & LFS_F_ERRED) &&
  2207. !lfs_pair_isnull(file->m.pair)) {
  2208. // update dir entry
  2209. uint16_t type;
  2210. const void *buffer;
  2211. lfs_size_t size;
  2212. struct lfs_ctz ctz;
  2213. if (file->flags & LFS_F_INLINE) {
  2214. // inline the whole file
  2215. type = LFS_TYPE_INLINESTRUCT;
  2216. buffer = file->cache.buffer;
  2217. size = file->ctz.size;
  2218. } else {
  2219. // update the ctz reference
  2220. type = LFS_TYPE_CTZSTRUCT;
  2221. // copy ctz so alloc will work during a relocate
  2222. ctz = file->ctz;
  2223. lfs_ctz_tole32(&ctz);
  2224. buffer = &ctz;
  2225. size = sizeof(ctz);
  2226. }
  2227. // commit file data and attributes
  2228. err = lfs_dir_commit(lfs, &file->m, LFS_MKATTRS(
  2229. {LFS_MKTAG(type, file->id, size), buffer},
  2230. {LFS_MKTAG(LFS_FROM_USERATTRS, file->id,
  2231. file->cfg->attr_count), file->cfg->attrs}));
  2232. if (err) {
  2233. if (err == LFS_ERR_NOSPC && (file->flags & LFS_F_INLINE)) {
  2234. goto relocate;
  2235. }
  2236. return err;
  2237. }
  2238. file->flags &= ~LFS_F_DIRTY;
  2239. }
  2240. return 0;
  2241. relocate:
  2242. // inline file doesn't fit anymore
  2243. file->off = file->pos;
  2244. err = lfs_file_relocate(lfs, file);
  2245. if (err) {
  2246. return err;
  2247. }
  2248. }
  2249. }
  2250. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  2251. void *buffer, lfs_size_t size) {
  2252. uint8_t *data = buffer;
  2253. lfs_size_t nsize = size;
  2254. if ((file->flags & 3) == LFS_O_WRONLY) {
  2255. return LFS_ERR_BADF;
  2256. }
  2257. if (file->flags & LFS_F_WRITING) {
  2258. // flush out any writes
  2259. int err = lfs_file_flush(lfs, file);
  2260. if (err) {
  2261. return err;
  2262. }
  2263. }
  2264. if (file->pos >= file->ctz.size) {
  2265. // eof if past end
  2266. return 0;
  2267. }
  2268. size = lfs_min(size, file->ctz.size - file->pos);
  2269. nsize = size;
  2270. while (nsize > 0) {
  2271. // check if we need a new block
  2272. if (!(file->flags & LFS_F_READING) ||
  2273. file->off == lfs->cfg->block_size) {
  2274. if (!(file->flags & LFS_F_INLINE)) {
  2275. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2276. file->ctz.head, file->ctz.size,
  2277. file->pos, &file->block, &file->off);
  2278. if (err) {
  2279. return err;
  2280. }
  2281. } else {
  2282. file->block = 0xfffffffe;
  2283. file->off = file->pos;
  2284. }
  2285. file->flags |= LFS_F_READING;
  2286. }
  2287. // read as much as we can in current block
  2288. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2289. if (file->flags & LFS_F_INLINE) {
  2290. int err = lfs_dir_getread(lfs, &file->m,
  2291. NULL, &file->cache, lfs->cfg->block_size,
  2292. LFS_MKTAG(0xfff, 0x1ff, 0),
  2293. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0),
  2294. file->off, data, diff);
  2295. if (err) {
  2296. return err;
  2297. }
  2298. } else {
  2299. int err = lfs_bd_read(lfs,
  2300. NULL, &file->cache, lfs->cfg->block_size,
  2301. file->block, file->off, data, diff);
  2302. if (err) {
  2303. return err;
  2304. }
  2305. }
  2306. file->pos += diff;
  2307. file->off += diff;
  2308. data += diff;
  2309. nsize -= diff;
  2310. }
  2311. return size;
  2312. }
  2313. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  2314. const void *buffer, lfs_size_t size) {
  2315. const uint8_t *data = buffer;
  2316. lfs_size_t nsize = size;
  2317. if ((file->flags & 3) == LFS_O_RDONLY) {
  2318. return LFS_ERR_BADF;
  2319. }
  2320. if (file->flags & LFS_F_READING) {
  2321. // drop any reads
  2322. int err = lfs_file_flush(lfs, file);
  2323. if (err) {
  2324. return err;
  2325. }
  2326. }
  2327. if ((file->flags & LFS_O_APPEND) && file->pos < file->ctz.size) {
  2328. file->pos = file->ctz.size;
  2329. }
  2330. if (file->pos + size > lfs->file_max) {
  2331. // Larger than file limit?
  2332. return LFS_ERR_FBIG;
  2333. }
  2334. if (!(file->flags & LFS_F_WRITING) && file->pos > file->ctz.size) {
  2335. // fill with zeros
  2336. lfs_off_t pos = file->pos;
  2337. file->pos = file->ctz.size;
  2338. while (file->pos < pos) {
  2339. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2340. if (res < 0) {
  2341. return res;
  2342. }
  2343. }
  2344. }
  2345. if ((file->flags & LFS_F_INLINE) &&
  2346. lfs_max(file->pos+nsize, file->ctz.size) >
  2347. lfs_min(LFS_ATTR_MAX, lfs_min(
  2348. lfs->cfg->cache_size, lfs->cfg->block_size/8))) {
  2349. // inline file doesn't fit anymore
  2350. file->off = file->pos;
  2351. lfs_alloc_ack(lfs);
  2352. int err = lfs_file_relocate(lfs, file);
  2353. if (err) {
  2354. file->flags |= LFS_F_ERRED;
  2355. return err;
  2356. }
  2357. }
  2358. while (nsize > 0) {
  2359. // check if we need a new block
  2360. if (!(file->flags & LFS_F_WRITING) ||
  2361. file->off == lfs->cfg->block_size) {
  2362. if (!(file->flags & LFS_F_INLINE)) {
  2363. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  2364. // find out which block we're extending from
  2365. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2366. file->ctz.head, file->ctz.size,
  2367. file->pos-1, &file->block, &file->off);
  2368. if (err) {
  2369. file->flags |= LFS_F_ERRED;
  2370. return err;
  2371. }
  2372. // mark cache as dirty since we may have read data into it
  2373. lfs_cache_zero(lfs, &file->cache);
  2374. }
  2375. // extend file with new blocks
  2376. lfs_alloc_ack(lfs);
  2377. int err = lfs_ctz_extend(lfs, &file->cache, &lfs->rcache,
  2378. file->block, file->pos,
  2379. &file->block, &file->off);
  2380. if (err) {
  2381. file->flags |= LFS_F_ERRED;
  2382. return err;
  2383. }
  2384. } else {
  2385. file->block = 0xfffffffe;
  2386. file->off = file->pos;
  2387. }
  2388. file->flags |= LFS_F_WRITING;
  2389. }
  2390. // program as much as we can in current block
  2391. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2392. while (true) {
  2393. int err = lfs_bd_prog(lfs, &file->cache, &lfs->rcache, true,
  2394. file->block, file->off, data, diff);
  2395. if (err) {
  2396. if (err == LFS_ERR_CORRUPT) {
  2397. goto relocate;
  2398. }
  2399. file->flags |= LFS_F_ERRED;
  2400. return err;
  2401. }
  2402. break;
  2403. relocate:
  2404. err = lfs_file_relocate(lfs, file);
  2405. if (err) {
  2406. file->flags |= LFS_F_ERRED;
  2407. return err;
  2408. }
  2409. }
  2410. file->pos += diff;
  2411. file->off += diff;
  2412. data += diff;
  2413. nsize -= diff;
  2414. lfs_alloc_ack(lfs);
  2415. }
  2416. file->flags &= ~LFS_F_ERRED;
  2417. return size;
  2418. }
  2419. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  2420. lfs_soff_t off, int whence) {
  2421. // write out everything beforehand, may be noop if rdonly
  2422. int err = lfs_file_flush(lfs, file);
  2423. if (err) {
  2424. return err;
  2425. }
  2426. // find new pos
  2427. lfs_off_t npos = file->pos;
  2428. if (whence == LFS_SEEK_SET) {
  2429. npos = off;
  2430. } else if (whence == LFS_SEEK_CUR) {
  2431. npos = file->pos + off;
  2432. } else if (whence == LFS_SEEK_END) {
  2433. npos = file->ctz.size + off;
  2434. }
  2435. if (npos > lfs->file_max) {
  2436. // file position out of range
  2437. return LFS_ERR_INVAL;
  2438. }
  2439. // update pos
  2440. file->pos = npos;
  2441. return npos;
  2442. }
  2443. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  2444. if ((file->flags & 3) == LFS_O_RDONLY) {
  2445. return LFS_ERR_BADF;
  2446. }
  2447. lfs_off_t oldsize = lfs_file_size(lfs, file);
  2448. if (size < oldsize) {
  2449. // need to flush since directly changing metadata
  2450. int err = lfs_file_flush(lfs, file);
  2451. if (err) {
  2452. return err;
  2453. }
  2454. // lookup new head in ctz skip list
  2455. err = lfs_ctz_find(lfs, NULL, &file->cache,
  2456. file->ctz.head, file->ctz.size,
  2457. size, &file->ctz.head, &(lfs_off_t){0});
  2458. if (err) {
  2459. return err;
  2460. }
  2461. file->ctz.size = size;
  2462. file->flags |= LFS_F_DIRTY;
  2463. } else if (size > oldsize) {
  2464. lfs_off_t pos = file->pos;
  2465. // flush+seek if not already at end
  2466. if (file->pos != oldsize) {
  2467. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  2468. if (err < 0) {
  2469. return err;
  2470. }
  2471. }
  2472. // fill with zeros
  2473. while (file->pos < size) {
  2474. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2475. if (res < 0) {
  2476. return res;
  2477. }
  2478. }
  2479. // restore pos
  2480. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  2481. if (err < 0) {
  2482. return err;
  2483. }
  2484. }
  2485. return 0;
  2486. }
  2487. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  2488. (void)lfs;
  2489. return file->pos;
  2490. }
  2491. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  2492. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  2493. if (res < 0) {
  2494. return res;
  2495. }
  2496. return 0;
  2497. }
  2498. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  2499. (void)lfs;
  2500. if (file->flags & LFS_F_WRITING) {
  2501. return lfs_max(file->pos, file->ctz.size);
  2502. } else {
  2503. return file->ctz.size;
  2504. }
  2505. }
  2506. /// General fs operations ///
  2507. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  2508. lfs_mdir_t cwd;
  2509. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2510. if (tag < 0) {
  2511. return tag;
  2512. }
  2513. return lfs_dir_getinfo(lfs, &cwd, lfs_tag_id(tag), info);
  2514. }
  2515. int lfs_remove(lfs_t *lfs, const char *path) {
  2516. // deorphan if we haven't yet, needed at most once after poweron
  2517. int err = lfs_fs_forceconsistency(lfs);
  2518. if (err) {
  2519. return err;
  2520. }
  2521. lfs_mdir_t cwd;
  2522. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2523. if (tag < 0 || lfs_tag_id(tag) == 0x3ff) {
  2524. return (tag < 0) ? tag : LFS_ERR_INVAL;
  2525. }
  2526. lfs_mdir_t dir;
  2527. if (lfs_tag_type3(tag) == LFS_TYPE_DIR) {
  2528. // must be empty before removal
  2529. lfs_block_t pair[2];
  2530. lfs_stag_t res = lfs_dir_get(lfs, &cwd, LFS_MKTAG(0x700, 0x3ff, 0),
  2531. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  2532. if (res < 0) {
  2533. return res;
  2534. }
  2535. lfs_pair_fromle32(pair);
  2536. err = lfs_dir_fetch(lfs, &dir, pair);
  2537. if (err) {
  2538. return err;
  2539. }
  2540. if (dir.count > 0 || dir.split) {
  2541. return LFS_ERR_NOTEMPTY;
  2542. }
  2543. // mark fs as orphaned
  2544. lfs_fs_preporphans(lfs, +1);
  2545. }
  2546. // delete the entry
  2547. err = lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
  2548. {LFS_MKTAG(LFS_TYPE_DELETE, lfs_tag_id(tag), 0), NULL}));
  2549. if (err) {
  2550. return err;
  2551. }
  2552. if (lfs_tag_type3(tag) == LFS_TYPE_DIR) {
  2553. // fix orphan
  2554. lfs_fs_preporphans(lfs, -1);
  2555. err = lfs_fs_pred(lfs, dir.pair, &cwd);
  2556. if (err) {
  2557. return err;
  2558. }
  2559. err = lfs_dir_drop(lfs, &cwd, &dir);
  2560. if (err) {
  2561. return err;
  2562. }
  2563. }
  2564. return 0;
  2565. }
  2566. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  2567. // deorphan if we haven't yet, needed at most once after poweron
  2568. int err = lfs_fs_forceconsistency(lfs);
  2569. if (err) {
  2570. return err;
  2571. }
  2572. // find old entry
  2573. lfs_mdir_t oldcwd;
  2574. lfs_stag_t oldtag = lfs_dir_find(lfs, &oldcwd, &oldpath, NULL);
  2575. if (oldtag < 0 || lfs_tag_id(oldtag) == 0x3ff) {
  2576. return (oldtag < 0) ? oldtag : LFS_ERR_INVAL;
  2577. }
  2578. // find new entry
  2579. lfs_mdir_t newcwd;
  2580. uint16_t newid;
  2581. lfs_stag_t prevtag = lfs_dir_find(lfs, &newcwd, &newpath, &newid);
  2582. if ((prevtag < 0 || lfs_tag_id(prevtag) == 0x3ff) &&
  2583. !(prevtag == LFS_ERR_NOENT && newid != 0x3ff)) {
  2584. return (prevtag < 0) ? prevtag : LFS_ERR_INVAL;
  2585. }
  2586. lfs_mdir_t prevdir;
  2587. if (prevtag == LFS_ERR_NOENT) {
  2588. // check that name fits
  2589. lfs_size_t nlen = strlen(newpath);
  2590. if (nlen > lfs->name_max) {
  2591. return LFS_ERR_NAMETOOLONG;
  2592. }
  2593. } else if (lfs_tag_type3(prevtag) != lfs_tag_type3(oldtag)) {
  2594. return LFS_ERR_ISDIR;
  2595. } else if (lfs_tag_type3(prevtag) == LFS_TYPE_DIR) {
  2596. // must be empty before removal
  2597. lfs_block_t prevpair[2];
  2598. lfs_stag_t res = lfs_dir_get(lfs, &newcwd, LFS_MKTAG(0x700, 0x3ff, 0),
  2599. LFS_MKTAG(LFS_TYPE_STRUCT, newid, 8), prevpair);
  2600. if (res < 0) {
  2601. return res;
  2602. }
  2603. lfs_pair_fromle32(prevpair);
  2604. // must be empty before removal
  2605. err = lfs_dir_fetch(lfs, &prevdir, prevpair);
  2606. if (err) {
  2607. return err;
  2608. }
  2609. if (prevdir.count > 0 || prevdir.split) {
  2610. return LFS_ERR_NOTEMPTY;
  2611. }
  2612. // mark fs as orphaned
  2613. lfs_fs_preporphans(lfs, +1);
  2614. }
  2615. // create move to fix later
  2616. uint16_t newoldtagid = lfs_tag_id(oldtag);
  2617. if (lfs_pair_cmp(oldcwd.pair, newcwd.pair) == 0 &&
  2618. prevtag == LFS_ERR_NOENT && newid <= newoldtagid) {
  2619. // there is a small chance we are being renamed in the same directory
  2620. // to an id less than our old id, the global update to handle this
  2621. // is a bit messy
  2622. newoldtagid += 1;
  2623. }
  2624. lfs_fs_prepmove(lfs, newoldtagid, oldcwd.pair);
  2625. // move over all attributes
  2626. err = lfs_dir_commit(lfs, &newcwd, LFS_MKATTRS(
  2627. {prevtag != LFS_ERR_NOENT
  2628. ? LFS_MKTAG(LFS_TYPE_DELETE, newid, 0)
  2629. : LFS_MKTAG(LFS_FROM_NOOP, 0, 0), NULL},
  2630. {LFS_MKTAG(LFS_TYPE_CREATE, newid, 0), NULL},
  2631. {LFS_MKTAG(lfs_tag_type3(oldtag), newid, strlen(newpath)),
  2632. newpath},
  2633. {LFS_MKTAG(LFS_FROM_MOVE, newid, lfs_tag_id(oldtag)), &oldcwd}));
  2634. if (err) {
  2635. return err;
  2636. }
  2637. // let commit clean up after move (if we're different! otherwise move
  2638. // logic already fixed it for us)
  2639. if (lfs_pair_cmp(oldcwd.pair, newcwd.pair) != 0) {
  2640. err = lfs_dir_commit(lfs, &oldcwd, NULL, 0);
  2641. if (err) {
  2642. return err;
  2643. }
  2644. }
  2645. if (prevtag != LFS_ERR_NOENT && lfs_tag_type3(prevtag) == LFS_TYPE_DIR) {
  2646. // fix orphan
  2647. lfs_fs_preporphans(lfs, -1);
  2648. err = lfs_fs_pred(lfs, prevdir.pair, &newcwd);
  2649. if (err) {
  2650. return err;
  2651. }
  2652. err = lfs_dir_drop(lfs, &newcwd, &prevdir);
  2653. if (err) {
  2654. return err;
  2655. }
  2656. }
  2657. return 0;
  2658. }
  2659. lfs_ssize_t lfs_getattr(lfs_t *lfs, const char *path,
  2660. uint8_t type, void *buffer, lfs_size_t size) {
  2661. lfs_mdir_t cwd;
  2662. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2663. if (tag < 0) {
  2664. return tag;
  2665. }
  2666. uint16_t id = lfs_tag_id(tag);
  2667. if (id == 0x3ff) {
  2668. // special case for root
  2669. id = 0;
  2670. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2671. if (err) {
  2672. return err;
  2673. }
  2674. }
  2675. tag = lfs_dir_get(lfs, &cwd, LFS_MKTAG(0x7ff, 0x3ff, 0),
  2676. LFS_MKTAG(LFS_TYPE_USERATTR + type,
  2677. id, lfs_min(size, lfs->attr_max)),
  2678. buffer);
  2679. if (tag < 0) {
  2680. if (tag == LFS_ERR_NOENT) {
  2681. return LFS_ERR_NOATTR;
  2682. }
  2683. return tag;
  2684. }
  2685. return lfs_tag_size(tag);
  2686. }
  2687. static int lfs_commitattr(lfs_t *lfs, const char *path,
  2688. uint8_t type, const void *buffer, lfs_size_t size) {
  2689. lfs_mdir_t cwd;
  2690. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2691. if (tag < 0) {
  2692. return tag;
  2693. }
  2694. uint16_t id = lfs_tag_id(tag);
  2695. if (id == 0x3ff) {
  2696. // special case for root
  2697. id = 0;
  2698. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2699. if (err) {
  2700. return err;
  2701. }
  2702. }
  2703. return lfs_dir_commit(lfs, &cwd, LFS_MKATTRS(
  2704. {LFS_MKTAG(LFS_TYPE_USERATTR + type, id, size), buffer}));
  2705. }
  2706. int lfs_setattr(lfs_t *lfs, const char *path,
  2707. uint8_t type, const void *buffer, lfs_size_t size) {
  2708. if (size > lfs->attr_max) {
  2709. return LFS_ERR_NOSPC;
  2710. }
  2711. return lfs_commitattr(lfs, path, type, buffer, size);
  2712. }
  2713. int lfs_removeattr(lfs_t *lfs, const char *path, uint8_t type) {
  2714. return lfs_commitattr(lfs, path, type, NULL, 0x3ff);
  2715. }
  2716. /// Filesystem operations ///
  2717. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2718. lfs->cfg = cfg;
  2719. int err = 0;
  2720. // check that block size is a multiple of cache size is a multiple
  2721. // of prog and read sizes
  2722. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->read_size == 0);
  2723. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->prog_size == 0);
  2724. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->cache_size == 0);
  2725. // check that the block size is large enough to fit ctz pointers
  2726. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2727. <= lfs->cfg->block_size);
  2728. // we don't support some corner cases
  2729. LFS_ASSERT(lfs->cfg->block_cycles < 0xffffffff);
  2730. // setup read cache
  2731. if (lfs->cfg->read_buffer) {
  2732. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2733. } else {
  2734. lfs->rcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2735. if (!lfs->rcache.buffer) {
  2736. err = LFS_ERR_NOMEM;
  2737. goto cleanup;
  2738. }
  2739. }
  2740. // setup program cache
  2741. if (lfs->cfg->prog_buffer) {
  2742. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2743. } else {
  2744. lfs->pcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2745. if (!lfs->pcache.buffer) {
  2746. err = LFS_ERR_NOMEM;
  2747. goto cleanup;
  2748. }
  2749. }
  2750. // zero to avoid information leaks
  2751. lfs_cache_zero(lfs, &lfs->rcache);
  2752. lfs_cache_zero(lfs, &lfs->pcache);
  2753. // setup lookahead, must be multiple of 64-bits
  2754. LFS_ASSERT(lfs->cfg->lookahead_size % 8 == 0);
  2755. LFS_ASSERT(lfs->cfg->lookahead_size > 0);
  2756. if (lfs->cfg->lookahead_buffer) {
  2757. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2758. } else {
  2759. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead_size);
  2760. if (!lfs->free.buffer) {
  2761. err = LFS_ERR_NOMEM;
  2762. goto cleanup;
  2763. }
  2764. }
  2765. // check that the size limits are sane
  2766. LFS_ASSERT(lfs->cfg->name_max <= LFS_NAME_MAX);
  2767. lfs->name_max = lfs->cfg->name_max;
  2768. if (!lfs->name_max) {
  2769. lfs->name_max = LFS_NAME_MAX;
  2770. }
  2771. LFS_ASSERT(lfs->cfg->file_max <= LFS_FILE_MAX);
  2772. lfs->file_max = lfs->cfg->file_max;
  2773. if (!lfs->file_max) {
  2774. lfs->file_max = LFS_FILE_MAX;
  2775. }
  2776. LFS_ASSERT(lfs->cfg->attr_max <= LFS_ATTR_MAX);
  2777. lfs->attr_max = lfs->cfg->attr_max;
  2778. if (!lfs->attr_max) {
  2779. lfs->attr_max = LFS_ATTR_MAX;
  2780. }
  2781. // setup default state
  2782. lfs->root[0] = 0xffffffff;
  2783. lfs->root[1] = 0xffffffff;
  2784. lfs->mlist = NULL;
  2785. lfs->seed = 0;
  2786. lfs->gstate = (struct lfs_gstate){0};
  2787. lfs->gpending = (struct lfs_gstate){0};
  2788. lfs->gdelta = (struct lfs_gstate){0};
  2789. return 0;
  2790. cleanup:
  2791. lfs_deinit(lfs);
  2792. return err;
  2793. }
  2794. static int lfs_deinit(lfs_t *lfs) {
  2795. // free allocated memory
  2796. if (!lfs->cfg->read_buffer) {
  2797. lfs_free(lfs->rcache.buffer);
  2798. }
  2799. if (!lfs->cfg->prog_buffer) {
  2800. lfs_free(lfs->pcache.buffer);
  2801. }
  2802. if (!lfs->cfg->lookahead_buffer) {
  2803. lfs_free(lfs->free.buffer);
  2804. }
  2805. return 0;
  2806. }
  2807. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2808. int err = 0;
  2809. if (true) {
  2810. err = lfs_init(lfs, cfg);
  2811. if (err) {
  2812. return err;
  2813. }
  2814. // create free lookahead
  2815. memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
  2816. lfs->free.off = 0;
  2817. lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size,
  2818. lfs->cfg->block_count);
  2819. lfs->free.i = 0;
  2820. lfs_alloc_ack(lfs);
  2821. // create root dir
  2822. lfs_mdir_t root;
  2823. err = lfs_dir_alloc(lfs, &root);
  2824. if (err) {
  2825. goto cleanup;
  2826. }
  2827. // write one superblock
  2828. lfs_superblock_t superblock = {
  2829. .version = LFS_DISK_VERSION,
  2830. .block_size = lfs->cfg->block_size,
  2831. .block_count = lfs->cfg->block_count,
  2832. .name_max = lfs->name_max,
  2833. .file_max = lfs->file_max,
  2834. .attr_max = lfs->attr_max,
  2835. };
  2836. lfs_superblock_tole32(&superblock);
  2837. err = lfs_dir_commit(lfs, &root, LFS_MKATTRS(
  2838. {LFS_MKTAG(LFS_TYPE_CREATE, 0, 0), NULL},
  2839. {LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8), "littlefs"},
  2840. {LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
  2841. &superblock}));
  2842. if (err) {
  2843. goto cleanup;
  2844. }
  2845. // sanity check that fetch works
  2846. err = lfs_dir_fetch(lfs, &root, (const lfs_block_t[2]){0, 1});
  2847. if (err) {
  2848. goto cleanup;
  2849. }
  2850. }
  2851. cleanup:
  2852. lfs_deinit(lfs);
  2853. return err;
  2854. }
  2855. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  2856. int err = lfs_init(lfs, cfg);
  2857. if (err) {
  2858. return err;
  2859. }
  2860. // scan directory blocks for superblock and any global updates
  2861. lfs_mdir_t dir = {.tail = {0, 1}};
  2862. while (!lfs_pair_isnull(dir.tail)) {
  2863. // fetch next block in tail list
  2864. lfs_stag_t tag = lfs_dir_fetchmatch(lfs, &dir, dir.tail,
  2865. LFS_MKTAG(0x7ff, 0x3ff, 0),
  2866. LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8),
  2867. NULL,
  2868. lfs_dir_find_match, &(struct lfs_dir_find_match){
  2869. lfs, "littlefs", 8});
  2870. if (tag < 0) {
  2871. err = tag;
  2872. goto cleanup;
  2873. }
  2874. // has superblock?
  2875. if (tag && !lfs_tag_isdelete(tag)) {
  2876. // update root
  2877. lfs->root[0] = dir.pair[0];
  2878. lfs->root[1] = dir.pair[1];
  2879. // grab superblock
  2880. lfs_superblock_t superblock;
  2881. tag = lfs_dir_get(lfs, &dir, LFS_MKTAG(0x7ff, 0x3ff, 0),
  2882. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
  2883. &superblock);
  2884. if (tag < 0) {
  2885. err = tag;
  2886. goto cleanup;
  2887. }
  2888. lfs_superblock_fromle32(&superblock);
  2889. // check version
  2890. uint16_t major_version = (0xffff & (superblock.version >> 16));
  2891. uint16_t minor_version = (0xffff & (superblock.version >> 0));
  2892. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  2893. minor_version > LFS_DISK_VERSION_MINOR)) {
  2894. LFS_ERROR("Invalid version %"PRIu16".%"PRIu16,
  2895. major_version, minor_version);
  2896. err = LFS_ERR_INVAL;
  2897. goto cleanup;
  2898. }
  2899. // check superblock configuration
  2900. if (superblock.name_max) {
  2901. if (superblock.name_max > lfs->name_max) {
  2902. LFS_ERROR("Unsupported name_max (%"PRIu32" > %"PRIu32")",
  2903. superblock.name_max, lfs->name_max);
  2904. err = LFS_ERR_INVAL;
  2905. goto cleanup;
  2906. }
  2907. lfs->name_max = superblock.name_max;
  2908. }
  2909. if (superblock.file_max) {
  2910. if (superblock.file_max > lfs->file_max) {
  2911. LFS_ERROR("Unsupported file_max (%"PRIu32" > %"PRIu32")",
  2912. superblock.file_max, lfs->file_max);
  2913. err = LFS_ERR_INVAL;
  2914. goto cleanup;
  2915. }
  2916. lfs->file_max = superblock.file_max;
  2917. }
  2918. if (superblock.attr_max) {
  2919. if (superblock.attr_max > lfs->attr_max) {
  2920. LFS_ERROR("Unsupported attr_max (%"PRIu32" > %"PRIu32")",
  2921. superblock.attr_max, lfs->attr_max);
  2922. err = LFS_ERR_INVAL;
  2923. goto cleanup;
  2924. }
  2925. lfs->attr_max = superblock.attr_max;
  2926. }
  2927. }
  2928. // has gstate?
  2929. err = lfs_dir_getgstate(lfs, &dir, &lfs->gpending);
  2930. if (err) {
  2931. return err;
  2932. }
  2933. }
  2934. // found superblock?
  2935. if (lfs_pair_isnull(lfs->root)) {
  2936. err = LFS_ERR_INVAL;
  2937. goto cleanup;
  2938. }
  2939. // update littlefs with gstate
  2940. lfs->gpending.tag += !lfs_tag_isvalid(lfs->gpending.tag);
  2941. lfs->gstate = lfs->gpending;
  2942. if (lfs_gstate_hasmove(&lfs->gstate)) {
  2943. LFS_DEBUG("Found move %"PRIu32" %"PRIu32" %"PRIu16,
  2944. lfs->gstate.pair[0],
  2945. lfs->gstate.pair[1],
  2946. lfs_tag_id(lfs->gstate.tag));
  2947. }
  2948. // setup free lookahead
  2949. lfs->free.off = lfs->seed % lfs->cfg->block_size;
  2950. lfs->free.size = 0;
  2951. lfs->free.i = 0;
  2952. lfs_alloc_ack(lfs);
  2953. return 0;
  2954. cleanup:
  2955. lfs_unmount(lfs);
  2956. return err;
  2957. }
  2958. int lfs_unmount(lfs_t *lfs) {
  2959. return lfs_deinit(lfs);
  2960. }
  2961. /// Filesystem filesystem operations ///
  2962. int lfs_fs_traverse(lfs_t *lfs,
  2963. int (*cb)(void *data, lfs_block_t block), void *data) {
  2964. // iterate over metadata pairs
  2965. lfs_mdir_t dir = {.tail = {0, 1}};
  2966. while (!lfs_pair_isnull(dir.tail)) {
  2967. for (int i = 0; i < 2; i++) {
  2968. int err = cb(data, dir.tail[i]);
  2969. if (err) {
  2970. return err;
  2971. }
  2972. }
  2973. // iterate through ids in directory
  2974. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  2975. if (err) {
  2976. return err;
  2977. }
  2978. for (uint16_t id = 0; id < dir.count; id++) {
  2979. struct lfs_ctz ctz;
  2980. lfs_stag_t tag = lfs_dir_get(lfs, &dir, LFS_MKTAG(0x700, 0x3ff, 0),
  2981. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  2982. if (tag < 0) {
  2983. if (tag == LFS_ERR_NOENT) {
  2984. continue;
  2985. }
  2986. return tag;
  2987. }
  2988. lfs_ctz_fromle32(&ctz);
  2989. if (lfs_tag_type3(tag) == LFS_TYPE_CTZSTRUCT) {
  2990. err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
  2991. ctz.head, ctz.size, cb, data);
  2992. if (err) {
  2993. return err;
  2994. }
  2995. }
  2996. }
  2997. }
  2998. // iterate over any open files
  2999. for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
  3000. if (f->type != LFS_TYPE_REG) {
  3001. continue;
  3002. }
  3003. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  3004. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  3005. f->ctz.head, f->ctz.size, cb, data);
  3006. if (err) {
  3007. return err;
  3008. }
  3009. }
  3010. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  3011. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  3012. f->block, f->pos, cb, data);
  3013. if (err) {
  3014. return err;
  3015. }
  3016. }
  3017. }
  3018. return 0;
  3019. }
  3020. static int lfs_fs_pred(lfs_t *lfs,
  3021. const lfs_block_t pair[2], lfs_mdir_t *pdir) {
  3022. // iterate over all directory directory entries
  3023. pdir->tail[0] = 0;
  3024. pdir->tail[1] = 1;
  3025. while (!lfs_pair_isnull(pdir->tail)) {
  3026. if (lfs_pair_cmp(pdir->tail, pair) == 0) {
  3027. return 0;
  3028. }
  3029. int err = lfs_dir_fetch(lfs, pdir, pdir->tail);
  3030. if (err) {
  3031. return err;
  3032. }
  3033. }
  3034. return LFS_ERR_NOENT;
  3035. }
  3036. struct lfs_fs_parent_match {
  3037. lfs_t *lfs;
  3038. const lfs_block_t pair[2];
  3039. };
  3040. static int lfs_fs_parent_match(void *data,
  3041. lfs_tag_t tag, const void *buffer) {
  3042. struct lfs_fs_parent_match *find = data;
  3043. lfs_t *lfs = find->lfs;
  3044. const struct lfs_diskoff *disk = buffer;
  3045. (void)tag;
  3046. lfs_block_t child[2];
  3047. int err = lfs_bd_read(lfs,
  3048. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  3049. disk->block, disk->off, &child, sizeof(child));
  3050. if (err) {
  3051. return err;
  3052. }
  3053. lfs_pair_fromle32(child);
  3054. return (lfs_pair_cmp(child, find->pair) == 0) ? LFS_CMP_EQ : LFS_CMP_LT;
  3055. }
  3056. static lfs_stag_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t pair[2],
  3057. lfs_mdir_t *parent) {
  3058. // use fetchmatch with callback to find pairs
  3059. parent->tail[0] = 0;
  3060. parent->tail[1] = 1;
  3061. while (!lfs_pair_isnull(parent->tail)) {
  3062. lfs_stag_t tag = lfs_dir_fetchmatch(lfs, parent, parent->tail,
  3063. LFS_MKTAG(0x7ff, 0, 0x3ff),
  3064. LFS_MKTAG(LFS_TYPE_DIRSTRUCT, 0, 8),
  3065. NULL,
  3066. lfs_fs_parent_match, &(struct lfs_fs_parent_match){
  3067. lfs, {pair[0], pair[1]}});
  3068. if (tag && tag != LFS_ERR_NOENT) {
  3069. return tag;
  3070. }
  3071. }
  3072. return LFS_ERR_NOENT;
  3073. }
  3074. static int lfs_fs_relocate(lfs_t *lfs,
  3075. const lfs_block_t oldpair[2], lfs_block_t newpair[2]) {
  3076. // update internal root
  3077. if (lfs_pair_cmp(oldpair, lfs->root) == 0) {
  3078. LFS_DEBUG("Relocating root %"PRIu32" %"PRIu32,
  3079. newpair[0], newpair[1]);
  3080. lfs->root[0] = newpair[0];
  3081. lfs->root[1] = newpair[1];
  3082. }
  3083. // update internally tracked dirs
  3084. for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
  3085. if (lfs_pair_cmp(oldpair, d->m.pair) == 0) {
  3086. d->m.pair[0] = newpair[0];
  3087. d->m.pair[1] = newpair[1];
  3088. }
  3089. }
  3090. // find parent
  3091. lfs_mdir_t parent;
  3092. lfs_stag_t tag = lfs_fs_parent(lfs, oldpair, &parent);
  3093. if (tag < 0 && tag != LFS_ERR_NOENT) {
  3094. return tag;
  3095. }
  3096. if (tag != LFS_ERR_NOENT) {
  3097. // update disk, this creates a desync
  3098. lfs_fs_preporphans(lfs, +1);
  3099. lfs_pair_tole32(newpair);
  3100. int err = lfs_dir_commit(lfs, &parent, LFS_MKATTRS({tag, newpair}));
  3101. lfs_pair_fromle32(newpair);
  3102. if (err) {
  3103. return err;
  3104. }
  3105. // next step, clean up orphans
  3106. lfs_fs_preporphans(lfs, -1);
  3107. }
  3108. // find pred
  3109. int err = lfs_fs_pred(lfs, oldpair, &parent);
  3110. if (err && err != LFS_ERR_NOENT) {
  3111. return err;
  3112. }
  3113. // if we can't find dir, it must be new
  3114. if (err != LFS_ERR_NOENT) {
  3115. // replace bad pair, either we clean up desync, or no desync occured
  3116. lfs_pair_tole32(newpair);
  3117. err = lfs_dir_commit(lfs, &parent, LFS_MKATTRS(
  3118. {LFS_MKTAG(LFS_TYPE_TAIL + parent.split, 0x3ff, 8), newpair}));
  3119. lfs_pair_fromle32(newpair);
  3120. if (err) {
  3121. return err;
  3122. }
  3123. }
  3124. return 0;
  3125. }
  3126. static void lfs_fs_preporphans(lfs_t *lfs, int8_t orphans) {
  3127. lfs->gpending.tag += orphans;
  3128. lfs_gstate_xororphans(&lfs->gdelta, &lfs->gpending,
  3129. lfs_gstate_hasorphans(&lfs->gpending));
  3130. lfs_gstate_xororphans(&lfs->gpending, &lfs->gpending,
  3131. lfs_gstate_hasorphans(&lfs->gpending));
  3132. }
  3133. static void lfs_fs_prepmove(lfs_t *lfs,
  3134. uint16_t id, const lfs_block_t pair[2]) {
  3135. lfs_gstate_xormove(&lfs->gdelta, &lfs->gpending, id, pair);
  3136. lfs_gstate_xormove(&lfs->gpending, &lfs->gpending, id, pair);
  3137. }
  3138. static int lfs_fs_demove(lfs_t *lfs) {
  3139. if (!lfs_gstate_hasmove(&lfs->gstate)) {
  3140. return 0;
  3141. }
  3142. // Fix bad moves
  3143. LFS_DEBUG("Fixing move %"PRIu32" %"PRIu32" %"PRIu16,
  3144. lfs->gstate.pair[0],
  3145. lfs->gstate.pair[1],
  3146. lfs_tag_id(lfs->gstate.tag));
  3147. // fetch and delete the moved entry
  3148. lfs_mdir_t movedir;
  3149. int err = lfs_dir_fetch(lfs, &movedir, lfs->gstate.pair);
  3150. if (err) {
  3151. return err;
  3152. }
  3153. // rely on cancel logic inside commit
  3154. err = lfs_dir_commit(lfs, &movedir, NULL, 0);
  3155. if (err) {
  3156. return err;
  3157. }
  3158. return 0;
  3159. }
  3160. static int lfs_fs_deorphan(lfs_t *lfs) {
  3161. if (!lfs_gstate_hasorphans(&lfs->gstate)) {
  3162. return 0;
  3163. }
  3164. // Fix any orphans
  3165. lfs_mdir_t pdir = {.split = true};
  3166. lfs_mdir_t dir = {.tail = {0, 1}};
  3167. // iterate over all directory directory entries
  3168. while (!lfs_pair_isnull(dir.tail)) {
  3169. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  3170. if (err) {
  3171. return err;
  3172. }
  3173. // check head blocks for orphans
  3174. if (!pdir.split) {
  3175. // check if we have a parent
  3176. lfs_mdir_t parent;
  3177. lfs_stag_t tag = lfs_fs_parent(lfs, pdir.tail, &parent);
  3178. if (tag < 0 && tag != LFS_ERR_NOENT) {
  3179. return tag;
  3180. }
  3181. if (tag == LFS_ERR_NOENT) {
  3182. // we are an orphan
  3183. LFS_DEBUG("Fixing orphan %"PRIu32" %"PRIu32,
  3184. pdir.tail[0], pdir.tail[1]);
  3185. err = lfs_dir_drop(lfs, &pdir, &dir);
  3186. if (err) {
  3187. return err;
  3188. }
  3189. break;
  3190. }
  3191. lfs_block_t pair[2];
  3192. lfs_stag_t res = lfs_dir_get(lfs, &parent,
  3193. LFS_MKTAG(0x7ff, 0x3ff, 0), tag, pair);
  3194. if (res < 0) {
  3195. return res;
  3196. }
  3197. lfs_pair_fromle32(pair);
  3198. if (!lfs_pair_sync(pair, pdir.tail)) {
  3199. // we have desynced
  3200. LFS_DEBUG("Fixing half-orphan %"PRIu32" %"PRIu32,
  3201. pair[0], pair[1]);
  3202. lfs_pair_tole32(pair);
  3203. err = lfs_dir_commit(lfs, &pdir, LFS_MKATTRS(
  3204. {LFS_MKTAG(LFS_TYPE_SOFTTAIL, 0x3ff, 8), pair}));
  3205. lfs_pair_fromle32(pair);
  3206. if (err) {
  3207. return err;
  3208. }
  3209. break;
  3210. }
  3211. }
  3212. memcpy(&pdir, &dir, sizeof(pdir));
  3213. }
  3214. // mark orphans as fixed
  3215. lfs_fs_preporphans(lfs, -lfs_gstate_getorphans(&lfs->gstate));
  3216. lfs->gstate = lfs->gpending;
  3217. return 0;
  3218. }
  3219. static int lfs_fs_forceconsistency(lfs_t *lfs) {
  3220. int err = lfs_fs_demove(lfs);
  3221. if (err) {
  3222. return err;
  3223. }
  3224. err = lfs_fs_deorphan(lfs);
  3225. if (err) {
  3226. return err;
  3227. }
  3228. return 0;
  3229. }
  3230. static int lfs_fs_size_count(void *p, lfs_block_t block) {
  3231. (void)block;
  3232. lfs_size_t *size = p;
  3233. *size += 1;
  3234. return 0;
  3235. }
  3236. lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
  3237. lfs_size_t size = 0;
  3238. int err = lfs_fs_traverse(lfs, lfs_fs_size_count, &size);
  3239. if (err) {
  3240. return err;
  3241. }
  3242. return size;
  3243. }