lfs.c 99 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458
  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. while (size > 0) {
  39. if (pcache && block == pcache->block &&
  40. off >= pcache->off &&
  41. off < pcache->off + pcache->size) {
  42. // is already in pcache?
  43. lfs_size_t diff = lfs_min(size, pcache->size - (off-pcache->off));
  44. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  45. data += diff;
  46. off += diff;
  47. size -= diff;
  48. continue;
  49. }
  50. if (block == rcache->block &&
  51. off >= rcache->off &&
  52. off < rcache->off + rcache->size) {
  53. // is already in rcache?
  54. lfs_size_t diff = lfs_min(size, rcache->size - (off-rcache->off));
  55. if (pcache && block == pcache->block) {
  56. diff = lfs_min(diff, pcache->off - off);
  57. }
  58. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  59. data += diff;
  60. off += diff;
  61. size -= diff;
  62. continue;
  63. }
  64. if (size >= hint && off % lfs->cfg->read_size == 0 &&
  65. size >= lfs->cfg->read_size) {
  66. // bypass cache?
  67. lfs_size_t diff = size - (size % lfs->cfg->read_size);
  68. int err = lfs->cfg->read(lfs->cfg, block, off, data, diff);
  69. if (err) {
  70. return err;
  71. }
  72. data += diff;
  73. off += diff;
  74. size -= diff;
  75. continue;
  76. }
  77. // load to cache, first condition can no longer fail
  78. LFS_ASSERT(block < lfs->cfg->block_count);
  79. rcache->block = block;
  80. rcache->off = lfs_aligndown(off, lfs->cfg->prog_size);
  81. rcache->size = lfs_min(lfs_min(
  82. lfs_alignup(off+hint, lfs->cfg->prog_size),
  83. lfs->cfg->block_size) - rcache->off, lfs->cfg->cache_size);
  84. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  85. rcache->off, rcache->buffer, rcache->size);
  86. if (err) {
  87. return err;
  88. }
  89. }
  90. return 0;
  91. }
  92. static int lfs_bd_cmp(lfs_t *lfs,
  93. const lfs_cache_t *pcache, lfs_cache_t *rcache, lfs_size_t hint,
  94. lfs_block_t block, lfs_off_t off,
  95. const void *buffer, lfs_size_t size) {
  96. const uint8_t *data = buffer;
  97. for (lfs_off_t i = 0; i < size; i++) {
  98. uint8_t dat;
  99. int err = lfs_bd_read(lfs,
  100. pcache, rcache, hint-i,
  101. block, off+i, &dat, 1);
  102. if (err) {
  103. return err;
  104. }
  105. if (dat != data[i]) {
  106. return false;
  107. }
  108. }
  109. return true;
  110. }
  111. static int lfs_bd_flush(lfs_t *lfs,
  112. lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate) {
  113. if (pcache->block != 0xffffffff && pcache->block != 0xfffffffe) {
  114. LFS_ASSERT(pcache->block < lfs->cfg->block_count);
  115. lfs_size_t diff = lfs_alignup(pcache->size, lfs->cfg->prog_size);
  116. int err = lfs->cfg->prog(lfs->cfg, pcache->block,
  117. pcache->off, pcache->buffer, diff);
  118. if (err) {
  119. return err;
  120. }
  121. if (validate) {
  122. // check data on disk
  123. lfs_cache_drop(lfs, rcache);
  124. int res = lfs_bd_cmp(lfs,
  125. NULL, rcache, diff,
  126. pcache->block, pcache->off, pcache->buffer, diff);
  127. if (res < 0) {
  128. return res;
  129. }
  130. if (!res) {
  131. return LFS_ERR_CORRUPT;
  132. }
  133. }
  134. lfs_cache_zero(lfs, pcache);
  135. }
  136. return 0;
  137. }
  138. static int lfs_bd_sync(lfs_t *lfs,
  139. lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate) {
  140. lfs_cache_drop(lfs, rcache);
  141. int err = lfs_bd_flush(lfs, pcache, rcache, validate);
  142. if (err) {
  143. return err;
  144. }
  145. return lfs->cfg->sync(lfs->cfg);
  146. }
  147. static int lfs_bd_prog(lfs_t *lfs,
  148. lfs_cache_t *pcache, lfs_cache_t *rcache, bool validate,
  149. lfs_block_t block, lfs_off_t off,
  150. const void *buffer, lfs_size_t size) {
  151. const uint8_t *data = buffer;
  152. LFS_ASSERT(block != 0xffffffff);
  153. LFS_ASSERT(off + size <= lfs->cfg->block_size);
  154. while (size > 0) {
  155. if (block == pcache->block &&
  156. off >= pcache->off &&
  157. off < pcache->off + lfs->cfg->cache_size) {
  158. // already fits in pcache?
  159. lfs_size_t diff = lfs_min(size,
  160. lfs->cfg->cache_size - (off-pcache->off));
  161. memcpy(&pcache->buffer[off-pcache->off], data, diff);
  162. data += diff;
  163. off += diff;
  164. size -= diff;
  165. pcache->size = off - pcache->off;
  166. if (pcache->size == lfs->cfg->cache_size) {
  167. // eagerly flush out pcache if we fill up
  168. int err = lfs_bd_flush(lfs, pcache, rcache, validate);
  169. if (err) {
  170. return err;
  171. }
  172. }
  173. continue;
  174. }
  175. // pcache must have been flushed, either by programming and
  176. // entire block or manually flushing the pcache
  177. LFS_ASSERT(pcache->block == 0xffffffff);
  178. // prepare pcache, first condition can no longer fail
  179. pcache->block = block;
  180. pcache->off = lfs_aligndown(off, lfs->cfg->prog_size);
  181. pcache->size = 0;
  182. }
  183. return 0;
  184. }
  185. static int lfs_bd_erase(lfs_t *lfs, lfs_block_t block) {
  186. LFS_ASSERT(block < lfs->cfg->block_count);
  187. return lfs->cfg->erase(lfs->cfg, block);
  188. }
  189. /// Internal operations predeclared here ///
  190. static int lfs_fs_pred(lfs_t *lfs, const lfs_block_t dir[2],
  191. lfs_mdir_t *pdir);
  192. static int32_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  193. lfs_mdir_t *parent);
  194. static int lfs_fs_relocate(lfs_t *lfs,
  195. const lfs_block_t oldpair[2], lfs_block_t newpair[2]);
  196. static int lfs_fs_deorphan(lfs_t *lfs);
  197. static int lfs_fs_demove(lfs_t *lfs);
  198. static int lfs_fs_forceconsistency(lfs_t *lfs);
  199. static int lfs_deinit(lfs_t *lfs);
  200. /// Block allocator ///
  201. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  202. lfs_t *lfs = (lfs_t*)p;
  203. lfs_block_t off = ((block - lfs->free.off)
  204. + lfs->cfg->block_count) % lfs->cfg->block_count;
  205. if (off < lfs->free.size) {
  206. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  207. }
  208. return 0;
  209. }
  210. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  211. while (true) {
  212. while (lfs->free.i != lfs->free.size) {
  213. lfs_block_t off = lfs->free.i;
  214. lfs->free.i += 1;
  215. lfs->free.ack -= 1;
  216. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  217. // found a free block
  218. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  219. // eagerly find next off so an alloc ack can
  220. // discredit old lookahead blocks
  221. while (lfs->free.i != lfs->free.size &&
  222. (lfs->free.buffer[lfs->free.i / 32]
  223. & (1U << (lfs->free.i % 32)))) {
  224. lfs->free.i += 1;
  225. lfs->free.ack -= 1;
  226. }
  227. return 0;
  228. }
  229. }
  230. // check if we have looked at all blocks since last ack
  231. if (lfs->free.ack == 0) {
  232. LFS_WARN("No more free space %"PRIu32,
  233. lfs->free.i + lfs->free.off);
  234. return LFS_ERR_NOSPC;
  235. }
  236. lfs->free.off = (lfs->free.off + lfs->free.size)
  237. % lfs->cfg->block_count;
  238. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->free.ack);
  239. lfs->free.i = 0;
  240. // find mask of free blocks from tree
  241. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  242. int err = lfs_fs_traverse(lfs, lfs_alloc_lookahead, lfs);
  243. if (err) {
  244. return err;
  245. }
  246. }
  247. }
  248. static void lfs_alloc_ack(lfs_t *lfs) {
  249. lfs->free.ack = lfs->cfg->block_count;
  250. }
  251. /// Metadata pair and directory operations ///
  252. static inline void lfs_pair_swap(lfs_block_t pair[2]) {
  253. lfs_block_t t = pair[0];
  254. pair[0] = pair[1];
  255. pair[1] = t;
  256. }
  257. static inline bool lfs_pair_isnull(const lfs_block_t pair[2]) {
  258. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  259. }
  260. static inline int lfs_pair_cmp(
  261. const lfs_block_t paira[2],
  262. const lfs_block_t pairb[2]) {
  263. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  264. paira[0] == pairb[1] || paira[1] == pairb[0]);
  265. }
  266. static inline bool lfs_pair_sync(
  267. const lfs_block_t paira[2],
  268. const lfs_block_t pairb[2]) {
  269. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  270. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  271. }
  272. static inline void lfs_pair_fromle32(lfs_block_t pair[2]) {
  273. pair[0] = lfs_fromle32(pair[0]);
  274. pair[1] = lfs_fromle32(pair[1]);
  275. }
  276. static inline void lfs_pair_tole32(lfs_block_t pair[2]) {
  277. pair[0] = lfs_tole32(pair[0]);
  278. pair[1] = lfs_tole32(pair[1]);
  279. }
  280. static void lfs_ctz_fromle32(struct lfs_ctz *ctz) {
  281. ctz->head = lfs_fromle32(ctz->head);
  282. ctz->size = lfs_fromle32(ctz->size);
  283. }
  284. static void lfs_ctz_tole32(struct lfs_ctz *ctz) {
  285. ctz->head = lfs_tole32(ctz->head);
  286. ctz->size = lfs_tole32(ctz->size);
  287. }
  288. static inline void lfs_superblock_fromle32(lfs_superblock_t *superblock) {
  289. superblock->version = lfs_fromle32(superblock->version);
  290. superblock->block_size = lfs_fromle32(superblock->block_size);
  291. superblock->block_count = lfs_fromle32(superblock->block_count);
  292. superblock->inline_max = lfs_fromle32(superblock->inline_max);
  293. superblock->attr_max = lfs_fromle32(superblock->attr_max);
  294. superblock->name_max = lfs_fromle32(superblock->name_max);
  295. }
  296. static inline void lfs_superblock_tole32(lfs_superblock_t *superblock) {
  297. superblock->version = lfs_tole32(superblock->version);
  298. superblock->block_size = lfs_tole32(superblock->block_size);
  299. superblock->block_count = lfs_tole32(superblock->block_count);
  300. superblock->inline_max = lfs_tole32(superblock->inline_max);
  301. superblock->attr_max = lfs_tole32(superblock->attr_max);
  302. superblock->name_max = lfs_tole32(superblock->name_max);
  303. }
  304. /// Entry tag operations ///
  305. #define LFS_MKTAG(type, id, size) \
  306. (((uint32_t)(type) << 22) | ((uint32_t)(id) << 12) | (uint32_t)(size))
  307. #define LFS_MKATTR(type, id, buffer, size, next) \
  308. &(const lfs_mattr_t){LFS_MKTAG(type, id, size), (buffer), (next)}
  309. static inline bool lfs_tag_isvalid(uint32_t tag) {
  310. return !(tag & 0x80000000);
  311. }
  312. static inline bool lfs_tag_isuser(uint32_t tag) {
  313. return (tag & 0x40000000);
  314. }
  315. static inline uint16_t lfs_tag_type(uint32_t tag) {
  316. return (tag & 0x7fc00000) >> 22;
  317. }
  318. static inline uint16_t lfs_tag_subtype(uint32_t tag) {
  319. return (tag & 0x7c000000) >> 22;
  320. }
  321. static inline uint16_t lfs_tag_id(uint32_t tag) {
  322. return (tag & 0x003ff000) >> 12;
  323. }
  324. static inline lfs_size_t lfs_tag_size(uint32_t tag) {
  325. return tag & 0x00000fff;
  326. }
  327. // operations on set of globals
  328. static inline void lfs_global_xor(lfs_global_t *a, const lfs_global_t *b) {
  329. for (int i = 0; i < sizeof(lfs_global_t)/4; i++) {
  330. a->u32[i] ^= b->u32[i];
  331. }
  332. }
  333. static inline bool lfs_global_iszero(const lfs_global_t *a) {
  334. for (int i = 0; i < sizeof(lfs_global_t)/4; i++) {
  335. if (a->u32[i] != 0) {
  336. return false;
  337. }
  338. }
  339. return true;
  340. }
  341. static inline void lfs_global_zero(lfs_global_t *a) {
  342. memset(a, 0, sizeof(lfs_global_t));
  343. }
  344. static inline void lfs_global_fromle32(lfs_global_t *a) {
  345. lfs_pair_fromle32(a->l.movepair);
  346. a->l.moveid = lfs_fromle16(a->l.moveid);
  347. }
  348. static inline void lfs_global_tole32(lfs_global_t *a) {
  349. lfs_pair_tole32(a->l.movepair);
  350. a->l.moveid = lfs_tole16(a->l.moveid);
  351. }
  352. static inline void lfs_global_move(lfs_t *lfs,
  353. const lfs_block_t pair[2], uint16_t id) {
  354. lfs_global_t diff;
  355. lfs_global_zero(&diff);
  356. diff.l.movepair[0] ^= lfs->globals.g.movepair[0] ^ pair[0];
  357. diff.l.movepair[1] ^= lfs->globals.g.movepair[1] ^ pair[1];
  358. diff.l.moveid ^= lfs->globals.g.moveid ^ id;
  359. lfs_global_fromle32(&lfs->locals);
  360. lfs_global_xor(&lfs->locals, &diff);
  361. lfs_global_tole32(&lfs->locals);
  362. lfs_global_xor(&lfs->globals, &diff);
  363. }
  364. static inline void lfs_global_orphans(lfs_t *lfs, int8_t orphans) {
  365. lfs->locals.l.deorphaned ^= (lfs->globals.g.orphans == 0);
  366. lfs->locals.l.deorphaned ^= (lfs->globals.g.orphans + orphans == 0);
  367. lfs->globals.g.orphans += orphans;
  368. }
  369. // commit logic
  370. struct lfs_commit {
  371. lfs_block_t block;
  372. lfs_off_t off;
  373. uint32_t ptag;
  374. uint32_t crc;
  375. lfs_off_t begin;
  376. lfs_off_t end;
  377. };
  378. struct lfs_diskoff {
  379. lfs_block_t block;
  380. lfs_off_t off;
  381. };
  382. static int32_t lfs_commit_get(lfs_t *lfs, lfs_block_t block, lfs_off_t off,
  383. uint32_t tag, uint32_t getmask, uint32_t gettag, int32_t getdiff,
  384. void *buffer, bool stopatcommit) {
  385. // iterate over dir block backwards (for faster lookups)
  386. while (off >= 2*sizeof(tag)+lfs_tag_size(tag)) {
  387. off -= sizeof(tag)+lfs_tag_size(tag);
  388. if (lfs_tag_type(tag) == LFS_TYPE_CRC && stopatcommit) {
  389. break;
  390. } else if (lfs_tag_type(tag) == LFS_TYPE_DELETE) {
  391. if (lfs_tag_id(tag) <= lfs_tag_id(gettag + getdiff)) {
  392. getdiff += LFS_MKTAG(0, 1, 0);
  393. }
  394. } else if ((tag & getmask) == ((gettag + getdiff) & getmask)) {
  395. if (buffer) {
  396. lfs_size_t diff = lfs_min(
  397. lfs_tag_size(gettag), lfs_tag_size(tag));
  398. int err = lfs_bd_read(lfs,
  399. &lfs->pcache, &lfs->rcache, diff,
  400. block, off+sizeof(tag), buffer, diff);
  401. if (err) {
  402. return err;
  403. }
  404. memset((uint8_t*)buffer + diff, 0,
  405. lfs_tag_size(gettag) - diff);
  406. }
  407. return tag - getdiff;
  408. }
  409. uint32_t ntag;
  410. int err = lfs_bd_read(lfs,
  411. &lfs->pcache, &lfs->rcache, sizeof(ntag),
  412. block, off, &ntag, sizeof(ntag));
  413. if (err) {
  414. return err;
  415. }
  416. tag ^= lfs_fromle32(ntag);
  417. }
  418. return LFS_ERR_NOENT;
  419. }
  420. static int lfs_commit_attrs(lfs_t *lfs, struct lfs_commit *commit,
  421. uint16_t id, const struct lfs_attr *attrs);
  422. static int lfs_commit_move(lfs_t *lfs, struct lfs_commit *commit,
  423. uint32_t frommask, uint32_t fromtag, uint32_t tomask, uint32_t totag,
  424. const lfs_mdir_t *dir, const lfs_mattr_t *attrs);
  425. static int lfs_commit_attr(lfs_t *lfs, struct lfs_commit *commit,
  426. uint32_t tag, const void *buffer) {
  427. if (lfs_tag_subtype(tag) == LFS_FROM_MOVE) {
  428. // special case for moves
  429. return lfs_commit_move(lfs, commit,
  430. 0x003ff000, LFS_MKTAG(0, lfs_tag_size(tag), 0),
  431. 0x003ff000, LFS_MKTAG(0, lfs_tag_id(tag), 0),
  432. buffer, NULL);
  433. } else if (lfs_tag_subtype(tag) == LFS_FROM_ATTRS) {
  434. // special case for custom attributes
  435. return lfs_commit_attrs(lfs, commit,
  436. lfs_tag_id(tag), buffer);
  437. }
  438. // check if we fit
  439. lfs_size_t size = lfs_tag_size(tag);
  440. if (commit->off + sizeof(tag)+size > commit->end) {
  441. return LFS_ERR_NOSPC;
  442. }
  443. // write out tag
  444. uint32_t ntag = lfs_tole32((tag & 0x7fffffff) ^ commit->ptag);
  445. commit->crc = lfs_crc(commit->crc, &ntag, sizeof(ntag));
  446. int err = lfs_bd_prog(lfs,
  447. &lfs->pcache, &lfs->rcache, false,
  448. commit->block, commit->off, &ntag, sizeof(ntag));
  449. if (err) {
  450. return err;
  451. }
  452. commit->off += sizeof(ntag);
  453. if (!(tag & 0x80000000)) {
  454. // from memory
  455. commit->crc = lfs_crc(commit->crc, buffer, size);
  456. err = lfs_bd_prog(lfs,
  457. &lfs->pcache, &lfs->rcache, false,
  458. commit->block, commit->off, buffer, size);
  459. if (err) {
  460. return err;
  461. }
  462. } else {
  463. // from disk
  464. const struct lfs_diskoff *disk = buffer;
  465. for (lfs_off_t i = 0; i < size; i++) {
  466. // rely on caching to make this efficient
  467. uint8_t dat;
  468. err = lfs_bd_read(lfs,
  469. &lfs->pcache, &lfs->rcache, size-i,
  470. disk->block, disk->off+i, &dat, 1);
  471. if (err) {
  472. return err;
  473. }
  474. commit->crc = lfs_crc(commit->crc, &dat, 1);
  475. err = lfs_bd_prog(lfs,
  476. &lfs->pcache, &lfs->rcache, false,
  477. commit->block, commit->off+i, &dat, 1);
  478. if (err) {
  479. return err;
  480. }
  481. }
  482. }
  483. commit->off += size;
  484. commit->ptag = tag & 0x7fffffff;
  485. return 0;
  486. }
  487. static int lfs_commit_attrs(lfs_t *lfs, struct lfs_commit *commit,
  488. uint16_t id, const struct lfs_attr *attrs) {
  489. for (const struct lfs_attr *a = attrs; a; a = a->next) {
  490. int err = lfs_commit_attr(lfs, commit,
  491. LFS_MKTAG(0x100 | a->type, id, a->size), a->buffer);
  492. if (err) {
  493. return err;
  494. }
  495. }
  496. return 0;
  497. }
  498. static int lfs_commit_move(lfs_t *lfs, struct lfs_commit *commit,
  499. uint32_t frommask, uint32_t fromtag, uint32_t tomask, uint32_t totag,
  500. const lfs_mdir_t *dir, const lfs_mattr_t *attrs) {
  501. // iterate through list and commits, only committing unique entries
  502. lfs_off_t off = dir->off;
  503. uint32_t ntag = dir->etag;
  504. while (attrs || off > sizeof(uint32_t)) {
  505. struct lfs_diskoff disk;
  506. uint32_t tag;
  507. const void *buffer;
  508. if (attrs) {
  509. tag = attrs->tag;
  510. buffer = attrs->buffer;
  511. attrs = attrs->next;
  512. } else {
  513. LFS_ASSERT(off > sizeof(ntag)+lfs_tag_size(ntag));
  514. off -= sizeof(ntag)+lfs_tag_size(ntag);
  515. tag = ntag;
  516. buffer = &disk;
  517. disk.block = dir->pair[0];
  518. disk.off = off + sizeof(tag);
  519. int err = lfs_bd_read(lfs,
  520. &lfs->pcache, &lfs->rcache, sizeof(ntag),
  521. dir->pair[0], off, &ntag, sizeof(ntag));
  522. if (err) {
  523. return err;
  524. }
  525. ntag = lfs_fromle32(ntag);
  526. ntag ^= tag;
  527. tag |= 0x80000000;
  528. }
  529. if (lfs_tag_type(tag) == LFS_TYPE_DELETE &&
  530. lfs_tag_id(tag) <= lfs_tag_id(fromtag)) {
  531. // something was deleted, we need to move around it
  532. fromtag += LFS_MKTAG(0, 1, 0);
  533. } else if ((tag & frommask) == (fromtag & frommask)) {
  534. // check if type has already been committed
  535. int32_t res = lfs_commit_get(lfs, commit->block,
  536. commit->off, commit->ptag,
  537. lfs_tag_isuser(tag) ? 0x7ffff000 : 0x7c3ff000,
  538. (tag & ~tomask) | totag,
  539. 0, NULL, true);
  540. if (res < 0 && res != LFS_ERR_NOENT) {
  541. return res;
  542. }
  543. if (res == LFS_ERR_NOENT) {
  544. // update id and commit, as we are currently unique
  545. int err = lfs_commit_attr(lfs, commit,
  546. (tag & ~tomask) | totag,
  547. buffer);
  548. if (err) {
  549. return err;
  550. }
  551. }
  552. }
  553. }
  554. return 0;
  555. }
  556. static int lfs_commit_globals(lfs_t *lfs, struct lfs_commit *commit,
  557. lfs_global_t *locals) {
  558. if (lfs_global_iszero(&lfs->locals)) {
  559. return 0;
  560. }
  561. lfs_global_xor(locals, &lfs->locals);
  562. int err = lfs_commit_attr(lfs, commit,
  563. LFS_MKTAG(LFS_TYPE_GLOBALS + locals->l.deorphaned, 0x3ff, 10),
  564. locals);
  565. lfs_global_xor(locals, &lfs->locals);
  566. return err;
  567. }
  568. static int lfs_commit_crc(lfs_t *lfs, struct lfs_commit *commit) {
  569. // align to program units
  570. lfs_off_t off = lfs_alignup(commit->off + 2*sizeof(uint32_t),
  571. lfs->cfg->prog_size);
  572. // read erased state from next program unit
  573. uint32_t tag = 0;
  574. if (off < lfs->cfg->block_size) {
  575. int err = lfs_bd_read(lfs,
  576. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  577. commit->block, off, &tag, sizeof(tag));
  578. if (err) {
  579. return err;
  580. }
  581. }
  582. // build crc tag
  583. tag = lfs_fromle32(tag);
  584. tag = (0x80000000 & ~tag) |
  585. LFS_MKTAG(LFS_TYPE_CRC, 0x3ff,
  586. off - (commit->off+sizeof(uint32_t)));
  587. // write out crc
  588. uint32_t footer[2];
  589. footer[0] = lfs_tole32(tag ^ commit->ptag);
  590. commit->crc = lfs_crc(commit->crc, &footer[0], sizeof(footer[0]));
  591. footer[1] = lfs_tole32(commit->crc);
  592. int err = lfs_bd_prog(lfs,
  593. &lfs->pcache, &lfs->rcache, false,
  594. commit->block, commit->off, &footer, sizeof(footer));
  595. if (err) {
  596. return err;
  597. }
  598. commit->off += sizeof(tag)+lfs_tag_size(tag);
  599. commit->ptag = tag;
  600. // flush buffers
  601. err = lfs_bd_sync(lfs, &lfs->pcache, &lfs->rcache, false);
  602. if (err) {
  603. return err;
  604. }
  605. // successful commit, check checksum to make sure
  606. uint32_t crc = 0xffffffff;
  607. lfs_size_t size = commit->off - lfs_tag_size(tag) - commit->begin;
  608. for (lfs_off_t i = 0; i < size; i++) {
  609. // leave it up to caching to make this efficient
  610. uint8_t dat;
  611. err = lfs_bd_read(lfs,
  612. NULL, &lfs->rcache, size-i,
  613. commit->block, commit->begin+i, &dat, 1);
  614. if (err) {
  615. return err;
  616. }
  617. crc = lfs_crc(crc, &dat, 1);
  618. }
  619. if (err) {
  620. return err;
  621. }
  622. if (crc != commit->crc) {
  623. return LFS_ERR_CORRUPT;
  624. }
  625. return 0;
  626. }
  627. // internal dir operations
  628. static int lfs_dir_alloc(lfs_t *lfs, lfs_mdir_t *dir) {
  629. // allocate pair of dir blocks (backwards, so we write block 1 first)
  630. for (int i = 0; i < 2; i++) {
  631. int err = lfs_alloc(lfs, &dir->pair[(i+1)%2]);
  632. if (err) {
  633. return err;
  634. }
  635. }
  636. // rather than clobbering one of the blocks we just pretend
  637. // the revision may be valid
  638. int err = lfs_bd_read(lfs,
  639. &lfs->pcache, &lfs->rcache, sizeof(dir->rev),
  640. dir->pair[0], 0, &dir->rev, sizeof(dir->rev));
  641. if (err) {
  642. return err;
  643. }
  644. dir->rev = lfs_fromle32(dir->rev);
  645. if (err && err != LFS_ERR_CORRUPT) {
  646. return err;
  647. }
  648. // set defaults
  649. dir->off = sizeof(dir->rev);
  650. dir->etag = 0;
  651. dir->count = 0;
  652. dir->tail[0] = 0xffffffff;
  653. dir->tail[1] = 0xffffffff;
  654. dir->erased = false;
  655. dir->split = false;
  656. lfs_global_zero(&dir->locals);
  657. // don't write out yet, let caller take care of that
  658. return 0;
  659. }
  660. static int32_t lfs_dir_fetchmatch(lfs_t *lfs,
  661. lfs_mdir_t *dir, const lfs_block_t pair[2],
  662. uint32_t findmask, uint32_t findtag, const void *findbuffer) {
  663. dir->pair[0] = pair[0];
  664. dir->pair[1] = pair[1];
  665. int32_t foundtag = LFS_ERR_NOENT;
  666. // find the block with the most recent revision
  667. uint32_t rev[2];
  668. for (int i = 0; i < 2; i++) {
  669. int err = lfs_bd_read(lfs,
  670. &lfs->pcache, &lfs->rcache, sizeof(rev[i]),
  671. dir->pair[i], 0, &rev[i], sizeof(rev[i]));
  672. rev[i] = lfs_fromle32(rev[i]);
  673. if (err && err != LFS_ERR_CORRUPT) {
  674. return err;
  675. }
  676. if (err == LFS_ERR_CORRUPT) {
  677. rev[i] = rev[(i+1)%2] - 1;
  678. }
  679. }
  680. if (lfs_scmp(rev[1], rev[0]) > 0) {
  681. lfs_pair_swap(dir->pair);
  682. lfs_pair_swap(rev);
  683. }
  684. // load blocks and check crc
  685. for (int i = 0; i < 2; i++) {
  686. lfs_off_t off = sizeof(dir->rev);
  687. uint32_t ptag = 0;
  688. uint32_t crc = 0xffffffff;
  689. dir->rev = lfs_tole32(rev[0]);
  690. crc = lfs_crc(crc, &dir->rev, sizeof(dir->rev));
  691. dir->rev = lfs_fromle32(dir->rev);
  692. dir->off = 0;
  693. uint32_t tempfoundtag = foundtag;
  694. uint16_t tempcount = 0;
  695. lfs_block_t temptail[2] = {0xffffffff, 0xffffffff};
  696. bool tempsplit = false;
  697. lfs_global_t templocals;
  698. lfs_global_zero(&templocals);
  699. while (true) {
  700. // reached end of block
  701. if (off+sizeof(uint32_t) >= lfs->cfg->block_size) {
  702. dir->erased = false;
  703. break;
  704. }
  705. // extract next tag
  706. uint32_t tag;
  707. int err = lfs_bd_read(lfs,
  708. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  709. dir->pair[0], off, &tag, sizeof(tag));
  710. if (err) {
  711. if (err == LFS_ERR_CORRUPT) {
  712. // can't continue?
  713. dir->erased = false;
  714. break;
  715. }
  716. return err;
  717. }
  718. crc = lfs_crc(crc, &tag, sizeof(tag));
  719. tag = lfs_fromle32(tag) ^ ptag;
  720. // next commit not yet programmed
  721. if (lfs_tag_type(ptag) == LFS_TYPE_CRC && !lfs_tag_isvalid(tag)) {
  722. dir->erased = true;
  723. break;
  724. }
  725. // check we're in valid range
  726. if (off + sizeof(tag)+lfs_tag_size(tag) > lfs->cfg->block_size) {
  727. dir->erased = false;
  728. break;
  729. }
  730. if (lfs_tag_type(tag) == LFS_TYPE_CRC) {
  731. // check the crc attr
  732. uint32_t dcrc;
  733. err = lfs_bd_read(lfs,
  734. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  735. dir->pair[0], off+sizeof(tag), &dcrc, sizeof(dcrc));
  736. if (err) {
  737. if (err == LFS_ERR_CORRUPT) {
  738. dir->erased = false;
  739. break;
  740. }
  741. return err;
  742. }
  743. dcrc = lfs_fromle32(dcrc);
  744. if (crc != dcrc) {
  745. dir->erased = false;
  746. break;
  747. }
  748. foundtag = tempfoundtag;
  749. dir->off = off + sizeof(tag)+lfs_tag_size(tag);
  750. dir->etag = tag;
  751. dir->count = tempcount;
  752. dir->tail[0] = temptail[0];
  753. dir->tail[1] = temptail[1];
  754. dir->split = tempsplit;
  755. dir->locals = templocals;
  756. lfs->seed ^= crc;
  757. crc = 0xffffffff;
  758. } else {
  759. // crc the entry first, leaving it in the cache
  760. for (lfs_off_t j = 0; j < lfs_tag_size(tag); j++) {
  761. uint8_t dat;
  762. err = lfs_bd_read(lfs,
  763. NULL, &lfs->rcache, lfs->cfg->block_size,
  764. dir->pair[0], off+sizeof(tag)+j, &dat, 1);
  765. if (err) {
  766. if (err == LFS_ERR_CORRUPT) {
  767. dir->erased = false;
  768. break;
  769. }
  770. return err;
  771. }
  772. crc = lfs_crc(crc, &dat, 1);
  773. }
  774. // keep track of id count
  775. if (lfs_tag_id(tag) < 0x3ff && lfs_tag_id(tag) >= tempcount) {
  776. tempcount = lfs_tag_id(tag)+1;
  777. }
  778. // check for special tags
  779. if (lfs_tag_subtype(tag) == LFS_TYPE_TAIL) {
  780. tempsplit = (lfs_tag_type(tag) & 1);
  781. err = lfs_bd_read(lfs,
  782. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  783. dir->pair[0], off+sizeof(tag),
  784. &temptail, sizeof(temptail));
  785. if (err) {
  786. if (err == LFS_ERR_CORRUPT) {
  787. dir->erased = false;
  788. break;
  789. }
  790. }
  791. lfs_pair_fromle32(temptail);
  792. } else if (lfs_tag_subtype(tag) == LFS_TYPE_GLOBALS) {
  793. templocals.l.deorphaned = (lfs_tag_type(tag) & 1);
  794. err = lfs_bd_read(lfs,
  795. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  796. dir->pair[0], off+sizeof(tag),
  797. &templocals, 10);
  798. if (err) {
  799. if (err == LFS_ERR_CORRUPT) {
  800. dir->erased = false;
  801. break;
  802. }
  803. }
  804. } else if (lfs_tag_subtype(tag) == LFS_TYPE_DELETE) {
  805. LFS_ASSERT(tempcount > 0);
  806. tempcount -= 1;
  807. if (lfs_tag_id(tag) == lfs_tag_id(tempfoundtag)) {
  808. tempfoundtag = LFS_ERR_NOENT;
  809. } else if (lfs_tag_isvalid(tempfoundtag) &&
  810. lfs_tag_id(tag) < lfs_tag_id(tempfoundtag)) {
  811. tempfoundtag -= LFS_MKTAG(0, 1, 0);
  812. }
  813. } else if ((tag & findmask) == (findtag & findmask)) {
  814. // found a match?
  815. if (lfs_tag_type(findtag) == LFS_TYPE_DIRSTRUCT) {
  816. lfs_block_t child[2];
  817. err = lfs_bd_read(lfs,
  818. &lfs->pcache, &lfs->rcache,
  819. lfs->cfg->block_size,
  820. dir->pair[0], off+sizeof(tag),
  821. &child, sizeof(child));
  822. if (err < 0) {
  823. if (err == LFS_ERR_CORRUPT) {
  824. dir->erased = false;
  825. break;
  826. }
  827. return err;
  828. }
  829. lfs_pair_fromle32(child);
  830. if (lfs_pair_cmp(child,
  831. (const lfs_block_t *)findbuffer) == 0) {
  832. tempfoundtag = tag;
  833. }
  834. } else if (lfs_tag_type(findtag) == LFS_TYPE_NAME) {
  835. int res = lfs_bd_cmp(lfs,
  836. NULL, &lfs->rcache, lfs_tag_size(findtag),
  837. dir->pair[0], off+sizeof(tag),
  838. findbuffer, lfs_tag_size(findtag));
  839. if (res < 0) {
  840. if (res == LFS_ERR_CORRUPT) {
  841. dir->erased = false;
  842. break;
  843. }
  844. return res;
  845. }
  846. if (res) {
  847. tempfoundtag = tag;
  848. }
  849. } else {
  850. tempfoundtag = tag;
  851. }
  852. }
  853. }
  854. ptag = tag;
  855. off += sizeof(tag)+lfs_tag_size(tag);
  856. }
  857. // consider what we have good enough
  858. if (dir->off > 0) {
  859. // synthetic move
  860. if (lfs_pair_cmp(dir->pair, lfs->globals.g.movepair) == 0) {
  861. if (lfs->globals.g.moveid == lfs_tag_id(foundtag)) {
  862. foundtag = LFS_ERR_NOENT;
  863. } else if (lfs_tag_isvalid(foundtag) &&
  864. lfs->globals.g.moveid < lfs_tag_id(foundtag)) {
  865. foundtag -= LFS_MKTAG(0, 1, 0);
  866. }
  867. }
  868. return foundtag;
  869. }
  870. // failed, try the other crc?
  871. lfs_pair_swap(dir->pair);
  872. lfs_pair_swap(rev);
  873. }
  874. LFS_ERROR("Corrupted dir pair at %"PRIu32" %"PRIu32,
  875. dir->pair[0], dir->pair[1]);
  876. return LFS_ERR_CORRUPT;
  877. }
  878. static int lfs_dir_fetch(lfs_t *lfs,
  879. lfs_mdir_t *dir, const lfs_block_t pair[2]) {
  880. int32_t res = lfs_dir_fetchmatch(lfs, dir, pair,
  881. 0xffffffff, 0xffffffff, NULL);
  882. if (res < 0 && res != LFS_ERR_NOENT) {
  883. return res;
  884. }
  885. return 0;
  886. }
  887. static int32_t lfs_dir_find(lfs_t *lfs,
  888. lfs_mdir_t *dir, const lfs_block_t pair[2], bool fs,
  889. uint32_t findmask, uint32_t findtag, const void *findbuffer) {
  890. dir->split = true;
  891. dir->tail[0] = pair[0];
  892. dir->tail[1] = pair[1];
  893. while ((dir->split || fs) && !lfs_pair_isnull(dir->tail)) {
  894. int32_t tag = lfs_dir_fetchmatch(lfs, dir, dir->tail,
  895. findmask, findtag, findbuffer);
  896. if (tag != LFS_ERR_NOENT) {
  897. return tag;
  898. }
  899. }
  900. return LFS_ERR_NOENT;
  901. }
  902. static int32_t lfs_dir_get(lfs_t *lfs, lfs_mdir_t *dir,
  903. uint32_t getmask, uint32_t gettag, void *buffer) {
  904. int32_t getdiff = 0;
  905. if (lfs_pair_cmp(dir->pair, lfs->globals.g.movepair) == 0 &&
  906. lfs_tag_id(gettag) <= lfs->globals.g.moveid) {
  907. // synthetic moves
  908. getdiff = LFS_MKTAG(0, 1, 0);
  909. }
  910. return lfs_commit_get(lfs, dir->pair[0], dir->off, dir->etag,
  911. getmask, gettag, getdiff, buffer, false);
  912. }
  913. static int lfs_dir_compact(lfs_t *lfs,
  914. lfs_mdir_t *dir, const lfs_mattr_t *attrs,
  915. lfs_mdir_t *source, uint16_t begin, uint16_t end) {
  916. // save some state in case block is bad
  917. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  918. bool relocated = false;
  919. // There's nothing special about our global delta, so feed it back
  920. // into the global global delta
  921. lfs_global_xor(&lfs->locals, &dir->locals);
  922. lfs_global_zero(&dir->locals);
  923. while (true) {
  924. // last complete id
  925. dir->count = end - begin;
  926. int16_t ack = -1;
  927. bool exhausted = false;
  928. // increment revision count
  929. dir->rev += 1;
  930. if (lfs->cfg->block_cycles && dir->rev % lfs->cfg->block_cycles == 0) {
  931. if (lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) == 0) {
  932. // we're writing too much to the superblock, should we expand?
  933. lfs_ssize_t res = lfs_fs_size(lfs);
  934. if (res < 0) {
  935. return res;
  936. }
  937. // do we have enough space to expand?
  938. if (res < lfs->cfg->block_count/2) {
  939. LFS_DEBUG("Expanding superblock at rev %"PRIu32, dir->rev);
  940. exhausted = true;
  941. goto split;
  942. }
  943. } else {
  944. // we're writing too much, time to relocate
  945. exhausted = true;
  946. goto relocate;
  947. }
  948. }
  949. // erase block to write to
  950. int err = lfs_bd_erase(lfs, dir->pair[1]);
  951. if (err) {
  952. if (err == LFS_ERR_CORRUPT) {
  953. goto relocate;
  954. }
  955. return err;
  956. }
  957. // write out header
  958. uint32_t crc = 0xffffffff;
  959. uint32_t rev = lfs_tole32(dir->rev);
  960. crc = lfs_crc(crc, &rev, sizeof(rev));
  961. err = lfs_bd_prog(lfs,
  962. &lfs->pcache, &lfs->rcache, false,
  963. dir->pair[1], 0, &rev, sizeof(rev));
  964. if (err) {
  965. if (err == LFS_ERR_CORRUPT) {
  966. goto relocate;
  967. }
  968. return err;
  969. }
  970. // setup compaction
  971. struct lfs_commit commit = {
  972. .block = dir->pair[1],
  973. .off = sizeof(dir->rev),
  974. .crc = crc,
  975. .ptag = 0,
  976. // space is complicated, we need room for tail, crc, globals,
  977. // and we cap at half a block to give room for metadata updates
  978. .begin = 0,
  979. .end = lfs_min(
  980. lfs_alignup(lfs->cfg->block_size/2, lfs->cfg->prog_size),
  981. lfs->cfg->block_size - 34),
  982. };
  983. // commit with a move
  984. for (uint16_t id = begin; id < end; id++) {
  985. err = lfs_commit_move(lfs, &commit,
  986. 0x003ff000, LFS_MKTAG(0, id, 0),
  987. 0x003ff000, LFS_MKTAG(0, id - begin, 0),
  988. source, attrs);
  989. if (err) {
  990. if (err == LFS_ERR_NOSPC) {
  991. goto split;
  992. } else if (err == LFS_ERR_CORRUPT) {
  993. goto relocate;
  994. }
  995. return err;
  996. }
  997. ack = id;
  998. }
  999. // reopen reserved space at the end
  1000. commit.end = lfs->cfg->block_size - 8;
  1001. if (lfs_pair_cmp(dir->pair, (const lfs_block_t[2]){0, 1}) == 0) {
  1002. // move over (duplicate) superblock if we are root
  1003. err = lfs_commit_move(lfs, &commit,
  1004. 0x7c000000, LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 0),
  1005. 0x7ffff000, LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 0),
  1006. source, attrs);
  1007. if (err) {
  1008. if (err == LFS_ERR_CORRUPT) {
  1009. goto relocate;
  1010. }
  1011. return err;
  1012. }
  1013. }
  1014. if (!relocated) {
  1015. // commit any globals, unless we're relocating, in which case our
  1016. // parent will steal our globals
  1017. err = lfs_commit_globals(lfs, &commit, &dir->locals);
  1018. if (err) {
  1019. if (err == LFS_ERR_CORRUPT) {
  1020. goto relocate;
  1021. }
  1022. return err;
  1023. }
  1024. }
  1025. if (!lfs_pair_isnull(dir->tail)) {
  1026. // commit tail, which may be new after last size check
  1027. lfs_pair_tole32(dir->tail);
  1028. err = lfs_commit_attr(lfs, &commit,
  1029. LFS_MKTAG(LFS_TYPE_TAIL + dir->split,
  1030. 0x3ff, sizeof(dir->tail)), dir->tail);
  1031. lfs_pair_fromle32(dir->tail);
  1032. if (err) {
  1033. if (err == LFS_ERR_CORRUPT) {
  1034. goto relocate;
  1035. }
  1036. return err;
  1037. }
  1038. }
  1039. err = lfs_commit_crc(lfs, &commit);
  1040. if (err) {
  1041. if (err == LFS_ERR_CORRUPT) {
  1042. goto relocate;
  1043. }
  1044. return err;
  1045. }
  1046. // successful compaction, swap dir pair to indicate most recent
  1047. lfs_pair_swap(dir->pair);
  1048. dir->off = commit.off;
  1049. dir->etag = commit.ptag;
  1050. dir->erased = true;
  1051. break;
  1052. split:
  1053. // commit no longer fits, need to split dir,
  1054. // drop caches and create tail
  1055. lfs_cache_drop(lfs, &lfs->pcache);
  1056. if (!exhausted && ack < 0) {
  1057. // If we can't fit in this block, we won't fit in next block
  1058. return LFS_ERR_NOSPC;
  1059. }
  1060. lfs_mdir_t tail;
  1061. err = lfs_dir_alloc(lfs, &tail);
  1062. if (err) {
  1063. return err;
  1064. }
  1065. if (exhausted) {
  1066. lfs->root[0] = tail.pair[0];
  1067. lfs->root[1] = tail.pair[1];
  1068. }
  1069. tail.split = dir->split;
  1070. tail.tail[0] = dir->tail[0];
  1071. tail.tail[1] = dir->tail[1];
  1072. err = lfs_dir_compact(lfs, &tail, attrs, source, ack+1, end);
  1073. if (err) {
  1074. return err;
  1075. }
  1076. end = ack+1;
  1077. dir->tail[0] = tail.pair[0];
  1078. dir->tail[1] = tail.pair[1];
  1079. dir->split = true;
  1080. continue;
  1081. relocate:
  1082. // commit was corrupted, drop caches and prepare to relocate block
  1083. relocated = true;
  1084. lfs_cache_drop(lfs, &lfs->pcache);
  1085. if (!exhausted) {
  1086. LFS_DEBUG("Bad block at %"PRIu32, dir->pair[1]);
  1087. }
  1088. // can't relocate superblock, filesystem is now frozen
  1089. if (lfs_pair_cmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  1090. LFS_WARN("Superblock %"PRIu32" has become unwritable", oldpair[1]);
  1091. return LFS_ERR_NOSPC;
  1092. }
  1093. // relocate half of pair
  1094. err = lfs_alloc(lfs, &dir->pair[1]);
  1095. if (err && (err != LFS_ERR_NOSPC && !exhausted)) {
  1096. return err;
  1097. }
  1098. continue;
  1099. }
  1100. if (!relocated) {
  1101. // successful commit, update globals
  1102. lfs_global_xor(&dir->locals, &lfs->locals);
  1103. lfs_global_zero(&lfs->locals);
  1104. } else {
  1105. // update references if we relocated
  1106. LFS_DEBUG("Relocating %"PRIu32" %"PRIu32" to %"PRIu32" %"PRIu32,
  1107. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  1108. int err = lfs_fs_relocate(lfs, oldpair, dir->pair);
  1109. if (err) {
  1110. return err;
  1111. }
  1112. }
  1113. return 0;
  1114. }
  1115. static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
  1116. const lfs_mattr_t *attrs) {
  1117. lfs_mattr_t cancelattr;
  1118. lfs_global_t canceldiff;
  1119. lfs_global_zero(&canceldiff);
  1120. if (lfs_pair_cmp(dir->pair, lfs->globals.g.movepair) == 0) {
  1121. // Wait, we have the move? Just cancel this out here
  1122. // We need to, or else the move can become outdated
  1123. canceldiff.l.movepair[0] ^= lfs->globals.g.movepair[0] ^ 0xffffffff;
  1124. canceldiff.l.movepair[1] ^= lfs->globals.g.movepair[1] ^ 0xffffffff;
  1125. canceldiff.l.moveid ^= lfs->globals.g.moveid ^ 0x3ff;
  1126. lfs_global_fromle32(&lfs->locals);
  1127. lfs_global_xor(&lfs->locals, &canceldiff);
  1128. lfs_global_tole32(&lfs->locals);
  1129. cancelattr.tag = LFS_MKTAG(LFS_TYPE_DELETE, lfs->globals.l.moveid, 0);
  1130. cancelattr.next = attrs;
  1131. attrs = &cancelattr;
  1132. }
  1133. // calculate new directory size
  1134. uint32_t deletetag = 0xffffffff;
  1135. for (const lfs_mattr_t *a = attrs; a; a = a->next) {
  1136. if (lfs_tag_id(a->tag) < 0x3ff && lfs_tag_id(a->tag) >= dir->count) {
  1137. dir->count = lfs_tag_id(a->tag)+1;
  1138. }
  1139. if (lfs_tag_type(a->tag) == LFS_TYPE_DELETE) {
  1140. LFS_ASSERT(dir->count > 0);
  1141. dir->count -= 1;
  1142. deletetag = a->tag;
  1143. if (dir->count == 0) {
  1144. // should we actually drop the directory block?
  1145. lfs_mdir_t pdir;
  1146. int err = lfs_fs_pred(lfs, dir->pair, &pdir);
  1147. if (err && err != LFS_ERR_NOENT) {
  1148. return err;
  1149. }
  1150. if (err != LFS_ERR_NOENT && pdir.split) {
  1151. // steal tail and global state
  1152. pdir.split = dir->split;
  1153. pdir.tail[0] = dir->tail[0];
  1154. pdir.tail[1] = dir->tail[1];
  1155. lfs_global_xor(&lfs->locals, &dir->locals);
  1156. return lfs_dir_commit(lfs, &pdir,
  1157. LFS_MKATTR(LFS_TYPE_TAIL + pdir.split, 0x3ff,
  1158. pdir.tail, sizeof(pdir.tail),
  1159. NULL));
  1160. }
  1161. }
  1162. }
  1163. }
  1164. while (true) {
  1165. if (!dir->erased) {
  1166. goto compact;
  1167. }
  1168. // try to commit
  1169. struct lfs_commit commit = {
  1170. .block = dir->pair[0],
  1171. .off = dir->off,
  1172. .crc = 0xffffffff,
  1173. .ptag = dir->etag,
  1174. .begin = dir->off,
  1175. .end = lfs->cfg->block_size - 8,
  1176. };
  1177. for (const lfs_mattr_t *a = attrs; a; a = a->next) {
  1178. if (lfs_tag_type(a->tag) != LFS_TYPE_DELETE) {
  1179. lfs_pair_tole32(dir->tail);
  1180. int err = lfs_commit_attr(lfs, &commit, a->tag, a->buffer);
  1181. lfs_pair_fromle32(dir->tail);
  1182. if (err) {
  1183. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1184. goto compact;
  1185. }
  1186. return err;
  1187. }
  1188. }
  1189. }
  1190. if (lfs_tag_isvalid(deletetag)) {
  1191. // special case for deletes, since order matters
  1192. int err = lfs_commit_attr(lfs, &commit, deletetag, NULL);
  1193. if (err) {
  1194. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1195. goto compact;
  1196. }
  1197. return err;
  1198. }
  1199. }
  1200. int err = lfs_commit_globals(lfs, &commit, &dir->locals);
  1201. if (err) {
  1202. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1203. goto compact;
  1204. }
  1205. return err;
  1206. }
  1207. err = lfs_commit_crc(lfs, &commit);
  1208. if (err) {
  1209. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1210. goto compact;
  1211. }
  1212. return err;
  1213. }
  1214. // successful commit, update dir
  1215. dir->off = commit.off;
  1216. dir->etag = commit.ptag;
  1217. // successful commit, update globals
  1218. lfs_global_xor(&dir->locals, &lfs->locals);
  1219. lfs_global_zero(&lfs->locals);
  1220. break;
  1221. compact:
  1222. // fall back to compaction
  1223. lfs_cache_drop(lfs, &lfs->pcache);
  1224. err = lfs_dir_compact(lfs, dir, attrs, dir, 0, dir->count);
  1225. if (err) {
  1226. return err;
  1227. }
  1228. break;
  1229. }
  1230. // update globals that are affected
  1231. lfs_global_xor(&lfs->globals, &canceldiff);
  1232. // update any directories that are affected
  1233. lfs_mdir_t copy = *dir;
  1234. // two passes, once for things that aren't us, and one
  1235. // for things that are
  1236. for (lfs_mlist_t *d = lfs->mlist; d; d = d->next) {
  1237. if (lfs_pair_cmp(d->m.pair, copy.pair) == 0) {
  1238. d->m = *dir;
  1239. if (d->id == lfs_tag_id(deletetag)) {
  1240. d->m.pair[0] = 0xffffffff;
  1241. d->m.pair[1] = 0xffffffff;
  1242. } else if (d->id > lfs_tag_id(deletetag)) {
  1243. d->id -= 1;
  1244. if (d->type == LFS_TYPE_DIR) {
  1245. ((lfs_dir_t*)d)->pos -= 1;
  1246. }
  1247. }
  1248. while (d->id >= d->m.count && d->m.split) {
  1249. // we split and id is on tail now
  1250. d->id -= d->m.count;
  1251. int err = lfs_dir_fetch(lfs, &d->m, d->m.tail);
  1252. if (err) {
  1253. return err;
  1254. }
  1255. }
  1256. }
  1257. }
  1258. return 0;
  1259. }
  1260. static int32_t lfs_dir_lookup(lfs_t *lfs, lfs_mdir_t *dir, const char **path) {
  1261. // we reduce path to a single name if we can find it
  1262. const char *name = *path;
  1263. *path = NULL;
  1264. // default to root dir
  1265. int32_t tag = LFS_MKTAG(LFS_TYPE_DIR, 0x3ff, 0);
  1266. lfs_block_t pair[2] = {lfs->root[0], lfs->root[1]};
  1267. while (true) {
  1268. nextname:
  1269. // skip slashes
  1270. name += strspn(name, "/");
  1271. lfs_size_t namelen = strcspn(name, "/");
  1272. // skip '.' and root '..'
  1273. if ((namelen == 1 && memcmp(name, ".", 1) == 0) ||
  1274. (namelen == 2 && memcmp(name, "..", 2) == 0)) {
  1275. name += namelen;
  1276. goto nextname;
  1277. }
  1278. // skip if matched by '..' in name
  1279. const char *suffix = name + namelen;
  1280. lfs_size_t sufflen;
  1281. int depth = 1;
  1282. while (true) {
  1283. suffix += strspn(suffix, "/");
  1284. sufflen = strcspn(suffix, "/");
  1285. if (sufflen == 0) {
  1286. break;
  1287. }
  1288. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  1289. depth -= 1;
  1290. if (depth == 0) {
  1291. name = suffix + sufflen;
  1292. goto nextname;
  1293. }
  1294. } else {
  1295. depth += 1;
  1296. }
  1297. suffix += sufflen;
  1298. }
  1299. // found path
  1300. if (name[0] == '\0') {
  1301. return tag;
  1302. }
  1303. // update what we've found if path is only a name
  1304. if (strchr(name, '/') == NULL) {
  1305. *path = name;
  1306. }
  1307. // only continue if we hit a directory
  1308. if (lfs_tag_type(tag) != LFS_TYPE_DIR) {
  1309. return LFS_ERR_NOTDIR;
  1310. }
  1311. // grab the entry data
  1312. if (lfs_tag_id(tag) != 0x3ff) {
  1313. int32_t res = lfs_dir_get(lfs, dir, 0x7c3ff000,
  1314. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  1315. if (res < 0) {
  1316. return res;
  1317. }
  1318. lfs_pair_fromle32(pair);
  1319. }
  1320. // find entry matching name
  1321. tag = lfs_dir_find(lfs, dir, pair, false, 0x7c000fff,
  1322. LFS_MKTAG(LFS_TYPE_NAME, 0, namelen), name);
  1323. if (tag < 0) {
  1324. return tag;
  1325. }
  1326. // to next name
  1327. name += namelen;
  1328. }
  1329. }
  1330. static int lfs_dir_getinfo(lfs_t *lfs, lfs_mdir_t *dir,
  1331. uint16_t id, struct lfs_info *info) {
  1332. if (id == 0x3ff) {
  1333. // special case for root
  1334. strcpy(info->name, "/");
  1335. info->type = LFS_TYPE_DIR;
  1336. return 0;
  1337. }
  1338. int32_t tag = lfs_dir_get(lfs, dir, 0x7c3ff000,
  1339. LFS_MKTAG(LFS_TYPE_NAME, id, lfs->name_max+1), info->name);
  1340. if (tag < 0) {
  1341. return tag;
  1342. }
  1343. info->type = lfs_tag_type(tag);
  1344. struct lfs_ctz ctz;
  1345. tag = lfs_dir_get(lfs, dir, 0x7c3ff000,
  1346. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  1347. if (tag < 0) {
  1348. return tag;
  1349. }
  1350. lfs_ctz_fromle32(&ctz);
  1351. if (lfs_tag_type(tag) == LFS_TYPE_CTZSTRUCT) {
  1352. info->size = ctz.size;
  1353. } else if (lfs_tag_type(tag) == LFS_TYPE_INLINESTRUCT) {
  1354. info->size = lfs_tag_size(tag);
  1355. }
  1356. return 0;
  1357. }
  1358. /// Top level directory operations ///
  1359. int lfs_mkdir(lfs_t *lfs, const char *path) {
  1360. // deorphan if we haven't yet, needed at most once after poweron
  1361. int err = lfs_fs_forceconsistency(lfs);
  1362. if (err) {
  1363. return err;
  1364. }
  1365. lfs_mdir_t cwd;
  1366. int32_t res = lfs_dir_lookup(lfs, &cwd, &path);
  1367. if (!(res == LFS_ERR_NOENT && path)) {
  1368. return (res < 0) ? res : LFS_ERR_EXIST;
  1369. }
  1370. // check that name fits
  1371. lfs_size_t nlen = strlen(path);
  1372. if (nlen > lfs->name_max) {
  1373. return LFS_ERR_NAMETOOLONG;
  1374. }
  1375. // build up new directory
  1376. lfs_alloc_ack(lfs);
  1377. lfs_mdir_t dir;
  1378. err = lfs_dir_alloc(lfs, &dir);
  1379. if (err) {
  1380. return err;
  1381. }
  1382. dir.tail[0] = cwd.tail[0];
  1383. dir.tail[1] = cwd.tail[1];
  1384. err = lfs_dir_commit(lfs, &dir, NULL);
  1385. if (err) {
  1386. return err;
  1387. }
  1388. // get next slot and commit
  1389. uint16_t id = cwd.count;
  1390. cwd.tail[0] = dir.pair[0];
  1391. cwd.tail[1] = dir.pair[1];
  1392. lfs_pair_tole32(dir.pair);
  1393. err = lfs_dir_commit(lfs, &cwd,
  1394. LFS_MKATTR(LFS_TYPE_DIR, id, path, nlen,
  1395. LFS_MKATTR(LFS_TYPE_DIRSTRUCT, id, dir.pair, sizeof(dir.pair),
  1396. LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x3ff, cwd.tail, sizeof(cwd.tail),
  1397. NULL))));
  1398. lfs_pair_fromle32(dir.pair);
  1399. if (err) {
  1400. return err;
  1401. }
  1402. return 0;
  1403. }
  1404. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1405. int32_t tag = lfs_dir_lookup(lfs, &dir->m, &path);
  1406. if (tag < 0) {
  1407. return tag;
  1408. }
  1409. if (lfs_tag_type(tag) != LFS_TYPE_DIR) {
  1410. return LFS_ERR_NOTDIR;
  1411. }
  1412. lfs_block_t pair[2];
  1413. if (lfs_tag_id(tag) == 0x3ff) {
  1414. // handle root dir separately
  1415. pair[0] = lfs->root[0];
  1416. pair[1] = lfs->root[1];
  1417. } else {
  1418. // get dir pair from parent
  1419. int32_t res = lfs_dir_get(lfs, &dir->m, 0x7c3ff000,
  1420. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  1421. if (res < 0) {
  1422. return res;
  1423. }
  1424. lfs_pair_fromle32(pair);
  1425. }
  1426. // fetch first pair
  1427. int err = lfs_dir_fetch(lfs, &dir->m, pair);
  1428. if (err) {
  1429. return err;
  1430. }
  1431. // setup entry
  1432. dir->head[0] = dir->m.pair[0];
  1433. dir->head[1] = dir->m.pair[1];
  1434. dir->id = 0;
  1435. dir->pos = 0;
  1436. // add to list of mdirs
  1437. dir->type = LFS_TYPE_DIR;
  1438. dir->next = (lfs_dir_t*)lfs->mlist;
  1439. lfs->mlist = (lfs_mlist_t*)dir;
  1440. return 0;
  1441. }
  1442. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1443. // remove from list of mdirs
  1444. for (lfs_mlist_t **p = &lfs->mlist; *p; p = &(*p)->next) {
  1445. if (*p == (lfs_mlist_t*)dir) {
  1446. *p = (*p)->next;
  1447. break;
  1448. }
  1449. }
  1450. return 0;
  1451. }
  1452. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1453. memset(info, 0, sizeof(*info));
  1454. // special offset for '.' and '..'
  1455. if (dir->pos == 0) {
  1456. info->type = LFS_TYPE_DIR;
  1457. strcpy(info->name, ".");
  1458. dir->pos += 1;
  1459. return 1;
  1460. } else if (dir->pos == 1) {
  1461. info->type = LFS_TYPE_DIR;
  1462. strcpy(info->name, "..");
  1463. dir->pos += 1;
  1464. return 1;
  1465. }
  1466. while (true) {
  1467. if (dir->id == dir->m.count) {
  1468. if (!dir->m.split) {
  1469. return false;
  1470. }
  1471. int err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1472. if (err) {
  1473. return err;
  1474. }
  1475. dir->id = 0;
  1476. }
  1477. int err = lfs_dir_getinfo(lfs, &dir->m, dir->id, info);
  1478. if (err && err != LFS_ERR_NOENT) {
  1479. return err;
  1480. }
  1481. dir->id += 1;
  1482. if (err != LFS_ERR_NOENT) {
  1483. break;
  1484. }
  1485. }
  1486. dir->pos += 1;
  1487. return true;
  1488. }
  1489. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1490. // simply walk from head dir
  1491. int err = lfs_dir_rewind(lfs, dir);
  1492. if (err) {
  1493. return err;
  1494. }
  1495. // first two for ./..
  1496. dir->pos = lfs_min(2, off);
  1497. off -= dir->pos;
  1498. while (off != 0) {
  1499. dir->id = lfs_min(dir->m.count, off);
  1500. dir->pos += dir->id;
  1501. off -= dir->id;
  1502. if (dir->id == dir->m.count) {
  1503. if (!dir->m.split) {
  1504. return LFS_ERR_INVAL;
  1505. }
  1506. err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1507. if (err) {
  1508. return err;
  1509. }
  1510. }
  1511. }
  1512. return 0;
  1513. }
  1514. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1515. (void)lfs;
  1516. return dir->pos;
  1517. }
  1518. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1519. // reload the head dir
  1520. int err = lfs_dir_fetch(lfs, &dir->m, dir->head);
  1521. if (err) {
  1522. return err;
  1523. }
  1524. dir->m.pair[0] = dir->head[0];
  1525. dir->m.pair[1] = dir->head[1];
  1526. dir->id = 0;
  1527. dir->pos = 0;
  1528. return 0;
  1529. }
  1530. /// File index list operations ///
  1531. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1532. lfs_off_t size = *off;
  1533. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1534. lfs_off_t i = size / b;
  1535. if (i == 0) {
  1536. return 0;
  1537. }
  1538. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1539. *off = size - b*i - 4*lfs_popc(i);
  1540. return i;
  1541. }
  1542. static int lfs_ctz_find(lfs_t *lfs,
  1543. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1544. lfs_block_t head, lfs_size_t size,
  1545. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1546. if (size == 0) {
  1547. *block = 0xffffffff;
  1548. *off = 0;
  1549. return 0;
  1550. }
  1551. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1552. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1553. while (current > target) {
  1554. lfs_size_t skip = lfs_min(
  1555. lfs_npw2(current-target+1) - 1,
  1556. lfs_ctz(current));
  1557. int err = lfs_bd_read(lfs,
  1558. pcache, rcache, sizeof(head),
  1559. head, 4*skip, &head, sizeof(head));
  1560. head = lfs_fromle32(head);
  1561. if (err) {
  1562. return err;
  1563. }
  1564. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1565. current -= 1 << skip;
  1566. }
  1567. *block = head;
  1568. *off = pos;
  1569. return 0;
  1570. }
  1571. static int lfs_ctz_extend(lfs_t *lfs,
  1572. lfs_cache_t *pcache, lfs_cache_t *rcache,
  1573. lfs_block_t head, lfs_size_t size,
  1574. lfs_block_t *block, lfs_off_t *off) {
  1575. while (true) {
  1576. // go ahead and grab a block
  1577. lfs_block_t nblock;
  1578. int err = lfs_alloc(lfs, &nblock);
  1579. if (err) {
  1580. return err;
  1581. }
  1582. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1583. err = lfs_bd_erase(lfs, nblock);
  1584. if (err) {
  1585. if (err == LFS_ERR_CORRUPT) {
  1586. goto relocate;
  1587. }
  1588. return err;
  1589. }
  1590. if (size == 0) {
  1591. *block = nblock;
  1592. *off = 0;
  1593. return 0;
  1594. }
  1595. size -= 1;
  1596. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1597. size += 1;
  1598. // just copy out the last block if it is incomplete
  1599. if (size != lfs->cfg->block_size) {
  1600. for (lfs_off_t i = 0; i < size; i++) {
  1601. uint8_t data;
  1602. err = lfs_bd_read(lfs,
  1603. NULL, rcache, size-i,
  1604. head, i, &data, 1);
  1605. if (err) {
  1606. return err;
  1607. }
  1608. err = lfs_bd_prog(lfs,
  1609. pcache, rcache, true,
  1610. nblock, i, &data, 1);
  1611. if (err) {
  1612. if (err == LFS_ERR_CORRUPT) {
  1613. goto relocate;
  1614. }
  1615. return err;
  1616. }
  1617. }
  1618. *block = nblock;
  1619. *off = size;
  1620. return 0;
  1621. }
  1622. // append block
  1623. index += 1;
  1624. lfs_size_t skips = lfs_ctz(index) + 1;
  1625. for (lfs_off_t i = 0; i < skips; i++) {
  1626. head = lfs_tole32(head);
  1627. err = lfs_bd_prog(lfs, pcache, rcache, true,
  1628. nblock, 4*i, &head, 4);
  1629. head = lfs_fromle32(head);
  1630. if (err) {
  1631. if (err == LFS_ERR_CORRUPT) {
  1632. goto relocate;
  1633. }
  1634. return err;
  1635. }
  1636. if (i != skips-1) {
  1637. err = lfs_bd_read(lfs,
  1638. NULL, rcache, sizeof(head),
  1639. head, 4*i, &head, sizeof(head));
  1640. head = lfs_fromle32(head);
  1641. if (err) {
  1642. return err;
  1643. }
  1644. }
  1645. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1646. }
  1647. *block = nblock;
  1648. *off = 4*skips;
  1649. return 0;
  1650. relocate:
  1651. LFS_DEBUG("Bad block at %"PRIu32, nblock);
  1652. // just clear cache and try a new block
  1653. lfs_cache_drop(lfs, pcache);
  1654. }
  1655. }
  1656. static int lfs_ctz_traverse(lfs_t *lfs,
  1657. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1658. lfs_block_t head, lfs_size_t size,
  1659. int (*cb)(void*, lfs_block_t), void *data) {
  1660. if (size == 0) {
  1661. return 0;
  1662. }
  1663. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1664. while (true) {
  1665. int err = cb(data, head);
  1666. if (err) {
  1667. return err;
  1668. }
  1669. if (index == 0) {
  1670. return 0;
  1671. }
  1672. lfs_block_t heads[2];
  1673. int count = 2 - (index & 1);
  1674. err = lfs_bd_read(lfs,
  1675. pcache, rcache, count*sizeof(head),
  1676. head, 0, &heads, count*sizeof(head));
  1677. heads[0] = lfs_fromle32(heads[0]);
  1678. heads[1] = lfs_fromle32(heads[1]);
  1679. if (err) {
  1680. return err;
  1681. }
  1682. for (int i = 0; i < count-1; i++) {
  1683. err = cb(data, heads[i]);
  1684. if (err) {
  1685. return err;
  1686. }
  1687. }
  1688. head = heads[count-1];
  1689. index -= count;
  1690. }
  1691. }
  1692. /// Top level file operations ///
  1693. int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
  1694. const char *path, int flags,
  1695. const struct lfs_file_config *cfg) {
  1696. // deorphan if we haven't yet, needed at most once after poweron
  1697. if ((flags & 3) != LFS_O_RDONLY) {
  1698. int err = lfs_fs_forceconsistency(lfs);
  1699. if (err) {
  1700. return err;
  1701. }
  1702. }
  1703. // setup simple file details
  1704. int err = 0;
  1705. file->cfg = cfg;
  1706. file->flags = flags;
  1707. file->pos = 0;
  1708. file->cache.buffer = NULL;
  1709. // allocate entry for file if it doesn't exist
  1710. int32_t tag = lfs_dir_lookup(lfs, &file->m, &path);
  1711. if (tag < 0 && !(tag == LFS_ERR_NOENT && path)) {
  1712. err = tag;
  1713. goto cleanup;
  1714. }
  1715. // get id, add to list of mdirs to catch update changes
  1716. file->id = lfs_tag_id(tag);
  1717. file->type = LFS_TYPE_REG;
  1718. file->next = (lfs_file_t*)lfs->mlist;
  1719. lfs->mlist = (lfs_mlist_t*)file;
  1720. if (tag == LFS_ERR_NOENT) {
  1721. if (!(flags & LFS_O_CREAT)) {
  1722. err = LFS_ERR_NOENT;
  1723. goto cleanup;
  1724. }
  1725. // check that name fits
  1726. lfs_size_t nlen = strlen(path);
  1727. if (nlen > lfs->name_max) {
  1728. err = LFS_ERR_NAMETOOLONG;
  1729. goto cleanup;
  1730. }
  1731. // get next slot and create entry to remember name
  1732. file->id = file->m.count;
  1733. err = lfs_dir_commit(lfs, &file->m,
  1734. LFS_MKATTR(LFS_TYPE_REG, file->id, path, nlen,
  1735. LFS_MKATTR(LFS_TYPE_INLINESTRUCT, file->id, NULL, 0,
  1736. NULL)));
  1737. if (err) {
  1738. err = LFS_ERR_NAMETOOLONG;
  1739. goto cleanup;
  1740. }
  1741. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, 0);
  1742. } else if (flags & LFS_O_EXCL) {
  1743. err = LFS_ERR_EXIST;
  1744. goto cleanup;
  1745. } else if (lfs_tag_type(tag) != LFS_TYPE_REG) {
  1746. err = LFS_ERR_ISDIR;
  1747. goto cleanup;
  1748. } else if (flags & LFS_O_TRUNC) {
  1749. // truncate if requested
  1750. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0);
  1751. file->flags |= LFS_F_DIRTY;
  1752. } else {
  1753. // try to load what's on disk, if it's inlined we'll fix it later
  1754. tag = lfs_dir_get(lfs, &file->m, 0x7c3ff000,
  1755. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, 8), &file->ctz);
  1756. if (tag < 0) {
  1757. err = tag;
  1758. goto cleanup;
  1759. }
  1760. lfs_ctz_fromle32(&file->ctz);
  1761. }
  1762. // fetch attrs
  1763. for (const struct lfs_attr *a = file->cfg->attrs; a; a = a->next) {
  1764. if ((file->flags & 3) != LFS_O_WRONLY) {
  1765. int32_t res = lfs_dir_get(lfs, &file->m, 0x7ffff000,
  1766. LFS_MKTAG(0x100 | a->type, file->id, a->size), a->buffer);
  1767. if (res < 0 && res != LFS_ERR_NOENT) {
  1768. err = res;
  1769. goto cleanup;
  1770. }
  1771. }
  1772. if ((file->flags & 3) != LFS_O_RDONLY) {
  1773. if (a->size > lfs->attr_max) {
  1774. err = LFS_ERR_NOSPC;
  1775. goto cleanup;
  1776. }
  1777. file->flags |= LFS_F_DIRTY;
  1778. }
  1779. }
  1780. // allocate buffer if needed
  1781. if (file->cfg->buffer) {
  1782. file->cache.buffer = file->cfg->buffer;
  1783. } else {
  1784. file->cache.buffer = lfs_malloc(lfs->cfg->cache_size);
  1785. if (!file->cache.buffer) {
  1786. err = LFS_ERR_NOMEM;
  1787. goto cleanup;
  1788. }
  1789. }
  1790. // zero to avoid information leak
  1791. lfs_cache_zero(lfs, &file->cache);
  1792. if (lfs_tag_type(tag) == LFS_TYPE_INLINESTRUCT) {
  1793. // load inline files
  1794. file->ctz.head = 0xfffffffe;
  1795. file->ctz.size = lfs_tag_size(tag);
  1796. file->flags |= LFS_F_INLINE;
  1797. file->cache.block = file->ctz.head;
  1798. file->cache.off = 0;
  1799. file->cache.size = lfs->cfg->cache_size;
  1800. // don't always read (may be new/trunc file)
  1801. if (file->ctz.size > 0) {
  1802. int32_t res = lfs_dir_get(lfs, &file->m, 0x7c3ff000,
  1803. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, file->ctz.size),
  1804. file->cache.buffer);
  1805. if (res < 0) {
  1806. err = res;
  1807. goto cleanup;
  1808. }
  1809. }
  1810. }
  1811. return 0;
  1812. cleanup:
  1813. // clean up lingering resources
  1814. file->flags |= LFS_F_ERRED;
  1815. lfs_file_close(lfs, file);
  1816. return err;
  1817. }
  1818. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1819. const char *path, int flags) {
  1820. static const struct lfs_file_config defaults = {0};
  1821. return lfs_file_opencfg(lfs, file, path, flags, &defaults);
  1822. }
  1823. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1824. int err = lfs_file_sync(lfs, file);
  1825. // remove from list of mdirs
  1826. for (lfs_mlist_t **p = &lfs->mlist; *p; p = &(*p)->next) {
  1827. if (*p == (lfs_mlist_t*)file) {
  1828. *p = (*p)->next;
  1829. break;
  1830. }
  1831. }
  1832. // clean up memory
  1833. if (!file->cfg->buffer) {
  1834. lfs_free(file->cache.buffer);
  1835. }
  1836. return err;
  1837. }
  1838. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1839. while (true) {
  1840. // just relocate what exists into new block
  1841. lfs_block_t nblock;
  1842. int err = lfs_alloc(lfs, &nblock);
  1843. if (err) {
  1844. return err;
  1845. }
  1846. err = lfs_bd_erase(lfs, nblock);
  1847. if (err) {
  1848. if (err == LFS_ERR_CORRUPT) {
  1849. goto relocate;
  1850. }
  1851. return err;
  1852. }
  1853. // either read from dirty cache or disk
  1854. for (lfs_off_t i = 0; i < file->off; i++) {
  1855. uint8_t data;
  1856. err = lfs_bd_read(lfs,
  1857. &file->cache, &lfs->rcache, file->off-i,
  1858. file->block, i, &data, 1);
  1859. if (err) {
  1860. return err;
  1861. }
  1862. err = lfs_bd_prog(lfs,
  1863. &lfs->pcache, &lfs->rcache, true,
  1864. nblock, i, &data, 1);
  1865. if (err) {
  1866. if (err == LFS_ERR_CORRUPT) {
  1867. goto relocate;
  1868. }
  1869. return err;
  1870. }
  1871. }
  1872. // copy over new state of file
  1873. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->cache_size);
  1874. file->cache.block = lfs->pcache.block;
  1875. file->cache.off = lfs->pcache.off;
  1876. file->cache.size = lfs->pcache.size;
  1877. lfs_cache_zero(lfs, &lfs->pcache);
  1878. file->block = nblock;
  1879. return 0;
  1880. relocate:
  1881. LFS_DEBUG("Bad block at %"PRIu32, nblock);
  1882. // just clear cache and try a new block
  1883. lfs_cache_drop(lfs, &lfs->pcache);
  1884. }
  1885. }
  1886. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  1887. if (file->flags & LFS_F_READING) {
  1888. file->flags &= ~LFS_F_READING;
  1889. }
  1890. if (file->flags & LFS_F_WRITING) {
  1891. lfs_off_t pos = file->pos;
  1892. if (!(file->flags & LFS_F_INLINE)) {
  1893. // copy over anything after current branch
  1894. lfs_file_t orig = {
  1895. .ctz.head = file->ctz.head,
  1896. .ctz.size = file->ctz.size,
  1897. .flags = LFS_O_RDONLY,
  1898. .pos = file->pos,
  1899. .cache = lfs->rcache,
  1900. };
  1901. lfs_cache_drop(lfs, &lfs->rcache);
  1902. while (file->pos < file->ctz.size) {
  1903. // copy over a byte at a time, leave it up to caching
  1904. // to make this efficient
  1905. uint8_t data;
  1906. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  1907. if (res < 0) {
  1908. return res;
  1909. }
  1910. res = lfs_file_write(lfs, file, &data, 1);
  1911. if (res < 0) {
  1912. return res;
  1913. }
  1914. // keep our reference to the rcache in sync
  1915. if (lfs->rcache.block != 0xffffffff) {
  1916. lfs_cache_drop(lfs, &orig.cache);
  1917. lfs_cache_drop(lfs, &lfs->rcache);
  1918. }
  1919. }
  1920. // write out what we have
  1921. while (true) {
  1922. int err = lfs_bd_flush(lfs,
  1923. &file->cache, &lfs->rcache, true);
  1924. if (err) {
  1925. if (err == LFS_ERR_CORRUPT) {
  1926. goto relocate;
  1927. }
  1928. return err;
  1929. }
  1930. break;
  1931. relocate:
  1932. LFS_DEBUG("Bad block at %"PRIu32, file->block);
  1933. err = lfs_file_relocate(lfs, file);
  1934. if (err) {
  1935. return err;
  1936. }
  1937. }
  1938. } else {
  1939. file->ctz.size = lfs_max(file->pos, file->ctz.size);
  1940. }
  1941. // actual file updates
  1942. file->ctz.head = file->block;
  1943. file->ctz.size = file->pos;
  1944. file->flags &= ~LFS_F_WRITING;
  1945. file->flags |= LFS_F_DIRTY;
  1946. file->pos = pos;
  1947. }
  1948. return 0;
  1949. }
  1950. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  1951. while (true) {
  1952. int err = lfs_file_flush(lfs, file);
  1953. if (err) {
  1954. return err;
  1955. }
  1956. if ((file->flags & LFS_F_DIRTY) &&
  1957. !(file->flags & LFS_F_ERRED) &&
  1958. !lfs_pair_isnull(file->m.pair)) {
  1959. // update dir entry
  1960. uint16_t type;
  1961. const void *buffer;
  1962. lfs_size_t size;
  1963. struct lfs_ctz ctz;
  1964. if (file->flags & LFS_F_INLINE) {
  1965. // inline the whole file
  1966. type = LFS_TYPE_INLINESTRUCT;
  1967. buffer = file->cache.buffer;
  1968. size = file->ctz.size;
  1969. } else {
  1970. // update the ctz reference
  1971. type = LFS_TYPE_CTZSTRUCT;
  1972. // copy ctz so alloc will work during a relocate
  1973. ctz = file->ctz;
  1974. lfs_ctz_tole32(&ctz);
  1975. buffer = &ctz;
  1976. size = sizeof(ctz);
  1977. }
  1978. // commit file data and attributes
  1979. err = lfs_dir_commit(lfs, &file->m,
  1980. LFS_MKATTR(type, file->id, buffer, size,
  1981. LFS_MKATTR(LFS_FROM_ATTRS, file->id, file->cfg->attrs, 0,
  1982. NULL)));
  1983. if (err) {
  1984. if (err == LFS_ERR_NOSPC && (file->flags & LFS_F_INLINE)) {
  1985. goto relocate;
  1986. }
  1987. return err;
  1988. }
  1989. file->flags &= ~LFS_F_DIRTY;
  1990. }
  1991. return 0;
  1992. relocate:
  1993. // inline file doesn't fit anymore
  1994. file->block = 0xfffffffe;
  1995. file->off = file->pos;
  1996. lfs_alloc_ack(lfs);
  1997. err = lfs_file_relocate(lfs, file);
  1998. if (err) {
  1999. return err;
  2000. }
  2001. file->flags &= ~LFS_F_INLINE;
  2002. file->flags |= LFS_F_WRITING;
  2003. }
  2004. }
  2005. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  2006. void *buffer, lfs_size_t size) {
  2007. uint8_t *data = buffer;
  2008. lfs_size_t nsize = size;
  2009. if ((file->flags & 3) == LFS_O_WRONLY) {
  2010. return LFS_ERR_BADF;
  2011. }
  2012. if (file->flags & LFS_F_WRITING) {
  2013. // flush out any writes
  2014. int err = lfs_file_flush(lfs, file);
  2015. if (err) {
  2016. return err;
  2017. }
  2018. }
  2019. if (file->pos >= file->ctz.size) {
  2020. // eof if past end
  2021. return 0;
  2022. }
  2023. size = lfs_min(size, file->ctz.size - file->pos);
  2024. nsize = size;
  2025. while (nsize > 0) {
  2026. // check if we need a new block
  2027. if (!(file->flags & LFS_F_READING) ||
  2028. file->off == lfs->cfg->block_size) {
  2029. if (!(file->flags & LFS_F_INLINE)) {
  2030. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2031. file->ctz.head, file->ctz.size,
  2032. file->pos, &file->block, &file->off);
  2033. if (err) {
  2034. return err;
  2035. }
  2036. } else {
  2037. file->block = 0xfffffffe;
  2038. file->off = file->pos;
  2039. }
  2040. file->flags |= LFS_F_READING;
  2041. }
  2042. // read as much as we can in current block
  2043. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2044. int err = lfs_bd_read(lfs,
  2045. NULL, &file->cache, lfs->cfg->block_size,
  2046. file->block, file->off, data, diff);
  2047. if (err) {
  2048. return err;
  2049. }
  2050. file->pos += diff;
  2051. file->off += diff;
  2052. data += diff;
  2053. nsize -= diff;
  2054. }
  2055. return size;
  2056. }
  2057. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  2058. const void *buffer, lfs_size_t size) {
  2059. const uint8_t *data = buffer;
  2060. lfs_size_t nsize = size;
  2061. if ((file->flags & 3) == LFS_O_RDONLY) {
  2062. return LFS_ERR_BADF;
  2063. }
  2064. if (file->flags & LFS_F_READING) {
  2065. // drop any reads
  2066. int err = lfs_file_flush(lfs, file);
  2067. if (err) {
  2068. return err;
  2069. }
  2070. }
  2071. if ((file->flags & LFS_O_APPEND) && file->pos < file->ctz.size) {
  2072. file->pos = file->ctz.size;
  2073. }
  2074. if (!(file->flags & LFS_F_WRITING) && file->pos > file->ctz.size) {
  2075. // fill with zeros
  2076. lfs_off_t pos = file->pos;
  2077. file->pos = file->ctz.size;
  2078. while (file->pos < pos) {
  2079. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2080. if (res < 0) {
  2081. return res;
  2082. }
  2083. }
  2084. }
  2085. if ((file->flags & LFS_F_INLINE) &&
  2086. file->pos + nsize > lfs->inline_max) {
  2087. // inline file doesn't fit anymore
  2088. file->block = 0xfffffffe;
  2089. file->off = file->pos;
  2090. lfs_alloc_ack(lfs);
  2091. int err = lfs_file_relocate(lfs, file);
  2092. if (err) {
  2093. file->flags |= LFS_F_ERRED;
  2094. return err;
  2095. }
  2096. file->flags &= ~LFS_F_INLINE;
  2097. file->flags |= LFS_F_WRITING;
  2098. }
  2099. while (nsize > 0) {
  2100. // check if we need a new block
  2101. if (!(file->flags & LFS_F_WRITING) ||
  2102. file->off == lfs->cfg->block_size) {
  2103. if (!(file->flags & LFS_F_INLINE)) {
  2104. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  2105. // find out which block we're extending from
  2106. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2107. file->ctz.head, file->ctz.size,
  2108. file->pos-1, &file->block, &file->off);
  2109. if (err) {
  2110. file->flags |= LFS_F_ERRED;
  2111. return err;
  2112. }
  2113. // mark cache as dirty since we may have read data into it
  2114. lfs_cache_zero(lfs, &file->cache);
  2115. }
  2116. // extend file with new blocks
  2117. lfs_alloc_ack(lfs);
  2118. int err = lfs_ctz_extend(lfs, &file->cache, &lfs->rcache,
  2119. file->block, file->pos,
  2120. &file->block, &file->off);
  2121. if (err) {
  2122. file->flags |= LFS_F_ERRED;
  2123. return err;
  2124. }
  2125. } else {
  2126. file->block = 0xfffffffe;
  2127. file->off = file->pos;
  2128. }
  2129. file->flags |= LFS_F_WRITING;
  2130. }
  2131. // program as much as we can in current block
  2132. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2133. while (true) {
  2134. int err = lfs_bd_prog(lfs, &file->cache, &lfs->rcache, true,
  2135. file->block, file->off, data, diff);
  2136. if (err) {
  2137. if (err == LFS_ERR_CORRUPT) {
  2138. goto relocate;
  2139. }
  2140. file->flags |= LFS_F_ERRED;
  2141. return err;
  2142. }
  2143. break;
  2144. relocate:
  2145. err = lfs_file_relocate(lfs, file);
  2146. if (err) {
  2147. file->flags |= LFS_F_ERRED;
  2148. return err;
  2149. }
  2150. }
  2151. file->pos += diff;
  2152. file->off += diff;
  2153. data += diff;
  2154. nsize -= diff;
  2155. lfs_alloc_ack(lfs);
  2156. }
  2157. file->flags &= ~LFS_F_ERRED;
  2158. return size;
  2159. }
  2160. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  2161. lfs_soff_t off, int whence) {
  2162. // write out everything beforehand, may be noop if rdonly
  2163. int err = lfs_file_flush(lfs, file);
  2164. if (err) {
  2165. return err;
  2166. }
  2167. // update pos
  2168. if (whence == LFS_SEEK_SET) {
  2169. file->pos = off;
  2170. } else if (whence == LFS_SEEK_CUR) {
  2171. if (off < 0 && (lfs_off_t)-off > file->pos) {
  2172. return LFS_ERR_INVAL;
  2173. }
  2174. file->pos = file->pos + off;
  2175. } else if (whence == LFS_SEEK_END) {
  2176. if (off < 0 && (lfs_off_t)-off > file->ctz.size) {
  2177. return LFS_ERR_INVAL;
  2178. }
  2179. file->pos = file->ctz.size + off;
  2180. }
  2181. return file->pos;
  2182. }
  2183. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  2184. if ((file->flags & 3) == LFS_O_RDONLY) {
  2185. return LFS_ERR_BADF;
  2186. }
  2187. lfs_off_t oldsize = lfs_file_size(lfs, file);
  2188. if (size < oldsize) {
  2189. // need to flush since directly changing metadata
  2190. int err = lfs_file_flush(lfs, file);
  2191. if (err) {
  2192. return err;
  2193. }
  2194. // lookup new head in ctz skip list
  2195. err = lfs_ctz_find(lfs, NULL, &file->cache,
  2196. file->ctz.head, file->ctz.size,
  2197. size, &file->ctz.head, &(lfs_off_t){0});
  2198. if (err) {
  2199. return err;
  2200. }
  2201. file->ctz.size = size;
  2202. file->flags |= LFS_F_DIRTY;
  2203. } else if (size > oldsize) {
  2204. lfs_off_t pos = file->pos;
  2205. // flush+seek if not already at end
  2206. if (file->pos != oldsize) {
  2207. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  2208. if (err < 0) {
  2209. return err;
  2210. }
  2211. }
  2212. // fill with zeros
  2213. while (file->pos < size) {
  2214. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2215. if (res < 0) {
  2216. return res;
  2217. }
  2218. }
  2219. // restore pos
  2220. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  2221. if (err < 0) {
  2222. return err;
  2223. }
  2224. }
  2225. return 0;
  2226. }
  2227. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  2228. (void)lfs;
  2229. return file->pos;
  2230. }
  2231. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  2232. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  2233. if (res < 0) {
  2234. return res;
  2235. }
  2236. return 0;
  2237. }
  2238. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  2239. (void)lfs;
  2240. if (file->flags & LFS_F_WRITING) {
  2241. return lfs_max(file->pos, file->ctz.size);
  2242. } else {
  2243. return file->ctz.size;
  2244. }
  2245. }
  2246. /// General fs operations ///
  2247. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  2248. lfs_mdir_t cwd;
  2249. int32_t tag = lfs_dir_lookup(lfs, &cwd, &path);
  2250. if (tag < 0) {
  2251. return tag;
  2252. }
  2253. return lfs_dir_getinfo(lfs, &cwd, lfs_tag_id(tag), info);
  2254. }
  2255. int lfs_remove(lfs_t *lfs, const char *path) {
  2256. // deorphan if we haven't yet, needed at most once after poweron
  2257. int err = lfs_fs_forceconsistency(lfs);
  2258. if (err) {
  2259. return err;
  2260. }
  2261. lfs_mdir_t cwd;
  2262. err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2263. if (err) {
  2264. return err;
  2265. }
  2266. int32_t tag = lfs_dir_lookup(lfs, &cwd, &path);
  2267. if (tag < 0) {
  2268. return tag;
  2269. }
  2270. lfs_mdir_t dir;
  2271. if (lfs_tag_type(tag) == LFS_TYPE_DIR) {
  2272. // must be empty before removal
  2273. lfs_block_t pair[2];
  2274. int32_t res = lfs_dir_get(lfs, &cwd, 0x7c3ff000,
  2275. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  2276. if (res < 0) {
  2277. return res;
  2278. }
  2279. lfs_pair_fromle32(pair);
  2280. err = lfs_dir_fetch(lfs, &dir, pair);
  2281. if (err) {
  2282. return err;
  2283. }
  2284. if (dir.count > 0 || dir.split) {
  2285. return LFS_ERR_NOTEMPTY;
  2286. }
  2287. // mark fs as orphaned
  2288. lfs_global_orphans(lfs, +1);
  2289. }
  2290. // delete the entry
  2291. err = lfs_dir_commit(lfs, &cwd,
  2292. LFS_MKATTR(LFS_TYPE_DELETE, lfs_tag_id(tag), NULL, 0,
  2293. NULL));
  2294. if (err) {
  2295. return err;
  2296. }
  2297. if (lfs_tag_type(tag) == LFS_TYPE_DIR) {
  2298. // fix orphan
  2299. lfs_global_orphans(lfs, -1);
  2300. err = lfs_fs_pred(lfs, dir.pair, &cwd);
  2301. if (err) {
  2302. return err;
  2303. }
  2304. // steal state
  2305. cwd.tail[0] = dir.tail[0];
  2306. cwd.tail[1] = dir.tail[1];
  2307. lfs_global_xor(&lfs->locals, &dir.locals);
  2308. err = lfs_dir_commit(lfs, &cwd,
  2309. LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x3ff,
  2310. cwd.tail, sizeof(cwd.tail),
  2311. NULL));
  2312. if (err) {
  2313. return err;
  2314. }
  2315. }
  2316. return 0;
  2317. }
  2318. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  2319. // deorphan if we haven't yet, needed at most once after poweron
  2320. int err = lfs_fs_forceconsistency(lfs);
  2321. if (err) {
  2322. return err;
  2323. }
  2324. // find old entry
  2325. lfs_mdir_t oldcwd;
  2326. int32_t oldtag = lfs_dir_lookup(lfs, &oldcwd, &oldpath);
  2327. if (oldtag < 0) {
  2328. return oldtag;
  2329. }
  2330. // find new entry
  2331. lfs_mdir_t newcwd;
  2332. int32_t prevtag = lfs_dir_lookup(lfs, &newcwd, &newpath);
  2333. if (prevtag < 0 && prevtag != LFS_ERR_NOENT) {
  2334. return prevtag;
  2335. }
  2336. uint16_t newid = lfs_tag_id(prevtag);
  2337. lfs_mdir_t prevdir;
  2338. if (prevtag == LFS_ERR_NOENT) {
  2339. // check that name fits
  2340. lfs_size_t nlen = strlen(newpath);
  2341. if (nlen > lfs->name_max) {
  2342. return LFS_ERR_NAMETOOLONG;
  2343. }
  2344. // get next id
  2345. newid = newcwd.count;
  2346. } else if (lfs_tag_type(prevtag) != lfs_tag_type(oldtag)) {
  2347. return LFS_ERR_ISDIR;
  2348. } else if (lfs_tag_type(prevtag) == LFS_TYPE_DIR) {
  2349. // must be empty before removal
  2350. lfs_block_t prevpair[2];
  2351. int32_t res = lfs_dir_get(lfs, &newcwd, 0x7c3ff000,
  2352. LFS_MKTAG(LFS_TYPE_STRUCT, newid, 8), prevpair);
  2353. if (res < 0) {
  2354. return res;
  2355. }
  2356. lfs_pair_fromle32(prevpair);
  2357. // must be empty before removal
  2358. err = lfs_dir_fetch(lfs, &prevdir, prevpair);
  2359. if (err) {
  2360. return err;
  2361. }
  2362. if (prevdir.count > 0 || prevdir.split) {
  2363. return LFS_ERR_NOTEMPTY;
  2364. }
  2365. // mark fs as orphaned
  2366. lfs_global_orphans(lfs, +1);
  2367. }
  2368. // create move to fix later
  2369. lfs_global_move(lfs, oldcwd.pair, lfs_tag_id(oldtag));
  2370. // move over all attributes
  2371. err = lfs_dir_commit(lfs, &newcwd,
  2372. LFS_MKATTR(lfs_tag_type(oldtag), newid, newpath, strlen(newpath),
  2373. LFS_MKATTR(LFS_FROM_MOVE, newid, &oldcwd, lfs_tag_id(oldtag),
  2374. NULL)));
  2375. if (err) {
  2376. return err;
  2377. }
  2378. // let commit clean up after move (if we're different! otherwise move
  2379. // logic already fixed it for us)
  2380. if (lfs_pair_cmp(oldcwd.pair, newcwd.pair) != 0) {
  2381. err = lfs_dir_commit(lfs, &oldcwd, NULL);
  2382. if (err) {
  2383. return err;
  2384. }
  2385. }
  2386. if (prevtag != LFS_ERR_NOENT && lfs_tag_type(prevtag) == LFS_TYPE_DIR) {
  2387. // fix orphan
  2388. lfs_global_orphans(lfs, -1);
  2389. err = lfs_fs_pred(lfs, prevdir.pair, &newcwd);
  2390. if (err) {
  2391. return err;
  2392. }
  2393. // steal state
  2394. newcwd.tail[0] = prevdir.tail[0];
  2395. newcwd.tail[1] = prevdir.tail[1];
  2396. lfs_global_xor(&lfs->locals, &prevdir.locals);
  2397. err = lfs_dir_commit(lfs, &newcwd,
  2398. LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x3ff,
  2399. newcwd.tail, sizeof(newcwd.tail),
  2400. NULL));
  2401. if (err) {
  2402. return err;
  2403. }
  2404. }
  2405. return 0;
  2406. }
  2407. lfs_ssize_t lfs_getattr(lfs_t *lfs, const char *path,
  2408. uint8_t type, void *buffer, lfs_size_t size) {
  2409. lfs_mdir_t cwd;
  2410. int32_t res = lfs_dir_lookup(lfs, &cwd, &path);
  2411. if (res < 0) {
  2412. return res;
  2413. }
  2414. uint16_t id = lfs_tag_id(res);
  2415. if (id == 0x3ff) {
  2416. // special case for root
  2417. id = 0;
  2418. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2419. if (err) {
  2420. return err;
  2421. }
  2422. }
  2423. res = lfs_dir_get(lfs, &cwd, 0x7ffff000,
  2424. LFS_MKTAG(0x100 | type, id, lfs_min(size, lfs->attr_max)),
  2425. buffer);
  2426. if (res < 0 && res != LFS_ERR_NOENT) {
  2427. return res;
  2428. }
  2429. return (res == LFS_ERR_NOENT) ? 0 : lfs_tag_size(res);
  2430. }
  2431. int lfs_setattr(lfs_t *lfs, const char *path,
  2432. uint8_t type, const void *buffer, lfs_size_t size) {
  2433. if (size > lfs->attr_max) {
  2434. return LFS_ERR_NOSPC;
  2435. }
  2436. lfs_mdir_t cwd;
  2437. int32_t res = lfs_dir_lookup(lfs, &cwd, &path);
  2438. if (res < 0) {
  2439. return res;
  2440. }
  2441. uint16_t id = lfs_tag_id(res);
  2442. if (id == 0x3ff) {
  2443. // special case for root
  2444. id = 0;
  2445. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2446. if (err) {
  2447. return err;
  2448. }
  2449. }
  2450. return lfs_dir_commit(lfs, &cwd,
  2451. LFS_MKATTR(0x100 | type, id, buffer, size,
  2452. NULL));
  2453. }
  2454. /// Filesystem operations ///
  2455. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2456. lfs->cfg = cfg;
  2457. int err = 0;
  2458. // check that block size is a multiple of cache size is a multiple
  2459. // of prog and read sizes
  2460. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->read_size == 0);
  2461. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->prog_size == 0);
  2462. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->cache_size == 0);
  2463. // check that the block size is large enough to fit ctz pointers
  2464. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2465. <= lfs->cfg->block_size);
  2466. // setup read cache
  2467. if (lfs->cfg->read_buffer) {
  2468. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2469. } else {
  2470. lfs->rcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2471. if (!lfs->rcache.buffer) {
  2472. err = LFS_ERR_NOMEM;
  2473. goto cleanup;
  2474. }
  2475. }
  2476. // setup program cache
  2477. if (lfs->cfg->prog_buffer) {
  2478. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2479. } else {
  2480. lfs->pcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2481. if (!lfs->pcache.buffer) {
  2482. err = LFS_ERR_NOMEM;
  2483. goto cleanup;
  2484. }
  2485. }
  2486. // zero to avoid information leaks
  2487. lfs_cache_zero(lfs, &lfs->rcache);
  2488. lfs_cache_zero(lfs, &lfs->pcache);
  2489. // setup lookahead, must be multiple of 32-bits
  2490. LFS_ASSERT(lfs->cfg->lookahead % 32 == 0);
  2491. LFS_ASSERT(lfs->cfg->lookahead > 0);
  2492. if (lfs->cfg->lookahead_buffer) {
  2493. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2494. } else {
  2495. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead/8);
  2496. if (!lfs->free.buffer) {
  2497. err = LFS_ERR_NOMEM;
  2498. goto cleanup;
  2499. }
  2500. }
  2501. // check that the size limits are sane
  2502. LFS_ASSERT(lfs->cfg->inline_max <= LFS_INLINE_MAX);
  2503. LFS_ASSERT(lfs->cfg->inline_max <= lfs->cfg->cache_size);
  2504. lfs->inline_max = lfs->cfg->inline_max;
  2505. if (!lfs->inline_max) {
  2506. lfs->inline_max = lfs_min(LFS_INLINE_MAX, lfs->cfg->cache_size);
  2507. }
  2508. LFS_ASSERT(lfs->cfg->attr_max <= LFS_ATTR_MAX);
  2509. lfs->attr_max = lfs->cfg->attr_max;
  2510. if (!lfs->attr_max) {
  2511. lfs->attr_max = LFS_ATTR_MAX;
  2512. }
  2513. LFS_ASSERT(lfs->cfg->name_max <= LFS_NAME_MAX);
  2514. lfs->name_max = lfs->cfg->name_max;
  2515. if (!lfs->name_max) {
  2516. lfs->name_max = LFS_NAME_MAX;
  2517. }
  2518. // setup default state
  2519. lfs->root[0] = 0xffffffff;
  2520. lfs->root[1] = 0xffffffff;
  2521. lfs->mlist = NULL;
  2522. lfs->seed = 0;
  2523. lfs->globals.g.movepair[0] = 0xffffffff;
  2524. lfs->globals.g.movepair[1] = 0xffffffff;
  2525. lfs->globals.g.moveid = 0x3ff;
  2526. lfs->globals.g.orphans = 0;
  2527. lfs_global_zero(&lfs->locals);
  2528. return 0;
  2529. cleanup:
  2530. lfs_deinit(lfs);
  2531. return err;
  2532. }
  2533. static int lfs_deinit(lfs_t *lfs) {
  2534. // free allocated memory
  2535. if (!lfs->cfg->read_buffer) {
  2536. lfs_free(lfs->rcache.buffer);
  2537. }
  2538. if (!lfs->cfg->prog_buffer) {
  2539. lfs_free(lfs->pcache.buffer);
  2540. }
  2541. if (!lfs->cfg->lookahead_buffer) {
  2542. lfs_free(lfs->free.buffer);
  2543. }
  2544. return 0;
  2545. }
  2546. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2547. int err = lfs_init(lfs, cfg);
  2548. if (err) {
  2549. return err;
  2550. }
  2551. // create free lookahead
  2552. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  2553. lfs->free.off = 0;
  2554. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->cfg->block_count);
  2555. lfs->free.i = 0;
  2556. lfs_alloc_ack(lfs);
  2557. // create root dir
  2558. lfs_mdir_t root;
  2559. err = lfs_dir_alloc(lfs, &root);
  2560. if (err) {
  2561. goto cleanup;
  2562. }
  2563. // write one superblock
  2564. lfs_superblock_t superblock = {
  2565. .magic = {"littlefs"},
  2566. .version = LFS_DISK_VERSION,
  2567. .block_size = lfs->cfg->block_size,
  2568. .block_count = lfs->cfg->block_count,
  2569. .attr_max = lfs->attr_max,
  2570. .name_max = lfs->name_max,
  2571. .inline_max = lfs->inline_max,
  2572. };
  2573. lfs_superblock_tole32(&superblock);
  2574. err = lfs_dir_commit(lfs, &root,
  2575. LFS_MKATTR(LFS_TYPE_ROOT, 0, &superblock, sizeof(superblock),
  2576. NULL));
  2577. if (err) {
  2578. goto cleanup;
  2579. }
  2580. // sanity check that fetch works
  2581. err = lfs_dir_fetch(lfs, &root, (const lfs_block_t[2]){0, 1});
  2582. if (err) {
  2583. goto cleanup;
  2584. }
  2585. cleanup:
  2586. lfs_deinit(lfs);
  2587. return err;
  2588. }
  2589. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  2590. int err = lfs_init(lfs, cfg);
  2591. if (err) {
  2592. return err;
  2593. }
  2594. // find root/superblock
  2595. lfs_mdir_t root;
  2596. lfs_superblock_t superblock;
  2597. int32_t tag = lfs_dir_find(lfs,
  2598. &root, (const lfs_block_t[2]){0, 1}, false, 0x7fc00000,
  2599. LFS_MKTAG(LFS_TYPE_ROOT, 0, 8), "littlefs");
  2600. if (tag < 0) {
  2601. err = tag;
  2602. goto cleanup;
  2603. }
  2604. int32_t res = lfs_dir_get(lfs, &root, 0x7c000000,
  2605. LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, sizeof(superblock)),
  2606. &superblock);
  2607. if (res < 0) {
  2608. err = res;
  2609. goto cleanup;
  2610. }
  2611. lfs_superblock_fromle32(&superblock);
  2612. lfs->root[0] = root.pair[0];
  2613. lfs->root[1] = root.pair[1];
  2614. // check version
  2615. uint16_t major_version = (0xffff & (superblock.version >> 16));
  2616. uint16_t minor_version = (0xffff & (superblock.version >> 0));
  2617. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  2618. minor_version > LFS_DISK_VERSION_MINOR)) {
  2619. LFS_ERROR("Invalid version %"PRIu32".%"PRIu32,
  2620. major_version, minor_version);
  2621. err = LFS_ERR_INVAL;
  2622. goto cleanup;
  2623. }
  2624. // check superblock configuration
  2625. if (superblock.attr_max) {
  2626. if (superblock.attr_max > lfs->attr_max) {
  2627. LFS_ERROR("Unsupported attr_max (%"PRIu32" > %"PRIu32")",
  2628. superblock.attr_max, lfs->attr_max);
  2629. err = LFS_ERR_INVAL;
  2630. goto cleanup;
  2631. }
  2632. lfs->attr_max = superblock.attr_max;
  2633. }
  2634. if (superblock.name_max) {
  2635. if (superblock.name_max > lfs->name_max) {
  2636. LFS_ERROR("Unsupported name_max (%"PRIu32" > %"PRIu32")",
  2637. superblock.name_max, lfs->name_max);
  2638. err = LFS_ERR_INVAL;
  2639. goto cleanup;
  2640. }
  2641. lfs->name_max = superblock.name_max;
  2642. }
  2643. if (superblock.inline_max) {
  2644. if (superblock.inline_max > lfs->inline_max) {
  2645. LFS_ERROR("Unsupported inline_max (%"PRIu32" > %"PRIu32")",
  2646. superblock.inline_max, lfs->inline_max);
  2647. err = LFS_ERR_INVAL;
  2648. goto cleanup;
  2649. }
  2650. lfs->inline_max = superblock.inline_max;
  2651. }
  2652. // scan for any global updates
  2653. lfs_mdir_t dir = {.tail = {0, 1}};
  2654. while (!lfs_pair_isnull(dir.tail)) {
  2655. err = lfs_dir_fetch(lfs, &dir, dir.tail);
  2656. if (err) {
  2657. err = LFS_ERR_INVAL;
  2658. goto cleanup;
  2659. }
  2660. // xor together indirect deletes
  2661. lfs_global_xor(&lfs->locals, &dir.locals);
  2662. }
  2663. // update littlefs with globals
  2664. lfs_global_fromle32(&lfs->locals);
  2665. lfs_global_xor(&lfs->globals, &lfs->locals);
  2666. lfs_global_zero(&lfs->locals);
  2667. if (!lfs_pair_isnull(lfs->globals.g.movepair)) {
  2668. LFS_DEBUG("Found move %"PRIu32" %"PRIu32" %"PRIu32,
  2669. lfs->globals.g.movepair[0],
  2670. lfs->globals.g.movepair[1],
  2671. lfs->globals.g.moveid);
  2672. }
  2673. // setup free lookahead
  2674. lfs->free.off = lfs->seed % lfs->cfg->block_size;
  2675. lfs->free.size = 0;
  2676. lfs->free.i = 0;
  2677. lfs_alloc_ack(lfs);
  2678. return 0;
  2679. cleanup:
  2680. lfs_unmount(lfs);
  2681. return err;
  2682. }
  2683. int lfs_unmount(lfs_t *lfs) {
  2684. return lfs_deinit(lfs);
  2685. }
  2686. /// Filesystem filesystem operations ///
  2687. int lfs_fs_traverse(lfs_t *lfs,
  2688. int (*cb)(void *data, lfs_block_t block), void *data) {
  2689. if (lfs_pair_isnull(lfs->root)) {
  2690. return 0;
  2691. }
  2692. // iterate over metadata pairs
  2693. lfs_mdir_t dir = {.tail = {0, 1}};
  2694. while (!lfs_pair_isnull(dir.tail)) {
  2695. for (int i = 0; i < 2; i++) {
  2696. int err = cb(data, dir.tail[i]);
  2697. if (err) {
  2698. return err;
  2699. }
  2700. }
  2701. // iterate through ids in directory
  2702. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  2703. if (err) {
  2704. return err;
  2705. }
  2706. for (uint16_t id = 0; id < dir.count; id++) {
  2707. struct lfs_ctz ctz;
  2708. int32_t tag = lfs_dir_get(lfs, &dir, 0x7c3ff000,
  2709. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  2710. if (tag < 0) {
  2711. if (tag == LFS_ERR_NOENT) {
  2712. continue;
  2713. }
  2714. return tag;
  2715. }
  2716. lfs_ctz_fromle32(&ctz);
  2717. if (lfs_tag_type(tag) == LFS_TYPE_CTZSTRUCT) {
  2718. err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
  2719. ctz.head, ctz.size, cb, data);
  2720. if (err) {
  2721. return err;
  2722. }
  2723. }
  2724. }
  2725. }
  2726. // iterate over any open files
  2727. for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
  2728. if (f->type != LFS_TYPE_REG) {
  2729. continue;
  2730. }
  2731. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  2732. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  2733. f->ctz.head, f->ctz.size, cb, data);
  2734. if (err) {
  2735. return err;
  2736. }
  2737. }
  2738. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  2739. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  2740. f->block, f->pos, cb, data);
  2741. if (err) {
  2742. return err;
  2743. }
  2744. }
  2745. }
  2746. return 0;
  2747. }
  2748. static int lfs_fs_pred(lfs_t *lfs,
  2749. const lfs_block_t pair[2], lfs_mdir_t *pdir) {
  2750. if (lfs_pair_isnull(lfs->root)) {
  2751. return LFS_ERR_NOENT;
  2752. }
  2753. // iterate over all directory directory entries
  2754. pdir->tail[0] = 0;
  2755. pdir->tail[1] = 1;
  2756. while (!lfs_pair_isnull(pdir->tail)) {
  2757. if (lfs_pair_cmp(pdir->tail, pair) == 0) {
  2758. return 0;
  2759. }
  2760. int err = lfs_dir_fetch(lfs, pdir, pdir->tail);
  2761. if (err) {
  2762. return err;
  2763. }
  2764. }
  2765. return LFS_ERR_NOENT;
  2766. }
  2767. static int32_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t pair[2],
  2768. lfs_mdir_t *parent) {
  2769. if (lfs_pair_isnull(lfs->root)) {
  2770. return LFS_ERR_NOENT;
  2771. }
  2772. // search for both orderings so we can reuse the find function
  2773. for (int i = 0; i < 2; i++) {
  2774. int32_t tag = lfs_dir_find(lfs, parent,
  2775. (const lfs_block_t[2]){0, 1}, true, 0x7fc00fff,
  2776. LFS_MKTAG(LFS_TYPE_DIRSTRUCT, 0, 8), pair);
  2777. if (tag != LFS_ERR_NOENT) {
  2778. return tag;
  2779. }
  2780. }
  2781. return LFS_ERR_NOENT;
  2782. }
  2783. static int lfs_fs_relocate(lfs_t *lfs,
  2784. const lfs_block_t oldpair[2], lfs_block_t newpair[2]) {
  2785. // update internal root
  2786. if (lfs_pair_cmp(oldpair, lfs->root) == 0) {
  2787. LFS_DEBUG("Relocating root %"PRIu32" %"PRIu32,
  2788. newpair[0], newpair[1]);
  2789. lfs->root[0] = newpair[0];
  2790. lfs->root[1] = newpair[1];
  2791. }
  2792. // update internally tracked dirs
  2793. for (lfs_mlist_t *d = lfs->mlist; d; d = d->next) {
  2794. if (lfs_pair_cmp(oldpair, d->m.pair) == 0) {
  2795. d->m.pair[0] = newpair[0];
  2796. d->m.pair[1] = newpair[1];
  2797. }
  2798. }
  2799. // find parent
  2800. lfs_mdir_t parent;
  2801. int32_t tag = lfs_fs_parent(lfs, oldpair, &parent);
  2802. if (tag < 0 && tag != LFS_ERR_NOENT) {
  2803. return tag;
  2804. }
  2805. if (tag != LFS_ERR_NOENT) {
  2806. // update disk, this creates a desync
  2807. lfs_global_orphans(lfs, +1);
  2808. lfs_pair_tole32(newpair);
  2809. int err = lfs_dir_commit(lfs, &parent,
  2810. &(lfs_mattr_t){.tag=tag, .buffer=newpair});
  2811. lfs_pair_fromle32(newpair);
  2812. if (err) {
  2813. return err;
  2814. }
  2815. // next step, clean up orphans
  2816. lfs_global_orphans(lfs, -1);
  2817. }
  2818. // find pred
  2819. int err = lfs_fs_pred(lfs, oldpair, &parent);
  2820. if (err && err != LFS_ERR_NOENT) {
  2821. return err;
  2822. }
  2823. // if we can't find dir, it must be new
  2824. if (err != LFS_ERR_NOENT) {
  2825. // replace bad pair, either we clean up desync, or no desync occured
  2826. parent.tail[0] = newpair[0];
  2827. parent.tail[1] = newpair[1];
  2828. err = lfs_dir_commit(lfs, &parent,
  2829. LFS_MKATTR(LFS_TYPE_TAIL + parent.split, 0x3ff,
  2830. parent.tail, sizeof(parent.tail),
  2831. NULL));
  2832. if (err) {
  2833. return err;
  2834. }
  2835. }
  2836. return 0;
  2837. }
  2838. static int lfs_fs_deorphan(lfs_t *lfs) {
  2839. // Fix any orphans
  2840. lfs_mdir_t pdir = {.split = true};
  2841. lfs_mdir_t dir = {.tail = {0, 1}};
  2842. // iterate over all directory directory entries
  2843. while (!lfs_pair_isnull(dir.tail)) {
  2844. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  2845. if (err) {
  2846. return err;
  2847. }
  2848. // check head blocks for orphans
  2849. if (!pdir.split) {
  2850. // check if we have a parent
  2851. lfs_mdir_t parent;
  2852. int32_t tag = lfs_fs_parent(lfs, pdir.tail, &parent);
  2853. if (tag < 0 && tag != LFS_ERR_NOENT) {
  2854. return tag;
  2855. }
  2856. if (tag == LFS_ERR_NOENT) {
  2857. // we are an orphan
  2858. LFS_DEBUG("Fixing orphan %"PRIu32" %"PRIu32,
  2859. pdir.tail[0], pdir.tail[1]);
  2860. pdir.tail[0] = dir.tail[0];
  2861. pdir.tail[1] = dir.tail[1];
  2862. err = lfs_dir_commit(lfs, &pdir,
  2863. LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x3ff,
  2864. pdir.tail, sizeof(pdir.tail),
  2865. NULL));
  2866. if (err) {
  2867. return err;
  2868. }
  2869. break;
  2870. }
  2871. lfs_block_t pair[2];
  2872. int32_t res = lfs_dir_get(lfs, &parent, 0x7ffff000, tag, pair);
  2873. if (res < 0) {
  2874. return res;
  2875. }
  2876. lfs_pair_fromle32(pair);
  2877. if (!lfs_pair_sync(pair, pdir.tail)) {
  2878. // we have desynced
  2879. LFS_DEBUG("Fixing half-orphan %"PRIu32" %"PRIu32,
  2880. pair[0], pair[1]);
  2881. pdir.tail[0] = pair[0];
  2882. pdir.tail[1] = pair[1];
  2883. err = lfs_dir_commit(lfs, &pdir,
  2884. LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x3ff,
  2885. pdir.tail, sizeof(pdir.tail),
  2886. NULL));
  2887. if (err) {
  2888. return err;
  2889. }
  2890. break;
  2891. }
  2892. }
  2893. memcpy(&pdir, &dir, sizeof(pdir));
  2894. }
  2895. // mark orphans as fixed
  2896. lfs_global_orphans(lfs, -lfs->globals.g.orphans);
  2897. return 0;
  2898. }
  2899. static int lfs_fs_demove(lfs_t *lfs) {
  2900. // Fix bad moves
  2901. LFS_DEBUG("Fixing move %"PRIu32" %"PRIu32" %"PRIu32,
  2902. lfs->globals.g.movepair[0],
  2903. lfs->globals.g.movepair[1],
  2904. lfs->globals.g.moveid);
  2905. // fetch and delete the moved entry
  2906. lfs_mdir_t movedir;
  2907. int err = lfs_dir_fetch(lfs, &movedir, lfs->globals.g.movepair);
  2908. if (err) {
  2909. return err;
  2910. }
  2911. // rely on cancel logic inside commit
  2912. err = lfs_dir_commit(lfs, &movedir, NULL);
  2913. if (err) {
  2914. return err;
  2915. }
  2916. return 0;
  2917. }
  2918. static int lfs_fs_forceconsistency(lfs_t *lfs) {
  2919. if (lfs->globals.g.orphans) {
  2920. int err = lfs_fs_deorphan(lfs);
  2921. if (err) {
  2922. return err;
  2923. }
  2924. }
  2925. if (lfs->globals.g.moveid != 0x3ff) {
  2926. int err = lfs_fs_demove(lfs);
  2927. if (err) {
  2928. return err;
  2929. }
  2930. }
  2931. return 0;
  2932. }
  2933. static int lfs_fs_size_count(void *p, lfs_block_t block) {
  2934. (void)block;
  2935. lfs_size_t *size = p;
  2936. *size += 1;
  2937. return 0;
  2938. }
  2939. lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
  2940. lfs_size_t size = 0;
  2941. int err = lfs_fs_traverse(lfs, lfs_fs_size_count, &size);
  2942. if (err) {
  2943. return err;
  2944. }
  2945. return size;
  2946. }