lfs.c 71 KB

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