lfs.c 68 KB

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