lfs.c 53 KB

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