lfs.c 65 KB

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