lfs.c 68 KB

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