lfs.c 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049
  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. /// Internal operations predeclared here ///
  159. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data);
  160. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir);
  161. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  162. lfs_dir_t *parent, lfs_entry_t *entry);
  163. static int lfs_relocate(lfs_t *lfs,
  164. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]);
  165. int lfs_deorphan(lfs_t *lfs);
  166. /// Block allocator ///
  167. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  168. lfs_t *lfs = p;
  169. lfs_block_t off = (block - lfs->free.start) % lfs->cfg->block_count;
  170. if (off < lfs->cfg->lookahead) {
  171. lfs->free.lookahead[off / 32] |= 1U << (off % 32);
  172. }
  173. return 0;
  174. }
  175. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  176. // deorphan if we haven't yet, only needed once after poweron
  177. if (!lfs->deorphaned) {
  178. int err = lfs_deorphan(lfs);
  179. if (err) {
  180. return err;
  181. }
  182. }
  183. while (true) {
  184. while (true) {
  185. // check if we have looked at all blocks since last ack
  186. if (lfs->free.start + lfs->free.off == lfs->free.end) {
  187. LFS_WARN("No more free space %d", lfs->free.end);
  188. return LFS_ERR_NOSPC;
  189. }
  190. if (lfs->free.off >= lfs->cfg->lookahead) {
  191. break;
  192. }
  193. lfs_block_t off = lfs->free.off;
  194. lfs->free.off += 1;
  195. if (!(lfs->free.lookahead[off / 32] & (1U << (off % 32)))) {
  196. // found a free block
  197. *block = (lfs->free.start + off) % lfs->cfg->block_count;
  198. return 0;
  199. }
  200. }
  201. lfs->free.start += lfs->cfg->lookahead;
  202. lfs->free.off = 0;
  203. // find mask of free blocks from tree
  204. memset(lfs->free.lookahead, 0, lfs->cfg->lookahead/8);
  205. int err = lfs_traverse(lfs, lfs_alloc_lookahead, lfs);
  206. if (err) {
  207. return err;
  208. }
  209. }
  210. }
  211. static void lfs_alloc_ack(lfs_t *lfs) {
  212. lfs->free.end = lfs->free.start + lfs->free.off + lfs->cfg->block_count;
  213. }
  214. /// Metadata pair and directory operations ///
  215. static inline void lfs_pairswap(lfs_block_t pair[2]) {
  216. lfs_block_t t = pair[0];
  217. pair[0] = pair[1];
  218. pair[1] = t;
  219. }
  220. static inline bool lfs_pairisnull(const lfs_block_t pair[2]) {
  221. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  222. }
  223. static inline int lfs_paircmp(
  224. const lfs_block_t paira[2],
  225. const lfs_block_t pairb[2]) {
  226. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  227. paira[0] == pairb[1] || paira[1] == pairb[0]);
  228. }
  229. static inline bool lfs_pairsync(
  230. const lfs_block_t paira[2],
  231. const lfs_block_t pairb[2]) {
  232. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  233. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  234. }
  235. static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {
  236. // allocate pair of dir blocks
  237. for (int i = 0; i < 2; i++) {
  238. int err = lfs_alloc(lfs, &dir->pair[i]);
  239. if (err) {
  240. return err;
  241. }
  242. }
  243. // rather than clobbering one of the blocks we just pretend
  244. // the revision may be valid
  245. int err = lfs_read(lfs, dir->pair[0], 0, &dir->d.rev, 4);
  246. if (err) {
  247. return err;
  248. }
  249. // set defaults
  250. dir->d.rev += 1;
  251. dir->d.size = sizeof(dir->d)+4;
  252. dir->d.tail[0] = -1;
  253. dir->d.tail[1] = -1;
  254. dir->off = sizeof(dir->d);
  255. // don't write out yet, let caller take care of that
  256. return 0;
  257. }
  258. static int lfs_dir_fetch(lfs_t *lfs,
  259. lfs_dir_t *dir, const lfs_block_t pair[2]) {
  260. // copy out pair, otherwise may be aliasing dir
  261. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  262. bool valid = false;
  263. // check both blocks for the most recent revision
  264. for (int i = 0; i < 2; i++) {
  265. struct lfs_disk_dir test;
  266. int err = lfs_read(lfs, tpair[i], 0, &test, sizeof(test));
  267. if (err) {
  268. return err;
  269. }
  270. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  271. continue;
  272. }
  273. if ((0x7fffffff & test.size) > lfs->cfg->block_size) {
  274. continue;
  275. }
  276. uint32_t crc = 0xffffffff;
  277. crc = lfs_crc(crc, &test, sizeof(test));
  278. for (lfs_off_t j = sizeof(test); j < (0x7fffffff & test.size); j++) {
  279. uint8_t data;
  280. int err = lfs_read(lfs, tpair[i], j, &data, 1);
  281. if (err) {
  282. return err;
  283. }
  284. crc = lfs_crc(crc, &data, 1);
  285. }
  286. if (crc != 0) {
  287. continue;
  288. }
  289. valid = true;
  290. // setup dir in case it's valid
  291. dir->pair[0] = tpair[(i+0) % 2];
  292. dir->pair[1] = tpair[(i+1) % 2];
  293. dir->off = sizeof(dir->d);
  294. dir->d = test;
  295. }
  296. if (!valid) {
  297. LFS_ERROR("Corrupted dir pair at %d %d", tpair[0], tpair[1]);
  298. return LFS_ERR_CORRUPT;
  299. }
  300. return 0;
  301. }
  302. struct lfs_region {
  303. lfs_off_t oldoff;
  304. lfs_size_t oldlen;
  305. const void *newdata;
  306. lfs_size_t newlen;
  307. };
  308. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  309. const struct lfs_region *regions, int count) {
  310. dir->d.rev += 1;
  311. lfs_pairswap(dir->pair);
  312. for (int i = 0; i < count; i++) {
  313. dir->d.size += regions[i].newlen - regions[i].oldlen;
  314. }
  315. const lfs_block_t oldpair[2] = {dir->pair[0], dir->pair[1]};
  316. bool relocated = false;
  317. while (true) {
  318. int err = lfs_erase(lfs, dir->pair[0]);
  319. if (err) {
  320. if (err == LFS_ERR_CORRUPT) {
  321. goto relocate;
  322. }
  323. return err;
  324. }
  325. uint32_t crc = 0xffffffff;
  326. crc = lfs_crc(crc, &dir->d, sizeof(dir->d));
  327. err = lfs_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  328. if (err) {
  329. if (err == LFS_ERR_CORRUPT) {
  330. goto relocate;
  331. }
  332. return err;
  333. }
  334. int i = 0;
  335. lfs_off_t oldoff = sizeof(dir->d);
  336. lfs_off_t newoff = sizeof(dir->d);
  337. while (newoff < (0x7fffffff & dir->d.size)-4) {
  338. if (i < count && regions[i].oldoff == oldoff) {
  339. crc = lfs_crc(crc, regions[i].newdata, regions[i].newlen);
  340. int err = lfs_prog(lfs, dir->pair[0],
  341. newoff, regions[i].newdata, regions[i].newlen);
  342. if (err) {
  343. if (err == LFS_ERR_CORRUPT) {
  344. goto relocate;
  345. }
  346. return err;
  347. }
  348. oldoff += regions[i].oldlen;
  349. newoff += regions[i].newlen;
  350. i += 1;
  351. } else {
  352. uint8_t data;
  353. int err = lfs_read(lfs, oldpair[1], oldoff, &data, 1);
  354. if (err) {
  355. return err;
  356. }
  357. crc = lfs_crc(crc, &data, 1);
  358. err = lfs_prog(lfs, dir->pair[0], newoff, &data, 1);
  359. if (err) {
  360. if (err == LFS_ERR_CORRUPT) {
  361. goto relocate;
  362. }
  363. return err;
  364. }
  365. oldoff += 1;
  366. newoff += 1;
  367. }
  368. }
  369. err = lfs_prog(lfs, dir->pair[0], newoff, &crc, 4);
  370. if (err) {
  371. if (err == LFS_ERR_CORRUPT) {
  372. goto relocate;
  373. }
  374. return err;
  375. }
  376. err = lfs_sync(lfs);
  377. if (err) {
  378. if (err == LFS_ERR_CORRUPT) {
  379. goto relocate;
  380. }
  381. return err;
  382. }
  383. // successful commit
  384. if (relocated) {
  385. LFS_DEBUG("Relocating %d %d to %d %d",
  386. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  387. return lfs_relocate(lfs, oldpair, dir->pair);
  388. }
  389. return 0;
  390. relocate:
  391. LFS_DEBUG("Bad block at %d", dir->pair[0]);
  392. // drop caches and prepare to relocate block
  393. relocated = true;
  394. lfs->pcache.block = 0xffffffff;
  395. // can't relocate superblock, filesystem is now frozen
  396. if (lfs_paircmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  397. LFS_WARN("Superblock %d has become unwritable", oldpair[0]);
  398. return LFS_ERR_CORRUPT;
  399. }
  400. // relocate half of pair
  401. err = lfs_alloc(lfs, &dir->pair[0]);
  402. if (err) {
  403. return err;
  404. }
  405. }
  406. }
  407. static int lfs_dir_update(lfs_t *lfs, lfs_dir_t *dir,
  408. const lfs_entry_t *entry, const void *data) {
  409. return lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  410. {entry->off, sizeof(entry->d), &entry->d, sizeof(entry->d)},
  411. {entry->off+sizeof(entry->d), entry->d.len-sizeof(entry->d),
  412. data, entry->d.len-sizeof(entry->d)}
  413. }, data ? 2 : 1);
  414. }
  415. static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,
  416. lfs_entry_t *entry, const void *data) {
  417. // check if we fit, if top bit is set we do not and move on
  418. while (true) {
  419. if (dir->d.size + entry->d.len <= lfs->cfg->block_size) {
  420. entry->off = dir->d.size - 4;
  421. return lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  422. {entry->off, 0, &entry->d, sizeof(entry->d)},
  423. {entry->off, 0, data, entry->d.len - sizeof(entry->d)}
  424. }, 2);
  425. }
  426. // we need to allocate a new dir block
  427. if (!(0x80000000 & dir->d.size)) {
  428. lfs_dir_t newdir;
  429. int err = lfs_dir_alloc(lfs, &newdir);
  430. if (err) {
  431. return err;
  432. }
  433. newdir.d.tail[0] = dir->d.tail[0];
  434. newdir.d.tail[1] = dir->d.tail[1];
  435. entry->off = newdir.d.size - 4;
  436. err = lfs_dir_commit(lfs, &newdir, (struct lfs_region[]){
  437. {entry->off, 0, &entry->d, sizeof(entry->d)},
  438. {entry->off, 0, data, entry->d.len - sizeof(entry->d)}
  439. }, 2);
  440. if (err) {
  441. return err;
  442. }
  443. dir->d.size |= 0x80000000;
  444. dir->d.tail[0] = newdir.pair[0];
  445. dir->d.tail[1] = newdir.pair[1];
  446. return lfs_dir_commit(lfs, dir, NULL, 0);
  447. }
  448. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  449. if (err) {
  450. return err;
  451. }
  452. }
  453. }
  454. static int lfs_dir_remove(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  455. // either shift out the one entry or remove the whole dir block
  456. if (dir->d.size == sizeof(dir->d)+4) {
  457. lfs_dir_t pdir;
  458. int res = lfs_pred(lfs, dir->pair, &pdir);
  459. if (res < 0) {
  460. return res;
  461. }
  462. if (!(pdir.d.size & 0x80000000)) {
  463. return lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  464. {entry->off, entry->d.len, NULL, 0},
  465. }, 1);
  466. } else {
  467. pdir.d.tail[0] = dir->d.tail[0];
  468. pdir.d.tail[1] = dir->d.tail[1];
  469. return lfs_dir_commit(lfs, dir, NULL, 0);
  470. }
  471. } else {
  472. return lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  473. {entry->off, entry->d.len, NULL, 0},
  474. }, 1);
  475. }
  476. }
  477. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  478. while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)-4) {
  479. if (!(0x80000000 & dir->d.size)) {
  480. entry->off = dir->off;
  481. return LFS_ERR_NOENT;
  482. }
  483. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  484. if (err) {
  485. return err;
  486. }
  487. dir->off = sizeof(dir->d);
  488. dir->pos += sizeof(dir->d) + 4;
  489. }
  490. int err = lfs_read(lfs, dir->pair[0], dir->off,
  491. &entry->d, sizeof(entry->d));
  492. if (err) {
  493. return err;
  494. }
  495. dir->off += entry->d.len;
  496. dir->pos += entry->d.len;
  497. entry->off = dir->off - entry->d.len;
  498. return 0;
  499. }
  500. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  501. lfs_entry_t *entry, const char **path) {
  502. const char *pathname = *path;
  503. size_t pathlen;
  504. while (true) {
  505. nextname:
  506. // skip slashes
  507. pathname += strspn(pathname, "/");
  508. pathlen = strcspn(pathname, "/");
  509. // skip '.' and root '..'
  510. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  511. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  512. pathname += pathlen;
  513. goto nextname;
  514. }
  515. // skip if matched by '..' in name
  516. const char *suffix = pathname + pathlen;
  517. size_t sufflen;
  518. int depth = 1;
  519. while (true) {
  520. suffix += strspn(suffix, "/");
  521. sufflen = strcspn(suffix, "/");
  522. if (sufflen == 0) {
  523. break;
  524. }
  525. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  526. depth -= 1;
  527. if (depth == 0) {
  528. pathname = suffix + sufflen;
  529. goto nextname;
  530. }
  531. } else {
  532. depth += 1;
  533. }
  534. suffix += sufflen;
  535. }
  536. // find path
  537. while (true) {
  538. int err = lfs_dir_next(lfs, dir, entry);
  539. if (err) {
  540. return err;
  541. }
  542. if (((0xff & entry->d.type) != LFS_TYPE_REG &&
  543. (0xff & entry->d.type) != LFS_TYPE_DIR) ||
  544. entry->d.len - sizeof(entry->d) != pathlen) {
  545. continue;
  546. }
  547. int ret = lfs_cmp(lfs, dir->pair[0],
  548. entry->off + sizeof(entry->d), pathlen, pathname);
  549. if (ret < 0) {
  550. return ret;
  551. }
  552. // found match
  553. if (ret == true) {
  554. break;
  555. }
  556. }
  557. pathname += pathlen;
  558. pathname += strspn(pathname, "/");
  559. if (pathname[0] == '\0') {
  560. return 0;
  561. }
  562. // continue on if we hit a directory
  563. if (entry->d.type != LFS_TYPE_DIR) {
  564. return LFS_ERR_NOTDIR;
  565. }
  566. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  567. if (err) {
  568. return err;
  569. }
  570. *path = pathname;
  571. }
  572. return 0;
  573. }
  574. /// Top level directory operations ///
  575. int lfs_mkdir(lfs_t *lfs, const char *path) {
  576. // fetch parent directory
  577. lfs_dir_t cwd;
  578. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  579. if (err) {
  580. return err;
  581. }
  582. lfs_entry_t entry;
  583. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  584. if (err != LFS_ERR_NOENT) {
  585. return err ? err : LFS_ERR_EXISTS;
  586. }
  587. // build up new directory
  588. lfs_alloc_ack(lfs);
  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, 0);
  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. err = lfs_dir_append(lfs, &cwd, &entry, path);
  607. if (err) {
  608. return err;
  609. }
  610. lfs_alloc_ack(lfs);
  611. return 0;
  612. }
  613. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  614. dir->pair[0] = lfs->root[0];
  615. dir->pair[1] = lfs->root[1];
  616. int err = lfs_dir_fetch(lfs, dir, dir->pair);
  617. if (err) {
  618. return err;
  619. }
  620. if (strspn(path, "/.") == strlen(path)) {
  621. // can only be something like '/././../.'
  622. dir->head[0] = dir->pair[0];
  623. dir->head[1] = dir->pair[1];
  624. dir->pos = sizeof(dir->d) - 2;
  625. dir->off = sizeof(dir->d);
  626. return 0;
  627. }
  628. lfs_entry_t entry;
  629. err = lfs_dir_find(lfs, dir, &entry, &path);
  630. if (err) {
  631. return err;
  632. } else if (entry.d.type != LFS_TYPE_DIR) {
  633. return LFS_ERR_NOTDIR;
  634. }
  635. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  636. if (err) {
  637. return err;
  638. }
  639. // setup head dir
  640. // special offset for '.' and '..'
  641. dir->head[0] = dir->pair[0];
  642. dir->head[1] = dir->pair[1];
  643. dir->pos = sizeof(dir->d) - 2;
  644. dir->off = sizeof(dir->d);
  645. return 0;
  646. }
  647. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  648. // do nothing, dir is always synchronized
  649. return 0;
  650. }
  651. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  652. memset(info, 0, sizeof(*info));
  653. // special offset for '.' and '..'
  654. if (dir->pos == sizeof(dir->d) - 2) {
  655. info->type = LFS_TYPE_DIR;
  656. strcpy(info->name, ".");
  657. dir->pos += 1;
  658. return 1;
  659. } else if (dir->pos == sizeof(dir->d) - 1) {
  660. info->type = LFS_TYPE_DIR;
  661. strcpy(info->name, "..");
  662. dir->pos += 1;
  663. return 1;
  664. }
  665. lfs_entry_t entry;
  666. while (true) {
  667. int err = lfs_dir_next(lfs, dir, &entry);
  668. if (err) {
  669. return (err == LFS_ERR_NOENT) ? 0 : err;
  670. }
  671. if ((0xff & entry.d.type) == LFS_TYPE_REG ||
  672. (0xff & entry.d.type) == LFS_TYPE_DIR) {
  673. break;
  674. }
  675. }
  676. info->type = entry.d.type & 0xff;
  677. if (info->type == LFS_TYPE_REG) {
  678. info->size = entry.d.u.file.size;
  679. }
  680. int err = lfs_read(lfs, dir->pair[0], entry.off + sizeof(entry.d),
  681. info->name, entry.d.len - sizeof(entry.d));
  682. if (err) {
  683. return err;
  684. }
  685. return 1;
  686. }
  687. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  688. // simply walk from head dir
  689. int err = lfs_dir_rewind(lfs, dir);
  690. if (err) {
  691. return err;
  692. }
  693. dir->pos = off;
  694. while (off > (0x7fffffff & dir->d.size)) {
  695. off -= 0x7fffffff & dir->d.size;
  696. if (!(0x80000000 & dir->d.size)) {
  697. return LFS_ERR_INVAL;
  698. }
  699. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  700. if (err) {
  701. return err;
  702. }
  703. }
  704. dir->off = off;
  705. return 0;
  706. }
  707. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  708. return dir->pos;
  709. }
  710. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  711. // reload the head dir
  712. int err = lfs_dir_fetch(lfs, dir, dir->head);
  713. if (err) {
  714. return err;
  715. }
  716. dir->pair[0] = dir->head[0];
  717. dir->pair[1] = dir->head[1];
  718. dir->pos = sizeof(dir->d) - 2;
  719. dir->off = sizeof(dir->d);
  720. return 0;
  721. }
  722. /// File index list operations ///
  723. static int lfs_index(lfs_t *lfs, lfs_off_t *off) {
  724. lfs_off_t i = 0;
  725. lfs_size_t words = lfs->cfg->block_size / 4;
  726. while (*off >= lfs->cfg->block_size) {
  727. i += 1;
  728. *off -= lfs->cfg->block_size;
  729. *off += 4*lfs_min(lfs_ctz(i)+1, words-1);
  730. }
  731. return i;
  732. }
  733. static int lfs_index_find(lfs_t *lfs,
  734. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  735. lfs_block_t head, lfs_size_t size,
  736. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  737. if (size == 0) {
  738. *block = -1;
  739. *off = 0;
  740. return 0;
  741. }
  742. lfs_off_t current = lfs_index(lfs, &(lfs_off_t){size-1});
  743. lfs_off_t target = lfs_index(lfs, &pos);
  744. lfs_size_t words = lfs->cfg->block_size / 4;
  745. while (current > target) {
  746. lfs_size_t skip = lfs_min(
  747. lfs_npw2(current-target+1) - 1,
  748. lfs_min(lfs_ctz(current)+1, words-1) - 1);
  749. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  750. if (err) {
  751. return err;
  752. }
  753. current -= 1 << skip;
  754. }
  755. *block = head;
  756. *off = pos;
  757. return 0;
  758. }
  759. static int lfs_index_extend(lfs_t *lfs,
  760. lfs_cache_t *rcache, lfs_cache_t *pcache,
  761. lfs_block_t head, lfs_size_t size,
  762. lfs_off_t *block, lfs_block_t *off) {
  763. while (true) {
  764. // go ahead and grab a block
  765. int err = lfs_alloc(lfs, block);
  766. if (err) {
  767. return err;
  768. }
  769. err = lfs_erase(lfs, *block);
  770. if (err) {
  771. if (err == LFS_ERR_CORRUPT) {
  772. goto relocate;
  773. }
  774. return err;
  775. }
  776. if (size == 0) {
  777. *off = 0;
  778. return 0;
  779. }
  780. size -= 1;
  781. lfs_off_t index = lfs_index(lfs, &size);
  782. size += 1;
  783. // just copy out the last block if it is incomplete
  784. if (size != lfs->cfg->block_size) {
  785. for (lfs_off_t i = 0; i < size; i++) {
  786. uint8_t data;
  787. int err = lfs_cache_read(lfs, rcache, NULL, head, i, &data, 1);
  788. if (err) {
  789. return err;
  790. }
  791. err = lfs_cache_prog(lfs, pcache, *block, i, &data, 1);
  792. if (err) {
  793. if (err == LFS_ERR_CORRUPT) {
  794. goto relocate;
  795. }
  796. return err;
  797. }
  798. }
  799. *off = size;
  800. return 0;
  801. }
  802. // append block
  803. index += 1;
  804. lfs_size_t words = lfs->cfg->block_size / 4;
  805. lfs_size_t skips = lfs_min(lfs_ctz(index)+1, words-1);
  806. for (lfs_off_t i = 0; i < skips; i++) {
  807. int err = lfs_cache_prog(lfs, pcache, *block, 4*i, &head, 4);
  808. if (err) {
  809. if (err == LFS_ERR_CORRUPT) {
  810. goto relocate;
  811. }
  812. return err;
  813. }
  814. if (i != skips-1) {
  815. err = lfs_cache_read(lfs, rcache, NULL, head, 4*i, &head, 4);
  816. if (err) {
  817. return err;
  818. }
  819. }
  820. }
  821. *off = 4*skips;
  822. return 0;
  823. relocate:
  824. LFS_DEBUG("Bad block at %d", *block);
  825. // just clear cache and try a new block
  826. pcache->block = 0xffffffff;
  827. }
  828. }
  829. static int lfs_index_traverse(lfs_t *lfs,
  830. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  831. lfs_block_t head, lfs_size_t size,
  832. int (*cb)(void*, lfs_block_t), void *data) {
  833. if (size == 0) {
  834. return 0;
  835. }
  836. lfs_off_t index = lfs_index(lfs, &(lfs_off_t){size-1});
  837. while (true) {
  838. int err = cb(data, head);
  839. if (err) {
  840. return err;
  841. }
  842. if (index == 0) {
  843. return 0;
  844. }
  845. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &head, 4);
  846. if (err) {
  847. return err;
  848. }
  849. index -= 1;
  850. }
  851. return 0;
  852. }
  853. /// Top level file operations ///
  854. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  855. const char *path, int flags) {
  856. // allocate entry for file if it doesn't exist
  857. lfs_dir_t cwd;
  858. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  859. if (err) {
  860. return err;
  861. }
  862. lfs_entry_t entry;
  863. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  864. if (err && err != LFS_ERR_NOENT) {
  865. return err;
  866. }
  867. if (err == LFS_ERR_NOENT) {
  868. if (!(flags & LFS_O_CREAT)) {
  869. return LFS_ERR_NOENT;
  870. }
  871. // create entry to remember name
  872. entry.d.type = LFS_TYPE_REG;
  873. entry.d.len = sizeof(entry.d) + strlen(path);
  874. entry.d.u.file.head = -1;
  875. entry.d.u.file.size = 0;
  876. err = lfs_dir_append(lfs, &cwd, &entry, path);
  877. if (err) {
  878. return err;
  879. }
  880. } else if (entry.d.type == LFS_TYPE_DIR) {
  881. return LFS_ERR_ISDIR;
  882. } else if (flags & LFS_O_EXCL) {
  883. return LFS_ERR_EXISTS;
  884. }
  885. // setup file struct
  886. file->pair[0] = cwd.pair[0];
  887. file->pair[1] = cwd.pair[1];
  888. file->poff = entry.off;
  889. file->head = entry.d.u.file.head;
  890. file->size = entry.d.u.file.size;
  891. file->flags = flags;
  892. file->pos = 0;
  893. if (flags & LFS_O_TRUNC) {
  894. file->head = -1;
  895. file->size = 0;
  896. }
  897. // allocate buffer if needed
  898. file->cache.block = 0xffffffff;
  899. if (lfs->cfg->file_buffer) {
  900. file->cache.buffer = lfs->cfg->file_buffer;
  901. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  902. file->cache.buffer = malloc(lfs->cfg->read_size);
  903. if (!file->cache.buffer) {
  904. return LFS_ERR_NOMEM;
  905. }
  906. } else {
  907. file->cache.buffer = malloc(lfs->cfg->prog_size);
  908. if (!file->cache.buffer) {
  909. return LFS_ERR_NOMEM;
  910. }
  911. }
  912. // add to list of files
  913. file->next = lfs->files;
  914. lfs->files = file;
  915. return 0;
  916. }
  917. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  918. int err = lfs_file_sync(lfs, file);
  919. // remove from list of files
  920. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  921. if (*p == file) {
  922. *p = file->next;
  923. break;
  924. }
  925. }
  926. // clean up memory
  927. if (!lfs->cfg->file_buffer) {
  928. free(file->cache.buffer);
  929. }
  930. return err;
  931. }
  932. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  933. if (file->flags & LFS_F_READING) {
  934. // just drop read cache
  935. file->cache.block = 0xffffffff;
  936. file->flags &= ~LFS_F_READING;
  937. }
  938. if (file->flags & LFS_F_WRITING) {
  939. lfs_off_t pos = file->pos;
  940. // copy over anything after current branch
  941. lfs_file_t orig = {
  942. .head = file->head,
  943. .size = file->size,
  944. .flags = LFS_O_RDONLY,
  945. .pos = file->pos,
  946. .cache = lfs->rcache,
  947. };
  948. lfs->rcache.block = 0xffffffff;
  949. while (file->pos < file->size) {
  950. // copy over a byte at a time, leave it up to caching
  951. // to make this efficient
  952. uint8_t data;
  953. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  954. if (res < 0) {
  955. return res;
  956. }
  957. res = lfs_file_write(lfs, file, &data, 1);
  958. if (res < 0) {
  959. return res;
  960. }
  961. // keep our reference to the rcache in sync
  962. if (lfs->rcache.block != 0xffffffff) {
  963. orig.cache.block = 0xffffffff;
  964. lfs->rcache.block = 0xffffffff;
  965. }
  966. }
  967. // write out what we have
  968. int err = lfs_cache_flush(lfs, &file->cache);
  969. if (err) {
  970. return err;
  971. }
  972. // actual file updates
  973. file->head = file->block;
  974. file->size = file->pos;
  975. file->flags &= ~LFS_F_WRITING;
  976. file->flags |= LFS_F_DIRTY;
  977. file->pos = pos;
  978. }
  979. return 0;
  980. }
  981. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  982. int err = lfs_file_flush(lfs, file);
  983. if (err) {
  984. return err;
  985. }
  986. if ((file->flags & LFS_F_DIRTY) && !lfs_pairisnull(file->pair)) {
  987. // update dir entry
  988. lfs_dir_t cwd;
  989. int err = lfs_dir_fetch(lfs, &cwd, file->pair);
  990. if (err) {
  991. return err;
  992. }
  993. lfs_entry_t entry = {.off = file->poff};
  994. err = lfs_read(lfs, cwd.pair[0], entry.off,
  995. &entry.d, sizeof(entry.d));
  996. if (err) {
  997. return err;
  998. }
  999. if (entry.d.type != LFS_TYPE_REG) {
  1000. // sanity check valid entry
  1001. return LFS_ERR_INVAL;
  1002. }
  1003. entry.d.u.file.head = file->head;
  1004. entry.d.u.file.size = file->size;
  1005. err = lfs_dir_update(lfs, &cwd, &entry, NULL);
  1006. if (err) {
  1007. return err;
  1008. }
  1009. file->flags &= ~LFS_F_DIRTY;
  1010. }
  1011. return 0;
  1012. }
  1013. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  1014. void *buffer, lfs_size_t size) {
  1015. uint8_t *data = buffer;
  1016. lfs_size_t nsize = size;
  1017. if ((file->flags & 3) == LFS_O_WRONLY) {
  1018. return LFS_ERR_INVAL;
  1019. }
  1020. if (file->flags & LFS_F_WRITING) {
  1021. // flush out any writes
  1022. int err = lfs_file_flush(lfs, file);
  1023. if (err) {
  1024. return err;
  1025. }
  1026. }
  1027. size = lfs_min(size, file->size - file->pos);
  1028. nsize = size;
  1029. while (nsize > 0) {
  1030. // check if we need a new block
  1031. if (!(file->flags & LFS_F_READING) ||
  1032. file->off == lfs->cfg->block_size) {
  1033. int err = lfs_index_find(lfs, &file->cache, NULL,
  1034. file->head, file->size,
  1035. file->pos, &file->block, &file->off);
  1036. if (err) {
  1037. return err;
  1038. }
  1039. file->flags |= LFS_F_READING;
  1040. }
  1041. // read as much as we can in current block
  1042. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1043. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1044. file->block, file->off, data, diff);
  1045. if (err) {
  1046. return err;
  1047. }
  1048. file->pos += diff;
  1049. file->off += diff;
  1050. data += diff;
  1051. nsize -= diff;
  1052. }
  1053. return size;
  1054. }
  1055. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1056. const void *buffer, lfs_size_t size) {
  1057. const uint8_t *data = buffer;
  1058. lfs_size_t nsize = size;
  1059. if ((file->flags & 3) == LFS_O_RDONLY) {
  1060. return LFS_ERR_INVAL;
  1061. }
  1062. if (file->flags & LFS_F_READING) {
  1063. // drop any reads
  1064. int err = lfs_file_flush(lfs, file);
  1065. if (err) {
  1066. return err;
  1067. }
  1068. }
  1069. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1070. file->pos = file->size;
  1071. }
  1072. while (nsize > 0) {
  1073. // check if we need a new block
  1074. if (!(file->flags & LFS_F_WRITING) ||
  1075. file->off == lfs->cfg->block_size) {
  1076. if (!(file->flags & LFS_F_WRITING)) {
  1077. // find out which block we're extending from
  1078. int err = lfs_index_find(lfs, &file->cache, NULL,
  1079. file->head, file->size,
  1080. file->pos, &file->block, &file->off);
  1081. if (err) {
  1082. return err;
  1083. }
  1084. // mark cache as dirty since we may have read data into it
  1085. file->cache.block = 0xffffffff;
  1086. file->flags |= LFS_F_WRITING;
  1087. }
  1088. // extend file with new blocks
  1089. lfs_alloc_ack(lfs);
  1090. int err = lfs_index_extend(lfs, &lfs->rcache, &file->cache,
  1091. file->block, file->pos,
  1092. &file->block, &file->off);
  1093. if (err) {
  1094. return err;
  1095. }
  1096. }
  1097. // program as much as we can in current block
  1098. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1099. while (true) {
  1100. int err = lfs_cache_prog(lfs, &file->cache,
  1101. file->block, file->off, data, diff);
  1102. if (err) {
  1103. if (err == LFS_ERR_CORRUPT) {
  1104. goto relocate;
  1105. }
  1106. return err;
  1107. }
  1108. break;
  1109. relocate:
  1110. LFS_DEBUG("Bad block at %d", file->block);
  1111. // just relocate what exists into new block
  1112. lfs_block_t nblock;
  1113. err = lfs_alloc(lfs, &nblock);
  1114. if (err) {
  1115. return err;
  1116. }
  1117. // either read from dirty cache or disk
  1118. for (lfs_off_t i = 0; i < file->off; i++) {
  1119. uint8_t data;
  1120. if (file->cache.block == file->block && i >= file->cache.off) {
  1121. data = file->cache.buffer[i - file->cache.off];
  1122. } else {
  1123. // just read from disk
  1124. err = lfs_read(lfs, file->block, i, &data, 1);
  1125. if (err) {
  1126. return err;
  1127. }
  1128. }
  1129. err = lfs_prog(lfs, nblock, i, &data, 1);
  1130. if (err) {
  1131. if (err == LFS_ERR_CORRUPT) {
  1132. goto relocate;
  1133. }
  1134. return err;
  1135. }
  1136. }
  1137. // copy over new state of file
  1138. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->prog_size);
  1139. file->cache.block = lfs->pcache.block;
  1140. file->cache.off = lfs->pcache.off;
  1141. lfs->pcache.block = 0xffffffff;
  1142. file->block = nblock;
  1143. }
  1144. file->pos += diff;
  1145. file->off += diff;
  1146. data += diff;
  1147. nsize -= diff;
  1148. lfs_alloc_ack(lfs);
  1149. }
  1150. return size;
  1151. }
  1152. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1153. lfs_soff_t off, int whence) {
  1154. // write out everything beforehand, may be noop if rdonly
  1155. int err = lfs_file_flush(lfs, file);
  1156. if (err) {
  1157. return err;
  1158. }
  1159. // update pos
  1160. lfs_off_t pos = file->pos;
  1161. if (whence == LFS_SEEK_SET) {
  1162. file->pos = off;
  1163. } else if (whence == LFS_SEEK_CUR) {
  1164. file->pos = file->pos + off;
  1165. } else if (whence == LFS_SEEK_END) {
  1166. file->pos = file->size + off;
  1167. }
  1168. return pos;
  1169. }
  1170. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1171. return file->pos;
  1172. }
  1173. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1174. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1175. if (res < 0) {
  1176. return res;
  1177. }
  1178. return 0;
  1179. }
  1180. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1181. return lfs_max(file->pos, file->size);
  1182. }
  1183. /// General fs oprations ///
  1184. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1185. lfs_dir_t cwd;
  1186. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1187. if (err) {
  1188. return err;
  1189. }
  1190. lfs_entry_t entry;
  1191. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1192. if (err) {
  1193. return err;
  1194. }
  1195. memset(info, 0, sizeof(*info));
  1196. info->type = entry.d.type & 0xff;
  1197. if (info->type == LFS_TYPE_REG) {
  1198. info->size = entry.d.u.file.size;
  1199. }
  1200. err = lfs_read(lfs, cwd.pair[0], entry.off + sizeof(entry.d),
  1201. info->name, entry.d.len - sizeof(entry.d));
  1202. if (err) {
  1203. return err;
  1204. }
  1205. return 0;
  1206. }
  1207. int lfs_remove(lfs_t *lfs, const char *path) {
  1208. lfs_dir_t cwd;
  1209. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1210. if (err) {
  1211. return err;
  1212. }
  1213. lfs_entry_t entry;
  1214. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1215. if (err) {
  1216. return err;
  1217. }
  1218. lfs_dir_t dir;
  1219. if (entry.d.type == LFS_TYPE_DIR) {
  1220. // must be empty before removal, checking size
  1221. // without masking top bit checks for any case where
  1222. // dir is not empty
  1223. int err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1224. if (err) {
  1225. return err;
  1226. } else if (dir.d.size != sizeof(dir.d)+4) {
  1227. return LFS_ERR_INVAL;
  1228. }
  1229. }
  1230. // remove the entry
  1231. err = lfs_dir_remove(lfs, &cwd, &entry);
  1232. if (err) {
  1233. return err;
  1234. }
  1235. // shift over any files that are affected
  1236. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  1237. if (lfs_paircmp(f->pair, cwd.pair) == 0) {
  1238. if (f->poff == entry.off) {
  1239. f->pair[0] = 0xffffffff;
  1240. f->pair[1] = 0xffffffff;
  1241. } else if (f->poff > entry.off) {
  1242. f->poff -= entry.d.len;
  1243. }
  1244. }
  1245. }
  1246. // if we were a directory, just run a deorphan step, this should
  1247. // collect us, although is expensive
  1248. if (entry.d.type == LFS_TYPE_DIR) {
  1249. int err = lfs_deorphan(lfs);
  1250. if (err) {
  1251. return err;
  1252. }
  1253. }
  1254. return 0;
  1255. }
  1256. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  1257. // find old entry
  1258. lfs_dir_t oldcwd;
  1259. int err = lfs_dir_fetch(lfs, &oldcwd, lfs->root);
  1260. if (err) {
  1261. return err;
  1262. }
  1263. lfs_entry_t oldentry;
  1264. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1265. if (err) {
  1266. return err;
  1267. }
  1268. // allocate new entry
  1269. lfs_dir_t newcwd;
  1270. err = lfs_dir_fetch(lfs, &newcwd, lfs->root);
  1271. if (err) {
  1272. return err;
  1273. }
  1274. lfs_entry_t preventry;
  1275. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  1276. if (err && err != LFS_ERR_NOENT) {
  1277. return err;
  1278. }
  1279. bool prevexists = (err != LFS_ERR_NOENT);
  1280. // must have same type
  1281. if (prevexists && preventry.d.type != oldentry.d.type) {
  1282. return LFS_ERR_INVAL;
  1283. }
  1284. lfs_dir_t dir;
  1285. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1286. // must be empty before removal, checking size
  1287. // without masking top bit checks for any case where
  1288. // dir is not empty
  1289. int err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  1290. if (err) {
  1291. return err;
  1292. } else if (dir.d.size != sizeof(dir.d)+4) {
  1293. return LFS_ERR_INVAL;
  1294. }
  1295. }
  1296. // move to new location
  1297. lfs_entry_t newentry = preventry;
  1298. newentry.d = oldentry.d;
  1299. newentry.d.len = sizeof(newentry.d) + strlen(newpath);
  1300. if (prevexists) {
  1301. int err = lfs_dir_update(lfs, &newcwd, &newentry, newpath);
  1302. if (err) {
  1303. return err;
  1304. }
  1305. } else {
  1306. int err = lfs_dir_append(lfs, &newcwd, &newentry, newpath);
  1307. if (err) {
  1308. return err;
  1309. }
  1310. }
  1311. // fetch again in case newcwd == oldcwd
  1312. err = lfs_dir_fetch(lfs, &oldcwd, oldcwd.pair);
  1313. if (err) {
  1314. return err;
  1315. }
  1316. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1317. if (err) {
  1318. return err;
  1319. }
  1320. // remove from old location
  1321. err = lfs_dir_remove(lfs, &oldcwd, &oldentry);
  1322. if (err) {
  1323. return err;
  1324. }
  1325. // shift over any files that are affected
  1326. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  1327. if (lfs_paircmp(f->pair, oldcwd.pair) == 0) {
  1328. if (f->poff == oldentry.off) {
  1329. f->pair[0] = 0xffffffff;
  1330. f->pair[1] = 0xffffffff;
  1331. } else if (f->poff > oldentry.off) {
  1332. f->poff -= oldentry.d.len;
  1333. }
  1334. }
  1335. }
  1336. // if we were a directory, just run a deorphan step, this should
  1337. // collect us, although is expensive
  1338. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1339. int err = lfs_deorphan(lfs);
  1340. if (err) {
  1341. return err;
  1342. }
  1343. }
  1344. return 0;
  1345. }
  1346. /// Filesystem operations ///
  1347. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  1348. lfs->cfg = cfg;
  1349. // setup read cache
  1350. lfs->rcache.block = 0xffffffff;
  1351. if (lfs->cfg->read_buffer) {
  1352. lfs->rcache.buffer = lfs->cfg->read_buffer;
  1353. } else {
  1354. lfs->rcache.buffer = malloc(lfs->cfg->read_size);
  1355. if (!lfs->rcache.buffer) {
  1356. return LFS_ERR_NOMEM;
  1357. }
  1358. }
  1359. // setup program cache
  1360. lfs->pcache.block = 0xffffffff;
  1361. if (lfs->cfg->prog_buffer) {
  1362. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  1363. } else {
  1364. lfs->pcache.buffer = malloc(lfs->cfg->prog_size);
  1365. if (!lfs->pcache.buffer) {
  1366. return LFS_ERR_NOMEM;
  1367. }
  1368. }
  1369. // setup lookahead
  1370. if (lfs->cfg->lookahead_buffer) {
  1371. lfs->free.lookahead = lfs->cfg->lookahead_buffer;
  1372. } else {
  1373. lfs->free.lookahead = malloc(lfs->cfg->lookahead/8);
  1374. if (!lfs->free.lookahead) {
  1375. return LFS_ERR_NOMEM;
  1376. }
  1377. }
  1378. // setup default state
  1379. lfs->root[0] = 0xffffffff;
  1380. lfs->root[1] = 0xffffffff;
  1381. lfs->files = NULL;
  1382. lfs->deorphaned = false;
  1383. return 0;
  1384. }
  1385. static int lfs_deinit(lfs_t *lfs) {
  1386. // free allocated memory
  1387. if (!lfs->cfg->read_buffer) {
  1388. free(lfs->rcache.buffer);
  1389. }
  1390. if (!lfs->cfg->prog_buffer) {
  1391. free(lfs->pcache.buffer);
  1392. }
  1393. if (!lfs->cfg->lookahead_buffer) {
  1394. free(lfs->free.lookahead);
  1395. }
  1396. return 0;
  1397. }
  1398. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  1399. int err = lfs_init(lfs, cfg);
  1400. if (err) {
  1401. return err;
  1402. }
  1403. // create free lookahead
  1404. memset(lfs->free.lookahead, 0, lfs->cfg->lookahead/8);
  1405. lfs->free.start = 0;
  1406. lfs->free.off = 0;
  1407. lfs->free.end = lfs->free.start + lfs->cfg->block_count;
  1408. // create superblock dir
  1409. lfs_alloc_ack(lfs);
  1410. lfs_dir_t superdir;
  1411. err = lfs_dir_alloc(lfs, &superdir);
  1412. if (err) {
  1413. return err;
  1414. }
  1415. // write root directory
  1416. lfs_dir_t root;
  1417. err = lfs_dir_alloc(lfs, &root);
  1418. if (err) {
  1419. return err;
  1420. }
  1421. err = lfs_dir_commit(lfs, &root, NULL, 0);
  1422. if (err) {
  1423. return err;
  1424. }
  1425. lfs->root[0] = root.pair[0];
  1426. lfs->root[1] = root.pair[1];
  1427. // write superblocks
  1428. lfs_superblock_t superblock = {
  1429. .off = sizeof(superdir.d),
  1430. .d.type = LFS_TYPE_SUPERBLOCK,
  1431. .d.len = sizeof(superblock.d),
  1432. .d.version = 0x00000001,
  1433. .d.magic = {"littlefs"},
  1434. .d.block_size = lfs->cfg->block_size,
  1435. .d.block_count = lfs->cfg->block_count,
  1436. .d.root = {lfs->root[0], lfs->root[1]},
  1437. };
  1438. superdir.d.tail[0] = root.pair[0];
  1439. superdir.d.tail[1] = root.pair[1];
  1440. superdir.d.size = sizeof(superdir.d) + sizeof(superblock.d) + 4;
  1441. // write both pairs to be safe
  1442. bool valid = false;
  1443. for (int i = 0; i < 2; i++) {
  1444. int err = lfs_dir_commit(lfs, &superdir, (struct lfs_region[]){
  1445. {sizeof(superdir.d), sizeof(superblock.d),
  1446. &superblock.d, sizeof(superblock.d)}
  1447. }, 1);
  1448. if (err && err != LFS_ERR_CORRUPT) {
  1449. return err;
  1450. }
  1451. valid = valid || !err;
  1452. }
  1453. if (!valid) {
  1454. return LFS_ERR_CORRUPT;
  1455. }
  1456. // sanity check that fetch works
  1457. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  1458. if (err) {
  1459. return err;
  1460. }
  1461. lfs_alloc_ack(lfs);
  1462. return lfs_deinit(lfs);
  1463. }
  1464. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  1465. int err = lfs_init(lfs, cfg);
  1466. if (err) {
  1467. return err;
  1468. }
  1469. // setup free lookahead
  1470. lfs->free.start = -lfs->cfg->lookahead;
  1471. lfs->free.off = lfs->cfg->lookahead;
  1472. lfs->free.end = lfs->free.start + lfs->cfg->block_count;
  1473. // load superblock
  1474. lfs_dir_t dir;
  1475. lfs_superblock_t superblock;
  1476. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  1477. if (!err) {
  1478. err = lfs_read(lfs, dir.pair[0],
  1479. sizeof(dir.d), &superblock.d, sizeof(superblock.d));
  1480. lfs->root[0] = superblock.d.root[0];
  1481. lfs->root[1] = superblock.d.root[1];
  1482. }
  1483. if (err == LFS_ERR_CORRUPT ||
  1484. memcmp(superblock.d.magic, "littlefs", 8) != 0) {
  1485. LFS_ERROR("Invalid superblock at %d %d", dir.pair[0], dir.pair[1]);
  1486. return LFS_ERR_CORRUPT;
  1487. }
  1488. if (superblock.d.version > 0x0000ffff) {
  1489. LFS_ERROR("Invalid version %d.%d\n",
  1490. 0xffff & (superblock.d.version >> 16),
  1491. 0xffff & (superblock.d.version >> 0));
  1492. return LFS_ERR_INVAL;
  1493. }
  1494. return err;
  1495. }
  1496. int lfs_unmount(lfs_t *lfs) {
  1497. return lfs_deinit(lfs);
  1498. }
  1499. /// Littlefs specific operations ///
  1500. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  1501. if (lfs_pairisnull(lfs->root)) {
  1502. return 0;
  1503. }
  1504. // iterate over metadata pairs
  1505. lfs_dir_t dir;
  1506. lfs_entry_t entry;
  1507. lfs_block_t cwd[2] = {0, 1};
  1508. while (true) {
  1509. for (int i = 0; i < 2; i++) {
  1510. int err = cb(data, cwd[i]);
  1511. if (err) {
  1512. return err;
  1513. }
  1514. }
  1515. int err = lfs_dir_fetch(lfs, &dir, cwd);
  1516. if (err) {
  1517. return err;
  1518. }
  1519. // iterate over contents
  1520. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  1521. int err = lfs_read(lfs, dir.pair[0], dir.off,
  1522. &entry.d, sizeof(entry.d));
  1523. if (err) {
  1524. return err;
  1525. }
  1526. dir.off += entry.d.len;
  1527. if ((0xf & entry.d.type) == LFS_TYPE_REG) {
  1528. int err = lfs_index_traverse(lfs, &lfs->rcache, NULL,
  1529. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  1530. if (err) {
  1531. return err;
  1532. }
  1533. }
  1534. }
  1535. cwd[0] = dir.d.tail[0];
  1536. cwd[1] = dir.d.tail[1];
  1537. if (lfs_pairisnull(cwd)) {
  1538. break;
  1539. }
  1540. }
  1541. // iterate over any open files
  1542. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  1543. if (f->flags & LFS_F_DIRTY) {
  1544. int err = lfs_index_traverse(lfs, &lfs->rcache, &f->cache,
  1545. f->head, f->size, cb, data);
  1546. if (err) {
  1547. return err;
  1548. }
  1549. }
  1550. if (f->flags & LFS_F_WRITING) {
  1551. int err = lfs_index_traverse(lfs, &lfs->rcache, &f->cache,
  1552. f->block, f->pos, cb, data);
  1553. if (err) {
  1554. return err;
  1555. }
  1556. }
  1557. }
  1558. return 0;
  1559. }
  1560. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir) {
  1561. if (lfs_pairisnull(lfs->root)) {
  1562. return 0;
  1563. }
  1564. // iterate over all directory directory entries
  1565. int err = lfs_dir_fetch(lfs, pdir, (const lfs_block_t[2]){0, 1});
  1566. if (err) {
  1567. return err;
  1568. }
  1569. while (!lfs_pairisnull(pdir->d.tail)) {
  1570. if (lfs_paircmp(pdir->d.tail, dir) == 0) {
  1571. return true;
  1572. }
  1573. int err = lfs_dir_fetch(lfs, pdir, pdir->d.tail);
  1574. if (err) {
  1575. return err;
  1576. }
  1577. }
  1578. return false;
  1579. }
  1580. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  1581. lfs_dir_t *parent, lfs_entry_t *entry) {
  1582. if (lfs_pairisnull(lfs->root)) {
  1583. return 0;
  1584. }
  1585. parent->d.tail[0] = 0;
  1586. parent->d.tail[1] = 1;
  1587. // iterate over all directory directory entries
  1588. while (!lfs_pairisnull(parent->d.tail)) {
  1589. int err = lfs_dir_fetch(lfs, parent, parent->d.tail);
  1590. if (err) {
  1591. return err;
  1592. }
  1593. while (true) {
  1594. int err = lfs_dir_next(lfs, parent, entry);
  1595. if (err && err != LFS_ERR_NOENT) {
  1596. return err;
  1597. }
  1598. if (err == LFS_ERR_NOENT) {
  1599. break;
  1600. }
  1601. if (((0xf & entry->d.type) == LFS_TYPE_DIR) &&
  1602. lfs_paircmp(entry->d.u.dir, dir) == 0) {
  1603. return true;
  1604. }
  1605. }
  1606. }
  1607. return false;
  1608. }
  1609. static int lfs_relocate(lfs_t *lfs,
  1610. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]) {
  1611. // find parent
  1612. lfs_dir_t parent;
  1613. lfs_entry_t entry;
  1614. int res = lfs_parent(lfs, oldpair, &parent, &entry);
  1615. if (res < 0) {
  1616. return res;
  1617. }
  1618. if (res) {
  1619. // update disk, this creates a desync
  1620. entry.d.u.dir[0] = newpair[0];
  1621. entry.d.u.dir[1] = newpair[1];
  1622. int err = lfs_dir_update(lfs, &parent, &entry, NULL);
  1623. if (err) {
  1624. return err;
  1625. }
  1626. // update internal root
  1627. if (lfs_paircmp(oldpair, lfs->root) == 0) {
  1628. LFS_DEBUG("Relocating root %d %d", newpair[0], newpair[1]);
  1629. lfs->root[0] = newpair[0];
  1630. lfs->root[1] = newpair[1];
  1631. }
  1632. // clean up bad block, which should now be a desync
  1633. return lfs_deorphan(lfs);
  1634. }
  1635. // find pred
  1636. res = lfs_pred(lfs, oldpair, &parent);
  1637. if (res < 0) {
  1638. return res;
  1639. }
  1640. if (res) {
  1641. // just replace bad pair, no desync can occur
  1642. parent.d.tail[0] = newpair[0];
  1643. parent.d.tail[0] = newpair[0];
  1644. return lfs_dir_commit(lfs, &parent, NULL, 0);
  1645. }
  1646. // couldn't find dir, must be new
  1647. return 0;
  1648. }
  1649. int lfs_deorphan(lfs_t *lfs) {
  1650. lfs->deorphaned = true;
  1651. if (lfs_pairisnull(lfs->root)) {
  1652. return 0;
  1653. }
  1654. lfs_dir_t pdir;
  1655. lfs_dir_t cdir;
  1656. // skip superblock
  1657. int err = lfs_dir_fetch(lfs, &pdir, (const lfs_block_t[2]){0, 1});
  1658. if (err) {
  1659. return err;
  1660. }
  1661. // iterate over all directories
  1662. while (!lfs_pairisnull(pdir.d.tail)) {
  1663. int err = lfs_dir_fetch(lfs, &cdir, pdir.d.tail);
  1664. if (err) {
  1665. return err;
  1666. }
  1667. // only check head blocks
  1668. if (!(0x80000000 & pdir.d.size)) {
  1669. // check if we have a parent
  1670. lfs_dir_t parent;
  1671. lfs_entry_t entry;
  1672. int res = lfs_parent(lfs, pdir.d.tail, &parent, &entry);
  1673. if (res < 0) {
  1674. return res;
  1675. }
  1676. if (!res) {
  1677. // we are an orphan
  1678. LFS_DEBUG("Orphan %d %d", pdir.d.tail[0], pdir.d.tail[1]);
  1679. pdir.d.tail[0] = cdir.d.tail[0];
  1680. pdir.d.tail[1] = cdir.d.tail[1];
  1681. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  1682. if (err) {
  1683. return err;
  1684. }
  1685. break;
  1686. }
  1687. if (!lfs_pairsync(entry.d.u.dir, pdir.d.tail)) {
  1688. // we have desynced
  1689. LFS_DEBUG("Desync %d %d", entry.d.u.dir[0], entry.d.u.dir[1]);
  1690. pdir.d.tail[0] = entry.d.u.dir[0];
  1691. pdir.d.tail[1] = entry.d.u.dir[1];
  1692. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  1693. if (err) {
  1694. return err;
  1695. }
  1696. break;
  1697. }
  1698. }
  1699. memcpy(&pdir, &cdir, sizeof(pdir));
  1700. }
  1701. return 0;
  1702. }