lfs.c 69 KB

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