lfs.c 69 KB

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