lfs.c 62 KB

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