lfs.c 67 KB

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