lfs.c 67 KB

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