lfs.c 68 KB

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