lfs.c 67 KB

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