lfs.c 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511
  1. /*
  2. * The little filesystem
  3. *
  4. * Copyright (c) 2017, Arm Limited. All rights reserved.
  5. * SPDX-License-Identifier: BSD-3-Clause
  6. */
  7. #include "lfs.h"
  8. #include "lfs_util.h"
  9. /// Caching block device operations ///
  10. static int lfs_cache_read(lfs_t *lfs, lfs_cache_t *rcache,
  11. const lfs_cache_t *pcache, lfs_block_t block,
  12. lfs_off_t off, void *buffer, lfs_size_t size) {
  13. uint8_t *data = buffer;
  14. LFS_ASSERT(block < lfs->cfg->block_count);
  15. while (size > 0) {
  16. if (pcache && block == pcache->block && off >= pcache->off &&
  17. off < pcache->off + lfs->cfg->prog_size) {
  18. // is already in pcache?
  19. lfs_size_t diff = lfs_min(size,
  20. lfs->cfg->prog_size - (off-pcache->off));
  21. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  22. data += diff;
  23. off += diff;
  24. size -= diff;
  25. continue;
  26. }
  27. if (block == rcache->block && off >= rcache->off &&
  28. off < rcache->off + lfs->cfg->read_size) {
  29. // is already in rcache?
  30. lfs_size_t diff = lfs_min(size,
  31. lfs->cfg->read_size - (off-rcache->off));
  32. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  33. data += diff;
  34. off += diff;
  35. size -= diff;
  36. continue;
  37. }
  38. if (off % lfs->cfg->read_size == 0 && size >= lfs->cfg->read_size) {
  39. // bypass cache?
  40. lfs_size_t diff = size - (size % lfs->cfg->read_size);
  41. int err = lfs->cfg->read(lfs->cfg, block, off, data, diff);
  42. if (err) {
  43. return err;
  44. }
  45. data += diff;
  46. off += diff;
  47. size -= diff;
  48. continue;
  49. }
  50. // load to cache, first condition can no longer fail
  51. rcache->block = block;
  52. rcache->off = off - (off % lfs->cfg->read_size);
  53. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  54. rcache->off, rcache->buffer, lfs->cfg->read_size);
  55. if (err) {
  56. return err;
  57. }
  58. }
  59. return 0;
  60. }
  61. static int lfs_cache_cmp(lfs_t *lfs, lfs_cache_t *rcache,
  62. const lfs_cache_t *pcache, lfs_block_t block,
  63. lfs_off_t off, const void *buffer, lfs_size_t size) {
  64. const uint8_t *data = buffer;
  65. for (lfs_off_t i = 0; i < size; i++) {
  66. uint8_t c;
  67. int err = lfs_cache_read(lfs, rcache, pcache,
  68. block, off+i, &c, 1);
  69. if (err) {
  70. return err;
  71. }
  72. if (c != data[i]) {
  73. return false;
  74. }
  75. }
  76. return true;
  77. }
  78. static int lfs_cache_crc(lfs_t *lfs, lfs_cache_t *rcache,
  79. const lfs_cache_t *pcache, lfs_block_t block,
  80. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  81. for (lfs_off_t i = 0; i < size; i++) {
  82. uint8_t c;
  83. int err = lfs_cache_read(lfs, rcache, pcache,
  84. block, off+i, &c, 1);
  85. if (err) {
  86. return err;
  87. }
  88. lfs_crc(crc, &c, 1);
  89. }
  90. return 0;
  91. }
  92. static int lfs_cache_flush(lfs_t *lfs,
  93. lfs_cache_t *pcache, lfs_cache_t *rcache) {
  94. if (pcache->block != 0xffffffff) {
  95. int err = lfs->cfg->prog(lfs->cfg, pcache->block,
  96. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  97. if (err) {
  98. return err;
  99. }
  100. if (rcache) {
  101. int res = lfs_cache_cmp(lfs, rcache, NULL, pcache->block,
  102. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  103. if (res < 0) {
  104. return res;
  105. }
  106. if (!res) {
  107. return LFS_ERR_CORRUPT;
  108. }
  109. }
  110. pcache->block = 0xffffffff;
  111. }
  112. return 0;
  113. }
  114. static int lfs_cache_prog(lfs_t *lfs, lfs_cache_t *pcache,
  115. lfs_cache_t *rcache, lfs_block_t block,
  116. lfs_off_t off, const void *buffer, lfs_size_t size) {
  117. const uint8_t *data = buffer;
  118. LFS_ASSERT(block < lfs->cfg->block_count);
  119. while (size > 0) {
  120. if (block == pcache->block && off >= pcache->off &&
  121. off < pcache->off + lfs->cfg->prog_size) {
  122. // is already in pcache?
  123. lfs_size_t diff = lfs_min(size,
  124. lfs->cfg->prog_size - (off-pcache->off));
  125. memcpy(&pcache->buffer[off-pcache->off], data, diff);
  126. data += diff;
  127. off += diff;
  128. size -= diff;
  129. if (off % lfs->cfg->prog_size == 0) {
  130. // eagerly flush out pcache if we fill up
  131. int err = lfs_cache_flush(lfs, pcache, rcache);
  132. if (err) {
  133. return err;
  134. }
  135. }
  136. continue;
  137. }
  138. // pcache must have been flushed, either by programming and
  139. // entire block or manually flushing the pcache
  140. LFS_ASSERT(pcache->block == 0xffffffff);
  141. if (off % lfs->cfg->prog_size == 0 &&
  142. size >= lfs->cfg->prog_size) {
  143. // bypass pcache?
  144. lfs_size_t diff = size - (size % lfs->cfg->prog_size);
  145. int err = lfs->cfg->prog(lfs->cfg, block, off, data, diff);
  146. if (err) {
  147. return err;
  148. }
  149. if (rcache) {
  150. int res = lfs_cache_cmp(lfs, rcache, NULL,
  151. block, off, data, diff);
  152. if (res < 0) {
  153. return res;
  154. }
  155. if (!res) {
  156. return LFS_ERR_CORRUPT;
  157. }
  158. }
  159. data += diff;
  160. off += diff;
  161. size -= diff;
  162. continue;
  163. }
  164. // prepare pcache, first condition can no longer fail
  165. pcache->block = block;
  166. pcache->off = off - (off % lfs->cfg->prog_size);
  167. }
  168. return 0;
  169. }
  170. /// General lfs block device operations ///
  171. static int lfs_bd_read(lfs_t *lfs, lfs_block_t block,
  172. lfs_off_t off, void *buffer, lfs_size_t size) {
  173. // if we ever do more than writes to alternating pairs,
  174. // this may need to consider pcache
  175. return lfs_cache_read(lfs, &lfs->rcache, NULL,
  176. block, off, buffer, size);
  177. }
  178. static int lfs_bd_prog(lfs_t *lfs, lfs_block_t block,
  179. lfs_off_t off, const void *buffer, lfs_size_t size) {
  180. return lfs_cache_prog(lfs, &lfs->pcache, NULL,
  181. block, off, buffer, size);
  182. }
  183. static int lfs_bd_cmp(lfs_t *lfs, lfs_block_t block,
  184. lfs_off_t off, const void *buffer, lfs_size_t size) {
  185. return lfs_cache_cmp(lfs, &lfs->rcache, NULL, block, off, buffer, size);
  186. }
  187. static int lfs_bd_crc(lfs_t *lfs, lfs_block_t block,
  188. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  189. return lfs_cache_crc(lfs, &lfs->rcache, NULL, block, off, size, crc);
  190. }
  191. static int lfs_bd_erase(lfs_t *lfs, lfs_block_t block) {
  192. return lfs->cfg->erase(lfs->cfg, block);
  193. }
  194. static int lfs_bd_sync(lfs_t *lfs) {
  195. lfs->rcache.block = 0xffffffff;
  196. int err = lfs_cache_flush(lfs, &lfs->pcache, NULL);
  197. if (err) {
  198. return err;
  199. }
  200. return lfs->cfg->sync(lfs->cfg);
  201. }
  202. /// Internal operations predeclared here ///
  203. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data);
  204. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir);
  205. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  206. lfs_dir_t *parent, lfs_entry_t *entry);
  207. static int lfs_moved(lfs_t *lfs, const void *e);
  208. static int lfs_relocate(lfs_t *lfs,
  209. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]);
  210. int lfs_deorphan(lfs_t *lfs);
  211. /// Block allocator ///
  212. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  213. lfs_t *lfs = p;
  214. lfs_block_t off = ((block - lfs->free.off)
  215. + lfs->cfg->block_count) % lfs->cfg->block_count;
  216. if (off < lfs->free.size) {
  217. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  218. }
  219. return 0;
  220. }
  221. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  222. while (true) {
  223. while (lfs->free.i != lfs->free.size) {
  224. lfs_block_t off = lfs->free.i;
  225. lfs->free.i += 1;
  226. lfs->free.ack -= 1;
  227. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  228. // found a free block
  229. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  230. // eagerly find next off so an alloc ack can
  231. // discredit old lookahead blocks
  232. while (lfs->free.i != lfs->free.size &&
  233. (lfs->free.buffer[lfs->free.i / 32]
  234. & (1U << (lfs->free.i % 32)))) {
  235. lfs->free.i += 1;
  236. lfs->free.ack -= 1;
  237. }
  238. return 0;
  239. }
  240. }
  241. // check if we have looked at all blocks since last ack
  242. if (lfs->free.ack == 0) {
  243. LFS_WARN("No more free space %d", lfs->free.i + lfs->free.off);
  244. return LFS_ERR_NOSPC;
  245. }
  246. lfs->free.off = (lfs->free.off + lfs->free.size)
  247. % lfs->cfg->block_count;
  248. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->free.ack);
  249. lfs->free.i = 0;
  250. // find mask of free blocks from tree
  251. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  252. int err = lfs_traverse(lfs, lfs_alloc_lookahead, lfs);
  253. if (err) {
  254. return err;
  255. }
  256. }
  257. }
  258. static void lfs_alloc_ack(lfs_t *lfs) {
  259. lfs->free.ack = lfs->cfg->block_count;
  260. }
  261. /// Endian swapping functions ///
  262. static void lfs_dir_fromle32(struct lfs_disk_dir *d) {
  263. d->rev = lfs_fromle32(d->rev);
  264. d->size = lfs_fromle32(d->size);
  265. d->tail[0] = lfs_fromle32(d->tail[0]);
  266. d->tail[1] = lfs_fromle32(d->tail[1]);
  267. }
  268. static void lfs_dir_tole32(struct lfs_disk_dir *d) {
  269. d->rev = lfs_tole32(d->rev);
  270. d->size = lfs_tole32(d->size);
  271. d->tail[0] = lfs_tole32(d->tail[0]);
  272. d->tail[1] = lfs_tole32(d->tail[1]);
  273. }
  274. static void lfs_entry_fromle32(struct lfs_disk_entry *d) {
  275. d->u.dir[0] = lfs_fromle32(d->u.dir[0]);
  276. d->u.dir[1] = lfs_fromle32(d->u.dir[1]);
  277. }
  278. static void lfs_entry_tole32(struct lfs_disk_entry *d) {
  279. d->u.dir[0] = lfs_tole32(d->u.dir[0]);
  280. d->u.dir[1] = lfs_tole32(d->u.dir[1]);
  281. }
  282. static void lfs_superblock_fromle32(struct lfs_disk_superblock *d) {
  283. d->root[0] = lfs_fromle32(d->root[0]);
  284. d->root[1] = lfs_fromle32(d->root[1]);
  285. d->block_size = lfs_fromle32(d->block_size);
  286. d->block_count = lfs_fromle32(d->block_count);
  287. d->version = lfs_fromle32(d->version);
  288. }
  289. static void lfs_superblock_tole32(struct lfs_disk_superblock *d) {
  290. d->root[0] = lfs_tole32(d->root[0]);
  291. d->root[1] = lfs_tole32(d->root[1]);
  292. d->block_size = lfs_tole32(d->block_size);
  293. d->block_count = lfs_tole32(d->block_count);
  294. d->version = lfs_tole32(d->version);
  295. }
  296. /// Metadata pair and directory operations ///
  297. static inline void lfs_pairswap(lfs_block_t pair[2]) {
  298. lfs_block_t t = pair[0];
  299. pair[0] = pair[1];
  300. pair[1] = t;
  301. }
  302. static inline bool lfs_pairisnull(const lfs_block_t pair[2]) {
  303. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  304. }
  305. static inline int lfs_paircmp(
  306. const lfs_block_t paira[2],
  307. const lfs_block_t pairb[2]) {
  308. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  309. paira[0] == pairb[1] || paira[1] == pairb[0]);
  310. }
  311. static inline bool lfs_pairsync(
  312. const lfs_block_t paira[2],
  313. const lfs_block_t pairb[2]) {
  314. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  315. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  316. }
  317. static inline lfs_size_t lfs_entry_size(const lfs_entry_t *entry) {
  318. return 4 + entry->d.elen + entry->d.alen + entry->d.nlen;
  319. }
  320. static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {
  321. // allocate pair of dir blocks
  322. for (int i = 0; i < 2; i++) {
  323. int err = lfs_alloc(lfs, &dir->pair[i]);
  324. if (err) {
  325. return err;
  326. }
  327. }
  328. // rather than clobbering one of the blocks we just pretend
  329. // the revision may be valid
  330. int err = lfs_bd_read(lfs, dir->pair[0], 0, &dir->d.rev, 4);
  331. dir->d.rev = lfs_fromle32(dir->d.rev);
  332. if (err) {
  333. return err;
  334. }
  335. // set defaults
  336. dir->d.rev += 1;
  337. dir->d.size = sizeof(dir->d)+4;
  338. dir->d.tail[0] = 0xffffffff;
  339. dir->d.tail[1] = 0xffffffff;
  340. dir->off = sizeof(dir->d);
  341. // don't write out yet, let caller take care of that
  342. return 0;
  343. }
  344. static int lfs_dir_fetch(lfs_t *lfs,
  345. lfs_dir_t *dir, const lfs_block_t pair[2]) {
  346. // copy out pair, otherwise may be aliasing dir
  347. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  348. bool valid = false;
  349. // check both blocks for the most recent revision
  350. for (int i = 0; i < 2; i++) {
  351. struct lfs_disk_dir test;
  352. int err = lfs_bd_read(lfs, tpair[i], 0, &test, sizeof(test));
  353. lfs_dir_fromle32(&test);
  354. if (err) {
  355. return err;
  356. }
  357. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  358. continue;
  359. }
  360. if ((0x7fffffff & test.size) < sizeof(test)+4 ||
  361. (0x7fffffff & test.size) > lfs->cfg->block_size) {
  362. continue;
  363. }
  364. uint32_t crc = 0xffffffff;
  365. lfs_dir_tole32(&test);
  366. lfs_crc(&crc, &test, sizeof(test));
  367. lfs_dir_fromle32(&test);
  368. err = lfs_bd_crc(lfs, tpair[i], sizeof(test),
  369. (0x7fffffff & test.size) - sizeof(test), &crc);
  370. if (err) {
  371. return err;
  372. }
  373. if (crc != 0) {
  374. continue;
  375. }
  376. valid = true;
  377. // setup dir in case it's valid
  378. dir->pair[0] = tpair[(i+0) % 2];
  379. dir->pair[1] = tpair[(i+1) % 2];
  380. dir->off = sizeof(dir->d);
  381. dir->d = test;
  382. }
  383. if (!valid) {
  384. LFS_ERROR("Corrupted dir pair at %d %d", tpair[0], tpair[1]);
  385. return LFS_ERR_CORRUPT;
  386. }
  387. return 0;
  388. }
  389. struct lfs_region {
  390. lfs_off_t oldoff;
  391. lfs_size_t oldlen;
  392. const void *newdata;
  393. lfs_size_t newlen;
  394. };
  395. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  396. const struct lfs_region *regions, int count) {
  397. // increment revision count
  398. dir->d.rev += 1;
  399. // keep pairs in order such that pair[0] is most recent
  400. lfs_pairswap(dir->pair);
  401. for (int i = 0; i < count; i++) {
  402. dir->d.size += regions[i].newlen - regions[i].oldlen;
  403. }
  404. const lfs_block_t oldpair[2] = {dir->pair[0], dir->pair[1]};
  405. bool relocated = false;
  406. while (true) {
  407. if (true) {
  408. int err = lfs_bd_erase(lfs, dir->pair[0]);
  409. if (err) {
  410. if (err == LFS_ERR_CORRUPT) {
  411. goto relocate;
  412. }
  413. return err;
  414. }
  415. uint32_t crc = 0xffffffff;
  416. lfs_dir_tole32(&dir->d);
  417. lfs_crc(&crc, &dir->d, sizeof(dir->d));
  418. err = lfs_bd_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  419. lfs_dir_fromle32(&dir->d);
  420. if (err) {
  421. if (err == LFS_ERR_CORRUPT) {
  422. goto relocate;
  423. }
  424. return err;
  425. }
  426. int i = 0;
  427. lfs_off_t oldoff = sizeof(dir->d);
  428. lfs_off_t newoff = sizeof(dir->d);
  429. while (newoff < (0x7fffffff & dir->d.size)-4) {
  430. if (i < count && regions[i].oldoff == oldoff) {
  431. lfs_crc(&crc, regions[i].newdata, regions[i].newlen);
  432. err = lfs_bd_prog(lfs, dir->pair[0],
  433. newoff, regions[i].newdata, regions[i].newlen);
  434. if (err) {
  435. if (err == LFS_ERR_CORRUPT) {
  436. goto relocate;
  437. }
  438. return err;
  439. }
  440. oldoff += regions[i].oldlen;
  441. newoff += regions[i].newlen;
  442. i += 1;
  443. } else {
  444. uint8_t data;
  445. err = lfs_bd_read(lfs, oldpair[1], oldoff, &data, 1);
  446. if (err) {
  447. return err;
  448. }
  449. lfs_crc(&crc, &data, 1);
  450. err = lfs_bd_prog(lfs, dir->pair[0], newoff, &data, 1);
  451. if (err) {
  452. if (err == LFS_ERR_CORRUPT) {
  453. goto relocate;
  454. }
  455. return err;
  456. }
  457. oldoff += 1;
  458. newoff += 1;
  459. }
  460. }
  461. crc = lfs_tole32(crc);
  462. err = lfs_bd_prog(lfs, dir->pair[0], newoff, &crc, 4);
  463. crc = lfs_fromle32(crc);
  464. if (err) {
  465. if (err == LFS_ERR_CORRUPT) {
  466. goto relocate;
  467. }
  468. return err;
  469. }
  470. err = lfs_bd_sync(lfs);
  471. if (err) {
  472. if (err == LFS_ERR_CORRUPT) {
  473. goto relocate;
  474. }
  475. return err;
  476. }
  477. // successful commit, check checksum to make sure
  478. uint32_t ncrc = 0xffffffff;
  479. err = lfs_bd_crc(lfs, dir->pair[0], 0,
  480. (0x7fffffff & dir->d.size)-4, &ncrc);
  481. if (err) {
  482. return err;
  483. }
  484. if (ncrc != crc) {
  485. goto relocate;
  486. }
  487. }
  488. break;
  489. relocate:
  490. //commit was corrupted
  491. LFS_DEBUG("Bad block at %d", dir->pair[0]);
  492. // drop caches and prepare to relocate block
  493. relocated = true;
  494. lfs->pcache.block = 0xffffffff;
  495. // can't relocate superblock, filesystem is now frozen
  496. if (lfs_paircmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  497. LFS_WARN("Superblock %d has become unwritable", oldpair[0]);
  498. return LFS_ERR_CORRUPT;
  499. }
  500. // relocate half of pair
  501. int err = lfs_alloc(lfs, &dir->pair[0]);
  502. if (err) {
  503. return err;
  504. }
  505. }
  506. if (relocated) {
  507. // update references if we relocated
  508. LFS_DEBUG("Relocating %d %d to %d %d",
  509. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  510. int err = lfs_relocate(lfs, oldpair, dir->pair);
  511. if (err) {
  512. return err;
  513. }
  514. }
  515. // shift over any directories that are affected
  516. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  517. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  518. d->pair[0] = dir->pair[0];
  519. d->pair[1] = dir->pair[1];
  520. }
  521. }
  522. return 0;
  523. }
  524. static int lfs_dir_update(lfs_t *lfs, lfs_dir_t *dir,
  525. lfs_entry_t *entry, const void *data) {
  526. lfs_entry_tole32(&entry->d);
  527. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  528. {entry->off, sizeof(entry->d), &entry->d, sizeof(entry->d)},
  529. {entry->off+sizeof(entry->d), entry->d.nlen, data, entry->d.nlen}
  530. }, data ? 2 : 1);
  531. lfs_entry_fromle32(&entry->d);
  532. return err;
  533. }
  534. static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,
  535. lfs_entry_t *entry, const void *data) {
  536. // check if we fit, if top bit is set we do not and move on
  537. while (true) {
  538. if (dir->d.size + lfs_entry_size(entry) <= lfs->cfg->block_size) {
  539. entry->off = dir->d.size - 4;
  540. lfs_entry_tole32(&entry->d);
  541. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  542. {entry->off, 0, &entry->d, sizeof(entry->d)},
  543. {entry->off, 0, data, entry->d.nlen}
  544. }, 2);
  545. lfs_entry_fromle32(&entry->d);
  546. return err;
  547. }
  548. // we need to allocate a new dir block
  549. if (!(0x80000000 & dir->d.size)) {
  550. lfs_dir_t olddir = *dir;
  551. int err = lfs_dir_alloc(lfs, dir);
  552. if (err) {
  553. return err;
  554. }
  555. dir->d.tail[0] = olddir.d.tail[0];
  556. dir->d.tail[1] = olddir.d.tail[1];
  557. entry->off = dir->d.size - 4;
  558. lfs_entry_tole32(&entry->d);
  559. err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  560. {entry->off, 0, &entry->d, sizeof(entry->d)},
  561. {entry->off, 0, data, entry->d.nlen}
  562. }, 2);
  563. lfs_entry_fromle32(&entry->d);
  564. if (err) {
  565. return err;
  566. }
  567. olddir.d.size |= 0x80000000;
  568. olddir.d.tail[0] = dir->pair[0];
  569. olddir.d.tail[1] = dir->pair[1];
  570. return lfs_dir_commit(lfs, &olddir, NULL, 0);
  571. }
  572. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  573. if (err) {
  574. return err;
  575. }
  576. }
  577. }
  578. static int lfs_dir_remove(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  579. // check if we should just drop the directory block
  580. if ((dir->d.size & 0x7fffffff) == sizeof(dir->d)+4
  581. + lfs_entry_size(entry)) {
  582. lfs_dir_t pdir;
  583. int res = lfs_pred(lfs, dir->pair, &pdir);
  584. if (res < 0) {
  585. return res;
  586. }
  587. if (pdir.d.size & 0x80000000) {
  588. pdir.d.size &= dir->d.size | 0x7fffffff;
  589. pdir.d.tail[0] = dir->d.tail[0];
  590. pdir.d.tail[1] = dir->d.tail[1];
  591. return lfs_dir_commit(lfs, &pdir, NULL, 0);
  592. }
  593. }
  594. // shift out the entry
  595. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  596. {entry->off, lfs_entry_size(entry), NULL, 0},
  597. }, 1);
  598. if (err) {
  599. return err;
  600. }
  601. // shift over any files/directories that are affected
  602. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  603. if (lfs_paircmp(f->pair, dir->pair) == 0) {
  604. if (f->poff == entry->off) {
  605. f->pair[0] = 0xffffffff;
  606. f->pair[1] = 0xffffffff;
  607. } else if (f->poff > entry->off) {
  608. f->poff -= lfs_entry_size(entry);
  609. }
  610. }
  611. }
  612. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  613. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  614. if (d->off > entry->off) {
  615. d->off -= lfs_entry_size(entry);
  616. d->pos -= lfs_entry_size(entry);
  617. }
  618. }
  619. }
  620. return 0;
  621. }
  622. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  623. while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)-4) {
  624. if (!(0x80000000 & dir->d.size)) {
  625. entry->off = dir->off;
  626. return LFS_ERR_NOENT;
  627. }
  628. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  629. if (err) {
  630. return err;
  631. }
  632. dir->off = sizeof(dir->d);
  633. dir->pos += sizeof(dir->d) + 4;
  634. }
  635. int err = lfs_bd_read(lfs, dir->pair[0], dir->off,
  636. &entry->d, sizeof(entry->d));
  637. lfs_entry_fromle32(&entry->d);
  638. if (err) {
  639. return err;
  640. }
  641. entry->off = dir->off;
  642. dir->off += lfs_entry_size(entry);
  643. dir->pos += lfs_entry_size(entry);
  644. return 0;
  645. }
  646. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  647. lfs_entry_t *entry, const char **path) {
  648. const char *pathname = *path;
  649. size_t pathlen;
  650. entry->d.type = LFS_TYPE_DIR;
  651. entry->d.elen = sizeof(entry->d) - 4;
  652. entry->d.alen = 0;
  653. entry->d.nlen = 0;
  654. entry->d.u.dir[0] = lfs->root[0];
  655. entry->d.u.dir[1] = lfs->root[1];
  656. while (true) {
  657. nextname:
  658. // skip slashes
  659. pathname += strspn(pathname, "/");
  660. pathlen = strcspn(pathname, "/");
  661. // skip '.' and root '..'
  662. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  663. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  664. pathname += pathlen;
  665. goto nextname;
  666. }
  667. // skip if matched by '..' in name
  668. const char *suffix = pathname + pathlen;
  669. size_t sufflen;
  670. int depth = 1;
  671. while (true) {
  672. suffix += strspn(suffix, "/");
  673. sufflen = strcspn(suffix, "/");
  674. if (sufflen == 0) {
  675. break;
  676. }
  677. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  678. depth -= 1;
  679. if (depth == 0) {
  680. pathname = suffix + sufflen;
  681. goto nextname;
  682. }
  683. } else {
  684. depth += 1;
  685. }
  686. suffix += sufflen;
  687. }
  688. // found path
  689. if (pathname[0] == '\0') {
  690. return 0;
  691. }
  692. // update what we've found
  693. *path = pathname;
  694. // continue on if we hit a directory
  695. if (entry->d.type != LFS_TYPE_DIR) {
  696. return LFS_ERR_NOTDIR;
  697. }
  698. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  699. if (err) {
  700. return err;
  701. }
  702. // find entry matching name
  703. while (true) {
  704. int err = lfs_dir_next(lfs, dir, entry);
  705. if (err) {
  706. return err;
  707. }
  708. if (((0x7f & entry->d.type) != LFS_TYPE_REG &&
  709. (0x7f & entry->d.type) != LFS_TYPE_DIR) ||
  710. entry->d.nlen != pathlen) {
  711. continue;
  712. }
  713. int res = lfs_bd_cmp(lfs, dir->pair[0],
  714. entry->off + 4+entry->d.elen+entry->d.alen,
  715. pathname, pathlen);
  716. if (res < 0) {
  717. return res;
  718. }
  719. // found match
  720. if (res) {
  721. break;
  722. }
  723. }
  724. // check that entry has not been moved
  725. if (entry->d.type & 0x80) {
  726. int moved = lfs_moved(lfs, &entry->d.u);
  727. if (moved < 0 || moved) {
  728. return (moved < 0) ? moved : LFS_ERR_NOENT;
  729. }
  730. entry->d.type &= ~0x80;
  731. }
  732. // to next name
  733. pathname += pathlen;
  734. }
  735. }
  736. /// Top level directory operations ///
  737. int lfs_mkdir(lfs_t *lfs, const char *path) {
  738. // deorphan if we haven't yet, needed at most once after poweron
  739. if (!lfs->deorphaned) {
  740. int err = lfs_deorphan(lfs);
  741. if (err) {
  742. return err;
  743. }
  744. }
  745. // fetch parent directory
  746. lfs_dir_t cwd;
  747. lfs_entry_t entry;
  748. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  749. if (err != LFS_ERR_NOENT || strchr(path, '/') != NULL) {
  750. return err ? err : LFS_ERR_EXIST;
  751. }
  752. // build up new directory
  753. lfs_alloc_ack(lfs);
  754. lfs_dir_t dir;
  755. err = lfs_dir_alloc(lfs, &dir);
  756. if (err) {
  757. return err;
  758. }
  759. dir.d.tail[0] = cwd.d.tail[0];
  760. dir.d.tail[1] = cwd.d.tail[1];
  761. err = lfs_dir_commit(lfs, &dir, NULL, 0);
  762. if (err) {
  763. return err;
  764. }
  765. entry.d.type = LFS_TYPE_DIR;
  766. entry.d.elen = sizeof(entry.d) - 4;
  767. entry.d.alen = 0;
  768. entry.d.nlen = strlen(path);
  769. entry.d.u.dir[0] = dir.pair[0];
  770. entry.d.u.dir[1] = dir.pair[1];
  771. cwd.d.tail[0] = dir.pair[0];
  772. cwd.d.tail[1] = dir.pair[1];
  773. err = lfs_dir_append(lfs, &cwd, &entry, path);
  774. if (err) {
  775. return err;
  776. }
  777. lfs_alloc_ack(lfs);
  778. return 0;
  779. }
  780. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  781. dir->pair[0] = lfs->root[0];
  782. dir->pair[1] = lfs->root[1];
  783. lfs_entry_t entry;
  784. int err = lfs_dir_find(lfs, dir, &entry, &path);
  785. if (err) {
  786. return err;
  787. } else if (entry.d.type != LFS_TYPE_DIR) {
  788. return LFS_ERR_NOTDIR;
  789. }
  790. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  791. if (err) {
  792. return err;
  793. }
  794. // setup head dir
  795. // special offset for '.' and '..'
  796. dir->head[0] = dir->pair[0];
  797. dir->head[1] = dir->pair[1];
  798. dir->pos = sizeof(dir->d) - 2;
  799. dir->off = sizeof(dir->d);
  800. // add to list of directories
  801. dir->next = lfs->dirs;
  802. lfs->dirs = dir;
  803. return 0;
  804. }
  805. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  806. // remove from list of directories
  807. for (lfs_dir_t **p = &lfs->dirs; *p; p = &(*p)->next) {
  808. if (*p == dir) {
  809. *p = dir->next;
  810. break;
  811. }
  812. }
  813. return 0;
  814. }
  815. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  816. memset(info, 0, sizeof(*info));
  817. // special offset for '.' and '..'
  818. if (dir->pos == sizeof(dir->d) - 2) {
  819. info->type = LFS_TYPE_DIR;
  820. strcpy(info->name, ".");
  821. dir->pos += 1;
  822. return 1;
  823. } else if (dir->pos == sizeof(dir->d) - 1) {
  824. info->type = LFS_TYPE_DIR;
  825. strcpy(info->name, "..");
  826. dir->pos += 1;
  827. return 1;
  828. }
  829. lfs_entry_t entry;
  830. while (true) {
  831. int err = lfs_dir_next(lfs, dir, &entry);
  832. if (err) {
  833. return (err == LFS_ERR_NOENT) ? 0 : err;
  834. }
  835. if ((0x7f & entry.d.type) != LFS_TYPE_REG &&
  836. (0x7f & entry.d.type) != LFS_TYPE_DIR) {
  837. continue;
  838. }
  839. // check that entry has not been moved
  840. if (entry.d.type & 0x80) {
  841. int moved = lfs_moved(lfs, &entry.d.u);
  842. if (moved < 0) {
  843. return moved;
  844. }
  845. if (moved) {
  846. continue;
  847. }
  848. entry.d.type &= ~0x80;
  849. }
  850. break;
  851. }
  852. info->type = entry.d.type;
  853. if (info->type == LFS_TYPE_REG) {
  854. info->size = entry.d.u.file.size;
  855. }
  856. int err = lfs_bd_read(lfs, dir->pair[0],
  857. entry.off + 4+entry.d.elen+entry.d.alen,
  858. info->name, entry.d.nlen);
  859. if (err) {
  860. return err;
  861. }
  862. return 1;
  863. }
  864. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  865. // simply walk from head dir
  866. int err = lfs_dir_rewind(lfs, dir);
  867. if (err) {
  868. return err;
  869. }
  870. dir->pos = off;
  871. while (off > (0x7fffffff & dir->d.size)) {
  872. off -= 0x7fffffff & dir->d.size;
  873. if (!(0x80000000 & dir->d.size)) {
  874. return LFS_ERR_INVAL;
  875. }
  876. err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  877. if (err) {
  878. return err;
  879. }
  880. }
  881. dir->off = off;
  882. return 0;
  883. }
  884. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  885. (void)lfs;
  886. return dir->pos;
  887. }
  888. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  889. // reload the head dir
  890. int err = lfs_dir_fetch(lfs, dir, dir->head);
  891. if (err) {
  892. return err;
  893. }
  894. dir->pair[0] = dir->head[0];
  895. dir->pair[1] = dir->head[1];
  896. dir->pos = sizeof(dir->d) - 2;
  897. dir->off = sizeof(dir->d);
  898. return 0;
  899. }
  900. /// File index list operations ///
  901. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  902. lfs_off_t size = *off;
  903. lfs_off_t b = lfs->cfg->block_size - 2*4;
  904. lfs_off_t i = size / b;
  905. if (i == 0) {
  906. return 0;
  907. }
  908. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  909. *off = size - b*i - 4*lfs_popc(i);
  910. return i;
  911. }
  912. static int lfs_ctz_find(lfs_t *lfs,
  913. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  914. lfs_block_t head, lfs_size_t size,
  915. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  916. if (size == 0) {
  917. *block = 0xffffffff;
  918. *off = 0;
  919. return 0;
  920. }
  921. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  922. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  923. while (current > target) {
  924. lfs_size_t skip = lfs_min(
  925. lfs_npw2(current-target+1) - 1,
  926. lfs_ctz(current));
  927. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  928. head = lfs_fromle32(head);
  929. if (err) {
  930. return err;
  931. }
  932. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  933. current -= 1 << skip;
  934. }
  935. *block = head;
  936. *off = pos;
  937. return 0;
  938. }
  939. static int lfs_ctz_extend(lfs_t *lfs,
  940. lfs_cache_t *rcache, lfs_cache_t *pcache,
  941. lfs_block_t head, lfs_size_t size,
  942. lfs_block_t *block, lfs_off_t *off) {
  943. while (true) {
  944. // go ahead and grab a block
  945. lfs_block_t nblock;
  946. int err = lfs_alloc(lfs, &nblock);
  947. if (err) {
  948. return err;
  949. }
  950. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  951. if (true) {
  952. err = lfs_bd_erase(lfs, nblock);
  953. if (err) {
  954. if (err == LFS_ERR_CORRUPT) {
  955. goto relocate;
  956. }
  957. return err;
  958. }
  959. if (size == 0) {
  960. *block = nblock;
  961. *off = 0;
  962. return 0;
  963. }
  964. size -= 1;
  965. lfs_off_t index = lfs_ctz_index(lfs, &size);
  966. size += 1;
  967. // just copy out the last block if it is incomplete
  968. if (size != lfs->cfg->block_size) {
  969. for (lfs_off_t i = 0; i < size; i++) {
  970. uint8_t data;
  971. err = lfs_cache_read(lfs, rcache, NULL,
  972. head, i, &data, 1);
  973. if (err) {
  974. return err;
  975. }
  976. err = lfs_cache_prog(lfs, pcache, rcache,
  977. nblock, i, &data, 1);
  978. if (err) {
  979. if (err == LFS_ERR_CORRUPT) {
  980. goto relocate;
  981. }
  982. return err;
  983. }
  984. }
  985. *block = nblock;
  986. *off = size;
  987. return 0;
  988. }
  989. // append block
  990. index += 1;
  991. lfs_size_t skips = lfs_ctz(index) + 1;
  992. for (lfs_off_t i = 0; i < skips; i++) {
  993. head = lfs_tole32(head);
  994. err = lfs_cache_prog(lfs, pcache, rcache,
  995. nblock, 4*i, &head, 4);
  996. head = lfs_fromle32(head);
  997. if (err) {
  998. if (err == LFS_ERR_CORRUPT) {
  999. goto relocate;
  1000. }
  1001. return err;
  1002. }
  1003. if (i != skips-1) {
  1004. err = lfs_cache_read(lfs, rcache, NULL,
  1005. head, 4*i, &head, 4);
  1006. head = lfs_fromle32(head);
  1007. if (err) {
  1008. return err;
  1009. }
  1010. }
  1011. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1012. }
  1013. *block = nblock;
  1014. *off = 4*skips;
  1015. return 0;
  1016. }
  1017. relocate:
  1018. LFS_DEBUG("Bad block at %d", nblock);
  1019. // just clear cache and try a new block
  1020. pcache->block = 0xffffffff;
  1021. }
  1022. }
  1023. static int lfs_ctz_traverse(lfs_t *lfs,
  1024. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1025. lfs_block_t head, lfs_size_t size,
  1026. int (*cb)(void*, lfs_block_t), void *data) {
  1027. if (size == 0) {
  1028. return 0;
  1029. }
  1030. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1031. while (true) {
  1032. int err = cb(data, head);
  1033. if (err) {
  1034. return err;
  1035. }
  1036. if (index == 0) {
  1037. return 0;
  1038. }
  1039. lfs_block_t heads[2];
  1040. int count = 2 - (index & 1);
  1041. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &heads, count*4);
  1042. heads[0] = lfs_fromle32(heads[0]);
  1043. heads[1] = lfs_fromle32(heads[1]);
  1044. if (err) {
  1045. return err;
  1046. }
  1047. for (int i = 0; i < count-1; i++) {
  1048. err = cb(data, heads[i]);
  1049. if (err) {
  1050. return err;
  1051. }
  1052. }
  1053. head = heads[count-1];
  1054. index -= count;
  1055. }
  1056. }
  1057. /// Top level file operations ///
  1058. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1059. const char *path, int flags) {
  1060. // deorphan if we haven't yet, needed at most once after poweron
  1061. if ((flags & 3) != LFS_O_RDONLY && !lfs->deorphaned) {
  1062. int err = lfs_deorphan(lfs);
  1063. if (err) {
  1064. return err;
  1065. }
  1066. }
  1067. // allocate entry for file if it doesn't exist
  1068. lfs_dir_t cwd;
  1069. lfs_entry_t entry;
  1070. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1071. if (err && (err != LFS_ERR_NOENT || strchr(path, '/') != NULL)) {
  1072. return err;
  1073. }
  1074. if (err == LFS_ERR_NOENT) {
  1075. if (!(flags & LFS_O_CREAT)) {
  1076. return LFS_ERR_NOENT;
  1077. }
  1078. // create entry to remember name
  1079. entry.d.type = LFS_TYPE_REG;
  1080. entry.d.elen = sizeof(entry.d) - 4;
  1081. entry.d.alen = 0;
  1082. entry.d.nlen = strlen(path);
  1083. entry.d.u.file.head = 0xffffffff;
  1084. entry.d.u.file.size = 0;
  1085. err = lfs_dir_append(lfs, &cwd, &entry, path);
  1086. if (err) {
  1087. return err;
  1088. }
  1089. } else if (entry.d.type == LFS_TYPE_DIR) {
  1090. return LFS_ERR_ISDIR;
  1091. } else if (flags & LFS_O_EXCL) {
  1092. return LFS_ERR_EXIST;
  1093. }
  1094. // setup file struct
  1095. file->pair[0] = cwd.pair[0];
  1096. file->pair[1] = cwd.pair[1];
  1097. file->poff = entry.off;
  1098. file->head = entry.d.u.file.head;
  1099. file->size = entry.d.u.file.size;
  1100. file->flags = flags;
  1101. file->pos = 0;
  1102. if (flags & LFS_O_TRUNC) {
  1103. if (file->size != 0) {
  1104. file->flags |= LFS_F_DIRTY;
  1105. }
  1106. file->head = 0xffffffff;
  1107. file->size = 0;
  1108. }
  1109. // allocate buffer if needed
  1110. file->cache.block = 0xffffffff;
  1111. if (lfs->cfg->file_buffer) {
  1112. if (lfs->files) {
  1113. // already in use
  1114. return LFS_ERR_NOMEM;
  1115. }
  1116. file->cache.buffer = lfs->cfg->file_buffer;
  1117. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  1118. file->cache.buffer = lfs_malloc(lfs->cfg->read_size);
  1119. if (!file->cache.buffer) {
  1120. return LFS_ERR_NOMEM;
  1121. }
  1122. } else {
  1123. file->cache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1124. if (!file->cache.buffer) {
  1125. return LFS_ERR_NOMEM;
  1126. }
  1127. }
  1128. // add to list of files
  1129. file->next = lfs->files;
  1130. lfs->files = file;
  1131. return 0;
  1132. }
  1133. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1134. int err = lfs_file_sync(lfs, file);
  1135. // remove from list of files
  1136. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  1137. if (*p == file) {
  1138. *p = file->next;
  1139. break;
  1140. }
  1141. }
  1142. // clean up memory
  1143. if (!lfs->cfg->file_buffer) {
  1144. lfs_free(file->cache.buffer);
  1145. }
  1146. return err;
  1147. }
  1148. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1149. relocate:
  1150. LFS_DEBUG("Bad block at %d", file->block);
  1151. // just relocate what exists into new block
  1152. lfs_block_t nblock;
  1153. int err = lfs_alloc(lfs, &nblock);
  1154. if (err) {
  1155. return err;
  1156. }
  1157. err = lfs_bd_erase(lfs, nblock);
  1158. if (err) {
  1159. if (err == LFS_ERR_CORRUPT) {
  1160. goto relocate;
  1161. }
  1162. return err;
  1163. }
  1164. // either read from dirty cache or disk
  1165. for (lfs_off_t i = 0; i < file->off; i++) {
  1166. uint8_t data;
  1167. err = lfs_cache_read(lfs, &lfs->rcache, &file->cache,
  1168. file->block, i, &data, 1);
  1169. if (err) {
  1170. return err;
  1171. }
  1172. err = lfs_cache_prog(lfs, &lfs->pcache, &lfs->rcache,
  1173. nblock, i, &data, 1);
  1174. if (err) {
  1175. if (err == LFS_ERR_CORRUPT) {
  1176. goto relocate;
  1177. }
  1178. return err;
  1179. }
  1180. }
  1181. // copy over new state of file
  1182. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->prog_size);
  1183. file->cache.block = lfs->pcache.block;
  1184. file->cache.off = lfs->pcache.off;
  1185. lfs->pcache.block = 0xffffffff;
  1186. file->block = nblock;
  1187. return 0;
  1188. }
  1189. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  1190. if (file->flags & LFS_F_READING) {
  1191. // just drop read cache
  1192. file->cache.block = 0xffffffff;
  1193. file->flags &= ~LFS_F_READING;
  1194. }
  1195. if (file->flags & LFS_F_WRITING) {
  1196. lfs_off_t pos = file->pos;
  1197. // copy over anything after current branch
  1198. lfs_file_t orig = {
  1199. .head = file->head,
  1200. .size = file->size,
  1201. .flags = LFS_O_RDONLY,
  1202. .pos = file->pos,
  1203. .cache = lfs->rcache,
  1204. };
  1205. lfs->rcache.block = 0xffffffff;
  1206. while (file->pos < file->size) {
  1207. // copy over a byte at a time, leave it up to caching
  1208. // to make this efficient
  1209. uint8_t data;
  1210. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  1211. if (res < 0) {
  1212. return res;
  1213. }
  1214. res = lfs_file_write(lfs, file, &data, 1);
  1215. if (res < 0) {
  1216. return res;
  1217. }
  1218. // keep our reference to the rcache in sync
  1219. if (lfs->rcache.block != 0xffffffff) {
  1220. orig.cache.block = 0xffffffff;
  1221. lfs->rcache.block = 0xffffffff;
  1222. }
  1223. }
  1224. // write out what we have
  1225. while (true) {
  1226. int err = lfs_cache_flush(lfs, &file->cache, &lfs->rcache);
  1227. if (err) {
  1228. if (err == LFS_ERR_CORRUPT) {
  1229. goto relocate;
  1230. }
  1231. return err;
  1232. }
  1233. break;
  1234. relocate:
  1235. err = lfs_file_relocate(lfs, file);
  1236. if (err) {
  1237. return err;
  1238. }
  1239. }
  1240. // actual file updates
  1241. file->head = file->block;
  1242. file->size = file->pos;
  1243. file->flags &= ~LFS_F_WRITING;
  1244. file->flags |= LFS_F_DIRTY;
  1245. file->pos = pos;
  1246. }
  1247. return 0;
  1248. }
  1249. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  1250. int err = lfs_file_flush(lfs, file);
  1251. if (err) {
  1252. return err;
  1253. }
  1254. if ((file->flags & LFS_F_DIRTY) &&
  1255. !(file->flags & LFS_F_ERRED) &&
  1256. !lfs_pairisnull(file->pair)) {
  1257. // update dir entry
  1258. lfs_dir_t cwd;
  1259. err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1260. if (err) {
  1261. return err;
  1262. }
  1263. lfs_entry_t entry = {.off = file->poff};
  1264. err = lfs_bd_read(lfs, cwd.pair[0], entry.off,
  1265. &entry.d, sizeof(entry.d));
  1266. lfs_entry_fromle32(&entry.d);
  1267. if (err) {
  1268. return err;
  1269. }
  1270. LFS_ASSERT(entry.d.type == LFS_TYPE_REG);
  1271. entry.d.u.file.head = file->head;
  1272. entry.d.u.file.size = file->size;
  1273. err = lfs_dir_update(lfs, &cwd, &entry, NULL);
  1274. if (err) {
  1275. return err;
  1276. }
  1277. file->flags &= ~LFS_F_DIRTY;
  1278. }
  1279. return 0;
  1280. }
  1281. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  1282. void *buffer, lfs_size_t size) {
  1283. uint8_t *data = buffer;
  1284. lfs_size_t nsize = size;
  1285. if ((file->flags & 3) == LFS_O_WRONLY) {
  1286. return LFS_ERR_BADF;
  1287. }
  1288. if (file->flags & LFS_F_WRITING) {
  1289. // flush out any writes
  1290. int err = lfs_file_flush(lfs, file);
  1291. if (err) {
  1292. return err;
  1293. }
  1294. }
  1295. if (file->pos >= file->size) {
  1296. // eof if past end
  1297. return 0;
  1298. }
  1299. size = lfs_min(size, file->size - file->pos);
  1300. nsize = size;
  1301. while (nsize > 0) {
  1302. // check if we need a new block
  1303. if (!(file->flags & LFS_F_READING) ||
  1304. file->off == lfs->cfg->block_size) {
  1305. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1306. file->head, file->size,
  1307. file->pos, &file->block, &file->off);
  1308. if (err) {
  1309. return err;
  1310. }
  1311. file->flags |= LFS_F_READING;
  1312. }
  1313. // read as much as we can in current block
  1314. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1315. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1316. file->block, file->off, data, diff);
  1317. if (err) {
  1318. return err;
  1319. }
  1320. file->pos += diff;
  1321. file->off += diff;
  1322. data += diff;
  1323. nsize -= diff;
  1324. }
  1325. return size;
  1326. }
  1327. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1328. const void *buffer, lfs_size_t size) {
  1329. const uint8_t *data = buffer;
  1330. lfs_size_t nsize = size;
  1331. if ((file->flags & 3) == LFS_O_RDONLY) {
  1332. return LFS_ERR_BADF;
  1333. }
  1334. if (file->flags & LFS_F_READING) {
  1335. // drop any reads
  1336. int err = lfs_file_flush(lfs, file);
  1337. if (err) {
  1338. return err;
  1339. }
  1340. }
  1341. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1342. file->pos = file->size;
  1343. }
  1344. if (!(file->flags & LFS_F_WRITING) && file->pos > file->size) {
  1345. // fill with zeros
  1346. lfs_off_t pos = file->pos;
  1347. file->pos = file->size;
  1348. while (file->pos < pos) {
  1349. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1350. if (res < 0) {
  1351. return res;
  1352. }
  1353. }
  1354. }
  1355. while (nsize > 0) {
  1356. // check if we need a new block
  1357. if (!(file->flags & LFS_F_WRITING) ||
  1358. file->off == lfs->cfg->block_size) {
  1359. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  1360. // find out which block we're extending from
  1361. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1362. file->head, file->size,
  1363. file->pos-1, &file->block, &file->off);
  1364. if (err) {
  1365. file->flags |= LFS_F_ERRED;
  1366. return err;
  1367. }
  1368. // mark cache as dirty since we may have read data into it
  1369. file->cache.block = 0xffffffff;
  1370. }
  1371. // extend file with new blocks
  1372. lfs_alloc_ack(lfs);
  1373. int err = lfs_ctz_extend(lfs, &lfs->rcache, &file->cache,
  1374. file->block, file->pos,
  1375. &file->block, &file->off);
  1376. if (err) {
  1377. file->flags |= LFS_F_ERRED;
  1378. return err;
  1379. }
  1380. file->flags |= LFS_F_WRITING;
  1381. }
  1382. // program as much as we can in current block
  1383. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1384. while (true) {
  1385. int err = lfs_cache_prog(lfs, &file->cache, &lfs->rcache,
  1386. file->block, file->off, data, diff);
  1387. if (err) {
  1388. if (err == LFS_ERR_CORRUPT) {
  1389. goto relocate;
  1390. }
  1391. file->flags |= LFS_F_ERRED;
  1392. return err;
  1393. }
  1394. break;
  1395. relocate:
  1396. err = lfs_file_relocate(lfs, file);
  1397. if (err) {
  1398. file->flags |= LFS_F_ERRED;
  1399. return err;
  1400. }
  1401. }
  1402. file->pos += diff;
  1403. file->off += diff;
  1404. data += diff;
  1405. nsize -= diff;
  1406. lfs_alloc_ack(lfs);
  1407. }
  1408. file->flags &= ~LFS_F_ERRED;
  1409. return size;
  1410. }
  1411. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1412. lfs_soff_t off, int whence) {
  1413. // write out everything beforehand, may be noop if rdonly
  1414. int err = lfs_file_flush(lfs, file);
  1415. if (err) {
  1416. return err;
  1417. }
  1418. // update pos
  1419. if (whence == LFS_SEEK_SET) {
  1420. file->pos = off;
  1421. } else if (whence == LFS_SEEK_CUR) {
  1422. if (off < 0 && (lfs_off_t)-off > file->pos) {
  1423. return LFS_ERR_INVAL;
  1424. }
  1425. file->pos = file->pos + off;
  1426. } else if (whence == LFS_SEEK_END) {
  1427. if (off < 0 && (lfs_off_t)-off > file->size) {
  1428. return LFS_ERR_INVAL;
  1429. }
  1430. file->pos = file->size + off;
  1431. }
  1432. return file->pos;
  1433. }
  1434. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  1435. if ((file->flags & 3) == LFS_O_RDONLY) {
  1436. return LFS_ERR_BADF;
  1437. }
  1438. lfs_off_t oldsize = lfs_file_size(lfs, file);
  1439. if (size < oldsize) {
  1440. // need to flush since directly changing metadata
  1441. int err = lfs_file_flush(lfs, file);
  1442. if (err) {
  1443. return err;
  1444. }
  1445. // lookup new head in ctz skip list
  1446. err = lfs_ctz_find(lfs, &file->cache, NULL,
  1447. file->head, file->size,
  1448. size, &file->head, &(lfs_off_t){0});
  1449. if (err) {
  1450. return err;
  1451. }
  1452. file->size = size;
  1453. file->flags |= LFS_F_DIRTY;
  1454. } else if (size > oldsize) {
  1455. lfs_off_t pos = file->pos;
  1456. // flush+seek if not already at end
  1457. if (file->pos != oldsize) {
  1458. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  1459. if (err < 0) {
  1460. return err;
  1461. }
  1462. }
  1463. // fill with zeros
  1464. while (file->pos < size) {
  1465. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1466. if (res < 0) {
  1467. return res;
  1468. }
  1469. }
  1470. // restore pos
  1471. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  1472. if (err < 0) {
  1473. return err;
  1474. }
  1475. }
  1476. return 0;
  1477. }
  1478. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1479. (void)lfs;
  1480. return file->pos;
  1481. }
  1482. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1483. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1484. if (res < 0) {
  1485. return res;
  1486. }
  1487. return 0;
  1488. }
  1489. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1490. (void)lfs;
  1491. if (file->flags & LFS_F_WRITING) {
  1492. return lfs_max(file->pos, file->size);
  1493. } else {
  1494. return file->size;
  1495. }
  1496. }
  1497. /// General fs operations ///
  1498. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1499. lfs_dir_t cwd;
  1500. lfs_entry_t entry;
  1501. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1502. if (err) {
  1503. return err;
  1504. }
  1505. memset(info, 0, sizeof(*info));
  1506. info->type = entry.d.type;
  1507. if (info->type == LFS_TYPE_REG) {
  1508. info->size = entry.d.u.file.size;
  1509. }
  1510. if (lfs_paircmp(entry.d.u.dir, lfs->root) == 0) {
  1511. strcpy(info->name, "/");
  1512. } else {
  1513. err = lfs_bd_read(lfs, cwd.pair[0],
  1514. entry.off + 4+entry.d.elen+entry.d.alen,
  1515. info->name, entry.d.nlen);
  1516. if (err) {
  1517. return err;
  1518. }
  1519. }
  1520. return 0;
  1521. }
  1522. int lfs_remove(lfs_t *lfs, const char *path) {
  1523. // deorphan if we haven't yet, needed at most once after poweron
  1524. if (!lfs->deorphaned) {
  1525. int err = lfs_deorphan(lfs);
  1526. if (err) {
  1527. return err;
  1528. }
  1529. }
  1530. lfs_dir_t cwd;
  1531. lfs_entry_t entry;
  1532. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1533. if (err) {
  1534. return err;
  1535. }
  1536. lfs_dir_t dir;
  1537. if (entry.d.type == LFS_TYPE_DIR) {
  1538. // must be empty before removal, checking size
  1539. // without masking top bit checks for any case where
  1540. // dir is not empty
  1541. err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1542. if (err) {
  1543. return err;
  1544. } else if (dir.d.size != sizeof(dir.d)+4) {
  1545. return LFS_ERR_NOTEMPTY;
  1546. }
  1547. }
  1548. // remove the entry
  1549. err = lfs_dir_remove(lfs, &cwd, &entry);
  1550. if (err) {
  1551. return err;
  1552. }
  1553. // if we were a directory, find pred, replace tail
  1554. if (entry.d.type == LFS_TYPE_DIR) {
  1555. int res = lfs_pred(lfs, dir.pair, &cwd);
  1556. if (res < 0) {
  1557. return res;
  1558. }
  1559. LFS_ASSERT(res); // must have pred
  1560. cwd.d.tail[0] = dir.d.tail[0];
  1561. cwd.d.tail[1] = dir.d.tail[1];
  1562. err = lfs_dir_commit(lfs, &cwd, NULL, 0);
  1563. if (err) {
  1564. return err;
  1565. }
  1566. }
  1567. return 0;
  1568. }
  1569. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  1570. // deorphan if we haven't yet, needed at most once after poweron
  1571. if (!lfs->deorphaned) {
  1572. int err = lfs_deorphan(lfs);
  1573. if (err) {
  1574. return err;
  1575. }
  1576. }
  1577. // find old entry
  1578. lfs_dir_t oldcwd;
  1579. lfs_entry_t oldentry;
  1580. int err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1581. if (err) {
  1582. return err;
  1583. }
  1584. // allocate new entry
  1585. lfs_dir_t newcwd;
  1586. lfs_entry_t preventry;
  1587. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  1588. if (err && (err != LFS_ERR_NOENT || strchr(newpath, '/') != NULL)) {
  1589. return err;
  1590. }
  1591. bool prevexists = (err != LFS_ERR_NOENT);
  1592. bool samepair = (lfs_paircmp(oldcwd.pair, newcwd.pair) == 0);
  1593. // must have same type
  1594. if (prevexists && preventry.d.type != oldentry.d.type) {
  1595. return LFS_ERR_ISDIR;
  1596. }
  1597. lfs_dir_t dir;
  1598. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1599. // must be empty before removal, checking size
  1600. // without masking top bit checks for any case where
  1601. // dir is not empty
  1602. err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  1603. if (err) {
  1604. return err;
  1605. } else if (dir.d.size != sizeof(dir.d)+4) {
  1606. return LFS_ERR_NOTEMPTY;
  1607. }
  1608. }
  1609. // mark as moving
  1610. oldentry.d.type |= 0x80;
  1611. err = lfs_dir_update(lfs, &oldcwd, &oldentry, NULL);
  1612. if (err) {
  1613. return err;
  1614. }
  1615. // update pair if newcwd == oldcwd
  1616. if (samepair) {
  1617. newcwd = oldcwd;
  1618. }
  1619. // move to new location
  1620. lfs_entry_t newentry = preventry;
  1621. newentry.d = oldentry.d;
  1622. newentry.d.type &= ~0x80;
  1623. newentry.d.nlen = strlen(newpath);
  1624. if (prevexists) {
  1625. err = lfs_dir_update(lfs, &newcwd, &newentry, newpath);
  1626. if (err) {
  1627. return err;
  1628. }
  1629. } else {
  1630. err = lfs_dir_append(lfs, &newcwd, &newentry, newpath);
  1631. if (err) {
  1632. return err;
  1633. }
  1634. }
  1635. // update pair if newcwd == oldcwd
  1636. if (samepair) {
  1637. oldcwd = newcwd;
  1638. }
  1639. // remove old entry
  1640. err = lfs_dir_remove(lfs, &oldcwd, &oldentry);
  1641. if (err) {
  1642. return err;
  1643. }
  1644. // if we were a directory, find pred, replace tail
  1645. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1646. int res = lfs_pred(lfs, dir.pair, &newcwd);
  1647. if (res < 0) {
  1648. return res;
  1649. }
  1650. LFS_ASSERT(res); // must have pred
  1651. newcwd.d.tail[0] = dir.d.tail[0];
  1652. newcwd.d.tail[1] = dir.d.tail[1];
  1653. err = lfs_dir_commit(lfs, &newcwd, NULL, 0);
  1654. if (err) {
  1655. return err;
  1656. }
  1657. }
  1658. return 0;
  1659. }
  1660. /// Filesystem operations ///
  1661. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  1662. lfs->cfg = cfg;
  1663. // setup read cache
  1664. lfs->rcache.block = 0xffffffff;
  1665. if (lfs->cfg->read_buffer) {
  1666. lfs->rcache.buffer = lfs->cfg->read_buffer;
  1667. } else {
  1668. lfs->rcache.buffer = lfs_malloc(lfs->cfg->read_size);
  1669. if (!lfs->rcache.buffer) {
  1670. return LFS_ERR_NOMEM;
  1671. }
  1672. }
  1673. // setup program cache
  1674. lfs->pcache.block = 0xffffffff;
  1675. if (lfs->cfg->prog_buffer) {
  1676. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  1677. } else {
  1678. lfs->pcache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1679. if (!lfs->pcache.buffer) {
  1680. return LFS_ERR_NOMEM;
  1681. }
  1682. }
  1683. // setup lookahead, round down to nearest 32-bits
  1684. LFS_ASSERT(lfs->cfg->lookahead % 32 == 0);
  1685. LFS_ASSERT(lfs->cfg->lookahead > 0);
  1686. if (lfs->cfg->lookahead_buffer) {
  1687. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  1688. } else {
  1689. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead/8);
  1690. if (!lfs->free.buffer) {
  1691. return LFS_ERR_NOMEM;
  1692. }
  1693. }
  1694. // check that program and read sizes are multiples of the block size
  1695. LFS_ASSERT(lfs->cfg->prog_size % lfs->cfg->read_size == 0);
  1696. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->prog_size == 0);
  1697. // check that the block size is large enough to fit ctz pointers
  1698. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  1699. <= lfs->cfg->block_size);
  1700. // setup default state
  1701. lfs->root[0] = 0xffffffff;
  1702. lfs->root[1] = 0xffffffff;
  1703. lfs->files = NULL;
  1704. lfs->dirs = NULL;
  1705. lfs->deorphaned = false;
  1706. return 0;
  1707. }
  1708. static int lfs_deinit(lfs_t *lfs) {
  1709. // free allocated memory
  1710. if (!lfs->cfg->read_buffer) {
  1711. lfs_free(lfs->rcache.buffer);
  1712. }
  1713. if (!lfs->cfg->prog_buffer) {
  1714. lfs_free(lfs->pcache.buffer);
  1715. }
  1716. if (!lfs->cfg->lookahead_buffer) {
  1717. lfs_free(lfs->free.buffer);
  1718. }
  1719. return 0;
  1720. }
  1721. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  1722. int err = lfs_init(lfs, cfg);
  1723. if (err) {
  1724. return err;
  1725. }
  1726. // create free lookahead
  1727. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  1728. lfs->free.off = 0;
  1729. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->cfg->block_count);
  1730. lfs->free.i = 0;
  1731. lfs_alloc_ack(lfs);
  1732. // create superblock dir
  1733. lfs_dir_t superdir;
  1734. err = lfs_dir_alloc(lfs, &superdir);
  1735. if (err) {
  1736. return err;
  1737. }
  1738. // write root directory
  1739. lfs_dir_t root;
  1740. err = lfs_dir_alloc(lfs, &root);
  1741. if (err) {
  1742. return err;
  1743. }
  1744. err = lfs_dir_commit(lfs, &root, NULL, 0);
  1745. if (err) {
  1746. return err;
  1747. }
  1748. lfs->root[0] = root.pair[0];
  1749. lfs->root[1] = root.pair[1];
  1750. // write superblocks
  1751. lfs_superblock_t superblock = {
  1752. .off = sizeof(superdir.d),
  1753. .d.type = LFS_TYPE_SUPERBLOCK,
  1754. .d.elen = sizeof(superblock.d) - sizeof(superblock.d.magic) - 4,
  1755. .d.nlen = sizeof(superblock.d.magic),
  1756. .d.version = LFS_DISK_VERSION,
  1757. .d.magic = {"littlefs"},
  1758. .d.block_size = lfs->cfg->block_size,
  1759. .d.block_count = lfs->cfg->block_count,
  1760. .d.root = {lfs->root[0], lfs->root[1]},
  1761. };
  1762. superdir.d.tail[0] = root.pair[0];
  1763. superdir.d.tail[1] = root.pair[1];
  1764. superdir.d.size = sizeof(superdir.d) + sizeof(superblock.d) + 4;
  1765. // write both pairs to be safe
  1766. lfs_superblock_tole32(&superblock.d);
  1767. bool valid = false;
  1768. for (int i = 0; i < 2; i++) {
  1769. err = lfs_dir_commit(lfs, &superdir, (struct lfs_region[]){
  1770. {sizeof(superdir.d), sizeof(superblock.d),
  1771. &superblock.d, sizeof(superblock.d)}
  1772. }, 1);
  1773. if (err && err != LFS_ERR_CORRUPT) {
  1774. return err;
  1775. }
  1776. valid = valid || !err;
  1777. }
  1778. if (!valid) {
  1779. return LFS_ERR_CORRUPT;
  1780. }
  1781. // sanity check that fetch works
  1782. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  1783. if (err) {
  1784. return err;
  1785. }
  1786. lfs_alloc_ack(lfs);
  1787. return lfs_deinit(lfs);
  1788. }
  1789. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  1790. int err = lfs_init(lfs, cfg);
  1791. if (err) {
  1792. return err;
  1793. }
  1794. // setup free lookahead
  1795. lfs->free.off = 0;
  1796. lfs->free.size = 0;
  1797. lfs->free.i = 0;
  1798. lfs_alloc_ack(lfs);
  1799. // load superblock
  1800. lfs_dir_t dir;
  1801. lfs_superblock_t superblock;
  1802. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  1803. if (err && err != LFS_ERR_CORRUPT) {
  1804. return err;
  1805. }
  1806. if (!err) {
  1807. err = lfs_bd_read(lfs, dir.pair[0], sizeof(dir.d),
  1808. &superblock.d, sizeof(superblock.d));
  1809. lfs_superblock_fromle32(&superblock.d);
  1810. if (err) {
  1811. return err;
  1812. }
  1813. lfs->root[0] = superblock.d.root[0];
  1814. lfs->root[1] = superblock.d.root[1];
  1815. }
  1816. if (err || memcmp(superblock.d.magic, "littlefs", 8) != 0) {
  1817. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  1818. return LFS_ERR_CORRUPT;
  1819. }
  1820. uint16_t major_version = (0xffff & (superblock.d.version >> 16));
  1821. uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
  1822. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  1823. minor_version > LFS_DISK_VERSION_MINOR)) {
  1824. LFS_ERROR("Invalid version %d.%d", major_version, minor_version);
  1825. return LFS_ERR_INVAL;
  1826. }
  1827. return 0;
  1828. }
  1829. int lfs_unmount(lfs_t *lfs) {
  1830. return lfs_deinit(lfs);
  1831. }
  1832. /// Littlefs specific operations ///
  1833. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  1834. if (lfs_pairisnull(lfs->root)) {
  1835. return 0;
  1836. }
  1837. // iterate over metadata pairs
  1838. lfs_dir_t dir;
  1839. lfs_entry_t entry;
  1840. lfs_block_t cwd[2] = {0, 1};
  1841. while (true) {
  1842. for (int i = 0; i < 2; i++) {
  1843. int err = cb(data, cwd[i]);
  1844. if (err) {
  1845. return err;
  1846. }
  1847. }
  1848. int err = lfs_dir_fetch(lfs, &dir, cwd);
  1849. if (err) {
  1850. return err;
  1851. }
  1852. // iterate over contents
  1853. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  1854. err = lfs_bd_read(lfs, dir.pair[0], dir.off,
  1855. &entry.d, sizeof(entry.d));
  1856. lfs_entry_fromle32(&entry.d);
  1857. if (err) {
  1858. return err;
  1859. }
  1860. dir.off += lfs_entry_size(&entry);
  1861. if ((0x70 & entry.d.type) == (0x70 & LFS_TYPE_REG)) {
  1862. err = lfs_ctz_traverse(lfs, &lfs->rcache, NULL,
  1863. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  1864. if (err) {
  1865. return err;
  1866. }
  1867. }
  1868. }
  1869. cwd[0] = dir.d.tail[0];
  1870. cwd[1] = dir.d.tail[1];
  1871. if (lfs_pairisnull(cwd)) {
  1872. break;
  1873. }
  1874. }
  1875. // iterate over any open files
  1876. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  1877. if (f->flags & LFS_F_DIRTY) {
  1878. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  1879. f->head, f->size, cb, data);
  1880. if (err) {
  1881. return err;
  1882. }
  1883. }
  1884. if (f->flags & LFS_F_WRITING) {
  1885. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  1886. f->block, f->pos, cb, data);
  1887. if (err) {
  1888. return err;
  1889. }
  1890. }
  1891. }
  1892. return 0;
  1893. }
  1894. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir) {
  1895. if (lfs_pairisnull(lfs->root)) {
  1896. return 0;
  1897. }
  1898. // iterate over all directory directory entries
  1899. int err = lfs_dir_fetch(lfs, pdir, (const lfs_block_t[2]){0, 1});
  1900. if (err) {
  1901. return err;
  1902. }
  1903. while (!lfs_pairisnull(pdir->d.tail)) {
  1904. if (lfs_paircmp(pdir->d.tail, dir) == 0) {
  1905. return true;
  1906. }
  1907. err = lfs_dir_fetch(lfs, pdir, pdir->d.tail);
  1908. if (err) {
  1909. return err;
  1910. }
  1911. }
  1912. return false;
  1913. }
  1914. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  1915. lfs_dir_t *parent, lfs_entry_t *entry) {
  1916. if (lfs_pairisnull(lfs->root)) {
  1917. return 0;
  1918. }
  1919. parent->d.tail[0] = 0;
  1920. parent->d.tail[1] = 1;
  1921. // iterate over all directory directory entries
  1922. while (!lfs_pairisnull(parent->d.tail)) {
  1923. int err = lfs_dir_fetch(lfs, parent, parent->d.tail);
  1924. if (err) {
  1925. return err;
  1926. }
  1927. while (true) {
  1928. err = lfs_dir_next(lfs, parent, entry);
  1929. if (err && err != LFS_ERR_NOENT) {
  1930. return err;
  1931. }
  1932. if (err == LFS_ERR_NOENT) {
  1933. break;
  1934. }
  1935. if (((0x70 & entry->d.type) == (0x70 & LFS_TYPE_DIR)) &&
  1936. lfs_paircmp(entry->d.u.dir, dir) == 0) {
  1937. return true;
  1938. }
  1939. }
  1940. }
  1941. return false;
  1942. }
  1943. static int lfs_moved(lfs_t *lfs, const void *e) {
  1944. if (lfs_pairisnull(lfs->root)) {
  1945. return 0;
  1946. }
  1947. // skip superblock
  1948. lfs_dir_t cwd;
  1949. int err = lfs_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
  1950. if (err) {
  1951. return err;
  1952. }
  1953. // iterate over all directory directory entries
  1954. lfs_entry_t entry;
  1955. while (!lfs_pairisnull(cwd.d.tail)) {
  1956. err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  1957. if (err) {
  1958. return err;
  1959. }
  1960. while (true) {
  1961. err = lfs_dir_next(lfs, &cwd, &entry);
  1962. if (err && err != LFS_ERR_NOENT) {
  1963. return err;
  1964. }
  1965. if (err == LFS_ERR_NOENT) {
  1966. break;
  1967. }
  1968. if (!(0x80 & entry.d.type) &&
  1969. memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
  1970. return true;
  1971. }
  1972. }
  1973. }
  1974. return false;
  1975. }
  1976. static int lfs_relocate(lfs_t *lfs,
  1977. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]) {
  1978. // find parent
  1979. lfs_dir_t parent;
  1980. lfs_entry_t entry;
  1981. int res = lfs_parent(lfs, oldpair, &parent, &entry);
  1982. if (res < 0) {
  1983. return res;
  1984. }
  1985. if (res) {
  1986. // update disk, this creates a desync
  1987. entry.d.u.dir[0] = newpair[0];
  1988. entry.d.u.dir[1] = newpair[1];
  1989. int err = lfs_dir_update(lfs, &parent, &entry, NULL);
  1990. if (err) {
  1991. return err;
  1992. }
  1993. // update internal root
  1994. if (lfs_paircmp(oldpair, lfs->root) == 0) {
  1995. LFS_DEBUG("Relocating root %d %d", newpair[0], newpair[1]);
  1996. lfs->root[0] = newpair[0];
  1997. lfs->root[1] = newpair[1];
  1998. }
  1999. // clean up bad block, which should now be a desync
  2000. return lfs_deorphan(lfs);
  2001. }
  2002. // find pred
  2003. res = lfs_pred(lfs, oldpair, &parent);
  2004. if (res < 0) {
  2005. return res;
  2006. }
  2007. if (res) {
  2008. // just replace bad pair, no desync can occur
  2009. parent.d.tail[0] = newpair[0];
  2010. parent.d.tail[1] = newpair[1];
  2011. return lfs_dir_commit(lfs, &parent, NULL, 0);
  2012. }
  2013. // couldn't find dir, must be new
  2014. return 0;
  2015. }
  2016. int lfs_deorphan(lfs_t *lfs) {
  2017. lfs->deorphaned = true;
  2018. if (lfs_pairisnull(lfs->root)) {
  2019. return 0;
  2020. }
  2021. lfs_dir_t pdir = {.d.size = 0x80000000};
  2022. lfs_dir_t cwd = {.d.tail[0] = 0, .d.tail[1] = 1};
  2023. // iterate over all directory directory entries
  2024. while (!lfs_pairisnull(cwd.d.tail)) {
  2025. int err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2026. if (err) {
  2027. return err;
  2028. }
  2029. // check head blocks for orphans
  2030. if (!(0x80000000 & pdir.d.size)) {
  2031. // check if we have a parent
  2032. lfs_dir_t parent;
  2033. lfs_entry_t entry;
  2034. int res = lfs_parent(lfs, pdir.d.tail, &parent, &entry);
  2035. if (res < 0) {
  2036. return res;
  2037. }
  2038. if (!res) {
  2039. // we are an orphan
  2040. LFS_DEBUG("Found orphan %d %d",
  2041. pdir.d.tail[0], pdir.d.tail[1]);
  2042. pdir.d.tail[0] = cwd.d.tail[0];
  2043. pdir.d.tail[1] = cwd.d.tail[1];
  2044. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2045. if (err) {
  2046. return err;
  2047. }
  2048. break;
  2049. }
  2050. if (!lfs_pairsync(entry.d.u.dir, pdir.d.tail)) {
  2051. // we have desynced
  2052. LFS_DEBUG("Found desync %d %d",
  2053. entry.d.u.dir[0], entry.d.u.dir[1]);
  2054. pdir.d.tail[0] = entry.d.u.dir[0];
  2055. pdir.d.tail[1] = entry.d.u.dir[1];
  2056. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2057. if (err) {
  2058. return err;
  2059. }
  2060. break;
  2061. }
  2062. }
  2063. // check entries for moves
  2064. lfs_entry_t entry;
  2065. while (true) {
  2066. err = lfs_dir_next(lfs, &cwd, &entry);
  2067. if (err && err != LFS_ERR_NOENT) {
  2068. return err;
  2069. }
  2070. if (err == LFS_ERR_NOENT) {
  2071. break;
  2072. }
  2073. // found moved entry
  2074. if (entry.d.type & 0x80) {
  2075. int moved = lfs_moved(lfs, &entry.d.u);
  2076. if (moved < 0) {
  2077. return moved;
  2078. }
  2079. if (moved) {
  2080. LFS_DEBUG("Found move %d %d",
  2081. entry.d.u.dir[0], entry.d.u.dir[1]);
  2082. err = lfs_dir_remove(lfs, &cwd, &entry);
  2083. if (err) {
  2084. return err;
  2085. }
  2086. } else {
  2087. LFS_DEBUG("Found partial move %d %d",
  2088. entry.d.u.dir[0], entry.d.u.dir[1]);
  2089. entry.d.type &= ~0x80;
  2090. err = lfs_dir_update(lfs, &cwd, &entry, NULL);
  2091. if (err) {
  2092. return err;
  2093. }
  2094. }
  2095. }
  2096. }
  2097. memcpy(&pdir, &cwd, sizeof(pdir));
  2098. }
  2099. return 0;
  2100. }