lfs.c 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836
  1. /*
  2. * The little filesystem
  3. *
  4. * Copyright (c) 2017 Christopher Haster
  5. * Distributed under the MIT license
  6. */
  7. #include "lfs.h"
  8. #include "lfs_util.h"
  9. #include <string.h>
  10. #include <stdlib.h>
  11. #include <assert.h>
  12. /// Caching block device operations ///
  13. static int lfs_cache_read(lfs_t *lfs, lfs_cache_t *rcache,
  14. const lfs_cache_t *pcache, lfs_block_t block,
  15. lfs_off_t off, void *buffer, lfs_size_t size) {
  16. uint8_t *data = buffer;
  17. assert(block < lfs->cfg->block_count);
  18. while (size > 0) {
  19. if (pcache && block == pcache->block && off >= pcache->off &&
  20. off < pcache->off + lfs->cfg->prog_size) {
  21. // is already in pcache?
  22. lfs_size_t diff = lfs_min(size,
  23. lfs->cfg->prog_size - (off-pcache->off));
  24. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  25. data += diff;
  26. off += diff;
  27. size -= diff;
  28. continue;
  29. }
  30. if (block == rcache->block && off >= rcache->off &&
  31. off < rcache->off + lfs->cfg->read_size) {
  32. // is already in rcache?
  33. lfs_size_t diff = lfs_min(size,
  34. lfs->cfg->read_size - (off-rcache->off));
  35. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  36. data += diff;
  37. off += diff;
  38. size -= diff;
  39. continue;
  40. }
  41. if (off % lfs->cfg->read_size == 0 && size >= lfs->cfg->read_size) {
  42. // bypass cache?
  43. lfs_size_t diff = size - (size % lfs->cfg->read_size);
  44. int err = lfs->cfg->read(lfs->cfg, block, off, data, diff);
  45. if (err) {
  46. return err;
  47. }
  48. data += diff;
  49. off += diff;
  50. size -= diff;
  51. continue;
  52. }
  53. // load to cache, first condition can no longer fail
  54. rcache->block = block;
  55. rcache->off = off - (off % lfs->cfg->read_size);
  56. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  57. rcache->off, rcache->buffer, lfs->cfg->read_size);
  58. if (err) {
  59. return err;
  60. }
  61. }
  62. return 0;
  63. }
  64. static int lfs_cache_flush(lfs_t *lfs, lfs_cache_t *cache) {
  65. if (cache->block != 0xffffffff) {
  66. int err = lfs->cfg->prog(lfs->cfg, cache->block,
  67. cache->off, cache->buffer, lfs->cfg->prog_size);
  68. if (err) {
  69. return err;
  70. }
  71. cache->block = 0xffffffff;
  72. }
  73. return 0;
  74. }
  75. static int lfs_cache_prog(lfs_t *lfs, lfs_cache_t *cache, lfs_block_t block,
  76. lfs_off_t off, const void *buffer, lfs_size_t size) {
  77. const uint8_t *data = buffer;
  78. assert(block < lfs->cfg->block_count);
  79. while (size > 0) {
  80. if (block == cache->block && off >= cache->off &&
  81. off < cache->off + lfs->cfg->prog_size) {
  82. // is already in cache?
  83. lfs_size_t diff = lfs_min(size,
  84. lfs->cfg->prog_size - (off-cache->off));
  85. memcpy(&cache->buffer[off-cache->off], data, diff);
  86. data += diff;
  87. off += diff;
  88. size -= diff;
  89. if (off % lfs->cfg->prog_size == 0) {
  90. // eagerly flush out cache if we fill up
  91. int err = lfs_cache_flush(lfs, cache);
  92. if (err) {
  93. return err;
  94. }
  95. }
  96. continue;
  97. }
  98. // cache must have been flushed, either by programming and
  99. // entire block or manually flushing the cache
  100. assert(cache->block == 0xffffffff);
  101. if (off % lfs->cfg->prog_size == 0 &&
  102. size >= lfs->cfg->prog_size) {
  103. // bypass cache?
  104. lfs_size_t diff = size - (size % lfs->cfg->prog_size);
  105. int err = lfs->cfg->prog(lfs->cfg, block, off, data, diff);
  106. if (err) {
  107. return err;
  108. }
  109. data += diff;
  110. off += diff;
  111. size -= diff;
  112. continue;
  113. }
  114. // prepare cache, first condition can no longer fail
  115. cache->block = block;
  116. cache->off = off - (off % lfs->cfg->prog_size);
  117. }
  118. return 0;
  119. }
  120. /// General lfs block device operations ///
  121. static int lfs_read(lfs_t *lfs, lfs_block_t block,
  122. lfs_off_t off, void *buffer, lfs_size_t size) {
  123. // if we ever do more than writes to alternating pairs,
  124. // this may need to consider pcache
  125. return lfs_cache_read(lfs, &lfs->rcache, NULL,
  126. block, off, buffer, size);
  127. }
  128. static int lfs_prog(lfs_t *lfs, lfs_block_t block,
  129. lfs_off_t off, const void *buffer, lfs_size_t size) {
  130. return lfs_cache_prog(lfs, &lfs->pcache,
  131. block, off, buffer, size);
  132. }
  133. static int lfs_erase(lfs_t *lfs, lfs_block_t block) {
  134. return lfs->cfg->erase(lfs->cfg, block);
  135. }
  136. static int lfs_sync(lfs_t *lfs) {
  137. int err = lfs_cache_flush(lfs, &lfs->pcache);
  138. if (err) {
  139. return err;
  140. }
  141. return lfs->cfg->sync(lfs->cfg);
  142. }
  143. static int lfs_cmp(lfs_t *lfs, lfs_block_t block,
  144. lfs_off_t off, lfs_size_t size, const void *buffer) {
  145. const uint8_t *data = buffer;
  146. for (lfs_off_t i = 0; i < size; i++) {
  147. uint8_t c;
  148. int err = lfs_read(lfs, block, off+i, &c, 1);
  149. if (err) {
  150. return err;
  151. }
  152. if (c != data[i]) {
  153. return false;
  154. }
  155. }
  156. return true;
  157. }
  158. /// Block allocator ///
  159. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  160. lfs_t *lfs = p;
  161. lfs_block_t off = (block - lfs->free.start) % lfs->cfg->block_count;
  162. if (off < lfs->cfg->lookahead) {
  163. lfs->free.lookahead[off / 32] |= 1U << (off % 32);
  164. }
  165. return 0;
  166. }
  167. static int lfs_alloc_scan(lfs_t *lfs, lfs_block_t *block) {
  168. lfs_block_t end = lfs->free.start + lfs->cfg->block_count;
  169. while (true) {
  170. while (lfs->free.off < lfs->cfg->lookahead) {
  171. lfs_block_t off = lfs->free.off;
  172. lfs->free.off += 1;
  173. if (!(lfs->free.lookahead[off / 32] & (1U << (off % 32)))) {
  174. // found a free block
  175. *block = (lfs->free.start + off) % lfs->cfg->block_count;
  176. return 0;
  177. }
  178. }
  179. // could not find block
  180. lfs->free.start += lfs->cfg->lookahead;
  181. lfs->free.off = 0;
  182. if (lfs_scmp(lfs->free.start, end) > 0) {
  183. return LFS_ERR_NOSPC;
  184. }
  185. // find mask of free blocks from tree
  186. memset(lfs->free.lookahead, 0, lfs->cfg->lookahead/8);
  187. int err = lfs_traverse(lfs, lfs_alloc_lookahead, lfs);
  188. if (err) {
  189. return err;
  190. }
  191. }
  192. }
  193. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  194. // try to scan for free block
  195. int err = lfs_alloc_scan(lfs, block);
  196. if (err != LFS_ERR_NOSPC) {
  197. return err;
  198. }
  199. // still can't allocate a block? check for orphans
  200. err = lfs_deorphan(lfs);
  201. if (err) {
  202. return err;
  203. }
  204. // scan again or die trying
  205. err = lfs_alloc_scan(lfs, block);
  206. if (err) {
  207. LFS_WARN("No more free space%s", "");
  208. return err;
  209. }
  210. return 0;
  211. }
  212. /// Metadata pair and directory operations ///
  213. static inline void lfs_pairswap(lfs_block_t pair[2]) {
  214. lfs_block_t t = pair[0];
  215. pair[0] = pair[1];
  216. pair[1] = t;
  217. }
  218. static inline bool lfs_pairisnull(const lfs_block_t pair[2]) {
  219. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  220. }
  221. static inline int lfs_paircmp(
  222. const lfs_block_t paira[2],
  223. const lfs_block_t pairb[2]) {
  224. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  225. paira[0] == pairb[1] || paira[1] == pairb[0]);
  226. }
  227. static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {
  228. // allocate pair of dir blocks
  229. for (int i = 0; i < 2; i++) {
  230. int err = lfs_alloc(lfs, &dir->pair[i]);
  231. if (err) {
  232. return err;
  233. }
  234. }
  235. // we couldn't find unique blocks, we're out of space
  236. if (dir->pair[0] == dir->pair[1]) {
  237. return LFS_ERR_NOSPC;
  238. }
  239. // rather than clobbering one of the blocks we just pretend
  240. // the revision may be valid
  241. int err = lfs_read(lfs, dir->pair[0], 0, &dir->d.rev, 4);
  242. if (err) {
  243. return err;
  244. }
  245. // set defaults
  246. dir->d.rev += 1;
  247. dir->d.size = sizeof(dir->d);
  248. dir->d.tail[0] = -1;
  249. dir->d.tail[1] = -1;
  250. dir->off = sizeof(dir->d);
  251. // don't write out yet, let caller take care of that
  252. return 0;
  253. }
  254. static int lfs_dir_fetch(lfs_t *lfs,
  255. lfs_dir_t *dir, const lfs_block_t pair[2]) {
  256. // copy out pair, otherwise may be aliasing dir
  257. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  258. bool valid = false;
  259. // check both blocks for the most recent revision
  260. for (int i = 0; i < 2; i++) {
  261. struct lfs_disk_dir test;
  262. int err = lfs_read(lfs, tpair[i], 0, &test, sizeof(test));
  263. if (err) {
  264. return err;
  265. }
  266. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  267. continue;
  268. }
  269. uint32_t crc = 0xffffffff;
  270. crc = lfs_crc(crc, &test, sizeof(test));
  271. for (lfs_off_t j = sizeof(test); j < lfs->cfg->block_size; j += 4) {
  272. uint32_t word;
  273. int err = lfs_read(lfs, tpair[i], j, &word, 4);
  274. if (err) {
  275. return err;
  276. }
  277. crc = lfs_crc(crc, &word, 4);
  278. }
  279. if (crc != 0) {
  280. continue;
  281. }
  282. valid = true;
  283. // setup dir in case it's valid
  284. dir->pair[0] = tpair[(i+0) % 2];
  285. dir->pair[1] = tpair[(i+1) % 2];
  286. dir->off = sizeof(dir->d);
  287. dir->d = test;
  288. }
  289. if (!valid) {
  290. LFS_ERROR("Corrupted dir pair at %d %d", tpair[0], tpair[1]);
  291. return LFS_ERR_CORRUPT;
  292. }
  293. return 0;
  294. }
  295. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  296. const lfs_entry_t *entry, const void *data) {
  297. dir->d.rev += 1;
  298. lfs_pairswap(dir->pair);
  299. int err = lfs_erase(lfs, dir->pair[0]);
  300. if (err) {
  301. return err;
  302. }
  303. uint32_t crc = 0xffffffff;
  304. crc = lfs_crc(crc, &dir->d, sizeof(dir->d));
  305. err = lfs_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  306. if (err) {
  307. return err;
  308. }
  309. lfs_off_t off = sizeof(dir->d);
  310. lfs_size_t size = 0x7fffffff & dir->d.size;
  311. while (off < size) {
  312. if (entry && off == entry->off) {
  313. crc = lfs_crc(crc, &entry->d, sizeof(entry->d));
  314. int err = lfs_prog(lfs, dir->pair[0],
  315. off, &entry->d, sizeof(entry->d));
  316. if (err) {
  317. return err;
  318. }
  319. off += sizeof(entry->d);
  320. if (data) {
  321. crc = lfs_crc(crc, data, entry->d.len - sizeof(entry->d));
  322. int err = lfs_prog(lfs, dir->pair[0],
  323. off, data, entry->d.len - sizeof(entry->d));
  324. if (err) {
  325. return err;
  326. }
  327. off += entry->d.len - sizeof(entry->d);
  328. }
  329. } else {
  330. uint8_t data;
  331. int err = lfs_read(lfs, dir->pair[1], off, &data, 1);
  332. if (err) {
  333. return err;
  334. }
  335. crc = lfs_crc(crc, &data, 1);
  336. err = lfs_prog(lfs, dir->pair[0], off, &data, 1);
  337. if (err) {
  338. return err;
  339. }
  340. off += 1;
  341. }
  342. }
  343. while (off < lfs->cfg->block_size-4) {
  344. uint8_t data = 0xff;
  345. crc = lfs_crc(crc, &data, 1);
  346. err = lfs_prog(lfs, dir->pair[0], off, &data, 1);
  347. if (err) {
  348. return err;
  349. }
  350. off += 1;
  351. }
  352. err = lfs_prog(lfs, dir->pair[0], lfs->cfg->block_size-4, &crc, 4);
  353. if (err) {
  354. return err;
  355. }
  356. return lfs_sync(lfs);
  357. }
  358. static int lfs_dir_shift(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  359. dir->d.rev += 1;
  360. dir->d.size -= entry->d.len;
  361. lfs_pairswap(dir->pair);
  362. int err = lfs_erase(lfs, dir->pair[0]);
  363. if (err) {
  364. return err;
  365. }
  366. uint32_t crc = 0xffffffff;
  367. crc = lfs_crc(crc, &dir->d, sizeof(dir->d));
  368. err = lfs_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  369. if (err) {
  370. return err;
  371. }
  372. lfs_off_t woff = sizeof(dir->d);
  373. lfs_off_t roff = sizeof(dir->d);
  374. lfs_size_t size = 0x7fffffff & dir->d.size;
  375. while (woff < size) {
  376. if (roff == entry->off) {
  377. roff += entry->d.len;
  378. } else {
  379. uint8_t data;
  380. int err = lfs_read(lfs, dir->pair[1], roff, &data, 1);
  381. if (err) {
  382. return err;
  383. }
  384. crc = lfs_crc(crc, &data, 1);
  385. err = lfs_prog(lfs, dir->pair[0], woff, &data, 1);
  386. if (err) {
  387. return err;
  388. }
  389. woff += 1;
  390. roff += 1;
  391. }
  392. }
  393. while (woff < lfs->cfg->block_size-4) {
  394. uint8_t data = 0xff;
  395. crc = lfs_crc(crc, &data, 1);
  396. err = lfs_prog(lfs, dir->pair[0], woff, &data, 1);
  397. if (err) {
  398. return err;
  399. }
  400. woff += 1;
  401. }
  402. err = lfs_prog(lfs, dir->pair[0], lfs->cfg->block_size-4, &crc, 4);
  403. if (err) {
  404. return err;
  405. }
  406. return lfs_sync(lfs);
  407. }
  408. static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,
  409. lfs_entry_t *entry, const void *data) {
  410. // check if we fit, if top bit is set we do not and move on
  411. while (true) {
  412. if (dir->d.size + entry->d.len <= lfs->cfg->block_size - 4) {
  413. entry->off = dir->d.size;
  414. dir->d.size += entry->d.len;
  415. return lfs_dir_commit(lfs, dir, entry, data);
  416. }
  417. // we need to allocate a new dir block
  418. if (!(0x80000000 & dir->d.size)) {
  419. lfs_dir_t newdir;
  420. int err = lfs_dir_alloc(lfs, &newdir);
  421. if (err) {
  422. return err;
  423. }
  424. // our allocator doesn't track blocks before being appended,
  425. // so even if we found some blocks, they may not be unique
  426. if (entry->d.type == LFS_TYPE_DIR &&
  427. lfs_paircmp(entry->d.u.dir, newdir.pair) == 0) {
  428. return LFS_ERR_NOSPC;
  429. }
  430. newdir.d.tail[0] = dir->d.tail[0];
  431. newdir.d.tail[1] = dir->d.tail[1];
  432. entry->off = newdir.d.size;
  433. newdir.d.size += entry->d.len;
  434. err = lfs_dir_commit(lfs, &newdir, entry, data);
  435. if (err) {
  436. return err;
  437. }
  438. dir->d.size |= 0x80000000;
  439. dir->d.tail[0] = newdir.pair[0];
  440. dir->d.tail[1] = newdir.pair[1];
  441. return lfs_dir_commit(lfs, dir, NULL, NULL);
  442. }
  443. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  444. if (err) {
  445. return err;
  446. }
  447. }
  448. }
  449. static int lfs_dir_remove(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  450. // either shift out the one entry or remove the whole dir block
  451. if (dir->d.size == sizeof(dir->d)) {
  452. lfs_dir_t pdir;
  453. int err = lfs_dir_fetch(lfs, &pdir, lfs->root);
  454. if (err) {
  455. return err;
  456. }
  457. while (lfs_paircmp(pdir.d.tail, dir->pair) != 0) {
  458. int err = lfs_dir_fetch(lfs, &pdir, pdir.d.tail);
  459. if (err) {
  460. return err;
  461. }
  462. }
  463. if (!(pdir.d.size & 0x80000000)) {
  464. return lfs_dir_shift(lfs, dir, entry);
  465. } else {
  466. pdir.d.tail[0] = dir->d.tail[0];
  467. pdir.d.tail[1] = dir->d.tail[1];
  468. return lfs_dir_commit(lfs, &pdir, NULL, NULL);
  469. }
  470. } else {
  471. return lfs_dir_shift(lfs, dir, entry);
  472. }
  473. }
  474. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  475. while (true) {
  476. if (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)) {
  477. if (!(0x80000000 & dir->d.size)) {
  478. entry->off = dir->off;
  479. return LFS_ERR_NOENT;
  480. }
  481. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  482. if (err) {
  483. return err;
  484. }
  485. dir->off = sizeof(dir->d);
  486. dir->pos += sizeof(dir->d);
  487. continue;
  488. }
  489. int err = lfs_read(lfs, dir->pair[0], dir->off,
  490. &entry->d, sizeof(entry->d));
  491. if (err) {
  492. return err;
  493. }
  494. dir->off += entry->d.len;
  495. dir->pos += entry->d.len;
  496. if ((0xff & entry->d.type) == LFS_TYPE_REG ||
  497. (0xff & entry->d.type) == LFS_TYPE_DIR) {
  498. entry->off = dir->off - entry->d.len;
  499. return 0;
  500. }
  501. }
  502. }
  503. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  504. lfs_entry_t *entry, const char **path) {
  505. const char *pathname = *path;
  506. size_t pathlen;
  507. while (true) {
  508. nextname:
  509. // skip slashes
  510. pathname += strspn(pathname, "/");
  511. pathlen = strcspn(pathname, "/");
  512. // skip '.' and root '..'
  513. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  514. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  515. pathname += pathlen;
  516. goto nextname;
  517. }
  518. // skip if matched by '..' in name
  519. const char *suffix = pathname + pathlen;
  520. size_t sufflen;
  521. int depth = 1;
  522. while (true) {
  523. suffix += strspn(suffix, "/");
  524. sufflen = strcspn(suffix, "/");
  525. if (sufflen == 0) {
  526. break;
  527. }
  528. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  529. depth -= 1;
  530. if (depth == 0) {
  531. pathname = suffix + sufflen;
  532. goto nextname;
  533. }
  534. } else {
  535. depth += 1;
  536. }
  537. suffix += sufflen;
  538. }
  539. // find path
  540. while (true) {
  541. int err = lfs_dir_next(lfs, dir, entry);
  542. if (err) {
  543. return err;
  544. }
  545. if (entry->d.len - sizeof(entry->d) != pathlen) {
  546. continue;
  547. }
  548. int ret = lfs_cmp(lfs, dir->pair[0],
  549. entry->off + sizeof(entry->d), pathlen, pathname);
  550. if (ret < 0) {
  551. return ret;
  552. }
  553. // Found match
  554. if (ret == true) {
  555. break;
  556. }
  557. }
  558. pathname += pathlen;
  559. pathname += strspn(pathname, "/");
  560. if (pathname[0] == '\0') {
  561. return 0;
  562. }
  563. // continue on if we hit a directory
  564. if (entry->d.type != LFS_TYPE_DIR) {
  565. return LFS_ERR_NOTDIR;
  566. }
  567. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  568. if (err) {
  569. return err;
  570. }
  571. *path = pathname;
  572. }
  573. return 0;
  574. }
  575. /// Top level directory operations ///
  576. int lfs_mkdir(lfs_t *lfs, const char *path) {
  577. // fetch parent directory
  578. lfs_dir_t cwd;
  579. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  580. if (err) {
  581. return err;
  582. }
  583. lfs_entry_t entry;
  584. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  585. if (err != LFS_ERR_NOENT) {
  586. return err ? err : LFS_ERR_EXISTS;
  587. }
  588. // Build up new directory
  589. lfs_dir_t dir;
  590. err = lfs_dir_alloc(lfs, &dir);
  591. if (err) {
  592. return err;
  593. }
  594. dir.d.tail[0] = cwd.d.tail[0];
  595. dir.d.tail[1] = cwd.d.tail[1];
  596. err = lfs_dir_commit(lfs, &dir, NULL, NULL);
  597. if (err) {
  598. return err;
  599. }
  600. entry.d.type = LFS_TYPE_DIR;
  601. entry.d.len = sizeof(entry.d) + strlen(path);
  602. entry.d.u.dir[0] = dir.pair[0];
  603. entry.d.u.dir[1] = dir.pair[1];
  604. cwd.d.tail[0] = dir.pair[0];
  605. cwd.d.tail[1] = dir.pair[1];
  606. return lfs_dir_append(lfs, &cwd, &entry, path);
  607. }
  608. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  609. dir->pair[0] = lfs->root[0];
  610. dir->pair[1] = lfs->root[1];
  611. int err = lfs_dir_fetch(lfs, dir, dir->pair);
  612. if (err) {
  613. return err;
  614. }
  615. if (strspn(path, "/.") == strlen(path)) {
  616. // can only be something like '/././../.'
  617. dir->head[0] = dir->pair[0];
  618. dir->head[1] = dir->pair[1];
  619. dir->pos = sizeof(dir->d) - 2;
  620. dir->off = sizeof(dir->d);
  621. return 0;
  622. }
  623. lfs_entry_t entry;
  624. err = lfs_dir_find(lfs, dir, &entry, &path);
  625. if (err) {
  626. return err;
  627. } else if (entry.d.type != LFS_TYPE_DIR) {
  628. return LFS_ERR_NOTDIR;
  629. }
  630. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  631. if (err) {
  632. return err;
  633. }
  634. // setup head dir
  635. // special offset for '.' and '..'
  636. dir->head[0] = dir->pair[0];
  637. dir->head[1] = dir->pair[1];
  638. dir->pos = sizeof(dir->d) - 2;
  639. dir->off = sizeof(dir->d);
  640. return 0;
  641. }
  642. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  643. // Do nothing, dir is always synchronized
  644. return 0;
  645. }
  646. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  647. memset(info, 0, sizeof(*info));
  648. // special offset for '.' and '..'
  649. if (dir->pos == sizeof(dir->d) - 2) {
  650. info->type = LFS_TYPE_DIR;
  651. strcpy(info->name, ".");
  652. dir->pos += 1;
  653. return 1;
  654. } else if (dir->pos == sizeof(dir->d) - 1) {
  655. info->type = LFS_TYPE_DIR;
  656. strcpy(info->name, "..");
  657. dir->pos += 1;
  658. return 1;
  659. }
  660. lfs_entry_t entry;
  661. int err = lfs_dir_next(lfs, dir, &entry);
  662. if (err) {
  663. return (err == LFS_ERR_NOENT) ? 0 : err;
  664. }
  665. info->type = entry.d.type & 0xff;
  666. if (info->type == LFS_TYPE_REG) {
  667. info->size = entry.d.u.file.size;
  668. }
  669. err = lfs_read(lfs, dir->pair[0], entry.off + sizeof(entry.d),
  670. info->name, entry.d.len - sizeof(entry.d));
  671. if (err) {
  672. return err;
  673. }
  674. return 1;
  675. }
  676. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  677. // simply walk from head dir
  678. int err = lfs_dir_rewind(lfs, dir);
  679. if (err) {
  680. return err;
  681. }
  682. dir->pos = off;
  683. while (off > (0x7fffffff & dir->d.size)) {
  684. off -= 0x7fffffff & dir->d.size;
  685. if (!(0x80000000 & dir->d.size)) {
  686. return LFS_ERR_INVAL;
  687. }
  688. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  689. if (err) {
  690. return err;
  691. }
  692. }
  693. dir->off = off;
  694. return 0;
  695. }
  696. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  697. return dir->pos;
  698. }
  699. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  700. // reload the head dir
  701. int err = lfs_dir_fetch(lfs, dir, dir->head);
  702. if (err) {
  703. return err;
  704. }
  705. dir->pair[0] = dir->head[0];
  706. dir->pair[1] = dir->head[1];
  707. dir->pos = sizeof(dir->d) - 2;
  708. dir->off = sizeof(dir->d);
  709. return 0;
  710. }
  711. /// File index list operations ///
  712. static int lfs_index(lfs_t *lfs, lfs_off_t *off) {
  713. lfs_off_t i = 0;
  714. while (*off >= lfs->cfg->block_size) {
  715. i += 1;
  716. *off -= lfs->cfg->block_size;
  717. *off += 4*lfs_min(lfs_ctz(i)+1, lfs->words-1);
  718. }
  719. return i;
  720. }
  721. static int lfs_index_find(lfs_t *lfs,
  722. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  723. lfs_block_t head, lfs_size_t size,
  724. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  725. if (size == 0) {
  726. *block = -1;
  727. *off = 0;
  728. return 0;
  729. }
  730. lfs_off_t current = lfs_index(lfs, &(lfs_off_t){size-1});
  731. lfs_off_t target = lfs_index(lfs, &pos);
  732. while (current > target) {
  733. lfs_size_t skip = lfs_min(
  734. lfs_npw2(current-target+1) - 1,
  735. lfs_min(lfs_ctz(current)+1, lfs->words-1) - 1);
  736. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  737. if (err) {
  738. return err;
  739. }
  740. current -= 1 << skip;
  741. }
  742. *block = head;
  743. *off = pos;
  744. return 0;
  745. }
  746. static int lfs_index_extend(lfs_t *lfs,
  747. lfs_cache_t *rcache, lfs_cache_t *pcache,
  748. lfs_block_t head, lfs_size_t size,
  749. lfs_off_t *block, lfs_block_t *off) {
  750. // go ahead and grab a block
  751. int err = lfs_alloc(lfs, block);
  752. if (err) {
  753. return err;
  754. }
  755. err = lfs_erase(lfs, *block);
  756. if (err) {
  757. return err;
  758. }
  759. if (size == 0) {
  760. *off = 0;
  761. return 0;
  762. }
  763. size -= 1;
  764. lfs_off_t index = lfs_index(lfs, &size);
  765. size += 1;
  766. // just copy out the last block if it is incomplete
  767. if (size != lfs->cfg->block_size) {
  768. for (lfs_off_t i = 0; i < size; i++) {
  769. uint8_t data;
  770. int err = lfs_cache_read(lfs, rcache, NULL, head, i, &data, 1);
  771. if (err) {
  772. return err;
  773. }
  774. err = lfs_cache_prog(lfs, pcache, *block, i, &data, 1);
  775. if (err) {
  776. return err;
  777. }
  778. }
  779. *off = size;
  780. return 0;
  781. }
  782. // append block
  783. index += 1;
  784. lfs_size_t skips = lfs_min(lfs_ctz(index)+1, lfs->words-1);
  785. for (lfs_off_t i = 0; i < skips; i++) {
  786. int err = lfs_cache_prog(lfs, pcache, *block, 4*i, &head, 4);
  787. if (err) {
  788. return err;
  789. }
  790. if (i != skips-1) {
  791. err = lfs_cache_read(lfs, rcache, NULL, head, 4*i, &head, 4);
  792. if (err) {
  793. return err;
  794. }
  795. }
  796. }
  797. *off = 4*skips;
  798. return 0;
  799. }
  800. static int lfs_index_traverse(lfs_t *lfs,
  801. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  802. lfs_block_t head, lfs_size_t size,
  803. int (*cb)(void*, lfs_block_t), void *data) {
  804. if (size == 0) {
  805. return 0;
  806. }
  807. lfs_off_t index = lfs_index(lfs, &(lfs_off_t){size-1});
  808. while (true) {
  809. int err = cb(data, head);
  810. if (err) {
  811. return err;
  812. }
  813. if (index == 0) {
  814. return 0;
  815. }
  816. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &head, 4);
  817. if (err) {
  818. return err;
  819. }
  820. index -= 1;
  821. }
  822. return 0;
  823. }
  824. /// Top level file operations ///
  825. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  826. const char *path, int flags) {
  827. // Allocate entry for file if it doesn't exist
  828. lfs_dir_t cwd;
  829. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  830. if (err) {
  831. return err;
  832. }
  833. lfs_entry_t entry;
  834. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  835. if (err && err != LFS_ERR_NOENT) {
  836. return err;
  837. }
  838. if (err == LFS_ERR_NOENT) {
  839. if (!(flags & LFS_O_CREAT)) {
  840. return LFS_ERR_NOENT;
  841. }
  842. // create entry to remember name
  843. entry.d.type = LFS_TYPE_REG;
  844. entry.d.len = sizeof(entry.d) + strlen(path);
  845. entry.d.u.file.head = -1;
  846. entry.d.u.file.size = 0;
  847. err = lfs_dir_append(lfs, &cwd, &entry, path);
  848. if (err) {
  849. return err;
  850. }
  851. } else if (entry.d.type == LFS_TYPE_DIR) {
  852. return LFS_ERR_ISDIR;
  853. } else if (flags & LFS_O_EXCL) {
  854. return LFS_ERR_EXISTS;
  855. }
  856. // setup file struct
  857. file->pair[0] = cwd.pair[0];
  858. file->pair[1] = cwd.pair[1];
  859. file->poff = entry.off;
  860. file->head = entry.d.u.file.head;
  861. file->size = entry.d.u.file.size;
  862. file->flags = flags;
  863. file->pos = 0;
  864. file->block = -1; // TODO rm me?
  865. if (flags & LFS_O_TRUNC) {
  866. file->head = -1;
  867. file->size = 0;
  868. }
  869. // allocate buffer if needed
  870. file->cache.block = 0xffffffff;
  871. if (lfs->cfg->file_buffer) {
  872. file->cache.buffer = lfs->cfg->file_buffer;
  873. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  874. file->cache.buffer = malloc(lfs->cfg->read_size);
  875. if (!file->cache.buffer) {
  876. return LFS_ERR_NOMEM;
  877. }
  878. } else {
  879. file->cache.buffer = malloc(lfs->cfg->prog_size);
  880. if (!file->cache.buffer) {
  881. return LFS_ERR_NOMEM;
  882. }
  883. }
  884. // add to list of files
  885. file->next = lfs->files;
  886. lfs->files = file;
  887. return 0;
  888. }
  889. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  890. int err = lfs_file_sync(lfs, file);
  891. // remove from list of files
  892. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  893. if (*p == file) {
  894. *p = file->next;
  895. break;
  896. }
  897. }
  898. // clean up memory
  899. if (!lfs->cfg->file_buffer) {
  900. free(file->cache.buffer);
  901. }
  902. return err;
  903. }
  904. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  905. if (file->flags & LFS_F_READING) {
  906. // just drop read cache
  907. file->cache.block = 0xffffffff;
  908. file->flags &= ~LFS_F_READING;
  909. }
  910. if (file->flags & LFS_F_WRITING) {
  911. lfs_off_t pos = file->pos;
  912. // copy over anything after current branch
  913. lfs_file_t orig = {
  914. .head = file->head,
  915. .size = file->size,
  916. .flags = LFS_O_RDONLY,
  917. .pos = file->pos,
  918. .cache = lfs->rcache,
  919. };
  920. lfs->rcache.block = 0xffffffff;
  921. while (file->pos < file->size) {
  922. // copy over a byte at a time, leave it up to caching
  923. // to make this efficient
  924. uint8_t data;
  925. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  926. if (res < 0) {
  927. return res;
  928. }
  929. res = lfs_file_write(lfs, file, &data, 1);
  930. if (res < 0) {
  931. return res;
  932. }
  933. // keep our reference to the rcache in sync
  934. if (lfs->rcache.block != 0xffffffff) {
  935. orig.cache.block = 0xffffffff;
  936. lfs->rcache.block = 0xffffffff;
  937. }
  938. }
  939. // write out what we have
  940. int err = lfs_cache_flush(lfs, &file->cache);
  941. if (err) {
  942. return err;
  943. }
  944. // actual file updates
  945. file->head = file->block;
  946. file->size = file->pos;
  947. file->flags &= ~LFS_F_WRITING;
  948. file->flags |= LFS_F_DIRTY;
  949. file->pos = pos;
  950. }
  951. return 0;
  952. }
  953. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  954. int err = lfs_file_flush(lfs, file);
  955. if (err) {
  956. return err;
  957. }
  958. if (file->flags & LFS_F_DIRTY) {
  959. // update dir entry
  960. lfs_dir_t cwd;
  961. int err = lfs_dir_fetch(lfs, &cwd, file->pair);
  962. if (err) {
  963. return err;
  964. }
  965. lfs_entry_t entry = {.off = file->poff};
  966. err = lfs_read(lfs, cwd.pair[0], entry.off,
  967. &entry.d, sizeof(entry.d));
  968. if (err) {
  969. return err;
  970. }
  971. if (entry.d.type != LFS_TYPE_REG) {
  972. // sanity check valid entry
  973. return LFS_ERR_INVAL;
  974. }
  975. entry.d.u.file.head = file->head;
  976. entry.d.u.file.size = file->size;
  977. err = lfs_dir_commit(lfs, &cwd, &entry, NULL);
  978. if (err) {
  979. return err;
  980. }
  981. file->flags &= ~LFS_F_DIRTY;
  982. }
  983. return 0;
  984. }
  985. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  986. void *buffer, lfs_size_t size) {
  987. uint8_t *data = buffer;
  988. lfs_size_t nsize = size;
  989. if ((file->flags & 3) == LFS_O_WRONLY) {
  990. return LFS_ERR_INVAL;
  991. }
  992. if (file->flags & LFS_F_WRITING) {
  993. // flush out any writes
  994. int err = lfs_file_flush(lfs, file);
  995. if (err) {
  996. return err;
  997. }
  998. }
  999. size = lfs_min(size, file->size - file->pos);
  1000. nsize = size;
  1001. while (nsize > 0) {
  1002. // check if we need a new block
  1003. if (!(file->flags & LFS_F_READING) ||
  1004. file->off == lfs->cfg->block_size) {
  1005. int err = lfs_index_find(lfs, &file->cache, NULL,
  1006. file->head, file->size,
  1007. file->pos, &file->block, &file->off);
  1008. if (err) {
  1009. return err;
  1010. }
  1011. file->flags |= LFS_F_READING;
  1012. }
  1013. // read as much as we can in current block
  1014. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1015. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1016. file->block, file->off, data, diff);
  1017. if (err) {
  1018. return err;
  1019. }
  1020. file->pos += diff;
  1021. file->off += diff;
  1022. data += diff;
  1023. nsize -= diff;
  1024. }
  1025. return size;
  1026. }
  1027. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1028. const void *buffer, lfs_size_t size) {
  1029. const uint8_t *data = buffer;
  1030. lfs_size_t nsize = size;
  1031. if ((file->flags & 3) == LFS_O_RDONLY) {
  1032. return LFS_ERR_INVAL;
  1033. }
  1034. if (file->flags & LFS_F_READING) {
  1035. // drop any reads
  1036. int err = lfs_file_flush(lfs, file);
  1037. if (err) {
  1038. return err;
  1039. }
  1040. }
  1041. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1042. file->pos = file->size;
  1043. }
  1044. while (nsize > 0) {
  1045. // check if we need a new block
  1046. if (!(file->flags & LFS_F_WRITING) ||
  1047. file->off == lfs->cfg->block_size) {
  1048. if (!(file->flags & LFS_F_WRITING)) {
  1049. // find out which block we're extending from
  1050. int err = lfs_index_find(lfs, &file->cache, NULL,
  1051. file->head, file->size,
  1052. file->pos, &file->block, &file->off);
  1053. if (err) {
  1054. return err;
  1055. }
  1056. // mark cache as dirty since we may have read data into it
  1057. file->cache.block = 0xffffffff;
  1058. file->flags |= LFS_F_WRITING;
  1059. }
  1060. // extend file with new blocks
  1061. int err = lfs_index_extend(lfs, &lfs->rcache, &file->cache,
  1062. file->block, file->pos,
  1063. &file->block, &file->off);
  1064. if (err) {
  1065. return err;
  1066. }
  1067. }
  1068. // program as much as we can in current block
  1069. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1070. int err = lfs_cache_prog(lfs, &file->cache,
  1071. file->block, file->off, data, diff);
  1072. if (err) {
  1073. return err;
  1074. }
  1075. file->pos += diff;
  1076. file->off += diff;
  1077. data += diff;
  1078. nsize -= diff;
  1079. }
  1080. return size;
  1081. }
  1082. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1083. lfs_soff_t off, int whence) {
  1084. // write out everything beforehand, may be noop if rdonly
  1085. int err = lfs_file_flush(lfs, file);
  1086. if (err) {
  1087. return err;
  1088. }
  1089. // update pos
  1090. lfs_off_t pos = file->pos;
  1091. if (whence == LFS_SEEK_SET) {
  1092. file->pos = off;
  1093. } else if (whence == LFS_SEEK_CUR) {
  1094. file->pos = file->pos + off;
  1095. } else if (whence == LFS_SEEK_END) {
  1096. file->pos = file->size + off;
  1097. }
  1098. return pos;
  1099. }
  1100. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1101. return file->pos;
  1102. }
  1103. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1104. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1105. if (res < 0) {
  1106. return res;
  1107. }
  1108. return 0;
  1109. }
  1110. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1111. return lfs_max(file->pos, file->size);
  1112. }
  1113. /// General fs oprations ///
  1114. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1115. lfs_dir_t cwd;
  1116. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1117. if (err) {
  1118. return err;
  1119. }
  1120. lfs_entry_t entry;
  1121. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1122. if (err) {
  1123. return err;
  1124. }
  1125. memset(info, 0, sizeof(*info));
  1126. info->type = entry.d.type & 0xff;
  1127. if (info->type == LFS_TYPE_REG) {
  1128. info->size = entry.d.u.file.size;
  1129. }
  1130. err = lfs_read(lfs, cwd.pair[0], entry.off + sizeof(entry.d),
  1131. info->name, entry.d.len - sizeof(entry.d));
  1132. if (err) {
  1133. return err;
  1134. }
  1135. return 0;
  1136. }
  1137. int lfs_remove(lfs_t *lfs, const char *path) {
  1138. lfs_dir_t cwd;
  1139. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1140. if (err) {
  1141. return err;
  1142. }
  1143. lfs_entry_t entry;
  1144. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1145. if (err) {
  1146. return err;
  1147. }
  1148. lfs_dir_t dir;
  1149. if (entry.d.type == LFS_TYPE_DIR) {
  1150. // must be empty before removal, checking size
  1151. // without masking top bit checks for any case where
  1152. // dir is not empty
  1153. int err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1154. if (err) {
  1155. return err;
  1156. } else if (dir.d.size != sizeof(dir.d)) {
  1157. return LFS_ERR_INVAL;
  1158. }
  1159. }
  1160. // remove the entry
  1161. err = lfs_dir_remove(lfs, &cwd, &entry);
  1162. if (err) {
  1163. return err;
  1164. }
  1165. // if we were a directory, just run a deorphan step, this should
  1166. // collect us, although is expensive
  1167. if (entry.d.type == LFS_TYPE_DIR) {
  1168. int err = lfs_deorphan(lfs);
  1169. if (err) {
  1170. return err;
  1171. }
  1172. }
  1173. return 0;
  1174. }
  1175. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  1176. // find old entry
  1177. lfs_dir_t oldcwd;
  1178. int err = lfs_dir_fetch(lfs, &oldcwd, lfs->root);
  1179. if (err) {
  1180. return err;
  1181. }
  1182. lfs_entry_t oldentry;
  1183. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1184. if (err) {
  1185. return err;
  1186. }
  1187. // allocate new entry
  1188. lfs_dir_t newcwd;
  1189. err = lfs_dir_fetch(lfs, &newcwd, lfs->root);
  1190. if (err) {
  1191. return err;
  1192. }
  1193. lfs_entry_t preventry;
  1194. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  1195. if (err && err != LFS_ERR_NOENT) {
  1196. return err;
  1197. }
  1198. bool prevexists = (err != LFS_ERR_NOENT);
  1199. // must have same type
  1200. if (prevexists && preventry.d.type != oldentry.d.type) {
  1201. return LFS_ERR_INVAL;
  1202. }
  1203. lfs_dir_t dir;
  1204. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1205. // must be empty before removal, checking size
  1206. // without masking top bit checks for any case where
  1207. // dir is not empty
  1208. int err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  1209. if (err) {
  1210. return err;
  1211. } else if (dir.d.size != sizeof(dir.d)) {
  1212. return LFS_ERR_INVAL;
  1213. }
  1214. }
  1215. // move to new location
  1216. lfs_entry_t newentry = preventry;
  1217. newentry.d = oldentry.d;
  1218. newentry.d.len = sizeof(newentry.d) + strlen(newpath);
  1219. if (prevexists) {
  1220. int err = lfs_dir_commit(lfs, &newcwd, &newentry, newpath);
  1221. if (err) {
  1222. return err;
  1223. }
  1224. } else {
  1225. int err = lfs_dir_append(lfs, &newcwd, &newentry, newpath);
  1226. if (err) {
  1227. return err;
  1228. }
  1229. }
  1230. // fetch again in case newcwd == oldcwd
  1231. err = lfs_dir_fetch(lfs, &oldcwd, oldcwd.pair);
  1232. if (err) {
  1233. return err;
  1234. }
  1235. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1236. if (err) {
  1237. return err;
  1238. }
  1239. // remove from old location
  1240. err = lfs_dir_remove(lfs, &oldcwd, &oldentry);
  1241. if (err) {
  1242. return err;
  1243. }
  1244. // if we were a directory, just run a deorphan step, this should
  1245. // collect us, although is expensive
  1246. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1247. int err = lfs_deorphan(lfs);
  1248. if (err) {
  1249. return err;
  1250. }
  1251. }
  1252. return 0;
  1253. }
  1254. /// Filesystem operations ///
  1255. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  1256. lfs->cfg = cfg;
  1257. lfs->words = lfs->cfg->block_size / sizeof(uint32_t);
  1258. // setup read cache
  1259. lfs->rcache.block = 0xffffffff;
  1260. if (lfs->cfg->read_buffer) {
  1261. lfs->rcache.buffer = lfs->cfg->read_buffer;
  1262. } else {
  1263. lfs->rcache.buffer = malloc(lfs->cfg->read_size);
  1264. if (!lfs->rcache.buffer) {
  1265. return LFS_ERR_NOMEM;
  1266. }
  1267. }
  1268. // setup program cache
  1269. lfs->pcache.block = 0xffffffff;
  1270. if (lfs->cfg->prog_buffer) {
  1271. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  1272. } else {
  1273. lfs->pcache.buffer = malloc(lfs->cfg->prog_size);
  1274. if (!lfs->pcache.buffer) {
  1275. return LFS_ERR_NOMEM;
  1276. }
  1277. }
  1278. // setup lookahead
  1279. if (lfs->cfg->lookahead_buffer) {
  1280. lfs->free.lookahead = lfs->cfg->lookahead_buffer;
  1281. } else {
  1282. lfs->free.lookahead = malloc(lfs->cfg->lookahead/8);
  1283. if (!lfs->free.lookahead) {
  1284. return LFS_ERR_NOMEM;
  1285. }
  1286. }
  1287. // setup files as an empty list
  1288. lfs->files = NULL;
  1289. return 0;
  1290. }
  1291. static int lfs_deinit(lfs_t *lfs) {
  1292. // Free allocated memory
  1293. if (!lfs->cfg->read_buffer) {
  1294. free(lfs->rcache.buffer);
  1295. }
  1296. if (!lfs->cfg->prog_buffer) {
  1297. free(lfs->pcache.buffer);
  1298. }
  1299. if (!lfs->cfg->lookahead_buffer) {
  1300. free(lfs->free.lookahead);
  1301. }
  1302. return 0;
  1303. }
  1304. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  1305. int err = lfs_init(lfs, cfg);
  1306. if (err) {
  1307. return err;
  1308. }
  1309. // Create free lookahead
  1310. memset(lfs->free.lookahead, 0, lfs->cfg->lookahead/8);
  1311. lfs->free.start = 0;
  1312. lfs->free.off = 0;
  1313. // Create superblock dir
  1314. lfs_dir_t superdir;
  1315. err = lfs_dir_alloc(lfs, &superdir);
  1316. if (err) {
  1317. return err;
  1318. }
  1319. // Write root directory
  1320. lfs_dir_t root;
  1321. err = lfs_dir_alloc(lfs, &root);
  1322. if (err) {
  1323. return err;
  1324. }
  1325. err = lfs_dir_commit(lfs, &root, NULL, NULL);
  1326. if (err) {
  1327. return err;
  1328. }
  1329. lfs->root[0] = root.pair[0];
  1330. lfs->root[1] = root.pair[1];
  1331. // Write superblocks
  1332. lfs_superblock_t superblock = {
  1333. .off = sizeof(superdir.d),
  1334. .d.type = LFS_TYPE_SUPERBLOCK,
  1335. .d.len = sizeof(superblock.d),
  1336. .d.version = 0x00000001,
  1337. .d.magic = {"littlefs"},
  1338. .d.block_size = lfs->cfg->block_size,
  1339. .d.block_count = lfs->cfg->block_count,
  1340. .d.root = {lfs->root[0], lfs->root[1]},
  1341. };
  1342. superdir.d.tail[0] = root.pair[0];
  1343. superdir.d.tail[1] = root.pair[1];
  1344. superdir.d.size += sizeof(superdir.d);
  1345. for (int i = 0; i < 2; i++) {
  1346. // Write both pairs for extra safety, do some finagling to pretend
  1347. // the superblock is an entry
  1348. int err = lfs_dir_commit(lfs, &superdir,
  1349. (const lfs_entry_t*)&superblock,
  1350. (const struct lfs_disk_entry*)&superblock.d + 1);
  1351. if (err) {
  1352. LFS_ERROR("Failed to write superblock at %d", superdir.pair[0]);
  1353. return err;
  1354. }
  1355. }
  1356. // sanity check that fetch works
  1357. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  1358. if (err) {
  1359. return err;
  1360. }
  1361. return lfs_deinit(lfs);
  1362. }
  1363. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  1364. int err = lfs_init(lfs, cfg);
  1365. if (err) {
  1366. return err;
  1367. }
  1368. // setup free lookahead
  1369. lfs->free.start = -lfs->cfg->lookahead;
  1370. lfs->free.off = lfs->cfg->lookahead;
  1371. // load superblock
  1372. lfs_dir_t dir;
  1373. lfs_superblock_t superblock;
  1374. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  1375. if (!err) {
  1376. err = lfs_read(lfs, dir.pair[0],
  1377. sizeof(dir.d), &superblock.d, sizeof(superblock.d));
  1378. lfs->root[0] = superblock.d.root[0];
  1379. lfs->root[1] = superblock.d.root[1];
  1380. }
  1381. if (err == LFS_ERR_CORRUPT ||
  1382. memcmp(superblock.d.magic, "littlefs", 8) != 0) {
  1383. LFS_ERROR("Invalid superblock at %d %d", dir.pair[0], dir.pair[1]);
  1384. return LFS_ERR_CORRUPT;
  1385. }
  1386. if (superblock.d.version > 0x0000ffff) {
  1387. LFS_ERROR("Invalid version %d.%d\n",
  1388. 0xffff & (superblock.d.version >> 16),
  1389. 0xffff & (superblock.d.version >> 0));
  1390. return LFS_ERR_INVAL;
  1391. }
  1392. return err;
  1393. }
  1394. int lfs_unmount(lfs_t *lfs) {
  1395. return lfs_deinit(lfs);
  1396. }
  1397. /// Littlefs specific operations ///
  1398. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  1399. // iterate over metadata pairs
  1400. lfs_dir_t dir;
  1401. lfs_entry_t entry;
  1402. lfs_block_t cwd[2] = {0, 1};
  1403. while (true) {
  1404. for (int i = 0; i < 2; i++) {
  1405. int err = cb(data, cwd[i]);
  1406. if (err) {
  1407. return err;
  1408. }
  1409. }
  1410. int err = lfs_dir_fetch(lfs, &dir, cwd);
  1411. if (err) {
  1412. return err;
  1413. }
  1414. // iterate over contents
  1415. while ((0x7fffffff & dir.d.size) >= dir.off + sizeof(entry.d)) {
  1416. int err = lfs_read(lfs, dir.pair[0], dir.off,
  1417. &entry.d, sizeof(entry.d));
  1418. if (err) {
  1419. return err;
  1420. }
  1421. dir.off += entry.d.len;
  1422. if ((0xf & entry.d.type) == LFS_TYPE_REG) {
  1423. int err = lfs_index_traverse(lfs, &lfs->rcache, NULL,
  1424. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  1425. if (err) {
  1426. return err;
  1427. }
  1428. }
  1429. }
  1430. cwd[0] = dir.d.tail[0];
  1431. cwd[1] = dir.d.tail[1];
  1432. if (lfs_pairisnull(cwd)) {
  1433. break;
  1434. }
  1435. }
  1436. // iterate over any open files
  1437. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  1438. if (f->flags & LFS_F_DIRTY) {
  1439. int err = lfs_index_traverse(lfs, &lfs->rcache, &f->cache,
  1440. f->head, f->size, cb, data);
  1441. if (err) {
  1442. return err;
  1443. }
  1444. }
  1445. if (f->flags & LFS_F_WRITING) {
  1446. int err = lfs_index_traverse(lfs, &lfs->rcache, &f->cache,
  1447. f->block, f->pos, cb, data);
  1448. if (err) {
  1449. return err;
  1450. }
  1451. }
  1452. }
  1453. return 0;
  1454. }
  1455. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2]) {
  1456. // iterate over all directory directory entries
  1457. lfs_dir_t parent = {
  1458. .d.tail[0] = lfs->root[0],
  1459. .d.tail[1] = lfs->root[1],
  1460. };
  1461. while (true) {
  1462. lfs_entry_t entry;
  1463. int err = lfs_dir_fetch(lfs, &parent, parent.d.tail);
  1464. if (err) {
  1465. return err;
  1466. }
  1467. while (true) {
  1468. int err = lfs_dir_next(lfs, &parent, &entry);
  1469. if (err && err != LFS_ERR_NOENT) {
  1470. return err;
  1471. }
  1472. if (err == LFS_ERR_NOENT) {
  1473. break;
  1474. }
  1475. if ((0xf & entry.d.type) == LFS_TYPE_DIR &&
  1476. lfs_paircmp(entry.d.u.dir, dir) == 0) {
  1477. return true;
  1478. }
  1479. }
  1480. if (lfs_pairisnull(parent.d.tail)) {
  1481. return false;
  1482. }
  1483. }
  1484. }
  1485. int lfs_deorphan(lfs_t *lfs) {
  1486. // iterate over all directories
  1487. lfs_dir_t pdir;
  1488. lfs_dir_t cdir;
  1489. // skip root
  1490. int err = lfs_dir_fetch(lfs, &pdir, lfs->root);
  1491. if (err) {
  1492. return err;
  1493. }
  1494. while (!lfs_pairisnull(pdir.d.tail)) {
  1495. int err = lfs_dir_fetch(lfs, &cdir, pdir.d.tail);
  1496. if (err) {
  1497. return err;
  1498. }
  1499. // only check head blocks
  1500. if (!(0x80000000 & pdir.d.size)) {
  1501. // check if we have a parent
  1502. int parent = lfs_parent(lfs, pdir.d.tail);
  1503. if (parent < 0) {
  1504. return parent;
  1505. }
  1506. if (!parent) {
  1507. // we are an orphan
  1508. LFS_DEBUG("Orphan %d %d", pdir.d.tail[0], pdir.d.tail[1]);
  1509. pdir.d.tail[0] = cdir.d.tail[0];
  1510. pdir.d.tail[1] = cdir.d.tail[1];
  1511. err = lfs_dir_commit(lfs, &pdir, NULL, NULL);
  1512. if (err) {
  1513. return err;
  1514. }
  1515. break;
  1516. }
  1517. }
  1518. memcpy(&pdir, &cdir, sizeof(pdir));
  1519. }
  1520. return 0;
  1521. }