lfs.c 67 KB

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