lfs.c 47 KB

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