lfs.c 46 KB

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