lfs.c 67 KB

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