lfs.c 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543
  1. /*
  2. * The little filesystem
  3. *
  4. * Copyright (c) 2017, Arm Limited. All rights reserved.
  5. * SPDX-License-Identifier: BSD-3-Clause
  6. */
  7. #include "lfs.h"
  8. #include "lfs_util.h"
  9. #include <inttypes.h>
  10. /// Caching block device operations ///
  11. static int lfs_cache_read(lfs_t *lfs, lfs_cache_t *rcache,
  12. const lfs_cache_t *pcache, lfs_block_t block,
  13. lfs_off_t off, void *buffer, lfs_size_t size) {
  14. uint8_t *data = buffer;
  15. LFS_ASSERT(block < lfs->cfg->block_count);
  16. while (size > 0) {
  17. if (pcache && block == pcache->block && off >= pcache->off &&
  18. off < pcache->off + lfs->cfg->prog_size) {
  19. // is already in pcache?
  20. lfs_size_t diff = lfs_min(size,
  21. lfs->cfg->prog_size - (off-pcache->off));
  22. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  23. data += diff;
  24. off += diff;
  25. size -= diff;
  26. continue;
  27. }
  28. if (block == rcache->block && off >= rcache->off &&
  29. off < rcache->off + lfs->cfg->read_size) {
  30. // is already in rcache?
  31. lfs_size_t diff = lfs_min(size,
  32. lfs->cfg->read_size - (off-rcache->off));
  33. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  34. data += diff;
  35. off += diff;
  36. size -= diff;
  37. continue;
  38. }
  39. if (off % lfs->cfg->read_size == 0 && size >= lfs->cfg->read_size) {
  40. // bypass cache?
  41. lfs_size_t diff = size - (size % lfs->cfg->read_size);
  42. int err = lfs->cfg->read(lfs->cfg, block, off, data, diff);
  43. if (err) {
  44. return err;
  45. }
  46. data += diff;
  47. off += diff;
  48. size -= diff;
  49. continue;
  50. }
  51. // load to cache, first condition can no longer fail
  52. rcache->block = block;
  53. rcache->off = off - (off % lfs->cfg->read_size);
  54. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  55. rcache->off, rcache->buffer, lfs->cfg->read_size);
  56. if (err) {
  57. return err;
  58. }
  59. }
  60. return 0;
  61. }
  62. static int lfs_cache_cmp(lfs_t *lfs, lfs_cache_t *rcache,
  63. const lfs_cache_t *pcache, lfs_block_t block,
  64. lfs_off_t off, const void *buffer, lfs_size_t size) {
  65. const uint8_t *data = buffer;
  66. for (lfs_off_t i = 0; i < size; i++) {
  67. uint8_t c;
  68. int err = lfs_cache_read(lfs, rcache, pcache,
  69. block, off+i, &c, 1);
  70. if (err) {
  71. return err;
  72. }
  73. if (c != data[i]) {
  74. return false;
  75. }
  76. }
  77. return true;
  78. }
  79. static int lfs_cache_crc(lfs_t *lfs, lfs_cache_t *rcache,
  80. const lfs_cache_t *pcache, lfs_block_t block,
  81. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  82. for (lfs_off_t i = 0; i < size; i++) {
  83. uint8_t c;
  84. int err = lfs_cache_read(lfs, rcache, pcache,
  85. block, off+i, &c, 1);
  86. if (err) {
  87. return err;
  88. }
  89. lfs_crc(crc, &c, 1);
  90. }
  91. return 0;
  92. }
  93. static inline void lfs_cache_drop(lfs_t *lfs, lfs_cache_t *rcache) {
  94. // do not zero, cheaper if cache is readonly or only going to be
  95. // written with identical data (during relocates)
  96. (void)lfs;
  97. rcache->block = 0xffffffff;
  98. }
  99. static inline void lfs_cache_zero(lfs_t *lfs, lfs_cache_t *pcache) {
  100. // zero to avoid information leak
  101. memset(pcache->buffer, 0xff, lfs->cfg->prog_size);
  102. pcache->block = 0xffffffff;
  103. }
  104. static int lfs_cache_flush(lfs_t *lfs,
  105. lfs_cache_t *pcache, lfs_cache_t *rcache) {
  106. if (pcache->block != 0xffffffff) {
  107. int err = lfs->cfg->prog(lfs->cfg, pcache->block,
  108. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  109. if (err) {
  110. return err;
  111. }
  112. if (rcache) {
  113. int res = lfs_cache_cmp(lfs, rcache, NULL, pcache->block,
  114. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  115. if (res < 0) {
  116. return res;
  117. }
  118. if (!res) {
  119. return LFS_ERR_CORRUPT;
  120. }
  121. }
  122. lfs_cache_zero(lfs, pcache);
  123. }
  124. return 0;
  125. }
  126. static int lfs_cache_prog(lfs_t *lfs, lfs_cache_t *pcache,
  127. lfs_cache_t *rcache, lfs_block_t block,
  128. lfs_off_t off, const void *buffer, lfs_size_t size) {
  129. const uint8_t *data = buffer;
  130. LFS_ASSERT(block < lfs->cfg->block_count);
  131. while (size > 0) {
  132. if (block == pcache->block && off >= pcache->off &&
  133. off < pcache->off + lfs->cfg->prog_size) {
  134. // is already in pcache?
  135. lfs_size_t diff = lfs_min(size,
  136. lfs->cfg->prog_size - (off-pcache->off));
  137. memcpy(&pcache->buffer[off-pcache->off], data, diff);
  138. data += diff;
  139. off += diff;
  140. size -= diff;
  141. if (off % lfs->cfg->prog_size == 0) {
  142. // eagerly flush out pcache if we fill up
  143. int err = lfs_cache_flush(lfs, pcache, rcache);
  144. if (err) {
  145. return err;
  146. }
  147. }
  148. continue;
  149. }
  150. // pcache must have been flushed, either by programming and
  151. // entire block or manually flushing the pcache
  152. LFS_ASSERT(pcache->block == 0xffffffff);
  153. if (off % lfs->cfg->prog_size == 0 &&
  154. size >= lfs->cfg->prog_size) {
  155. // bypass pcache?
  156. lfs_size_t diff = size - (size % lfs->cfg->prog_size);
  157. int err = lfs->cfg->prog(lfs->cfg, block, off, data, diff);
  158. if (err) {
  159. return err;
  160. }
  161. if (rcache) {
  162. int res = lfs_cache_cmp(lfs, rcache, NULL,
  163. block, off, data, diff);
  164. if (res < 0) {
  165. return res;
  166. }
  167. if (!res) {
  168. return LFS_ERR_CORRUPT;
  169. }
  170. }
  171. data += diff;
  172. off += diff;
  173. size -= diff;
  174. continue;
  175. }
  176. // prepare pcache, first condition can no longer fail
  177. pcache->block = block;
  178. pcache->off = off - (off % lfs->cfg->prog_size);
  179. }
  180. return 0;
  181. }
  182. /// General lfs block device operations ///
  183. static int lfs_bd_read(lfs_t *lfs, lfs_block_t block,
  184. lfs_off_t off, void *buffer, lfs_size_t size) {
  185. // if we ever do more than writes to alternating pairs,
  186. // this may need to consider pcache
  187. return lfs_cache_read(lfs, &lfs->rcache, NULL,
  188. block, off, buffer, size);
  189. }
  190. static int lfs_bd_prog(lfs_t *lfs, lfs_block_t block,
  191. lfs_off_t off, const void *buffer, lfs_size_t size) {
  192. return lfs_cache_prog(lfs, &lfs->pcache, NULL,
  193. block, off, buffer, size);
  194. }
  195. static int lfs_bd_cmp(lfs_t *lfs, lfs_block_t block,
  196. lfs_off_t off, const void *buffer, lfs_size_t size) {
  197. return lfs_cache_cmp(lfs, &lfs->rcache, NULL, block, off, buffer, size);
  198. }
  199. static int lfs_bd_crc(lfs_t *lfs, lfs_block_t block,
  200. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  201. return lfs_cache_crc(lfs, &lfs->rcache, NULL, block, off, size, crc);
  202. }
  203. static int lfs_bd_erase(lfs_t *lfs, lfs_block_t block) {
  204. return lfs->cfg->erase(lfs->cfg, block);
  205. }
  206. static int lfs_bd_sync(lfs_t *lfs) {
  207. lfs_cache_drop(lfs, &lfs->rcache);
  208. int err = lfs_cache_flush(lfs, &lfs->pcache, NULL);
  209. if (err) {
  210. return err;
  211. }
  212. return lfs->cfg->sync(lfs->cfg);
  213. }
  214. /// Internal operations predeclared here ///
  215. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data);
  216. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir);
  217. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  218. lfs_dir_t *parent, lfs_entry_t *entry);
  219. static int lfs_moved(lfs_t *lfs, const void *e);
  220. static int lfs_relocate(lfs_t *lfs,
  221. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]);
  222. int lfs_deorphan(lfs_t *lfs);
  223. /// Block allocator ///
  224. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  225. lfs_t *lfs = p;
  226. lfs_block_t off = ((block - lfs->free.off)
  227. + lfs->cfg->block_count) % lfs->cfg->block_count;
  228. if (off < lfs->free.size) {
  229. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  230. }
  231. return 0;
  232. }
  233. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  234. while (true) {
  235. while (lfs->free.i != lfs->free.size) {
  236. lfs_block_t off = lfs->free.i;
  237. lfs->free.i += 1;
  238. lfs->free.ack -= 1;
  239. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  240. // found a free block
  241. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  242. // eagerly find next off so an alloc ack can
  243. // discredit old lookahead blocks
  244. while (lfs->free.i != lfs->free.size &&
  245. (lfs->free.buffer[lfs->free.i / 32]
  246. & (1U << (lfs->free.i % 32)))) {
  247. lfs->free.i += 1;
  248. lfs->free.ack -= 1;
  249. }
  250. return 0;
  251. }
  252. }
  253. // check if we have looked at all blocks since last ack
  254. if (lfs->free.ack == 0) {
  255. LFS_WARN("No more free space %" PRIu32,
  256. lfs->free.i + lfs->free.off);
  257. return LFS_ERR_NOSPC;
  258. }
  259. lfs->free.off = (lfs->free.off + lfs->free.size)
  260. % lfs->cfg->block_count;
  261. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->free.ack);
  262. lfs->free.i = 0;
  263. // find mask of free blocks from tree
  264. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  265. int err = lfs_traverse(lfs, lfs_alloc_lookahead, lfs);
  266. if (err) {
  267. return err;
  268. }
  269. }
  270. }
  271. static void lfs_alloc_ack(lfs_t *lfs) {
  272. lfs->free.ack = lfs->cfg->block_count;
  273. }
  274. /// Endian swapping functions ///
  275. static void lfs_dir_fromle32(struct lfs_disk_dir *d) {
  276. d->rev = lfs_fromle32(d->rev);
  277. d->size = lfs_fromle32(d->size);
  278. d->tail[0] = lfs_fromle32(d->tail[0]);
  279. d->tail[1] = lfs_fromle32(d->tail[1]);
  280. }
  281. static void lfs_dir_tole32(struct lfs_disk_dir *d) {
  282. d->rev = lfs_tole32(d->rev);
  283. d->size = lfs_tole32(d->size);
  284. d->tail[0] = lfs_tole32(d->tail[0]);
  285. d->tail[1] = lfs_tole32(d->tail[1]);
  286. }
  287. static void lfs_entry_fromle32(struct lfs_disk_entry *d) {
  288. d->u.dir[0] = lfs_fromle32(d->u.dir[0]);
  289. d->u.dir[1] = lfs_fromle32(d->u.dir[1]);
  290. }
  291. static void lfs_entry_tole32(struct lfs_disk_entry *d) {
  292. d->u.dir[0] = lfs_tole32(d->u.dir[0]);
  293. d->u.dir[1] = lfs_tole32(d->u.dir[1]);
  294. }
  295. static void lfs_superblock_fromle32(struct lfs_disk_superblock *d) {
  296. d->root[0] = lfs_fromle32(d->root[0]);
  297. d->root[1] = lfs_fromle32(d->root[1]);
  298. d->block_size = lfs_fromle32(d->block_size);
  299. d->block_count = lfs_fromle32(d->block_count);
  300. d->version = lfs_fromle32(d->version);
  301. }
  302. static void lfs_superblock_tole32(struct lfs_disk_superblock *d) {
  303. d->root[0] = lfs_tole32(d->root[0]);
  304. d->root[1] = lfs_tole32(d->root[1]);
  305. d->block_size = lfs_tole32(d->block_size);
  306. d->block_count = lfs_tole32(d->block_count);
  307. d->version = lfs_tole32(d->version);
  308. }
  309. /// Metadata pair and directory operations ///
  310. static inline void lfs_pairswap(lfs_block_t pair[2]) {
  311. lfs_block_t t = pair[0];
  312. pair[0] = pair[1];
  313. pair[1] = t;
  314. }
  315. static inline bool lfs_pairisnull(const lfs_block_t pair[2]) {
  316. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  317. }
  318. static inline int lfs_paircmp(
  319. const lfs_block_t paira[2],
  320. const lfs_block_t pairb[2]) {
  321. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  322. paira[0] == pairb[1] || paira[1] == pairb[0]);
  323. }
  324. static inline bool lfs_pairsync(
  325. const lfs_block_t paira[2],
  326. const lfs_block_t pairb[2]) {
  327. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  328. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  329. }
  330. static inline lfs_size_t lfs_entry_size(const lfs_entry_t *entry) {
  331. return 4 + entry->d.elen + entry->d.alen + entry->d.nlen;
  332. }
  333. static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {
  334. // allocate pair of dir blocks
  335. for (int i = 0; i < 2; i++) {
  336. int err = lfs_alloc(lfs, &dir->pair[i]);
  337. if (err) {
  338. return err;
  339. }
  340. }
  341. // rather than clobbering one of the blocks we just pretend
  342. // the revision may be valid
  343. int err = lfs_bd_read(lfs, dir->pair[0], 0, &dir->d.rev, 4);
  344. dir->d.rev = lfs_fromle32(dir->d.rev);
  345. if (err) {
  346. return err;
  347. }
  348. // set defaults
  349. dir->d.rev += 1;
  350. dir->d.size = sizeof(dir->d)+4;
  351. dir->d.tail[0] = 0xffffffff;
  352. dir->d.tail[1] = 0xffffffff;
  353. dir->off = sizeof(dir->d);
  354. // don't write out yet, let caller take care of that
  355. return 0;
  356. }
  357. static int lfs_dir_fetch(lfs_t *lfs,
  358. lfs_dir_t *dir, const lfs_block_t pair[2]) {
  359. // copy out pair, otherwise may be aliasing dir
  360. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  361. bool valid = false;
  362. // check both blocks for the most recent revision
  363. for (int i = 0; i < 2; i++) {
  364. struct lfs_disk_dir test;
  365. int err = lfs_bd_read(lfs, tpair[i], 0, &test, sizeof(test));
  366. lfs_dir_fromle32(&test);
  367. if (err) {
  368. return err;
  369. }
  370. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  371. continue;
  372. }
  373. if ((0x7fffffff & test.size) < sizeof(test)+4 ||
  374. (0x7fffffff & test.size) > lfs->cfg->block_size) {
  375. continue;
  376. }
  377. uint32_t crc = 0xffffffff;
  378. lfs_dir_tole32(&test);
  379. lfs_crc(&crc, &test, sizeof(test));
  380. lfs_dir_fromle32(&test);
  381. err = lfs_bd_crc(lfs, tpair[i], sizeof(test),
  382. (0x7fffffff & test.size) - sizeof(test), &crc);
  383. if (err) {
  384. return err;
  385. }
  386. if (crc != 0) {
  387. continue;
  388. }
  389. valid = true;
  390. // setup dir in case it's valid
  391. dir->pair[0] = tpair[(i+0) % 2];
  392. dir->pair[1] = tpair[(i+1) % 2];
  393. dir->off = sizeof(dir->d);
  394. dir->d = test;
  395. }
  396. if (!valid) {
  397. LFS_ERROR("Corrupted dir pair at %" PRIu32 " %" PRIu32 ,
  398. tpair[0], tpair[1]);
  399. return LFS_ERR_CORRUPT;
  400. }
  401. return 0;
  402. }
  403. struct lfs_region {
  404. lfs_off_t oldoff;
  405. lfs_size_t oldlen;
  406. const void *newdata;
  407. lfs_size_t newlen;
  408. };
  409. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  410. const struct lfs_region *regions, int count) {
  411. // increment revision count
  412. dir->d.rev += 1;
  413. // keep pairs in order such that pair[0] is most recent
  414. lfs_pairswap(dir->pair);
  415. for (int i = 0; i < count; i++) {
  416. dir->d.size += regions[i].newlen - regions[i].oldlen;
  417. }
  418. const lfs_block_t oldpair[2] = {dir->pair[0], dir->pair[1]};
  419. bool relocated = false;
  420. while (true) {
  421. if (true) {
  422. int err = lfs_bd_erase(lfs, dir->pair[0]);
  423. if (err) {
  424. if (err == LFS_ERR_CORRUPT) {
  425. goto relocate;
  426. }
  427. return err;
  428. }
  429. uint32_t crc = 0xffffffff;
  430. lfs_dir_tole32(&dir->d);
  431. lfs_crc(&crc, &dir->d, sizeof(dir->d));
  432. err = lfs_bd_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  433. lfs_dir_fromle32(&dir->d);
  434. if (err) {
  435. if (err == LFS_ERR_CORRUPT) {
  436. goto relocate;
  437. }
  438. return err;
  439. }
  440. int i = 0;
  441. lfs_off_t oldoff = sizeof(dir->d);
  442. lfs_off_t newoff = sizeof(dir->d);
  443. while (newoff < (0x7fffffff & dir->d.size)-4) {
  444. if (i < count && regions[i].oldoff == oldoff) {
  445. lfs_crc(&crc, regions[i].newdata, regions[i].newlen);
  446. err = lfs_bd_prog(lfs, dir->pair[0],
  447. newoff, regions[i].newdata, regions[i].newlen);
  448. if (err) {
  449. if (err == LFS_ERR_CORRUPT) {
  450. goto relocate;
  451. }
  452. return err;
  453. }
  454. oldoff += regions[i].oldlen;
  455. newoff += regions[i].newlen;
  456. i += 1;
  457. } else {
  458. uint8_t data;
  459. err = lfs_bd_read(lfs, oldpair[1], oldoff, &data, 1);
  460. if (err) {
  461. return err;
  462. }
  463. lfs_crc(&crc, &data, 1);
  464. err = lfs_bd_prog(lfs, dir->pair[0], newoff, &data, 1);
  465. if (err) {
  466. if (err == LFS_ERR_CORRUPT) {
  467. goto relocate;
  468. }
  469. return err;
  470. }
  471. oldoff += 1;
  472. newoff += 1;
  473. }
  474. }
  475. crc = lfs_tole32(crc);
  476. err = lfs_bd_prog(lfs, dir->pair[0], newoff, &crc, 4);
  477. crc = lfs_fromle32(crc);
  478. if (err) {
  479. if (err == LFS_ERR_CORRUPT) {
  480. goto relocate;
  481. }
  482. return err;
  483. }
  484. err = lfs_bd_sync(lfs);
  485. if (err) {
  486. if (err == LFS_ERR_CORRUPT) {
  487. goto relocate;
  488. }
  489. return err;
  490. }
  491. // successful commit, check checksum to make sure
  492. uint32_t ncrc = 0xffffffff;
  493. err = lfs_bd_crc(lfs, dir->pair[0], 0,
  494. (0x7fffffff & dir->d.size)-4, &ncrc);
  495. if (err) {
  496. return err;
  497. }
  498. if (ncrc != crc) {
  499. goto relocate;
  500. }
  501. }
  502. break;
  503. relocate:
  504. //commit was corrupted
  505. LFS_DEBUG("Bad block at %" PRIu32, dir->pair[0]);
  506. // drop caches and prepare to relocate block
  507. relocated = true;
  508. lfs_cache_drop(lfs, &lfs->pcache);
  509. // can't relocate superblock, filesystem is now frozen
  510. if (lfs_paircmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  511. LFS_WARN("Superblock %" PRIu32 " has become unwritable",
  512. oldpair[0]);
  513. return LFS_ERR_CORRUPT;
  514. }
  515. // relocate half of pair
  516. int err = lfs_alloc(lfs, &dir->pair[0]);
  517. if (err) {
  518. return err;
  519. }
  520. }
  521. if (relocated) {
  522. // update references if we relocated
  523. LFS_DEBUG("Relocating %" PRIu32 " %" PRIu32 " to %" PRIu32 " %" PRIu32,
  524. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  525. int err = lfs_relocate(lfs, oldpair, dir->pair);
  526. if (err) {
  527. return err;
  528. }
  529. }
  530. // shift over any directories that are affected
  531. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  532. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  533. d->pair[0] = dir->pair[0];
  534. d->pair[1] = dir->pair[1];
  535. }
  536. }
  537. return 0;
  538. }
  539. static int lfs_dir_update(lfs_t *lfs, lfs_dir_t *dir,
  540. lfs_entry_t *entry, const void *data) {
  541. lfs_entry_tole32(&entry->d);
  542. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  543. {entry->off, sizeof(entry->d), &entry->d, sizeof(entry->d)},
  544. {entry->off+sizeof(entry->d), entry->d.nlen, data, entry->d.nlen}
  545. }, data ? 2 : 1);
  546. lfs_entry_fromle32(&entry->d);
  547. return err;
  548. }
  549. static int lfs_dir_append(lfs_t *lfs, lfs_dir_t *dir,
  550. lfs_entry_t *entry, const void *data) {
  551. // check if we fit, if top bit is set we do not and move on
  552. while (true) {
  553. if (dir->d.size + lfs_entry_size(entry) <= lfs->cfg->block_size) {
  554. entry->off = dir->d.size - 4;
  555. lfs_entry_tole32(&entry->d);
  556. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  557. {entry->off, 0, &entry->d, sizeof(entry->d)},
  558. {entry->off, 0, data, entry->d.nlen}
  559. }, 2);
  560. lfs_entry_fromle32(&entry->d);
  561. return err;
  562. }
  563. // we need to allocate a new dir block
  564. if (!(0x80000000 & dir->d.size)) {
  565. lfs_dir_t olddir = *dir;
  566. int err = lfs_dir_alloc(lfs, dir);
  567. if (err) {
  568. return err;
  569. }
  570. dir->d.tail[0] = olddir.d.tail[0];
  571. dir->d.tail[1] = olddir.d.tail[1];
  572. entry->off = dir->d.size - 4;
  573. lfs_entry_tole32(&entry->d);
  574. err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  575. {entry->off, 0, &entry->d, sizeof(entry->d)},
  576. {entry->off, 0, data, entry->d.nlen}
  577. }, 2);
  578. lfs_entry_fromle32(&entry->d);
  579. if (err) {
  580. return err;
  581. }
  582. olddir.d.size |= 0x80000000;
  583. olddir.d.tail[0] = dir->pair[0];
  584. olddir.d.tail[1] = dir->pair[1];
  585. return lfs_dir_commit(lfs, &olddir, NULL, 0);
  586. }
  587. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  588. if (err) {
  589. return err;
  590. }
  591. }
  592. }
  593. static int lfs_dir_remove(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  594. // check if we should just drop the directory block
  595. if ((dir->d.size & 0x7fffffff) == sizeof(dir->d)+4
  596. + lfs_entry_size(entry)) {
  597. lfs_dir_t pdir;
  598. int res = lfs_pred(lfs, dir->pair, &pdir);
  599. if (res < 0) {
  600. return res;
  601. }
  602. if (pdir.d.size & 0x80000000) {
  603. pdir.d.size &= dir->d.size | 0x7fffffff;
  604. pdir.d.tail[0] = dir->d.tail[0];
  605. pdir.d.tail[1] = dir->d.tail[1];
  606. return lfs_dir_commit(lfs, &pdir, NULL, 0);
  607. }
  608. }
  609. // shift out the entry
  610. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  611. {entry->off, lfs_entry_size(entry), NULL, 0},
  612. }, 1);
  613. if (err) {
  614. return err;
  615. }
  616. // shift over any files/directories that are affected
  617. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  618. if (lfs_paircmp(f->pair, dir->pair) == 0) {
  619. if (f->poff == entry->off) {
  620. f->pair[0] = 0xffffffff;
  621. f->pair[1] = 0xffffffff;
  622. } else if (f->poff > entry->off) {
  623. f->poff -= lfs_entry_size(entry);
  624. }
  625. }
  626. }
  627. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  628. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  629. if (d->off > entry->off) {
  630. d->off -= lfs_entry_size(entry);
  631. d->pos -= lfs_entry_size(entry);
  632. }
  633. }
  634. }
  635. return 0;
  636. }
  637. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  638. while (dir->off + sizeof(entry->d) > (0x7fffffff & dir->d.size)-4) {
  639. if (!(0x80000000 & dir->d.size)) {
  640. entry->off = dir->off;
  641. return LFS_ERR_NOENT;
  642. }
  643. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  644. if (err) {
  645. return err;
  646. }
  647. dir->off = sizeof(dir->d);
  648. dir->pos += sizeof(dir->d) + 4;
  649. }
  650. int err = lfs_bd_read(lfs, dir->pair[0], dir->off,
  651. &entry->d, sizeof(entry->d));
  652. lfs_entry_fromle32(&entry->d);
  653. if (err) {
  654. return err;
  655. }
  656. entry->off = dir->off;
  657. dir->off += lfs_entry_size(entry);
  658. dir->pos += lfs_entry_size(entry);
  659. return 0;
  660. }
  661. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  662. lfs_entry_t *entry, const char **path) {
  663. const char *pathname = *path;
  664. size_t pathlen;
  665. entry->d.type = LFS_TYPE_DIR;
  666. entry->d.elen = sizeof(entry->d) - 4;
  667. entry->d.alen = 0;
  668. entry->d.nlen = 0;
  669. entry->d.u.dir[0] = lfs->root[0];
  670. entry->d.u.dir[1] = lfs->root[1];
  671. while (true) {
  672. nextname:
  673. // skip slashes
  674. pathname += strspn(pathname, "/");
  675. pathlen = strcspn(pathname, "/");
  676. // skip '.' and root '..'
  677. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  678. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  679. pathname += pathlen;
  680. goto nextname;
  681. }
  682. // skip if matched by '..' in name
  683. const char *suffix = pathname + pathlen;
  684. size_t sufflen;
  685. int depth = 1;
  686. while (true) {
  687. suffix += strspn(suffix, "/");
  688. sufflen = strcspn(suffix, "/");
  689. if (sufflen == 0) {
  690. break;
  691. }
  692. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  693. depth -= 1;
  694. if (depth == 0) {
  695. pathname = suffix + sufflen;
  696. goto nextname;
  697. }
  698. } else {
  699. depth += 1;
  700. }
  701. suffix += sufflen;
  702. }
  703. // found path
  704. if (pathname[0] == '\0') {
  705. return 0;
  706. }
  707. // update what we've found
  708. *path = pathname;
  709. // continue on if we hit a directory
  710. if (entry->d.type != LFS_TYPE_DIR) {
  711. return LFS_ERR_NOTDIR;
  712. }
  713. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  714. if (err) {
  715. return err;
  716. }
  717. // find entry matching name
  718. while (true) {
  719. err = lfs_dir_next(lfs, dir, entry);
  720. if (err) {
  721. return err;
  722. }
  723. if (((0x7f & entry->d.type) != LFS_TYPE_REG &&
  724. (0x7f & entry->d.type) != LFS_TYPE_DIR) ||
  725. entry->d.nlen != pathlen) {
  726. continue;
  727. }
  728. int res = lfs_bd_cmp(lfs, dir->pair[0],
  729. entry->off + 4+entry->d.elen+entry->d.alen,
  730. pathname, pathlen);
  731. if (res < 0) {
  732. return res;
  733. }
  734. // found match
  735. if (res) {
  736. break;
  737. }
  738. }
  739. // check that entry has not been moved
  740. if (entry->d.type & 0x80) {
  741. int moved = lfs_moved(lfs, &entry->d.u);
  742. if (moved < 0 || moved) {
  743. return (moved < 0) ? moved : LFS_ERR_NOENT;
  744. }
  745. entry->d.type &= ~0x80;
  746. }
  747. // to next name
  748. pathname += pathlen;
  749. }
  750. }
  751. /// Top level directory operations ///
  752. int lfs_mkdir(lfs_t *lfs, const char *path) {
  753. // deorphan if we haven't yet, needed at most once after poweron
  754. if (!lfs->deorphaned) {
  755. int err = lfs_deorphan(lfs);
  756. if (err) {
  757. return err;
  758. }
  759. }
  760. // fetch parent directory
  761. lfs_dir_t cwd;
  762. lfs_entry_t entry;
  763. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  764. if (err != LFS_ERR_NOENT || strchr(path, '/') != NULL) {
  765. return err ? err : LFS_ERR_EXIST;
  766. }
  767. // build up new directory
  768. lfs_alloc_ack(lfs);
  769. lfs_dir_t dir;
  770. err = lfs_dir_alloc(lfs, &dir);
  771. if (err) {
  772. return err;
  773. }
  774. dir.d.tail[0] = cwd.d.tail[0];
  775. dir.d.tail[1] = cwd.d.tail[1];
  776. err = lfs_dir_commit(lfs, &dir, NULL, 0);
  777. if (err) {
  778. return err;
  779. }
  780. entry.d.type = LFS_TYPE_DIR;
  781. entry.d.elen = sizeof(entry.d) - 4;
  782. entry.d.alen = 0;
  783. entry.d.nlen = strlen(path);
  784. entry.d.u.dir[0] = dir.pair[0];
  785. entry.d.u.dir[1] = dir.pair[1];
  786. cwd.d.tail[0] = dir.pair[0];
  787. cwd.d.tail[1] = dir.pair[1];
  788. err = lfs_dir_append(lfs, &cwd, &entry, path);
  789. if (err) {
  790. return err;
  791. }
  792. lfs_alloc_ack(lfs);
  793. return 0;
  794. }
  795. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  796. dir->pair[0] = lfs->root[0];
  797. dir->pair[1] = lfs->root[1];
  798. lfs_entry_t entry;
  799. int err = lfs_dir_find(lfs, dir, &entry, &path);
  800. if (err) {
  801. return err;
  802. } else if (entry.d.type != LFS_TYPE_DIR) {
  803. return LFS_ERR_NOTDIR;
  804. }
  805. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  806. if (err) {
  807. return err;
  808. }
  809. // setup head dir
  810. // special offset for '.' and '..'
  811. dir->head[0] = dir->pair[0];
  812. dir->head[1] = dir->pair[1];
  813. dir->pos = sizeof(dir->d) - 2;
  814. dir->off = sizeof(dir->d);
  815. // add to list of directories
  816. dir->next = lfs->dirs;
  817. lfs->dirs = dir;
  818. return 0;
  819. }
  820. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  821. // remove from list of directories
  822. for (lfs_dir_t **p = &lfs->dirs; *p; p = &(*p)->next) {
  823. if (*p == dir) {
  824. *p = dir->next;
  825. break;
  826. }
  827. }
  828. return 0;
  829. }
  830. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  831. memset(info, 0, sizeof(*info));
  832. // special offset for '.' and '..'
  833. if (dir->pos == sizeof(dir->d) - 2) {
  834. info->type = LFS_TYPE_DIR;
  835. strcpy(info->name, ".");
  836. dir->pos += 1;
  837. return 1;
  838. } else if (dir->pos == sizeof(dir->d) - 1) {
  839. info->type = LFS_TYPE_DIR;
  840. strcpy(info->name, "..");
  841. dir->pos += 1;
  842. return 1;
  843. }
  844. lfs_entry_t entry;
  845. while (true) {
  846. int err = lfs_dir_next(lfs, dir, &entry);
  847. if (err) {
  848. return (err == LFS_ERR_NOENT) ? 0 : err;
  849. }
  850. if ((0x7f & entry.d.type) != LFS_TYPE_REG &&
  851. (0x7f & entry.d.type) != LFS_TYPE_DIR) {
  852. continue;
  853. }
  854. // check that entry has not been moved
  855. if (entry.d.type & 0x80) {
  856. int moved = lfs_moved(lfs, &entry.d.u);
  857. if (moved < 0) {
  858. return moved;
  859. }
  860. if (moved) {
  861. continue;
  862. }
  863. entry.d.type &= ~0x80;
  864. }
  865. break;
  866. }
  867. info->type = entry.d.type;
  868. if (info->type == LFS_TYPE_REG) {
  869. info->size = entry.d.u.file.size;
  870. }
  871. int err = lfs_bd_read(lfs, dir->pair[0],
  872. entry.off + 4+entry.d.elen+entry.d.alen,
  873. info->name, entry.d.nlen);
  874. if (err) {
  875. return err;
  876. }
  877. return 1;
  878. }
  879. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  880. // simply walk from head dir
  881. int err = lfs_dir_rewind(lfs, dir);
  882. if (err) {
  883. return err;
  884. }
  885. dir->pos = off;
  886. while (off > (0x7fffffff & dir->d.size)) {
  887. off -= 0x7fffffff & dir->d.size;
  888. if (!(0x80000000 & dir->d.size)) {
  889. return LFS_ERR_INVAL;
  890. }
  891. err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  892. if (err) {
  893. return err;
  894. }
  895. }
  896. dir->off = off;
  897. return 0;
  898. }
  899. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  900. (void)lfs;
  901. return dir->pos;
  902. }
  903. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  904. // reload the head dir
  905. int err = lfs_dir_fetch(lfs, dir, dir->head);
  906. if (err) {
  907. return err;
  908. }
  909. dir->pair[0] = dir->head[0];
  910. dir->pair[1] = dir->head[1];
  911. dir->pos = sizeof(dir->d) - 2;
  912. dir->off = sizeof(dir->d);
  913. return 0;
  914. }
  915. /// File index list operations ///
  916. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  917. lfs_off_t size = *off;
  918. lfs_off_t b = lfs->cfg->block_size - 2*4;
  919. lfs_off_t i = size / b;
  920. if (i == 0) {
  921. return 0;
  922. }
  923. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  924. *off = size - b*i - 4*lfs_popc(i);
  925. return i;
  926. }
  927. static int lfs_ctz_find(lfs_t *lfs,
  928. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  929. lfs_block_t head, lfs_size_t size,
  930. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  931. if (size == 0) {
  932. *block = 0xffffffff;
  933. *off = 0;
  934. return 0;
  935. }
  936. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  937. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  938. while (current > target) {
  939. lfs_size_t skip = lfs_min(
  940. lfs_npw2(current-target+1) - 1,
  941. lfs_ctz(current));
  942. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  943. head = lfs_fromle32(head);
  944. if (err) {
  945. return err;
  946. }
  947. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  948. current -= 1 << skip;
  949. }
  950. *block = head;
  951. *off = pos;
  952. return 0;
  953. }
  954. static int lfs_ctz_extend(lfs_t *lfs,
  955. lfs_cache_t *rcache, lfs_cache_t *pcache,
  956. lfs_block_t head, lfs_size_t size,
  957. lfs_block_t *block, lfs_off_t *off) {
  958. while (true) {
  959. // go ahead and grab a block
  960. lfs_block_t nblock;
  961. int err = lfs_alloc(lfs, &nblock);
  962. if (err) {
  963. return err;
  964. }
  965. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  966. if (true) {
  967. err = lfs_bd_erase(lfs, nblock);
  968. if (err) {
  969. if (err == LFS_ERR_CORRUPT) {
  970. goto relocate;
  971. }
  972. return err;
  973. }
  974. if (size == 0) {
  975. *block = nblock;
  976. *off = 0;
  977. return 0;
  978. }
  979. size -= 1;
  980. lfs_off_t index = lfs_ctz_index(lfs, &size);
  981. size += 1;
  982. // just copy out the last block if it is incomplete
  983. if (size != lfs->cfg->block_size) {
  984. for (lfs_off_t i = 0; i < size; i++) {
  985. uint8_t data;
  986. err = lfs_cache_read(lfs, rcache, NULL,
  987. head, i, &data, 1);
  988. if (err) {
  989. return err;
  990. }
  991. err = lfs_cache_prog(lfs, pcache, rcache,
  992. nblock, i, &data, 1);
  993. if (err) {
  994. if (err == LFS_ERR_CORRUPT) {
  995. goto relocate;
  996. }
  997. return err;
  998. }
  999. }
  1000. *block = nblock;
  1001. *off = size;
  1002. return 0;
  1003. }
  1004. // append block
  1005. index += 1;
  1006. lfs_size_t skips = lfs_ctz(index) + 1;
  1007. for (lfs_off_t i = 0; i < skips; i++) {
  1008. head = lfs_tole32(head);
  1009. err = lfs_cache_prog(lfs, pcache, rcache,
  1010. nblock, 4*i, &head, 4);
  1011. head = lfs_fromle32(head);
  1012. if (err) {
  1013. if (err == LFS_ERR_CORRUPT) {
  1014. goto relocate;
  1015. }
  1016. return err;
  1017. }
  1018. if (i != skips-1) {
  1019. err = lfs_cache_read(lfs, rcache, NULL,
  1020. head, 4*i, &head, 4);
  1021. head = lfs_fromle32(head);
  1022. if (err) {
  1023. return err;
  1024. }
  1025. }
  1026. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1027. }
  1028. *block = nblock;
  1029. *off = 4*skips;
  1030. return 0;
  1031. }
  1032. relocate:
  1033. LFS_DEBUG("Bad block at %" PRIu32, nblock);
  1034. // just clear cache and try a new block
  1035. lfs_cache_drop(lfs, &lfs->pcache);
  1036. }
  1037. }
  1038. static int lfs_ctz_traverse(lfs_t *lfs,
  1039. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1040. lfs_block_t head, lfs_size_t size,
  1041. int (*cb)(void*, lfs_block_t), void *data) {
  1042. if (size == 0) {
  1043. return 0;
  1044. }
  1045. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1046. while (true) {
  1047. int err = cb(data, head);
  1048. if (err) {
  1049. return err;
  1050. }
  1051. if (index == 0) {
  1052. return 0;
  1053. }
  1054. lfs_block_t heads[2];
  1055. int count = 2 - (index & 1);
  1056. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &heads, count*4);
  1057. heads[0] = lfs_fromle32(heads[0]);
  1058. heads[1] = lfs_fromle32(heads[1]);
  1059. if (err) {
  1060. return err;
  1061. }
  1062. for (int i = 0; i < count-1; i++) {
  1063. err = cb(data, heads[i]);
  1064. if (err) {
  1065. return err;
  1066. }
  1067. }
  1068. head = heads[count-1];
  1069. index -= count;
  1070. }
  1071. }
  1072. /// Top level file operations ///
  1073. int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
  1074. const char *path, int flags,
  1075. const struct lfs_file_config *cfg) {
  1076. // deorphan if we haven't yet, needed at most once after poweron
  1077. if ((flags & 3) != LFS_O_RDONLY && !lfs->deorphaned) {
  1078. int err = lfs_deorphan(lfs);
  1079. if (err) {
  1080. return err;
  1081. }
  1082. }
  1083. // allocate entry for file if it doesn't exist
  1084. lfs_dir_t cwd;
  1085. lfs_entry_t entry;
  1086. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1087. if (err && (err != LFS_ERR_NOENT || strchr(path, '/') != NULL)) {
  1088. return err;
  1089. }
  1090. if (err == LFS_ERR_NOENT) {
  1091. if (!(flags & LFS_O_CREAT)) {
  1092. return LFS_ERR_NOENT;
  1093. }
  1094. // create entry to remember name
  1095. entry.d.type = LFS_TYPE_REG;
  1096. entry.d.elen = sizeof(entry.d) - 4;
  1097. entry.d.alen = 0;
  1098. entry.d.nlen = strlen(path);
  1099. entry.d.u.file.head = 0xffffffff;
  1100. entry.d.u.file.size = 0;
  1101. err = lfs_dir_append(lfs, &cwd, &entry, path);
  1102. if (err) {
  1103. return err;
  1104. }
  1105. } else if (entry.d.type == LFS_TYPE_DIR) {
  1106. return LFS_ERR_ISDIR;
  1107. } else if (flags & LFS_O_EXCL) {
  1108. return LFS_ERR_EXIST;
  1109. }
  1110. // setup file struct
  1111. file->cfg = cfg;
  1112. file->pair[0] = cwd.pair[0];
  1113. file->pair[1] = cwd.pair[1];
  1114. file->poff = entry.off;
  1115. file->head = entry.d.u.file.head;
  1116. file->size = entry.d.u.file.size;
  1117. file->flags = flags;
  1118. file->pos = 0;
  1119. if (flags & LFS_O_TRUNC) {
  1120. if (file->size != 0) {
  1121. file->flags |= LFS_F_DIRTY;
  1122. }
  1123. file->head = 0xffffffff;
  1124. file->size = 0;
  1125. }
  1126. // allocate buffer if needed
  1127. file->cache.block = 0xffffffff;
  1128. if (file->cfg && file->cfg->buffer) {
  1129. file->cache.buffer = file->cfg->buffer;
  1130. } else if (lfs->cfg->file_buffer) {
  1131. if (lfs->files) {
  1132. // already in use
  1133. return LFS_ERR_NOMEM;
  1134. }
  1135. file->cache.buffer = lfs->cfg->file_buffer;
  1136. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  1137. file->cache.buffer = lfs_malloc(lfs->cfg->read_size);
  1138. if (!file->cache.buffer) {
  1139. return LFS_ERR_NOMEM;
  1140. }
  1141. } else {
  1142. file->cache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1143. if (!file->cache.buffer) {
  1144. return LFS_ERR_NOMEM;
  1145. }
  1146. }
  1147. // zero to avoid information leak
  1148. lfs_cache_zero(lfs, &file->cache);
  1149. // add to list of files
  1150. file->next = lfs->files;
  1151. lfs->files = file;
  1152. return 0;
  1153. }
  1154. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1155. const char *path, int flags) {
  1156. return lfs_file_opencfg(lfs, file, path, flags, NULL);
  1157. }
  1158. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1159. int err = lfs_file_sync(lfs, file);
  1160. // remove from list of files
  1161. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  1162. if (*p == file) {
  1163. *p = file->next;
  1164. break;
  1165. }
  1166. }
  1167. // clean up memory
  1168. if (!(file->cfg && file->cfg->buffer) && !lfs->cfg->file_buffer) {
  1169. lfs_free(file->cache.buffer);
  1170. }
  1171. return err;
  1172. }
  1173. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1174. relocate:
  1175. LFS_DEBUG("Bad block at %" PRIu32, file->block);
  1176. // just relocate what exists into new block
  1177. lfs_block_t nblock;
  1178. int err = lfs_alloc(lfs, &nblock);
  1179. if (err) {
  1180. return err;
  1181. }
  1182. err = lfs_bd_erase(lfs, nblock);
  1183. if (err) {
  1184. if (err == LFS_ERR_CORRUPT) {
  1185. goto relocate;
  1186. }
  1187. return err;
  1188. }
  1189. // either read from dirty cache or disk
  1190. for (lfs_off_t i = 0; i < file->off; i++) {
  1191. uint8_t data;
  1192. err = lfs_cache_read(lfs, &lfs->rcache, &file->cache,
  1193. file->block, i, &data, 1);
  1194. if (err) {
  1195. return err;
  1196. }
  1197. err = lfs_cache_prog(lfs, &lfs->pcache, &lfs->rcache,
  1198. nblock, i, &data, 1);
  1199. if (err) {
  1200. if (err == LFS_ERR_CORRUPT) {
  1201. goto relocate;
  1202. }
  1203. return err;
  1204. }
  1205. }
  1206. // copy over new state of file
  1207. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->prog_size);
  1208. file->cache.block = lfs->pcache.block;
  1209. file->cache.off = lfs->pcache.off;
  1210. lfs_cache_zero(lfs, &lfs->pcache);
  1211. file->block = nblock;
  1212. return 0;
  1213. }
  1214. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  1215. if (file->flags & LFS_F_READING) {
  1216. // just drop read cache
  1217. lfs_cache_drop(lfs, &file->cache);
  1218. file->flags &= ~LFS_F_READING;
  1219. }
  1220. if (file->flags & LFS_F_WRITING) {
  1221. lfs_off_t pos = file->pos;
  1222. // copy over anything after current branch
  1223. lfs_file_t orig = {
  1224. .head = file->head,
  1225. .size = file->size,
  1226. .flags = LFS_O_RDONLY,
  1227. .pos = file->pos,
  1228. .cache = lfs->rcache,
  1229. };
  1230. lfs_cache_drop(lfs, &lfs->rcache);
  1231. while (file->pos < file->size) {
  1232. // copy over a byte at a time, leave it up to caching
  1233. // to make this efficient
  1234. uint8_t data;
  1235. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  1236. if (res < 0) {
  1237. return res;
  1238. }
  1239. res = lfs_file_write(lfs, file, &data, 1);
  1240. if (res < 0) {
  1241. return res;
  1242. }
  1243. // keep our reference to the rcache in sync
  1244. if (lfs->rcache.block != 0xffffffff) {
  1245. lfs_cache_drop(lfs, &orig.cache);
  1246. lfs_cache_drop(lfs, &lfs->rcache);
  1247. }
  1248. }
  1249. // write out what we have
  1250. while (true) {
  1251. int err = lfs_cache_flush(lfs, &file->cache, &lfs->rcache);
  1252. if (err) {
  1253. if (err == LFS_ERR_CORRUPT) {
  1254. goto relocate;
  1255. }
  1256. return err;
  1257. }
  1258. break;
  1259. relocate:
  1260. err = lfs_file_relocate(lfs, file);
  1261. if (err) {
  1262. return err;
  1263. }
  1264. }
  1265. // actual file updates
  1266. file->head = file->block;
  1267. file->size = file->pos;
  1268. file->flags &= ~LFS_F_WRITING;
  1269. file->flags |= LFS_F_DIRTY;
  1270. file->pos = pos;
  1271. }
  1272. return 0;
  1273. }
  1274. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  1275. int err = lfs_file_flush(lfs, file);
  1276. if (err) {
  1277. return err;
  1278. }
  1279. if ((file->flags & LFS_F_DIRTY) &&
  1280. !(file->flags & LFS_F_ERRED) &&
  1281. !lfs_pairisnull(file->pair)) {
  1282. // update dir entry
  1283. lfs_dir_t cwd;
  1284. err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1285. if (err) {
  1286. return err;
  1287. }
  1288. lfs_entry_t entry = {.off = file->poff};
  1289. err = lfs_bd_read(lfs, cwd.pair[0], entry.off,
  1290. &entry.d, sizeof(entry.d));
  1291. lfs_entry_fromle32(&entry.d);
  1292. if (err) {
  1293. return err;
  1294. }
  1295. LFS_ASSERT(entry.d.type == LFS_TYPE_REG);
  1296. entry.d.u.file.head = file->head;
  1297. entry.d.u.file.size = file->size;
  1298. err = lfs_dir_update(lfs, &cwd, &entry, NULL);
  1299. if (err) {
  1300. return err;
  1301. }
  1302. file->flags &= ~LFS_F_DIRTY;
  1303. }
  1304. return 0;
  1305. }
  1306. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  1307. void *buffer, lfs_size_t size) {
  1308. uint8_t *data = buffer;
  1309. lfs_size_t nsize = size;
  1310. if ((file->flags & 3) == LFS_O_WRONLY) {
  1311. return LFS_ERR_BADF;
  1312. }
  1313. if (file->flags & LFS_F_WRITING) {
  1314. // flush out any writes
  1315. int err = lfs_file_flush(lfs, file);
  1316. if (err) {
  1317. return err;
  1318. }
  1319. }
  1320. if (file->pos >= file->size) {
  1321. // eof if past end
  1322. return 0;
  1323. }
  1324. size = lfs_min(size, file->size - file->pos);
  1325. nsize = size;
  1326. while (nsize > 0) {
  1327. // check if we need a new block
  1328. if (!(file->flags & LFS_F_READING) ||
  1329. file->off == lfs->cfg->block_size) {
  1330. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1331. file->head, file->size,
  1332. file->pos, &file->block, &file->off);
  1333. if (err) {
  1334. return err;
  1335. }
  1336. file->flags |= LFS_F_READING;
  1337. }
  1338. // read as much as we can in current block
  1339. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1340. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1341. file->block, file->off, data, diff);
  1342. if (err) {
  1343. return err;
  1344. }
  1345. file->pos += diff;
  1346. file->off += diff;
  1347. data += diff;
  1348. nsize -= diff;
  1349. }
  1350. return size;
  1351. }
  1352. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1353. const void *buffer, lfs_size_t size) {
  1354. const uint8_t *data = buffer;
  1355. lfs_size_t nsize = size;
  1356. if ((file->flags & 3) == LFS_O_RDONLY) {
  1357. return LFS_ERR_BADF;
  1358. }
  1359. if (file->flags & LFS_F_READING) {
  1360. // drop any reads
  1361. int err = lfs_file_flush(lfs, file);
  1362. if (err) {
  1363. return err;
  1364. }
  1365. }
  1366. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1367. file->pos = file->size;
  1368. }
  1369. if (!(file->flags & LFS_F_WRITING) && file->pos > file->size) {
  1370. // fill with zeros
  1371. lfs_off_t pos = file->pos;
  1372. file->pos = file->size;
  1373. while (file->pos < pos) {
  1374. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1375. if (res < 0) {
  1376. return res;
  1377. }
  1378. }
  1379. }
  1380. while (nsize > 0) {
  1381. // check if we need a new block
  1382. if (!(file->flags & LFS_F_WRITING) ||
  1383. file->off == lfs->cfg->block_size) {
  1384. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  1385. // find out which block we're extending from
  1386. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1387. file->head, file->size,
  1388. file->pos-1, &file->block, &file->off);
  1389. if (err) {
  1390. file->flags |= LFS_F_ERRED;
  1391. return err;
  1392. }
  1393. // mark cache as dirty since we may have read data into it
  1394. lfs_cache_zero(lfs, &file->cache);
  1395. }
  1396. // extend file with new blocks
  1397. lfs_alloc_ack(lfs);
  1398. int err = lfs_ctz_extend(lfs, &lfs->rcache, &file->cache,
  1399. file->block, file->pos,
  1400. &file->block, &file->off);
  1401. if (err) {
  1402. file->flags |= LFS_F_ERRED;
  1403. return err;
  1404. }
  1405. file->flags |= LFS_F_WRITING;
  1406. }
  1407. // program as much as we can in current block
  1408. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1409. while (true) {
  1410. int err = lfs_cache_prog(lfs, &file->cache, &lfs->rcache,
  1411. file->block, file->off, data, diff);
  1412. if (err) {
  1413. if (err == LFS_ERR_CORRUPT) {
  1414. goto relocate;
  1415. }
  1416. file->flags |= LFS_F_ERRED;
  1417. return err;
  1418. }
  1419. break;
  1420. relocate:
  1421. err = lfs_file_relocate(lfs, file);
  1422. if (err) {
  1423. file->flags |= LFS_F_ERRED;
  1424. return err;
  1425. }
  1426. }
  1427. file->pos += diff;
  1428. file->off += diff;
  1429. data += diff;
  1430. nsize -= diff;
  1431. lfs_alloc_ack(lfs);
  1432. }
  1433. file->flags &= ~LFS_F_ERRED;
  1434. return size;
  1435. }
  1436. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1437. lfs_soff_t off, int whence) {
  1438. // write out everything beforehand, may be noop if rdonly
  1439. int err = lfs_file_flush(lfs, file);
  1440. if (err) {
  1441. return err;
  1442. }
  1443. // update pos
  1444. if (whence == LFS_SEEK_SET) {
  1445. file->pos = off;
  1446. } else if (whence == LFS_SEEK_CUR) {
  1447. if (off < 0 && (lfs_off_t)-off > file->pos) {
  1448. return LFS_ERR_INVAL;
  1449. }
  1450. file->pos = file->pos + off;
  1451. } else if (whence == LFS_SEEK_END) {
  1452. if (off < 0 && (lfs_off_t)-off > file->size) {
  1453. return LFS_ERR_INVAL;
  1454. }
  1455. file->pos = file->size + off;
  1456. }
  1457. return file->pos;
  1458. }
  1459. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  1460. if ((file->flags & 3) == LFS_O_RDONLY) {
  1461. return LFS_ERR_BADF;
  1462. }
  1463. lfs_off_t oldsize = lfs_file_size(lfs, file);
  1464. if (size < oldsize) {
  1465. // need to flush since directly changing metadata
  1466. int err = lfs_file_flush(lfs, file);
  1467. if (err) {
  1468. return err;
  1469. }
  1470. // lookup new head in ctz skip list
  1471. err = lfs_ctz_find(lfs, &file->cache, NULL,
  1472. file->head, file->size,
  1473. size, &file->head, &(lfs_off_t){0});
  1474. if (err) {
  1475. return err;
  1476. }
  1477. file->size = size;
  1478. file->flags |= LFS_F_DIRTY;
  1479. } else if (size > oldsize) {
  1480. lfs_off_t pos = file->pos;
  1481. // flush+seek if not already at end
  1482. if (file->pos != oldsize) {
  1483. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  1484. if (err < 0) {
  1485. return err;
  1486. }
  1487. }
  1488. // fill with zeros
  1489. while (file->pos < size) {
  1490. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1491. if (res < 0) {
  1492. return res;
  1493. }
  1494. }
  1495. // restore pos
  1496. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  1497. if (err < 0) {
  1498. return err;
  1499. }
  1500. }
  1501. return 0;
  1502. }
  1503. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1504. (void)lfs;
  1505. return file->pos;
  1506. }
  1507. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1508. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1509. if (res < 0) {
  1510. return res;
  1511. }
  1512. return 0;
  1513. }
  1514. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1515. (void)lfs;
  1516. if (file->flags & LFS_F_WRITING) {
  1517. return lfs_max(file->pos, file->size);
  1518. } else {
  1519. return file->size;
  1520. }
  1521. }
  1522. /// General fs operations ///
  1523. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1524. lfs_dir_t cwd;
  1525. lfs_entry_t entry;
  1526. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1527. if (err) {
  1528. return err;
  1529. }
  1530. memset(info, 0, sizeof(*info));
  1531. info->type = entry.d.type;
  1532. if (info->type == LFS_TYPE_REG) {
  1533. info->size = entry.d.u.file.size;
  1534. }
  1535. if (lfs_paircmp(entry.d.u.dir, lfs->root) == 0) {
  1536. strcpy(info->name, "/");
  1537. } else {
  1538. err = lfs_bd_read(lfs, cwd.pair[0],
  1539. entry.off + 4+entry.d.elen+entry.d.alen,
  1540. info->name, entry.d.nlen);
  1541. if (err) {
  1542. return err;
  1543. }
  1544. }
  1545. return 0;
  1546. }
  1547. int lfs_remove(lfs_t *lfs, const char *path) {
  1548. // deorphan if we haven't yet, needed at most once after poweron
  1549. if (!lfs->deorphaned) {
  1550. int err = lfs_deorphan(lfs);
  1551. if (err) {
  1552. return err;
  1553. }
  1554. }
  1555. lfs_dir_t cwd;
  1556. lfs_entry_t entry;
  1557. int err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1558. if (err) {
  1559. return err;
  1560. }
  1561. lfs_dir_t dir;
  1562. if (entry.d.type == LFS_TYPE_DIR) {
  1563. // must be empty before removal, checking size
  1564. // without masking top bit checks for any case where
  1565. // dir is not empty
  1566. err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1567. if (err) {
  1568. return err;
  1569. } else if (dir.d.size != sizeof(dir.d)+4) {
  1570. return LFS_ERR_NOTEMPTY;
  1571. }
  1572. }
  1573. // remove the entry
  1574. err = lfs_dir_remove(lfs, &cwd, &entry);
  1575. if (err) {
  1576. return err;
  1577. }
  1578. // if we were a directory, find pred, replace tail
  1579. if (entry.d.type == LFS_TYPE_DIR) {
  1580. int res = lfs_pred(lfs, dir.pair, &cwd);
  1581. if (res < 0) {
  1582. return res;
  1583. }
  1584. LFS_ASSERT(res); // must have pred
  1585. cwd.d.tail[0] = dir.d.tail[0];
  1586. cwd.d.tail[1] = dir.d.tail[1];
  1587. err = lfs_dir_commit(lfs, &cwd, NULL, 0);
  1588. if (err) {
  1589. return err;
  1590. }
  1591. }
  1592. return 0;
  1593. }
  1594. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  1595. // deorphan if we haven't yet, needed at most once after poweron
  1596. if (!lfs->deorphaned) {
  1597. int err = lfs_deorphan(lfs);
  1598. if (err) {
  1599. return err;
  1600. }
  1601. }
  1602. // find old entry
  1603. lfs_dir_t oldcwd;
  1604. lfs_entry_t oldentry;
  1605. int err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1606. if (err) {
  1607. return err;
  1608. }
  1609. // allocate new entry
  1610. lfs_dir_t newcwd;
  1611. lfs_entry_t preventry;
  1612. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  1613. if (err && (err != LFS_ERR_NOENT || strchr(newpath, '/') != NULL)) {
  1614. return err;
  1615. }
  1616. bool prevexists = (err != LFS_ERR_NOENT);
  1617. bool samepair = (lfs_paircmp(oldcwd.pair, newcwd.pair) == 0);
  1618. // must have same type
  1619. if (prevexists && preventry.d.type != oldentry.d.type) {
  1620. return LFS_ERR_ISDIR;
  1621. }
  1622. lfs_dir_t dir;
  1623. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1624. // must be empty before removal, checking size
  1625. // without masking top bit checks for any case where
  1626. // dir is not empty
  1627. err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  1628. if (err) {
  1629. return err;
  1630. } else if (dir.d.size != sizeof(dir.d)+4) {
  1631. return LFS_ERR_NOTEMPTY;
  1632. }
  1633. }
  1634. // mark as moving
  1635. oldentry.d.type |= 0x80;
  1636. err = lfs_dir_update(lfs, &oldcwd, &oldentry, NULL);
  1637. if (err) {
  1638. return err;
  1639. }
  1640. // update pair if newcwd == oldcwd
  1641. if (samepair) {
  1642. newcwd = oldcwd;
  1643. }
  1644. // move to new location
  1645. lfs_entry_t newentry = preventry;
  1646. newentry.d = oldentry.d;
  1647. newentry.d.type &= ~0x80;
  1648. newentry.d.nlen = strlen(newpath);
  1649. if (prevexists) {
  1650. err = lfs_dir_update(lfs, &newcwd, &newentry, newpath);
  1651. if (err) {
  1652. return err;
  1653. }
  1654. } else {
  1655. err = lfs_dir_append(lfs, &newcwd, &newentry, newpath);
  1656. if (err) {
  1657. return err;
  1658. }
  1659. }
  1660. // update pair if newcwd == oldcwd
  1661. if (samepair) {
  1662. oldcwd = newcwd;
  1663. }
  1664. // remove old entry
  1665. err = lfs_dir_remove(lfs, &oldcwd, &oldentry);
  1666. if (err) {
  1667. return err;
  1668. }
  1669. // if we were a directory, find pred, replace tail
  1670. if (prevexists && preventry.d.type == LFS_TYPE_DIR) {
  1671. int res = lfs_pred(lfs, dir.pair, &newcwd);
  1672. if (res < 0) {
  1673. return res;
  1674. }
  1675. LFS_ASSERT(res); // must have pred
  1676. newcwd.d.tail[0] = dir.d.tail[0];
  1677. newcwd.d.tail[1] = dir.d.tail[1];
  1678. err = lfs_dir_commit(lfs, &newcwd, NULL, 0);
  1679. if (err) {
  1680. return err;
  1681. }
  1682. }
  1683. return 0;
  1684. }
  1685. /// Filesystem operations ///
  1686. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  1687. lfs->cfg = cfg;
  1688. // setup read cache
  1689. if (lfs->cfg->read_buffer) {
  1690. lfs->rcache.buffer = lfs->cfg->read_buffer;
  1691. } else {
  1692. lfs->rcache.buffer = lfs_malloc(lfs->cfg->read_size);
  1693. if (!lfs->rcache.buffer) {
  1694. return LFS_ERR_NOMEM;
  1695. }
  1696. }
  1697. // setup program cache
  1698. if (lfs->cfg->prog_buffer) {
  1699. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  1700. } else {
  1701. lfs->pcache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1702. if (!lfs->pcache.buffer) {
  1703. return LFS_ERR_NOMEM;
  1704. }
  1705. }
  1706. // zero to avoid information leaks
  1707. lfs_cache_zero(lfs, &lfs->rcache);
  1708. lfs_cache_zero(lfs, &lfs->pcache);
  1709. // setup lookahead, round down to nearest 32-bits
  1710. LFS_ASSERT(lfs->cfg->lookahead % 32 == 0);
  1711. LFS_ASSERT(lfs->cfg->lookahead > 0);
  1712. if (lfs->cfg->lookahead_buffer) {
  1713. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  1714. } else {
  1715. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead/8);
  1716. if (!lfs->free.buffer) {
  1717. return LFS_ERR_NOMEM;
  1718. }
  1719. }
  1720. // check that program and read sizes are multiples of the block size
  1721. LFS_ASSERT(lfs->cfg->prog_size % lfs->cfg->read_size == 0);
  1722. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->prog_size == 0);
  1723. // check that the block size is large enough to fit ctz pointers
  1724. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  1725. <= lfs->cfg->block_size);
  1726. // setup default state
  1727. lfs->root[0] = 0xffffffff;
  1728. lfs->root[1] = 0xffffffff;
  1729. lfs->files = NULL;
  1730. lfs->dirs = NULL;
  1731. lfs->deorphaned = false;
  1732. return 0;
  1733. }
  1734. static int lfs_deinit(lfs_t *lfs) {
  1735. // free allocated memory
  1736. if (!lfs->cfg->read_buffer) {
  1737. lfs_free(lfs->rcache.buffer);
  1738. }
  1739. if (!lfs->cfg->prog_buffer) {
  1740. lfs_free(lfs->pcache.buffer);
  1741. }
  1742. if (!lfs->cfg->lookahead_buffer) {
  1743. lfs_free(lfs->free.buffer);
  1744. }
  1745. return 0;
  1746. }
  1747. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  1748. int err = lfs_init(lfs, cfg);
  1749. if (err) {
  1750. return err;
  1751. }
  1752. // create free lookahead
  1753. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  1754. lfs->free.off = 0;
  1755. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->cfg->block_count);
  1756. lfs->free.i = 0;
  1757. lfs_alloc_ack(lfs);
  1758. // create superblock dir
  1759. lfs_dir_t superdir;
  1760. err = lfs_dir_alloc(lfs, &superdir);
  1761. if (err) {
  1762. return err;
  1763. }
  1764. // write root directory
  1765. lfs_dir_t root;
  1766. err = lfs_dir_alloc(lfs, &root);
  1767. if (err) {
  1768. return err;
  1769. }
  1770. err = lfs_dir_commit(lfs, &root, NULL, 0);
  1771. if (err) {
  1772. return err;
  1773. }
  1774. lfs->root[0] = root.pair[0];
  1775. lfs->root[1] = root.pair[1];
  1776. // write superblocks
  1777. lfs_superblock_t superblock = {
  1778. .off = sizeof(superdir.d),
  1779. .d.type = LFS_TYPE_SUPERBLOCK,
  1780. .d.elen = sizeof(superblock.d) - sizeof(superblock.d.magic) - 4,
  1781. .d.nlen = sizeof(superblock.d.magic),
  1782. .d.version = LFS_DISK_VERSION,
  1783. .d.magic = {"littlefs"},
  1784. .d.block_size = lfs->cfg->block_size,
  1785. .d.block_count = lfs->cfg->block_count,
  1786. .d.root = {lfs->root[0], lfs->root[1]},
  1787. };
  1788. superdir.d.tail[0] = root.pair[0];
  1789. superdir.d.tail[1] = root.pair[1];
  1790. superdir.d.size = sizeof(superdir.d) + sizeof(superblock.d) + 4;
  1791. // write both pairs to be safe
  1792. lfs_superblock_tole32(&superblock.d);
  1793. bool valid = false;
  1794. for (int i = 0; i < 2; i++) {
  1795. err = lfs_dir_commit(lfs, &superdir, (struct lfs_region[]){
  1796. {sizeof(superdir.d), sizeof(superblock.d),
  1797. &superblock.d, sizeof(superblock.d)}
  1798. }, 1);
  1799. if (err && err != LFS_ERR_CORRUPT) {
  1800. return err;
  1801. }
  1802. valid = valid || !err;
  1803. }
  1804. if (!valid) {
  1805. return LFS_ERR_CORRUPT;
  1806. }
  1807. // sanity check that fetch works
  1808. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  1809. if (err) {
  1810. return err;
  1811. }
  1812. lfs_alloc_ack(lfs);
  1813. return lfs_deinit(lfs);
  1814. }
  1815. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  1816. int err = lfs_init(lfs, cfg);
  1817. if (err) {
  1818. return err;
  1819. }
  1820. // setup free lookahead
  1821. lfs->free.off = 0;
  1822. lfs->free.size = 0;
  1823. lfs->free.i = 0;
  1824. lfs_alloc_ack(lfs);
  1825. // load superblock
  1826. lfs_dir_t dir;
  1827. lfs_superblock_t superblock;
  1828. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  1829. if (err && err != LFS_ERR_CORRUPT) {
  1830. return err;
  1831. }
  1832. if (!err) {
  1833. err = lfs_bd_read(lfs, dir.pair[0], sizeof(dir.d),
  1834. &superblock.d, sizeof(superblock.d));
  1835. lfs_superblock_fromle32(&superblock.d);
  1836. if (err) {
  1837. return err;
  1838. }
  1839. lfs->root[0] = superblock.d.root[0];
  1840. lfs->root[1] = superblock.d.root[1];
  1841. }
  1842. if (err || memcmp(superblock.d.magic, "littlefs", 8) != 0) {
  1843. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  1844. return LFS_ERR_CORRUPT;
  1845. }
  1846. uint16_t major_version = (0xffff & (superblock.d.version >> 16));
  1847. uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
  1848. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  1849. minor_version > LFS_DISK_VERSION_MINOR)) {
  1850. LFS_ERROR("Invalid version %d.%d", major_version, minor_version);
  1851. return LFS_ERR_INVAL;
  1852. }
  1853. return 0;
  1854. }
  1855. int lfs_unmount(lfs_t *lfs) {
  1856. return lfs_deinit(lfs);
  1857. }
  1858. /// Littlefs specific operations ///
  1859. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  1860. if (lfs_pairisnull(lfs->root)) {
  1861. return 0;
  1862. }
  1863. // iterate over metadata pairs
  1864. lfs_dir_t dir;
  1865. lfs_entry_t entry;
  1866. lfs_block_t cwd[2] = {0, 1};
  1867. while (true) {
  1868. for (int i = 0; i < 2; i++) {
  1869. int err = cb(data, cwd[i]);
  1870. if (err) {
  1871. return err;
  1872. }
  1873. }
  1874. int err = lfs_dir_fetch(lfs, &dir, cwd);
  1875. if (err) {
  1876. return err;
  1877. }
  1878. // iterate over contents
  1879. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  1880. err = lfs_bd_read(lfs, dir.pair[0], dir.off,
  1881. &entry.d, sizeof(entry.d));
  1882. lfs_entry_fromle32(&entry.d);
  1883. if (err) {
  1884. return err;
  1885. }
  1886. dir.off += lfs_entry_size(&entry);
  1887. if ((0x70 & entry.d.type) == (0x70 & LFS_TYPE_REG)) {
  1888. err = lfs_ctz_traverse(lfs, &lfs->rcache, NULL,
  1889. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  1890. if (err) {
  1891. return err;
  1892. }
  1893. }
  1894. }
  1895. cwd[0] = dir.d.tail[0];
  1896. cwd[1] = dir.d.tail[1];
  1897. if (lfs_pairisnull(cwd)) {
  1898. break;
  1899. }
  1900. }
  1901. // iterate over any open files
  1902. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  1903. if (f->flags & LFS_F_DIRTY) {
  1904. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  1905. f->head, f->size, cb, data);
  1906. if (err) {
  1907. return err;
  1908. }
  1909. }
  1910. if (f->flags & LFS_F_WRITING) {
  1911. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  1912. f->block, f->pos, cb, data);
  1913. if (err) {
  1914. return err;
  1915. }
  1916. }
  1917. }
  1918. return 0;
  1919. }
  1920. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir) {
  1921. if (lfs_pairisnull(lfs->root)) {
  1922. return 0;
  1923. }
  1924. // iterate over all directory directory entries
  1925. int err = lfs_dir_fetch(lfs, pdir, (const lfs_block_t[2]){0, 1});
  1926. if (err) {
  1927. return err;
  1928. }
  1929. while (!lfs_pairisnull(pdir->d.tail)) {
  1930. if (lfs_paircmp(pdir->d.tail, dir) == 0) {
  1931. return true;
  1932. }
  1933. err = lfs_dir_fetch(lfs, pdir, pdir->d.tail);
  1934. if (err) {
  1935. return err;
  1936. }
  1937. }
  1938. return false;
  1939. }
  1940. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  1941. lfs_dir_t *parent, lfs_entry_t *entry) {
  1942. if (lfs_pairisnull(lfs->root)) {
  1943. return 0;
  1944. }
  1945. parent->d.tail[0] = 0;
  1946. parent->d.tail[1] = 1;
  1947. // iterate over all directory directory entries
  1948. while (!lfs_pairisnull(parent->d.tail)) {
  1949. int err = lfs_dir_fetch(lfs, parent, parent->d.tail);
  1950. if (err) {
  1951. return err;
  1952. }
  1953. while (true) {
  1954. err = lfs_dir_next(lfs, parent, entry);
  1955. if (err && err != LFS_ERR_NOENT) {
  1956. return err;
  1957. }
  1958. if (err == LFS_ERR_NOENT) {
  1959. break;
  1960. }
  1961. if (((0x70 & entry->d.type) == (0x70 & LFS_TYPE_DIR)) &&
  1962. lfs_paircmp(entry->d.u.dir, dir) == 0) {
  1963. return true;
  1964. }
  1965. }
  1966. }
  1967. return false;
  1968. }
  1969. static int lfs_moved(lfs_t *lfs, const void *e) {
  1970. if (lfs_pairisnull(lfs->root)) {
  1971. return 0;
  1972. }
  1973. // skip superblock
  1974. lfs_dir_t cwd;
  1975. int err = lfs_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
  1976. if (err) {
  1977. return err;
  1978. }
  1979. // iterate over all directory directory entries
  1980. lfs_entry_t entry;
  1981. while (!lfs_pairisnull(cwd.d.tail)) {
  1982. err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  1983. if (err) {
  1984. return err;
  1985. }
  1986. while (true) {
  1987. err = lfs_dir_next(lfs, &cwd, &entry);
  1988. if (err && err != LFS_ERR_NOENT) {
  1989. return err;
  1990. }
  1991. if (err == LFS_ERR_NOENT) {
  1992. break;
  1993. }
  1994. if (!(0x80 & entry.d.type) &&
  1995. memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
  1996. return true;
  1997. }
  1998. }
  1999. }
  2000. return false;
  2001. }
  2002. static int lfs_relocate(lfs_t *lfs,
  2003. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]) {
  2004. // find parent
  2005. lfs_dir_t parent;
  2006. lfs_entry_t entry;
  2007. int res = lfs_parent(lfs, oldpair, &parent, &entry);
  2008. if (res < 0) {
  2009. return res;
  2010. }
  2011. if (res) {
  2012. // update disk, this creates a desync
  2013. entry.d.u.dir[0] = newpair[0];
  2014. entry.d.u.dir[1] = newpair[1];
  2015. int err = lfs_dir_update(lfs, &parent, &entry, NULL);
  2016. if (err) {
  2017. return err;
  2018. }
  2019. // update internal root
  2020. if (lfs_paircmp(oldpair, lfs->root) == 0) {
  2021. LFS_DEBUG("Relocating root %" PRIu32 " %" PRIu32,
  2022. newpair[0], newpair[1]);
  2023. lfs->root[0] = newpair[0];
  2024. lfs->root[1] = newpair[1];
  2025. }
  2026. // clean up bad block, which should now be a desync
  2027. return lfs_deorphan(lfs);
  2028. }
  2029. // find pred
  2030. res = lfs_pred(lfs, oldpair, &parent);
  2031. if (res < 0) {
  2032. return res;
  2033. }
  2034. if (res) {
  2035. // just replace bad pair, no desync can occur
  2036. parent.d.tail[0] = newpair[0];
  2037. parent.d.tail[1] = newpair[1];
  2038. return lfs_dir_commit(lfs, &parent, NULL, 0);
  2039. }
  2040. // couldn't find dir, must be new
  2041. return 0;
  2042. }
  2043. int lfs_deorphan(lfs_t *lfs) {
  2044. lfs->deorphaned = true;
  2045. if (lfs_pairisnull(lfs->root)) {
  2046. return 0;
  2047. }
  2048. lfs_dir_t pdir = {.d.size = 0x80000000};
  2049. lfs_dir_t cwd = {.d.tail[0] = 0, .d.tail[1] = 1};
  2050. // iterate over all directory directory entries
  2051. while (!lfs_pairisnull(cwd.d.tail)) {
  2052. int err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2053. if (err) {
  2054. return err;
  2055. }
  2056. // check head blocks for orphans
  2057. if (!(0x80000000 & pdir.d.size)) {
  2058. // check if we have a parent
  2059. lfs_dir_t parent;
  2060. lfs_entry_t entry;
  2061. int res = lfs_parent(lfs, pdir.d.tail, &parent, &entry);
  2062. if (res < 0) {
  2063. return res;
  2064. }
  2065. if (!res) {
  2066. // we are an orphan
  2067. LFS_DEBUG("Found orphan %" PRIu32 " %" PRIu32,
  2068. pdir.d.tail[0], pdir.d.tail[1]);
  2069. pdir.d.tail[0] = cwd.d.tail[0];
  2070. pdir.d.tail[1] = cwd.d.tail[1];
  2071. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2072. if (err) {
  2073. return err;
  2074. }
  2075. break;
  2076. }
  2077. if (!lfs_pairsync(entry.d.u.dir, pdir.d.tail)) {
  2078. // we have desynced
  2079. LFS_DEBUG("Found desync %" PRIu32 " %" PRIu32,
  2080. entry.d.u.dir[0], entry.d.u.dir[1]);
  2081. pdir.d.tail[0] = entry.d.u.dir[0];
  2082. pdir.d.tail[1] = entry.d.u.dir[1];
  2083. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2084. if (err) {
  2085. return err;
  2086. }
  2087. break;
  2088. }
  2089. }
  2090. // check entries for moves
  2091. lfs_entry_t entry;
  2092. while (true) {
  2093. err = lfs_dir_next(lfs, &cwd, &entry);
  2094. if (err && err != LFS_ERR_NOENT) {
  2095. return err;
  2096. }
  2097. if (err == LFS_ERR_NOENT) {
  2098. break;
  2099. }
  2100. // found moved entry
  2101. if (entry.d.type & 0x80) {
  2102. int moved = lfs_moved(lfs, &entry.d.u);
  2103. if (moved < 0) {
  2104. return moved;
  2105. }
  2106. if (moved) {
  2107. LFS_DEBUG("Found move %" PRIu32 " %" PRIu32,
  2108. entry.d.u.dir[0], entry.d.u.dir[1]);
  2109. err = lfs_dir_remove(lfs, &cwd, &entry);
  2110. if (err) {
  2111. return err;
  2112. }
  2113. } else {
  2114. LFS_DEBUG("Found partial move %" PRIu32 " %" PRIu32,
  2115. entry.d.u.dir[0], entry.d.u.dir[1]);
  2116. entry.d.type &= ~0x80;
  2117. err = lfs_dir_update(lfs, &cwd, &entry, NULL);
  2118. if (err) {
  2119. return err;
  2120. }
  2121. }
  2122. }
  2123. }
  2124. memcpy(&pdir, &cwd, sizeof(pdir));
  2125. }
  2126. return 0;
  2127. }