lfs.c 69 KB

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