lfs.c 88 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202
  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 != 0xffffffff);
  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. LFS_ASSERT(block < lfs->cfg->block_count);
  63. rcache->block = block;
  64. rcache->off = off - (off % lfs->cfg->read_size);
  65. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  66. rcache->off, rcache->buffer, lfs->cfg->read_size);
  67. if (err) {
  68. return err;
  69. }
  70. }
  71. return 0;
  72. }
  73. static int lfs_cache_cmp(lfs_t *lfs, lfs_cache_t *rcache,
  74. const lfs_cache_t *pcache, lfs_block_t block,
  75. lfs_off_t off, const void *buffer, lfs_size_t size) {
  76. const uint8_t *data = buffer;
  77. for (lfs_off_t i = 0; i < size; i++) {
  78. uint8_t c;
  79. int err = lfs_cache_read(lfs, rcache, pcache,
  80. block, off+i, &c, 1);
  81. if (err) {
  82. return err;
  83. }
  84. if (c != data[i]) {
  85. return false;
  86. }
  87. }
  88. return true;
  89. }
  90. static int lfs_cache_crc(lfs_t *lfs, lfs_cache_t *rcache,
  91. const lfs_cache_t *pcache, lfs_block_t block,
  92. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  93. for (lfs_off_t i = 0; i < size; i++) {
  94. uint8_t c;
  95. int err = lfs_cache_read(lfs, rcache, pcache,
  96. block, off+i, &c, 1);
  97. if (err) {
  98. return err;
  99. }
  100. lfs_crc(crc, &c, 1);
  101. }
  102. return 0;
  103. }
  104. static int lfs_cache_flush(lfs_t *lfs,
  105. lfs_cache_t *pcache, lfs_cache_t *rcache) {
  106. if (pcache->block != 0xffffffff) {
  107. LFS_ASSERT(pcache->block < lfs->cfg->block_count);
  108. int err = lfs->cfg->prog(lfs->cfg, pcache->block,
  109. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  110. if (err) {
  111. return err;
  112. }
  113. if (rcache) {
  114. int res = lfs_cache_cmp(lfs, rcache, NULL, pcache->block,
  115. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  116. if (res < 0) {
  117. return res;
  118. }
  119. if (!res) {
  120. return LFS_ERR_CORRUPT;
  121. }
  122. }
  123. pcache->block = 0xffffffff;
  124. }
  125. return 0;
  126. }
  127. static int lfs_cache_prog(lfs_t *lfs, lfs_cache_t *pcache,
  128. lfs_cache_t *rcache, lfs_block_t block,
  129. lfs_off_t off, const void *buffer, lfs_size_t size) {
  130. const uint8_t *data = buffer;
  131. LFS_ASSERT(block != 0xffffffff);
  132. LFS_ASSERT(off + size <= lfs->cfg->block_size);
  133. while (size > 0) {
  134. if (block == pcache->block && off >= pcache->off &&
  135. off < pcache->off + lfs->cfg->prog_size) {
  136. // is already in pcache?
  137. lfs_size_t diff = lfs_min(size,
  138. lfs->cfg->prog_size - (off-pcache->off));
  139. memcpy(&pcache->buffer[off-pcache->off], data, diff);
  140. data += diff;
  141. off += diff;
  142. size -= diff;
  143. if (off % lfs->cfg->prog_size == 0) {
  144. // eagerly flush out pcache if we fill up
  145. int err = lfs_cache_flush(lfs, pcache, rcache);
  146. if (err) {
  147. return err;
  148. }
  149. }
  150. continue;
  151. }
  152. // pcache must have been flushed, either by programming and
  153. // entire block or manually flushing the pcache
  154. LFS_ASSERT(pcache->block == 0xffffffff);
  155. if (off % lfs->cfg->prog_size == 0 &&
  156. size >= lfs->cfg->prog_size) {
  157. // bypass pcache?
  158. LFS_ASSERT(block < lfs->cfg->block_count);
  159. lfs_size_t diff = size - (size % lfs->cfg->prog_size);
  160. int err = lfs->cfg->prog(lfs->cfg, block, off, data, diff);
  161. if (err) {
  162. return err;
  163. }
  164. if (rcache) {
  165. int res = lfs_cache_cmp(lfs, rcache, NULL,
  166. block, off, data, diff);
  167. if (res < 0) {
  168. return res;
  169. }
  170. if (!res) {
  171. return LFS_ERR_CORRUPT;
  172. }
  173. }
  174. data += diff;
  175. off += diff;
  176. size -= diff;
  177. continue;
  178. }
  179. // prepare pcache, first condition can no longer fail
  180. pcache->block = block;
  181. pcache->off = off - (off % lfs->cfg->prog_size);
  182. }
  183. return 0;
  184. }
  185. /// General lfs block device operations ///
  186. static int lfs_bd_read(lfs_t *lfs, lfs_block_t block,
  187. lfs_off_t off, void *buffer, lfs_size_t size) {
  188. // if we ever do more than writes to alternating pairs,
  189. // this may need to consider pcache
  190. return lfs_cache_read(lfs, &lfs->rcache, NULL,
  191. block, off, buffer, size);
  192. }
  193. static int lfs_bd_prog(lfs_t *lfs, lfs_block_t block,
  194. lfs_off_t off, const void *buffer, lfs_size_t size) {
  195. return lfs_cache_prog(lfs, &lfs->pcache, NULL,
  196. block, off, buffer, size);
  197. }
  198. static int lfs_bd_cmp(lfs_t *lfs, lfs_block_t block,
  199. lfs_off_t off, const void *buffer, lfs_size_t size) {
  200. return lfs_cache_cmp(lfs, &lfs->rcache, NULL, block, off, buffer, size);
  201. }
  202. static int lfs_bd_crc(lfs_t *lfs, lfs_block_t block,
  203. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  204. return lfs_cache_crc(lfs, &lfs->rcache, NULL, block, off, size, crc);
  205. }
  206. static int lfs_bd_erase(lfs_t *lfs, lfs_block_t block) {
  207. LFS_ASSERT(block < lfs->cfg->block_count);
  208. return lfs->cfg->erase(lfs->cfg, block);
  209. }
  210. static int lfs_bd_sync(lfs_t *lfs) {
  211. lfs->rcache.block = 0xffffffff;
  212. int err = lfs_cache_flush(lfs, &lfs->pcache, NULL);
  213. if (err) {
  214. return err;
  215. }
  216. return lfs->cfg->sync(lfs->cfg);
  217. }
  218. /// Internal operations predeclared here ///
  219. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data);
  220. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir);
  221. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  222. lfs_dir_t *parent, lfs_entry_t *entry);
  223. static int lfs_moved(lfs_t *lfs, const void *e);
  224. static int lfs_relocate(lfs_t *lfs,
  225. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]);
  226. int lfs_deorphan(lfs_t *lfs);
  227. /// Block allocator ///
  228. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  229. lfs_t *lfs = p;
  230. lfs_block_t off = ((block - lfs->free.off)
  231. + lfs->cfg->block_count) % lfs->cfg->block_count;
  232. if (off < lfs->free.size) {
  233. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  234. }
  235. return 0;
  236. }
  237. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  238. while (true) {
  239. while (lfs->free.i != lfs->free.size) {
  240. lfs_block_t off = lfs->free.i;
  241. lfs->free.i += 1;
  242. lfs->free.ack -= 1;
  243. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  244. // found a free block
  245. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  246. // eagerly find next off so an alloc ack can
  247. // discredit old lookahead blocks
  248. while (lfs->free.i != lfs->free.size &&
  249. (lfs->free.buffer[lfs->free.i / 32]
  250. & (1U << (lfs->free.i % 32)))) {
  251. lfs->free.i += 1;
  252. lfs->free.ack -= 1;
  253. }
  254. return 0;
  255. }
  256. }
  257. // check if we have looked at all blocks since last ack
  258. if (lfs->free.ack == 0) {
  259. LFS_WARN("No more free space %d", lfs->free.i + lfs->free.off);
  260. return LFS_ERR_NOSPC;
  261. }
  262. lfs->free.off = (lfs->free.off + lfs->free.size)
  263. % lfs->cfg->block_count;
  264. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->free.ack);
  265. lfs->free.i = 0;
  266. // find mask of free blocks from tree
  267. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  268. int err = lfs_traverse(lfs, lfs_alloc_lookahead, lfs);
  269. if (err) {
  270. return err;
  271. }
  272. }
  273. }
  274. static void lfs_alloc_ack(lfs_t *lfs) {
  275. lfs->free.ack = lfs->cfg->block_count;
  276. }
  277. /// Endian swapping functions ///
  278. static void lfs_dir_fromle32(struct lfs_disk_dir *d) {
  279. d->rev = lfs_fromle32(d->rev);
  280. d->size = lfs_fromle32(d->size);
  281. d->tail[0] = lfs_fromle32(d->tail[0]);
  282. d->tail[1] = lfs_fromle32(d->tail[1]);
  283. }
  284. static void lfs_dir_tole32(struct lfs_disk_dir *d) {
  285. d->rev = lfs_tole32(d->rev);
  286. d->size = lfs_tole32(d->size);
  287. d->tail[0] = lfs_tole32(d->tail[0]);
  288. d->tail[1] = lfs_tole32(d->tail[1]);
  289. }
  290. static void lfs_entry_fromle32(struct lfs_disk_entry *d) {
  291. d->u.dir[0] = lfs_fromle32(d->u.dir[0]);
  292. d->u.dir[1] = lfs_fromle32(d->u.dir[1]);
  293. }
  294. static void lfs_entry_tole32(struct lfs_disk_entry *d) {
  295. d->u.dir[0] = lfs_tole32(d->u.dir[0]);
  296. d->u.dir[1] = lfs_tole32(d->u.dir[1]);
  297. }
  298. static void lfs_superblock_fromle32(struct lfs_disk_superblock *d) {
  299. d->root[0] = lfs_fromle32(d->root[0]);
  300. d->root[1] = lfs_fromle32(d->root[1]);
  301. d->block_size = lfs_fromle32(d->block_size);
  302. d->block_count = lfs_fromle32(d->block_count);
  303. d->version = lfs_fromle32(d->version);
  304. d->inline_size = lfs_fromle32(d->inline_size);
  305. d->attrs_size = lfs_fromle32(d->attrs_size);
  306. d->name_size = lfs_fromle32(d->name_size);
  307. }
  308. static void lfs_superblock_tole32(struct lfs_disk_superblock *d) {
  309. d->root[0] = lfs_tole32(d->root[0]);
  310. d->root[1] = lfs_tole32(d->root[1]);
  311. d->block_size = lfs_tole32(d->block_size);
  312. d->block_count = lfs_tole32(d->block_count);
  313. d->version = lfs_tole32(d->version);
  314. d->inline_size = lfs_tole32(d->inline_size);
  315. d->attrs_size = lfs_tole32(d->attrs_size);
  316. d->name_size = lfs_tole32(d->name_size);
  317. }
  318. /// Other struct functions ///
  319. static inline lfs_size_t lfs_entry_elen(const lfs_entry_t *entry) {
  320. return (lfs_size_t)(entry->d.elen) |
  321. ((lfs_size_t)(entry->d.alen & 0xc0) << 2);
  322. }
  323. static inline lfs_size_t lfs_entry_alen(const lfs_entry_t *entry) {
  324. return entry->d.alen & 0x3f;
  325. }
  326. static inline lfs_size_t lfs_entry_nlen(const lfs_entry_t *entry) {
  327. return entry->d.nlen;
  328. }
  329. static inline lfs_size_t lfs_entry_size(const lfs_entry_t *entry) {
  330. return 4 + lfs_entry_elen(entry) +
  331. lfs_entry_alen(entry) +
  332. lfs_entry_nlen(entry);
  333. }
  334. /// Metadata pair and directory operations ///
  335. static inline void lfs_pairswap(lfs_block_t pair[2]) {
  336. lfs_block_t t = pair[0];
  337. pair[0] = pair[1];
  338. pair[1] = t;
  339. }
  340. static inline bool lfs_pairisnull(const lfs_block_t pair[2]) {
  341. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  342. }
  343. static inline int lfs_paircmp(
  344. const lfs_block_t paira[2],
  345. const lfs_block_t pairb[2]) {
  346. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  347. paira[0] == pairb[1] || paira[1] == pairb[0]);
  348. }
  349. static inline bool lfs_pairsync(
  350. const lfs_block_t paira[2],
  351. const lfs_block_t pairb[2]) {
  352. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  353. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  354. }
  355. static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {
  356. // allocate pair of dir blocks
  357. for (int i = 0; i < 2; i++) {
  358. int err = lfs_alloc(lfs, &dir->pair[i]);
  359. if (err) {
  360. return err;
  361. }
  362. }
  363. // rather than clobbering one of the blocks we just pretend
  364. // the revision may be valid
  365. int err = lfs_bd_read(lfs, dir->pair[0], 0, &dir->d.rev, 4);
  366. dir->d.rev = lfs_fromle32(dir->d.rev);
  367. if (err) {
  368. return err;
  369. }
  370. // set defaults
  371. dir->d.rev += 1;
  372. dir->d.size = sizeof(dir->d)+4;
  373. dir->d.tail[0] = 0xffffffff;
  374. dir->d.tail[1] = 0xffffffff;
  375. dir->off = sizeof(dir->d);
  376. // don't write out yet, let caller take care of that
  377. return 0;
  378. }
  379. static int lfs_dir_fetch(lfs_t *lfs,
  380. lfs_dir_t *dir, const lfs_block_t pair[2]) {
  381. // copy out pair, otherwise may be aliasing dir
  382. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  383. bool valid = false;
  384. // check both blocks for the most recent revision
  385. for (int i = 0; i < 2; i++) {
  386. struct lfs_disk_dir test;
  387. int err = lfs_bd_read(lfs, tpair[i], 0, &test, sizeof(test));
  388. lfs_dir_fromle32(&test);
  389. if (err) {
  390. return err;
  391. }
  392. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  393. continue;
  394. }
  395. if ((0x7fffffff & test.size) < sizeof(test)+4 ||
  396. (0x7fffffff & test.size) > lfs->cfg->block_size) {
  397. continue;
  398. }
  399. uint32_t crc = 0xffffffff;
  400. lfs_dir_tole32(&test);
  401. lfs_crc(&crc, &test, sizeof(test));
  402. lfs_dir_fromle32(&test);
  403. err = lfs_bd_crc(lfs, tpair[i], sizeof(test),
  404. (0x7fffffff & test.size) - sizeof(test), &crc);
  405. if (err) {
  406. return err;
  407. }
  408. if (crc != 0) {
  409. continue;
  410. }
  411. valid = true;
  412. // setup dir in case it's valid
  413. dir->pair[0] = tpair[(i+0) % 2];
  414. dir->pair[1] = tpair[(i+1) % 2];
  415. dir->off = sizeof(dir->d);
  416. dir->d = test;
  417. }
  418. if (!valid) {
  419. LFS_ERROR("Corrupted dir pair at %d %d", tpair[0], tpair[1]);
  420. return LFS_ERR_CORRUPT;
  421. }
  422. return 0;
  423. }
  424. struct lfs_region {
  425. enum {
  426. LFS_FROM_MEM,
  427. LFS_FROM_REGION,
  428. LFS_FROM_ATTRS,
  429. } type;
  430. lfs_off_t oldoff;
  431. lfs_size_t oldsize;
  432. const void *buffer;
  433. lfs_size_t newsize;
  434. };
  435. struct lfs_region_attrs {
  436. const struct lfs_attr *attrs;
  437. int count;
  438. };
  439. struct lfs_region_region {
  440. lfs_block_t block;
  441. lfs_off_t off;
  442. struct lfs_region *regions;
  443. int count;
  444. };
  445. static int lfs_commit_region(lfs_t *lfs, uint32_t *crc,
  446. lfs_block_t oldblock, lfs_off_t oldoff,
  447. lfs_block_t newblock, lfs_off_t newoff,
  448. lfs_off_t regionoff, lfs_size_t regionsize,
  449. const struct lfs_region *regions, int count) {
  450. int i = 0;
  451. lfs_size_t newend = newoff + regionsize;
  452. while (newoff < newend) {
  453. // commit from different types of regions
  454. if (i < count && regions[i].oldoff == oldoff - regionoff) {
  455. switch (regions[i].type) {
  456. case LFS_FROM_MEM: {
  457. lfs_crc(crc, regions[i].buffer, regions[i].newsize);
  458. int err = lfs_bd_prog(lfs, newblock, newoff,
  459. regions[i].buffer, regions[i].newsize);
  460. if (err) {
  461. return err;
  462. }
  463. newoff += regions[i].newsize;
  464. oldoff += regions[i].oldsize;
  465. break;
  466. }
  467. case LFS_FROM_REGION: {
  468. const struct lfs_region_region *disk = regions[i].buffer;
  469. int err = lfs_commit_region(lfs, crc,
  470. disk->block, disk->off,
  471. newblock, newoff,
  472. disk->off, regions[i].newsize,
  473. disk->regions, disk->count);
  474. if (err) {
  475. return err;
  476. }
  477. newoff += regions[i].newsize;
  478. oldoff -= regions[i].oldsize;
  479. break;
  480. }
  481. case LFS_FROM_ATTRS: {
  482. const struct lfs_region_attrs *attrs = regions[i].buffer;
  483. // order doesn't matter, so we write new attrs first. this
  484. // is still O(n^2) but only O(n) disk access
  485. for (int j = 0; j < attrs->count; j++) {
  486. if (attrs->attrs[j].size == 0) {
  487. continue;
  488. }
  489. lfs_entry_attr_t attr;
  490. attr.d.type = attrs->attrs[j].type;
  491. attr.d.len = attrs->attrs[j].size;
  492. lfs_crc(crc, &attr.d, sizeof(attr.d));
  493. int err = lfs_bd_prog(lfs, newblock, newoff,
  494. &attr.d, sizeof(attr.d));
  495. if (err) {
  496. return err;
  497. }
  498. lfs_crc(crc,
  499. attrs->attrs[j].buffer, attrs->attrs[j].size);
  500. err = lfs_bd_prog(lfs, newblock, newoff+sizeof(attr.d),
  501. attrs->attrs[j].buffer, attrs->attrs[j].size);
  502. if (err) {
  503. return err;
  504. }
  505. newoff += 2+attrs->attrs[j].size;
  506. }
  507. // copy over attributes without updates
  508. lfs_off_t oldend = oldoff + regions[i].oldsize;
  509. while (oldoff < oldend) {
  510. lfs_entry_attr_t attr;
  511. int err = lfs_bd_read(lfs, oldblock, oldoff,
  512. &attr.d, sizeof(attr.d));
  513. if (err) {
  514. return err;
  515. }
  516. bool updating = false;
  517. for (int j = 0; j < attrs->count; j++) {
  518. if (attr.d.type == attrs->attrs[j].type) {
  519. updating = true;
  520. }
  521. }
  522. if (!updating) {
  523. err = lfs_commit_region(lfs, crc,
  524. oldblock, oldoff,
  525. newblock, newoff,
  526. 0, 2+attr.d.len,
  527. NULL, 0);
  528. if (err) {
  529. return err;
  530. }
  531. newoff += 2+attr.d.len;
  532. }
  533. oldoff += 2+attr.d.len;
  534. }
  535. break;
  536. }
  537. }
  538. i += 1;
  539. } else {
  540. // copy data from old block if not covered by region
  541. uint8_t data;
  542. int err = lfs_bd_read(lfs, oldblock, oldoff, &data, 1);
  543. if (err) {
  544. return err;
  545. }
  546. lfs_crc(crc, &data, 1);
  547. err = lfs_bd_prog(lfs, newblock, newoff, &data, 1);
  548. if (err) {
  549. return err;
  550. }
  551. oldoff += 1;
  552. newoff += 1;
  553. }
  554. }
  555. // sanity check our commit math
  556. LFS_ASSERT(newoff == newend);
  557. return 0;
  558. }
  559. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  560. const struct lfs_region *regions, int count) {
  561. // state for copying over
  562. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  563. bool relocated = false;
  564. // increment revision count
  565. dir->d.rev += 1;
  566. // keep pairs in order such that pair[0] is most recent
  567. lfs_pairswap(dir->pair);
  568. for (int i = 0; i < count; i++) {
  569. dir->d.size += regions[i].newsize;
  570. dir->d.size -= regions[i].oldsize;
  571. }
  572. while (true) {
  573. if (true) {
  574. int err = lfs_bd_erase(lfs, dir->pair[0]);
  575. if (err) {
  576. if (err == LFS_ERR_CORRUPT) {
  577. goto relocate;
  578. }
  579. return err;
  580. }
  581. // commit header
  582. uint32_t crc = 0xffffffff;
  583. lfs_dir_tole32(&dir->d);
  584. lfs_crc(&crc, &dir->d, sizeof(dir->d));
  585. err = lfs_bd_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  586. lfs_dir_fromle32(&dir->d);
  587. if (err) {
  588. if (err == LFS_ERR_CORRUPT) {
  589. goto relocate;
  590. }
  591. return err;
  592. }
  593. // commit region
  594. err = lfs_commit_region(lfs, &crc,
  595. dir->pair[1], sizeof(dir->d),
  596. dir->pair[0], sizeof(dir->d),
  597. 0, (0x7fffffff & dir->d.size)-sizeof(dir->d)-4,
  598. regions, count);
  599. if (err) {
  600. if (err == LFS_ERR_CORRUPT) {
  601. goto relocate;
  602. }
  603. return err;
  604. }
  605. // commit crc
  606. crc = lfs_tole32(crc);
  607. err = lfs_bd_prog(lfs, dir->pair[0],
  608. (0x7fffffff & dir->d.size)-4, &crc, 4);
  609. crc = lfs_fromle32(crc);
  610. if (err) {
  611. if (err == LFS_ERR_CORRUPT) {
  612. goto relocate;
  613. }
  614. return err;
  615. }
  616. err = lfs_bd_sync(lfs);
  617. if (err) {
  618. if (err == LFS_ERR_CORRUPT) {
  619. goto relocate;
  620. }
  621. return err;
  622. }
  623. // successful commit, check checksum to make sure
  624. uint32_t ncrc = 0xffffffff;
  625. err = lfs_bd_crc(lfs, dir->pair[0], 0,
  626. (0x7fffffff & dir->d.size)-4, &ncrc);
  627. if (err) {
  628. return err;
  629. }
  630. if (ncrc != crc) {
  631. goto relocate;
  632. }
  633. }
  634. break;
  635. relocate:
  636. //commit was corrupted
  637. LFS_DEBUG("Bad block at %d", dir->pair[0]);
  638. // drop caches and prepare to relocate block
  639. relocated = true;
  640. lfs->pcache.block = 0xffffffff;
  641. // can't relocate superblock, filesystem is now frozen
  642. if (lfs_paircmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  643. LFS_WARN("Superblock %d has become unwritable", oldpair[0]);
  644. return LFS_ERR_CORRUPT;
  645. }
  646. // relocate half of pair
  647. int err = lfs_alloc(lfs, &dir->pair[0]);
  648. if (err) {
  649. return err;
  650. }
  651. }
  652. if (relocated) {
  653. // update references if we relocated
  654. LFS_DEBUG("Relocating %d %d to %d %d",
  655. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  656. int err = lfs_relocate(lfs, oldpair, dir->pair);
  657. if (err) {
  658. return err;
  659. }
  660. }
  661. // shift over any directories that are affected
  662. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  663. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  664. d->pair[0] = dir->pair[0];
  665. d->pair[1] = dir->pair[1];
  666. }
  667. }
  668. return 0;
  669. }
  670. static int lfs_dir_get(lfs_t *lfs, const lfs_dir_t *dir,
  671. lfs_off_t off, void *buffer, lfs_size_t size) {
  672. return lfs_bd_read(lfs, dir->pair[0], off, buffer, size);
  673. }
  674. static int lfs_dir_set(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry,
  675. struct lfs_region *regions, int count) {
  676. lfs_ssize_t diff = 0;
  677. for (int i = 0; i < count; i++) {
  678. diff += regions[i].newsize;
  679. diff -= regions[i].oldsize;
  680. }
  681. lfs_size_t oldsize = entry->size;
  682. if (entry->off == 0) {
  683. entry->off = (0x7fffffff & dir->d.size) - 4;
  684. }
  685. if ((0x7fffffff & dir->d.size) + diff > lfs->cfg->block_size) {
  686. lfs_dir_t olddir = *dir;
  687. lfs_off_t oldoff = entry->off;
  688. if (oldsize) {
  689. // mark as moving
  690. uint8_t type;
  691. int err = lfs_dir_get(lfs, &olddir, oldoff, &type, 1);
  692. if (err) {
  693. return err;
  694. }
  695. type |= LFS_STRUCT_MOVED;
  696. err = lfs_dir_commit(lfs, &olddir, (struct lfs_region[]){
  697. {LFS_FROM_MEM, oldoff, 1, &type, 1}}, 1);
  698. if (err) {
  699. return err;
  700. }
  701. }
  702. lfs_dir_t pdir = olddir;
  703. // find available block or create a new one
  704. while ((0x7fffffff & dir->d.size) + oldsize + diff
  705. > lfs->cfg->block_size) {
  706. // we need to allocate a new dir block
  707. if (!(0x80000000 & dir->d.size)) {
  708. pdir = *dir;
  709. int err = lfs_dir_alloc(lfs, dir);
  710. if (err) {
  711. return err;
  712. }
  713. dir->d.tail[0] = pdir.d.tail[0];
  714. dir->d.tail[1] = pdir.d.tail[1];
  715. break;
  716. }
  717. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  718. if (err) {
  719. return err;
  720. }
  721. }
  722. // writing out new entry
  723. entry->off = dir->d.size - 4;
  724. entry->size += diff;
  725. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  726. {LFS_FROM_REGION, entry->off, 0, &(struct lfs_region_region){
  727. olddir.pair[0], oldoff,
  728. regions, count}, entry->size}}, 1);
  729. if (err) {
  730. return err;
  731. }
  732. // update pred dir, unless pred == old we can coalesce
  733. if (!oldsize || lfs_paircmp(pdir.pair, olddir.pair) != 0) {
  734. pdir.d.size |= 0x80000000;
  735. pdir.d.tail[0] = dir->pair[0];
  736. pdir.d.tail[1] = dir->pair[1];
  737. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  738. if (err) {
  739. return err;
  740. }
  741. } else if (oldsize) {
  742. olddir.d.size |= 0x80000000;
  743. olddir.d.tail[0] = dir->pair[0];
  744. olddir.d.tail[1] = dir->pair[1];
  745. }
  746. // remove old entry
  747. if (oldsize) {
  748. lfs_entry_t oldentry;
  749. oldentry.off = oldoff;
  750. err = lfs_dir_set(lfs, &olddir, &oldentry, (struct lfs_region[]){
  751. {LFS_FROM_MEM, 0, oldsize, NULL, 0}}, 1);
  752. if (err) {
  753. return err;
  754. }
  755. }
  756. goto shift;
  757. }
  758. if ((0x7fffffff & dir->d.size) + diff == sizeof(dir->d)+4) {
  759. lfs_dir_t pdir;
  760. int res = lfs_pred(lfs, dir->pair, &pdir);
  761. if (res < 0) {
  762. return res;
  763. }
  764. if (pdir.d.size & 0x80000000) {
  765. pdir.d.size &= dir->d.size | 0x7fffffff;
  766. pdir.d.tail[0] = dir->d.tail[0];
  767. pdir.d.tail[1] = dir->d.tail[1];
  768. int err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  769. if (err) {
  770. return err;
  771. }
  772. goto shift;
  773. }
  774. }
  775. for (int i = 0; i < count; i++) {
  776. regions[i].oldoff += entry->off;
  777. }
  778. int err = lfs_dir_commit(lfs, dir, regions, count);
  779. if (err) {
  780. return err;
  781. }
  782. entry->size += diff;
  783. shift:
  784. // shift over any files/directories that are affected
  785. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  786. if (lfs_paircmp(f->pair, dir->pair) == 0) {
  787. if (f->pairoff == entry->off && entry->size == 0) {
  788. f->pair[0] = 0xffffffff;
  789. f->pair[1] = 0xffffffff;
  790. } else if (f->pairoff > entry->off) {
  791. f->pairoff += diff;
  792. }
  793. }
  794. }
  795. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  796. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  797. if (d->off > entry->off) {
  798. d->off += diff;
  799. d->pos += diff;
  800. }
  801. }
  802. }
  803. return 0;
  804. }
  805. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  806. while (dir->off >= (0x7fffffff & dir->d.size)-4) {
  807. if (!(0x80000000 & dir->d.size)) {
  808. entry->off = dir->off;
  809. return LFS_ERR_NOENT;
  810. }
  811. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  812. if (err) {
  813. return err;
  814. }
  815. dir->off = sizeof(dir->d);
  816. dir->pos += sizeof(dir->d) + 4;
  817. }
  818. int err = lfs_dir_get(lfs, dir, dir->off, &entry->d, sizeof(entry->d));
  819. lfs_entry_fromle32(&entry->d);
  820. if (err) {
  821. return err;
  822. }
  823. entry->off = dir->off;
  824. entry->size = lfs_entry_size(entry);
  825. dir->off += entry->size;
  826. dir->pos += entry->size;
  827. return 0;
  828. }
  829. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  830. lfs_entry_t *entry, const char **path) {
  831. const char *pathname = *path;
  832. lfs_size_t pathlen;
  833. while (true) {
  834. nextname:
  835. // skip slashes
  836. pathname += strspn(pathname, "/");
  837. pathlen = strcspn(pathname, "/");
  838. // special case for root dir
  839. if (pathname[0] == '\0') {
  840. *entry = (lfs_entry_t){
  841. .d.type = LFS_STRUCT_DIR | LFS_TYPE_DIR,
  842. .d.u.dir[0] = lfs->root[0],
  843. .d.u.dir[1] = lfs->root[1],
  844. };
  845. return 0;
  846. }
  847. // skip '.' and root '..'
  848. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  849. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  850. pathname += pathlen;
  851. goto nextname;
  852. }
  853. // skip if matched by '..' in name
  854. const char *suffix = pathname + pathlen;
  855. lfs_size_t sufflen;
  856. int depth = 1;
  857. while (true) {
  858. suffix += strspn(suffix, "/");
  859. sufflen = strcspn(suffix, "/");
  860. if (sufflen == 0) {
  861. break;
  862. }
  863. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  864. depth -= 1;
  865. if (depth == 0) {
  866. pathname = suffix + sufflen;
  867. goto nextname;
  868. }
  869. } else {
  870. depth += 1;
  871. }
  872. suffix += sufflen;
  873. }
  874. // update what we've found
  875. *path = pathname;
  876. // find path
  877. while (true) {
  878. int err = lfs_dir_next(lfs, dir, entry);
  879. if (err) {
  880. return err;
  881. }
  882. if (((0xf & entry->d.type) != LFS_TYPE_REG &&
  883. (0xf & entry->d.type) != LFS_TYPE_DIR) ||
  884. entry->d.nlen != pathlen) {
  885. continue;
  886. }
  887. int res = lfs_bd_cmp(lfs, dir->pair[0],
  888. entry->off + entry->size - pathlen,
  889. pathname, pathlen);
  890. if (res < 0) {
  891. return res;
  892. }
  893. // found match
  894. if (res) {
  895. break;
  896. }
  897. }
  898. // check that entry has not been moved
  899. if (entry->d.type & LFS_STRUCT_MOVED) {
  900. int moved = lfs_moved(lfs, &entry->d.u);
  901. if (moved < 0 || moved) {
  902. return (moved < 0) ? moved : LFS_ERR_NOENT;
  903. }
  904. entry->d.type &= ~LFS_STRUCT_MOVED;
  905. }
  906. pathname += pathlen;
  907. pathname += strspn(pathname, "/");
  908. if (pathname[0] == '\0') {
  909. return 0;
  910. }
  911. // continue on if we hit a directory
  912. if ((0xf & entry->d.type) != LFS_TYPE_DIR) {
  913. return LFS_ERR_NOTDIR;
  914. }
  915. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  916. if (err) {
  917. return err;
  918. }
  919. }
  920. }
  921. /// Internal attribute operations ///
  922. static int lfs_dir_getinfo(lfs_t *lfs,
  923. lfs_dir_t *dir, const lfs_entry_t *entry, struct lfs_info *info) {
  924. memset(info, 0, sizeof(*info));
  925. info->type = 0xf & entry->d.type;
  926. if (entry->d.type == (LFS_STRUCT_CTZ | LFS_TYPE_REG)) {
  927. info->size = entry->d.u.file.size;
  928. } else if (entry->d.type == (LFS_STRUCT_INLINE | LFS_TYPE_REG)) {
  929. info->size = lfs_entry_elen(entry);
  930. }
  931. if (lfs_paircmp(entry->d.u.dir, lfs->root) == 0) {
  932. strcpy(info->name, "/");
  933. } else {
  934. int err = lfs_dir_get(lfs, dir,
  935. entry->off + entry->size - entry->d.nlen,
  936. info->name, entry->d.nlen);
  937. if (err) {
  938. return err;
  939. }
  940. }
  941. return 0;
  942. }
  943. static int lfs_dir_getattrs(lfs_t *lfs,
  944. lfs_dir_t *dir, const lfs_entry_t *entry,
  945. const struct lfs_attr *attrs, int count) {
  946. // set to zero in case we can't find the attributes or size mismatch
  947. for (int j = 0; j < count; j++) {
  948. memset(attrs[j].buffer, 0, attrs[j].size);
  949. }
  950. // search for attribute in attribute region
  951. lfs_off_t off = entry->off + 4+lfs_entry_elen(entry);
  952. lfs_off_t end = off + lfs_entry_alen(entry);
  953. while (off < end) {
  954. lfs_entry_attr_t attr;
  955. int err = lfs_dir_get(lfs, dir, off, &attr.d, sizeof(attr.d));
  956. if (err) {
  957. return err;
  958. }
  959. for (int j = 0; j < count; j++) {
  960. if (attrs[j].type == attr.d.type) {
  961. if (attrs[j].size < attr.d.len) {
  962. return LFS_ERR_RANGE;
  963. }
  964. err = lfs_dir_get(lfs, dir, off+sizeof(attr.d),
  965. attrs[j].buffer, attr.d.len);
  966. if (err) {
  967. return err;
  968. }
  969. }
  970. }
  971. off += 2+attr.d.len;
  972. }
  973. return 0;
  974. }
  975. static lfs_ssize_t lfs_dir_checkattrs(lfs_t *lfs,
  976. lfs_dir_t *dir, lfs_entry_t *entry,
  977. const struct lfs_attr *attrs, int count) {
  978. // check that attributes fit
  979. // two separate passes so disk access is O(n)
  980. lfs_size_t nsize = 0;
  981. for (int j = 0; j < count; j++) {
  982. if (attrs[j].size > 0) {
  983. nsize += 2+attrs[j].size;
  984. }
  985. }
  986. lfs_off_t off = entry->off + 4+lfs_entry_elen(entry);
  987. lfs_off_t end = off + lfs_entry_alen(entry);
  988. while (off < end) {
  989. lfs_entry_attr_t attr;
  990. int err = lfs_dir_get(lfs, dir, off, &attr.d, sizeof(attr.d));
  991. if (err) {
  992. return err;
  993. }
  994. bool updated = false;
  995. for (int j = 0; j < count; j++) {
  996. if (attr.d.type == attrs[j].type) {
  997. updated = true;
  998. }
  999. }
  1000. if (!updated) {
  1001. nsize += 2+attr.d.len;
  1002. }
  1003. off += 2+attr.d.len;
  1004. }
  1005. if (nsize > lfs->attrs_size || (
  1006. lfs_entry_size(entry) - lfs_entry_alen(entry) + nsize
  1007. > lfs->cfg->block_size)) {
  1008. return LFS_ERR_NOSPC;
  1009. }
  1010. return nsize;
  1011. }
  1012. static int lfs_dir_setattrs(lfs_t *lfs,
  1013. lfs_dir_t *dir, lfs_entry_t *entry,
  1014. const struct lfs_attr *attrs, int count) {
  1015. // make sure attributes fit
  1016. lfs_size_t oldlen = lfs_entry_alen(entry);
  1017. lfs_ssize_t newlen = lfs_dir_checkattrs(lfs, dir, entry, attrs, count);
  1018. if (newlen < 0) {
  1019. return newlen;
  1020. }
  1021. // commit to entry, majority of work is in LFS_FROM_ATTRS
  1022. entry->d.alen = (0xc0 & entry->d.alen) | newlen;
  1023. return lfs_dir_set(lfs, dir, entry, (struct lfs_region[]){
  1024. {LFS_FROM_MEM, 0, 4, &entry->d, 4},
  1025. {LFS_FROM_ATTRS, 4+lfs_entry_elen(entry), oldlen,
  1026. &(struct lfs_region_attrs){attrs, count}, newlen}}, 2);
  1027. }
  1028. /// Top level directory operations ///
  1029. int lfs_mkdir(lfs_t *lfs, const char *path) {
  1030. // deorphan if we haven't yet, needed at most once after poweron
  1031. if (!lfs->deorphaned) {
  1032. int err = lfs_deorphan(lfs);
  1033. if (err) {
  1034. return err;
  1035. }
  1036. }
  1037. // fetch parent directory
  1038. lfs_dir_t cwd;
  1039. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1040. if (err) {
  1041. return err;
  1042. }
  1043. lfs_entry_t entry;
  1044. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1045. if (err != LFS_ERR_NOENT || strchr(path, '/') != NULL) {
  1046. return err ? err : LFS_ERR_EXIST;
  1047. }
  1048. // check that name fits
  1049. lfs_size_t nlen = strlen(path);
  1050. if (nlen > lfs->name_size) {
  1051. return LFS_ERR_NAMETOOLONG;
  1052. }
  1053. // build up new directory
  1054. lfs_alloc_ack(lfs);
  1055. lfs_dir_t dir;
  1056. err = lfs_dir_alloc(lfs, &dir);
  1057. if (err) {
  1058. return err;
  1059. }
  1060. dir.d.tail[0] = cwd.d.tail[0];
  1061. dir.d.tail[1] = cwd.d.tail[1];
  1062. err = lfs_dir_commit(lfs, &dir, NULL, 0);
  1063. if (err) {
  1064. return err;
  1065. }
  1066. entry.d.type = LFS_STRUCT_DIR | LFS_TYPE_DIR;
  1067. entry.d.elen = sizeof(entry.d) - 4;
  1068. entry.d.alen = 0;
  1069. entry.d.nlen = nlen;
  1070. entry.d.u.dir[0] = dir.pair[0];
  1071. entry.d.u.dir[1] = dir.pair[1];
  1072. entry.size = 0;
  1073. cwd.d.tail[0] = dir.pair[0];
  1074. cwd.d.tail[1] = dir.pair[1];
  1075. lfs_entry_tole32(&entry.d);
  1076. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1077. {LFS_FROM_MEM, 0, 0, &entry.d, sizeof(entry.d)},
  1078. {LFS_FROM_MEM, 0, 0, path, nlen}}, 2);
  1079. if (err) {
  1080. return err;
  1081. }
  1082. lfs_alloc_ack(lfs);
  1083. return 0;
  1084. }
  1085. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1086. dir->pair[0] = lfs->root[0];
  1087. dir->pair[1] = lfs->root[1];
  1088. int err = lfs_dir_fetch(lfs, dir, dir->pair);
  1089. if (err) {
  1090. return err;
  1091. }
  1092. lfs_entry_t entry;
  1093. err = lfs_dir_find(lfs, dir, &entry, &path);
  1094. if (err) {
  1095. return err;
  1096. } else if (entry.d.type != (LFS_STRUCT_DIR | LFS_TYPE_DIR)) {
  1097. return LFS_ERR_NOTDIR;
  1098. }
  1099. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  1100. if (err) {
  1101. return err;
  1102. }
  1103. // setup head dir
  1104. // special offset for '.' and '..'
  1105. dir->head[0] = dir->pair[0];
  1106. dir->head[1] = dir->pair[1];
  1107. dir->pos = sizeof(dir->d) - 2;
  1108. dir->off = sizeof(dir->d);
  1109. // add to list of directories
  1110. dir->next = lfs->dirs;
  1111. lfs->dirs = dir;
  1112. return 0;
  1113. }
  1114. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1115. // remove from list of directories
  1116. for (lfs_dir_t **p = &lfs->dirs; *p; p = &(*p)->next) {
  1117. if (*p == dir) {
  1118. *p = dir->next;
  1119. break;
  1120. }
  1121. }
  1122. return 0;
  1123. }
  1124. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1125. memset(info, 0, sizeof(*info));
  1126. // special offset for '.' and '..'
  1127. if (dir->pos == sizeof(dir->d) - 2) {
  1128. info->type = LFS_TYPE_DIR;
  1129. strcpy(info->name, ".");
  1130. dir->pos += 1;
  1131. return 1;
  1132. } else if (dir->pos == sizeof(dir->d) - 1) {
  1133. info->type = LFS_TYPE_DIR;
  1134. strcpy(info->name, "..");
  1135. dir->pos += 1;
  1136. return 1;
  1137. }
  1138. lfs_entry_t entry;
  1139. while (true) {
  1140. int err = lfs_dir_next(lfs, dir, &entry);
  1141. if (err) {
  1142. return (err == LFS_ERR_NOENT) ? 0 : err;
  1143. }
  1144. if ((0xf & entry.d.type) != LFS_TYPE_REG &&
  1145. (0xf & entry.d.type) != LFS_TYPE_DIR) {
  1146. continue;
  1147. }
  1148. // check that entry has not been moved
  1149. if (entry.d.type & LFS_STRUCT_MOVED) {
  1150. int moved = lfs_moved(lfs, &entry.d.u);
  1151. if (moved < 0) {
  1152. return moved;
  1153. }
  1154. if (moved) {
  1155. continue;
  1156. }
  1157. entry.d.type &= ~LFS_STRUCT_MOVED;
  1158. }
  1159. break;
  1160. }
  1161. int err = lfs_dir_getinfo(lfs, dir, &entry, info);
  1162. if (err) {
  1163. return err;
  1164. }
  1165. return 1;
  1166. }
  1167. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1168. // simply walk from head dir
  1169. int err = lfs_dir_rewind(lfs, dir);
  1170. if (err) {
  1171. return err;
  1172. }
  1173. dir->pos = off;
  1174. while (off > (0x7fffffff & dir->d.size)) {
  1175. off -= 0x7fffffff & dir->d.size;
  1176. if (!(0x80000000 & dir->d.size)) {
  1177. return LFS_ERR_INVAL;
  1178. }
  1179. err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  1180. if (err) {
  1181. return err;
  1182. }
  1183. }
  1184. dir->off = off;
  1185. return 0;
  1186. }
  1187. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1188. (void)lfs;
  1189. return dir->pos;
  1190. }
  1191. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1192. // reload the head dir
  1193. int err = lfs_dir_fetch(lfs, dir, dir->head);
  1194. if (err) {
  1195. return err;
  1196. }
  1197. dir->pair[0] = dir->head[0];
  1198. dir->pair[1] = dir->head[1];
  1199. dir->pos = sizeof(dir->d) - 2;
  1200. dir->off = sizeof(dir->d);
  1201. return 0;
  1202. }
  1203. /// File index list operations ///
  1204. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1205. lfs_off_t size = *off;
  1206. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1207. lfs_off_t i = size / b;
  1208. if (i == 0) {
  1209. return 0;
  1210. }
  1211. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1212. *off = size - b*i - 4*lfs_popc(i);
  1213. return i;
  1214. }
  1215. static int lfs_ctz_find(lfs_t *lfs,
  1216. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1217. lfs_block_t head, lfs_size_t size,
  1218. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1219. if (size == 0) {
  1220. *block = 0xffffffff;
  1221. *off = 0;
  1222. return 0;
  1223. }
  1224. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1225. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1226. while (current > target) {
  1227. lfs_size_t skip = lfs_min(
  1228. lfs_npw2(current-target+1) - 1,
  1229. lfs_ctz(current));
  1230. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  1231. head = lfs_fromle32(head);
  1232. if (err) {
  1233. return err;
  1234. }
  1235. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1236. current -= 1 << skip;
  1237. }
  1238. *block = head;
  1239. *off = pos;
  1240. return 0;
  1241. }
  1242. static int lfs_ctz_extend(lfs_t *lfs,
  1243. lfs_cache_t *rcache, lfs_cache_t *pcache,
  1244. lfs_block_t head, lfs_size_t size,
  1245. lfs_block_t *block, lfs_off_t *off) {
  1246. while (true) {
  1247. // go ahead and grab a block
  1248. lfs_block_t nblock;
  1249. int err = lfs_alloc(lfs, &nblock);
  1250. if (err) {
  1251. return err;
  1252. }
  1253. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1254. if (true) {
  1255. err = lfs_bd_erase(lfs, nblock);
  1256. if (err) {
  1257. if (err == LFS_ERR_CORRUPT) {
  1258. goto relocate;
  1259. }
  1260. return err;
  1261. }
  1262. if (size == 0) {
  1263. *block = nblock;
  1264. *off = 0;
  1265. return 0;
  1266. }
  1267. size -= 1;
  1268. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1269. size += 1;
  1270. // just copy out the last block if it is incomplete
  1271. if (size != lfs->cfg->block_size) {
  1272. for (lfs_off_t i = 0; i < size; i++) {
  1273. uint8_t data;
  1274. err = lfs_cache_read(lfs, rcache, NULL,
  1275. head, i, &data, 1);
  1276. if (err) {
  1277. return err;
  1278. }
  1279. err = lfs_cache_prog(lfs, pcache, rcache,
  1280. nblock, i, &data, 1);
  1281. if (err) {
  1282. if (err == LFS_ERR_CORRUPT) {
  1283. goto relocate;
  1284. }
  1285. return err;
  1286. }
  1287. }
  1288. *block = nblock;
  1289. *off = size;
  1290. return 0;
  1291. }
  1292. // append block
  1293. index += 1;
  1294. lfs_size_t skips = lfs_ctz(index) + 1;
  1295. for (lfs_off_t i = 0; i < skips; i++) {
  1296. head = lfs_tole32(head);
  1297. err = lfs_cache_prog(lfs, pcache, rcache,
  1298. nblock, 4*i, &head, 4);
  1299. head = lfs_fromle32(head);
  1300. if (err) {
  1301. if (err == LFS_ERR_CORRUPT) {
  1302. goto relocate;
  1303. }
  1304. return err;
  1305. }
  1306. if (i != skips-1) {
  1307. err = lfs_cache_read(lfs, rcache, NULL,
  1308. head, 4*i, &head, 4);
  1309. head = lfs_fromle32(head);
  1310. if (err) {
  1311. return err;
  1312. }
  1313. }
  1314. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1315. }
  1316. *block = nblock;
  1317. *off = 4*skips;
  1318. return 0;
  1319. }
  1320. relocate:
  1321. LFS_DEBUG("Bad block at %d", nblock);
  1322. // just clear cache and try a new block
  1323. pcache->block = 0xffffffff;
  1324. }
  1325. }
  1326. static int lfs_ctz_traverse(lfs_t *lfs,
  1327. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1328. lfs_block_t head, lfs_size_t size,
  1329. int (*cb)(void*, lfs_block_t), void *data) {
  1330. if (size == 0) {
  1331. return 0;
  1332. }
  1333. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1334. while (true) {
  1335. int err = cb(data, head);
  1336. if (err) {
  1337. return err;
  1338. }
  1339. if (index == 0) {
  1340. return 0;
  1341. }
  1342. lfs_block_t heads[2];
  1343. int count = 2 - (index & 1);
  1344. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &heads, count*4);
  1345. heads[0] = lfs_fromle32(heads[0]);
  1346. heads[1] = lfs_fromle32(heads[1]);
  1347. if (err) {
  1348. return err;
  1349. }
  1350. for (int i = 0; i < count-1; i++) {
  1351. err = cb(data, heads[i]);
  1352. if (err) {
  1353. return err;
  1354. }
  1355. }
  1356. head = heads[count-1];
  1357. index -= count;
  1358. }
  1359. }
  1360. /// Top level file operations ///
  1361. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1362. const char *path, int flags) {
  1363. // deorphan if we haven't yet, needed at most once after poweron
  1364. if ((flags & 3) != LFS_O_RDONLY && !lfs->deorphaned) {
  1365. int err = lfs_deorphan(lfs);
  1366. if (err) {
  1367. return err;
  1368. }
  1369. }
  1370. // allocate entry for file if it doesn't exist
  1371. lfs_dir_t cwd;
  1372. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1373. if (err) {
  1374. return err;
  1375. }
  1376. lfs_entry_t entry;
  1377. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1378. if (err && (err != LFS_ERR_NOENT || strchr(path, '/') != NULL)) {
  1379. return err;
  1380. }
  1381. if (err == LFS_ERR_NOENT) {
  1382. if (!(flags & LFS_O_CREAT)) {
  1383. return LFS_ERR_NOENT;
  1384. }
  1385. // check that name fits
  1386. lfs_size_t nlen = strlen(path);
  1387. if (nlen > lfs->name_size) {
  1388. return LFS_ERR_NAMETOOLONG;
  1389. }
  1390. // create entry to remember name
  1391. entry.d.type = LFS_STRUCT_INLINE | LFS_TYPE_REG;
  1392. entry.d.elen = 0;
  1393. entry.d.alen = 0;
  1394. entry.d.nlen = nlen;
  1395. entry.size = 0;
  1396. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1397. {LFS_FROM_MEM, 0, 0, &entry.d, 4},
  1398. {LFS_FROM_MEM, 0, 0, path, nlen}}, 2);
  1399. if (err) {
  1400. return err;
  1401. }
  1402. } else if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1403. return LFS_ERR_ISDIR;
  1404. } else if (flags & LFS_O_EXCL) {
  1405. return LFS_ERR_EXIST;
  1406. }
  1407. // allocate buffer if needed
  1408. file->cache.block = 0xffffffff;
  1409. if (lfs->cfg->file_buffer) {
  1410. file->cache.buffer = lfs->cfg->file_buffer;
  1411. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  1412. file->cache.buffer = lfs_malloc(lfs->cfg->read_size);
  1413. if (!file->cache.buffer) {
  1414. return LFS_ERR_NOMEM;
  1415. }
  1416. } else {
  1417. file->cache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1418. if (!file->cache.buffer) {
  1419. return LFS_ERR_NOMEM;
  1420. }
  1421. }
  1422. // setup file struct
  1423. file->pair[0] = cwd.pair[0];
  1424. file->pair[1] = cwd.pair[1];
  1425. file->pairoff = entry.off;
  1426. file->flags = flags;
  1427. file->pos = 0;
  1428. // calculate max inline size based on the size of the entry
  1429. file->inline_size = lfs_min(lfs->inline_size,
  1430. lfs->cfg->block_size - (sizeof(cwd.d)+4) -
  1431. (lfs_entry_size(&entry) - lfs_entry_elen(&entry)));
  1432. if ((0x70 & entry.d.type) == LFS_STRUCT_INLINE) {
  1433. // load inline files
  1434. file->head = 0xfffffffe;
  1435. file->size = lfs_entry_elen(&entry);
  1436. file->flags |= LFS_F_INLINE;
  1437. file->cache.block = file->head;
  1438. file->cache.off = 0;
  1439. err = lfs_dir_get(lfs, &cwd,
  1440. entry.off + 4,
  1441. file->cache.buffer, file->size);
  1442. if (err) {
  1443. lfs_free(file->cache.buffer);
  1444. return err;
  1445. }
  1446. } else {
  1447. // use ctz list from entry
  1448. file->head = entry.d.u.file.head;
  1449. file->size = entry.d.u.file.size;
  1450. }
  1451. // truncate if requested
  1452. if (flags & LFS_O_TRUNC) {
  1453. if (file->size != 0) {
  1454. file->flags |= LFS_F_DIRTY;
  1455. }
  1456. file->head = 0xfffffffe;
  1457. file->size = 0;
  1458. file->flags |= LFS_F_INLINE;
  1459. file->cache.block = file->head;
  1460. file->cache.off = 0;
  1461. }
  1462. // add to list of files
  1463. file->next = lfs->files;
  1464. lfs->files = file;
  1465. return 0;
  1466. }
  1467. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1468. int err = lfs_file_sync(lfs, file);
  1469. // remove from list of files
  1470. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  1471. if (*p == file) {
  1472. *p = file->next;
  1473. break;
  1474. }
  1475. }
  1476. // clean up memory
  1477. if (!lfs->cfg->file_buffer) {
  1478. lfs_free(file->cache.buffer);
  1479. }
  1480. return err;
  1481. }
  1482. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1483. relocate:;
  1484. // just relocate what exists into new block
  1485. lfs_block_t nblock;
  1486. int err = lfs_alloc(lfs, &nblock);
  1487. if (err) {
  1488. return err;
  1489. }
  1490. err = lfs_bd_erase(lfs, nblock);
  1491. if (err) {
  1492. if (err == LFS_ERR_CORRUPT) {
  1493. goto relocate;
  1494. }
  1495. return err;
  1496. }
  1497. // either read from dirty cache or disk
  1498. for (lfs_off_t i = 0; i < file->off; i++) {
  1499. uint8_t data;
  1500. err = lfs_cache_read(lfs, &lfs->rcache, &file->cache,
  1501. file->block, i, &data, 1);
  1502. if (err) {
  1503. return err;
  1504. }
  1505. err = lfs_cache_prog(lfs, &lfs->pcache, &lfs->rcache,
  1506. nblock, i, &data, 1);
  1507. if (err) {
  1508. if (err == LFS_ERR_CORRUPT) {
  1509. goto relocate;
  1510. }
  1511. return err;
  1512. }
  1513. }
  1514. // copy over new state of file
  1515. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->prog_size);
  1516. file->cache.block = lfs->pcache.block;
  1517. file->cache.off = lfs->pcache.off;
  1518. lfs->pcache.block = 0xffffffff;
  1519. file->block = nblock;
  1520. return 0;
  1521. }
  1522. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  1523. if (file->flags & LFS_F_READING) {
  1524. file->flags &= ~LFS_F_READING;
  1525. }
  1526. if (file->flags & LFS_F_WRITING) {
  1527. lfs_off_t pos = file->pos;
  1528. if (!(file->flags & LFS_F_INLINE)) {
  1529. // copy over anything after current branch
  1530. lfs_file_t orig = {
  1531. .head = file->head,
  1532. .size = file->size,
  1533. .flags = LFS_O_RDONLY,
  1534. .pos = file->pos,
  1535. .cache = lfs->rcache,
  1536. };
  1537. lfs->rcache.block = 0xffffffff;
  1538. while (file->pos < file->size) {
  1539. // copy over a byte at a time, leave it up to caching
  1540. // to make this efficient
  1541. uint8_t data;
  1542. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  1543. if (res < 0) {
  1544. return res;
  1545. }
  1546. res = lfs_file_write(lfs, file, &data, 1);
  1547. if (res < 0) {
  1548. return res;
  1549. }
  1550. // keep our reference to the rcache in sync
  1551. if (lfs->rcache.block != 0xffffffff) {
  1552. orig.cache.block = 0xffffffff;
  1553. lfs->rcache.block = 0xffffffff;
  1554. }
  1555. }
  1556. // write out what we have
  1557. while (true) {
  1558. int err = lfs_cache_flush(lfs, &file->cache, &lfs->rcache);
  1559. if (err) {
  1560. if (err == LFS_ERR_CORRUPT) {
  1561. goto relocate;
  1562. }
  1563. return err;
  1564. }
  1565. break;
  1566. relocate:
  1567. LFS_DEBUG("Bad block at %d", file->block);
  1568. err = lfs_file_relocate(lfs, file);
  1569. if (err) {
  1570. return err;
  1571. }
  1572. }
  1573. } else {
  1574. file->size = lfs_max(file->pos, file->size);
  1575. }
  1576. // actual file updates
  1577. file->head = file->block;
  1578. file->size = file->pos;
  1579. file->flags &= ~LFS_F_WRITING;
  1580. file->flags |= LFS_F_DIRTY;
  1581. file->pos = pos;
  1582. }
  1583. return 0;
  1584. }
  1585. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  1586. int err = lfs_file_flush(lfs, file);
  1587. if (err) {
  1588. return err;
  1589. }
  1590. if ((file->flags & LFS_F_DIRTY) &&
  1591. !(file->flags & LFS_F_ERRED) &&
  1592. !lfs_pairisnull(file->pair)) {
  1593. // update dir entry
  1594. lfs_dir_t cwd;
  1595. err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1596. if (err) {
  1597. return err;
  1598. }
  1599. lfs_entry_t entry = {.off = file->pairoff};
  1600. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, 4);
  1601. if (err) {
  1602. return err;
  1603. }
  1604. entry.size = lfs_entry_size(&entry);
  1605. LFS_ASSERT((0xf & entry.d.type) == LFS_TYPE_REG);
  1606. lfs_size_t oldelen = lfs_entry_elen(&entry);
  1607. lfs_size_t oldalen = lfs_entry_alen(&entry);
  1608. const void *buffer;
  1609. lfs_size_t size;
  1610. // either update the references or inline the whole file
  1611. if (!(file->flags & LFS_F_INLINE)) {
  1612. entry.d.type = LFS_STRUCT_CTZ | LFS_TYPE_REG;
  1613. entry.d.u.file.head = file->head;
  1614. entry.d.u.file.size = file->size;
  1615. lfs_entry_tole32(&entry.d);
  1616. buffer = (const uint8_t *)&entry.d + 4;
  1617. size = sizeof(entry.d) - 4;
  1618. } else {
  1619. entry.d.type = LFS_STRUCT_INLINE | LFS_TYPE_REG;
  1620. buffer = file->cache.buffer;
  1621. size = file->size;
  1622. }
  1623. // get new alen from disk
  1624. lfs_ssize_t newalen = lfs_dir_checkattrs(lfs, &cwd, &entry,
  1625. file->attrs, file->attrcount);
  1626. if (newalen < 0) {
  1627. return newalen;
  1628. }
  1629. entry.d.elen = size & 0xff;
  1630. entry.d.alen = (newalen & 0x3f) | ((size >> 2) & 0xc0);
  1631. // write out update
  1632. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1633. {LFS_FROM_MEM, 0, 4, &entry.d, 4},
  1634. {LFS_FROM_MEM, 4, oldelen, buffer, size},
  1635. {LFS_FROM_ATTRS, 4+oldelen, oldalen,
  1636. &(struct lfs_region_attrs){file->attrs, file->attrcount},
  1637. newalen}}, 3);
  1638. if (err) {
  1639. return err;
  1640. }
  1641. file->flags &= ~LFS_F_DIRTY;
  1642. }
  1643. return 0;
  1644. }
  1645. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  1646. void *buffer, lfs_size_t size) {
  1647. uint8_t *data = buffer;
  1648. lfs_size_t nsize = size;
  1649. if ((file->flags & 3) == LFS_O_WRONLY) {
  1650. return LFS_ERR_BADF;
  1651. }
  1652. if (file->flags & LFS_F_WRITING) {
  1653. // flush out any writes
  1654. int err = lfs_file_flush(lfs, file);
  1655. if (err) {
  1656. return err;
  1657. }
  1658. }
  1659. if (file->pos >= file->size) {
  1660. // eof if past end
  1661. return 0;
  1662. }
  1663. size = lfs_min(size, file->size - file->pos);
  1664. nsize = size;
  1665. while (nsize > 0) {
  1666. // check if we need a new block
  1667. if (!(file->flags & LFS_F_READING) ||
  1668. file->off == lfs->cfg->block_size) {
  1669. if (!(file->flags & LFS_F_INLINE)) {
  1670. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1671. file->head, file->size,
  1672. file->pos, &file->block, &file->off);
  1673. if (err) {
  1674. return err;
  1675. }
  1676. } else {
  1677. file->block = 0xfffffffe;
  1678. file->off = file->pos;
  1679. }
  1680. file->flags |= LFS_F_READING;
  1681. }
  1682. // read as much as we can in current block
  1683. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1684. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1685. file->block, file->off, data, diff);
  1686. if (err) {
  1687. return err;
  1688. }
  1689. file->pos += diff;
  1690. file->off += diff;
  1691. data += diff;
  1692. nsize -= diff;
  1693. }
  1694. return size;
  1695. }
  1696. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1697. const void *buffer, lfs_size_t size) {
  1698. const uint8_t *data = buffer;
  1699. lfs_size_t nsize = size;
  1700. if ((file->flags & 3) == LFS_O_RDONLY) {
  1701. return LFS_ERR_BADF;
  1702. }
  1703. if (file->flags & LFS_F_READING) {
  1704. // drop any reads
  1705. int err = lfs_file_flush(lfs, file);
  1706. if (err) {
  1707. return err;
  1708. }
  1709. }
  1710. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1711. file->pos = file->size;
  1712. }
  1713. if (!(file->flags & LFS_F_WRITING) && file->pos > file->size) {
  1714. // fill with zeros
  1715. lfs_off_t pos = file->pos;
  1716. file->pos = file->size;
  1717. while (file->pos < pos) {
  1718. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1719. if (res < 0) {
  1720. return res;
  1721. }
  1722. }
  1723. }
  1724. if ((file->flags & LFS_F_INLINE) &&
  1725. file->pos + nsize >= file->inline_size) {
  1726. // inline file doesn't fit anymore
  1727. file->block = 0xfffffffe;
  1728. file->off = file->pos;
  1729. lfs_alloc_ack(lfs);
  1730. int err = lfs_file_relocate(lfs, file);
  1731. if (err) {
  1732. file->flags |= LFS_F_ERRED;
  1733. return err;
  1734. }
  1735. file->flags &= ~LFS_F_INLINE;
  1736. file->flags |= LFS_F_WRITING;
  1737. }
  1738. while (nsize > 0) {
  1739. // check if we need a new block
  1740. if (!(file->flags & LFS_F_WRITING) ||
  1741. file->off == lfs->cfg->block_size) {
  1742. if (!(file->flags & LFS_F_INLINE)) {
  1743. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  1744. // find out which block we're extending from
  1745. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1746. file->head, file->size,
  1747. file->pos-1, &file->block, &file->off);
  1748. if (err) {
  1749. file->flags |= LFS_F_ERRED;
  1750. return err;
  1751. }
  1752. // mark cache as dirty since we may have read data into it
  1753. file->cache.block = 0xffffffff;
  1754. }
  1755. // extend file with new blocks
  1756. lfs_alloc_ack(lfs);
  1757. int err = lfs_ctz_extend(lfs, &lfs->rcache, &file->cache,
  1758. file->block, file->pos,
  1759. &file->block, &file->off);
  1760. if (err) {
  1761. file->flags |= LFS_F_ERRED;
  1762. return err;
  1763. }
  1764. } else {
  1765. file->block = 0xfffffffe;
  1766. file->off = file->pos;
  1767. }
  1768. file->flags |= LFS_F_WRITING;
  1769. }
  1770. // program as much as we can in current block
  1771. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1772. while (true) {
  1773. int err = lfs_cache_prog(lfs, &file->cache, &lfs->rcache,
  1774. file->block, file->off, data, diff);
  1775. if (err) {
  1776. if (err == LFS_ERR_CORRUPT) {
  1777. goto relocate;
  1778. }
  1779. file->flags |= LFS_F_ERRED;
  1780. return err;
  1781. }
  1782. break;
  1783. relocate:
  1784. err = lfs_file_relocate(lfs, file);
  1785. if (err) {
  1786. file->flags |= LFS_F_ERRED;
  1787. return err;
  1788. }
  1789. }
  1790. file->pos += diff;
  1791. file->off += diff;
  1792. data += diff;
  1793. nsize -= diff;
  1794. lfs_alloc_ack(lfs);
  1795. }
  1796. file->flags &= ~LFS_F_ERRED;
  1797. return size;
  1798. }
  1799. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1800. lfs_soff_t off, int whence) {
  1801. // write out everything beforehand, may be noop if rdonly
  1802. int err = lfs_file_flush(lfs, file);
  1803. if (err) {
  1804. return err;
  1805. }
  1806. // update pos
  1807. if (whence == LFS_SEEK_SET) {
  1808. file->pos = off;
  1809. } else if (whence == LFS_SEEK_CUR) {
  1810. if (off < 0 && (lfs_off_t)-off > file->pos) {
  1811. return LFS_ERR_INVAL;
  1812. }
  1813. file->pos = file->pos + off;
  1814. } else if (whence == LFS_SEEK_END) {
  1815. if (off < 0 && (lfs_off_t)-off > file->size) {
  1816. return LFS_ERR_INVAL;
  1817. }
  1818. file->pos = file->size + off;
  1819. }
  1820. return file->pos;
  1821. }
  1822. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  1823. if ((file->flags & 3) == LFS_O_RDONLY) {
  1824. return LFS_ERR_BADF;
  1825. }
  1826. lfs_off_t oldsize = lfs_file_size(lfs, file);
  1827. if (size < oldsize) {
  1828. // need to flush since directly changing metadata
  1829. int err = lfs_file_flush(lfs, file);
  1830. if (err) {
  1831. return err;
  1832. }
  1833. // lookup new head in ctz skip list
  1834. err = lfs_ctz_find(lfs, &file->cache, NULL,
  1835. file->head, file->size,
  1836. size, &file->head, &(lfs_off_t){0});
  1837. if (err) {
  1838. return err;
  1839. }
  1840. file->size = size;
  1841. file->flags |= LFS_F_DIRTY;
  1842. } else if (size > oldsize) {
  1843. lfs_off_t pos = file->pos;
  1844. // flush+seek if not already at end
  1845. if (file->pos != oldsize) {
  1846. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  1847. if (err < 0) {
  1848. return err;
  1849. }
  1850. }
  1851. // fill with zeros
  1852. while (file->pos < size) {
  1853. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1854. if (res < 0) {
  1855. return res;
  1856. }
  1857. }
  1858. // restore pos
  1859. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  1860. if (err < 0) {
  1861. return err;
  1862. }
  1863. }
  1864. return 0;
  1865. }
  1866. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1867. (void)lfs;
  1868. return file->pos;
  1869. }
  1870. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1871. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1872. if (res < 0) {
  1873. return res;
  1874. }
  1875. return 0;
  1876. }
  1877. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1878. (void)lfs;
  1879. if (file->flags & LFS_F_WRITING) {
  1880. return lfs_max(file->pos, file->size);
  1881. } else {
  1882. return file->size;
  1883. }
  1884. }
  1885. int lfs_file_getattrs(lfs_t *lfs, lfs_file_t *file,
  1886. const struct lfs_attr *attrs, int count) {
  1887. // set to null in case we can't find the attrs (missing file?)
  1888. for (int j = 0; j < count; j++) {
  1889. memset(attrs[j].buffer, 0, attrs[j].size);
  1890. }
  1891. // load from disk if we haven't already been deleted
  1892. if (!lfs_pairisnull(file->pair)) {
  1893. lfs_dir_t cwd;
  1894. int err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1895. if (err) {
  1896. return err;
  1897. }
  1898. lfs_entry_t entry = {.off = file->pairoff};
  1899. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, 4);
  1900. if (err) {
  1901. return err;
  1902. }
  1903. entry.size = lfs_entry_size(&entry);
  1904. err = lfs_dir_getattrs(lfs, &cwd, &entry, attrs, count);
  1905. if (err) {
  1906. return err;
  1907. }
  1908. }
  1909. // override an attrs we have stored locally
  1910. for (int i = 0; i < file->attrcount; i++) {
  1911. for (int j = 0; j < count; j++) {
  1912. if (attrs[j].type == file->attrs[i].type) {
  1913. if (attrs[j].size < file->attrs[i].size) {
  1914. return LFS_ERR_RANGE;
  1915. }
  1916. memcpy(attrs[j].buffer,
  1917. file->attrs[i].buffer, file->attrs[i].size);
  1918. }
  1919. }
  1920. }
  1921. return 0;
  1922. }
  1923. int lfs_file_setattrs(lfs_t *lfs, lfs_file_t *file,
  1924. const struct lfs_attr *attrs, int count) {
  1925. // just tack to the file, will be written at sync time
  1926. file->attrs = attrs;
  1927. file->attrcount = count;
  1928. // at least make sure attributes fit
  1929. if (!lfs_pairisnull(file->pair)) {
  1930. lfs_dir_t cwd;
  1931. int err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1932. if (err) {
  1933. return err;
  1934. }
  1935. lfs_entry_t entry = {.off = file->pairoff};
  1936. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, 4);
  1937. if (err) {
  1938. return err;
  1939. }
  1940. entry.size = lfs_entry_size(&entry);
  1941. lfs_ssize_t res = lfs_dir_checkattrs(lfs, &cwd, &entry, attrs, count);
  1942. if (res < 0) {
  1943. return res;
  1944. }
  1945. }
  1946. return 0;
  1947. }
  1948. /// General fs operations ///
  1949. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1950. lfs_dir_t cwd;
  1951. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1952. if (err) {
  1953. return err;
  1954. }
  1955. lfs_entry_t entry;
  1956. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1957. if (err) {
  1958. return err;
  1959. }
  1960. return lfs_dir_getinfo(lfs, &cwd, &entry, info);
  1961. }
  1962. int lfs_remove(lfs_t *lfs, const char *path) {
  1963. // deorphan if we haven't yet, needed at most once after poweron
  1964. if (!lfs->deorphaned) {
  1965. int err = lfs_deorphan(lfs);
  1966. if (err) {
  1967. return err;
  1968. }
  1969. }
  1970. lfs_dir_t cwd;
  1971. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1972. if (err) {
  1973. return err;
  1974. }
  1975. lfs_entry_t entry;
  1976. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1977. if (err) {
  1978. return err;
  1979. }
  1980. lfs_dir_t dir;
  1981. if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1982. // must be empty before removal, checking size
  1983. // without masking top bit checks for any case where
  1984. // dir is not empty
  1985. err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1986. if (err) {
  1987. return err;
  1988. } else if (dir.d.size != sizeof(dir.d)+4) {
  1989. return LFS_ERR_NOTEMPTY;
  1990. }
  1991. }
  1992. // remove the entry
  1993. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1994. {LFS_FROM_MEM, 0, entry.size, NULL, 0}}, 1);
  1995. if (err) {
  1996. return err;
  1997. }
  1998. // if we were a directory, find pred, replace tail
  1999. if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  2000. int res = lfs_pred(lfs, dir.pair, &cwd);
  2001. if (res < 0) {
  2002. return res;
  2003. }
  2004. LFS_ASSERT(res); // must have pred
  2005. cwd.d.tail[0] = dir.d.tail[0];
  2006. cwd.d.tail[1] = dir.d.tail[1];
  2007. err = lfs_dir_commit(lfs, &cwd, NULL, 0);
  2008. if (err) {
  2009. return err;
  2010. }
  2011. }
  2012. return 0;
  2013. }
  2014. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  2015. // deorphan if we haven't yet, needed at most once after poweron
  2016. if (!lfs->deorphaned) {
  2017. int err = lfs_deorphan(lfs);
  2018. if (err) {
  2019. return err;
  2020. }
  2021. }
  2022. // find old entry
  2023. lfs_dir_t oldcwd;
  2024. int err = lfs_dir_fetch(lfs, &oldcwd, lfs->root);
  2025. if (err) {
  2026. return err;
  2027. }
  2028. lfs_entry_t oldentry;
  2029. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  2030. if (err) {
  2031. return err;
  2032. }
  2033. // allocate new entry
  2034. lfs_dir_t newcwd;
  2035. err = lfs_dir_fetch(lfs, &newcwd, lfs->root);
  2036. if (err) {
  2037. return err;
  2038. }
  2039. lfs_entry_t preventry;
  2040. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  2041. if (err && (err != LFS_ERR_NOENT || strchr(newpath, '/') != NULL)) {
  2042. return err;
  2043. }
  2044. bool prevexists = (err != LFS_ERR_NOENT);
  2045. bool samepair = (lfs_paircmp(oldcwd.pair, newcwd.pair) == 0);
  2046. // check that name fits
  2047. lfs_size_t nlen = strlen(newpath);
  2048. if (nlen > lfs->name_size) {
  2049. return LFS_ERR_NAMETOOLONG;
  2050. }
  2051. // must have same type
  2052. if (prevexists && preventry.d.type != oldentry.d.type) {
  2053. return LFS_ERR_ISDIR;
  2054. }
  2055. lfs_dir_t dir;
  2056. if (prevexists && (0xf & preventry.d.type) == LFS_TYPE_DIR) {
  2057. // must be empty before removal, checking size
  2058. // without masking top bit checks for any case where
  2059. // dir is not empty
  2060. err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  2061. if (err) {
  2062. return err;
  2063. } else if (dir.d.size != sizeof(dir.d)+4) {
  2064. return LFS_ERR_NOTEMPTY;
  2065. }
  2066. }
  2067. // mark as moving
  2068. oldentry.d.type |= LFS_STRUCT_MOVED;
  2069. err = lfs_dir_set(lfs, &oldcwd, &oldentry, (struct lfs_region[]){
  2070. {LFS_FROM_MEM, 0, 1, &oldentry.d.type, 1}}, 1);
  2071. oldentry.d.type &= ~LFS_STRUCT_MOVED;
  2072. if (err) {
  2073. return err;
  2074. }
  2075. // update pair if newcwd == oldcwd
  2076. if (samepair) {
  2077. newcwd = oldcwd;
  2078. }
  2079. // move to new location
  2080. lfs_entry_t newentry = preventry;
  2081. newentry.d = oldentry.d;
  2082. newentry.d.type &= ~LFS_STRUCT_MOVED;
  2083. newentry.d.nlen = nlen;
  2084. newentry.size = prevexists ? preventry.size : 0;
  2085. lfs_size_t newsize = oldentry.size - oldentry.d.nlen + newentry.d.nlen;
  2086. err = lfs_dir_set(lfs, &newcwd, &newentry, (struct lfs_region[]){
  2087. {LFS_FROM_REGION, 0, prevexists ? preventry.size : 0,
  2088. &(struct lfs_region_region){
  2089. oldcwd.pair[0], oldentry.off, (struct lfs_region[]){
  2090. {LFS_FROM_MEM, 0, 4, &newentry.d, 4},
  2091. {LFS_FROM_MEM, newsize-nlen, 0, newpath, nlen}}, 2},
  2092. newsize}}, 1);
  2093. if (err) {
  2094. return err;
  2095. }
  2096. // update pair if newcwd == oldcwd
  2097. if (samepair) {
  2098. oldcwd = newcwd;
  2099. }
  2100. // remove old entry
  2101. err = lfs_dir_set(lfs, &oldcwd, &oldentry, (struct lfs_region[]){
  2102. {LFS_FROM_MEM, 0, oldentry.size, NULL, 0}}, 1);
  2103. if (err) {
  2104. return err;
  2105. }
  2106. // if we were a directory, find pred, replace tail
  2107. if (prevexists && (0xf & preventry.d.type) == LFS_TYPE_DIR) {
  2108. int res = lfs_pred(lfs, dir.pair, &newcwd);
  2109. if (res < 0) {
  2110. return res;
  2111. }
  2112. LFS_ASSERT(res); // must have pred
  2113. newcwd.d.tail[0] = dir.d.tail[0];
  2114. newcwd.d.tail[1] = dir.d.tail[1];
  2115. err = lfs_dir_commit(lfs, &newcwd, NULL, 0);
  2116. if (err) {
  2117. return err;
  2118. }
  2119. }
  2120. return 0;
  2121. }
  2122. int lfs_getattrs(lfs_t *lfs, const char *path,
  2123. const struct lfs_attr *attrs, int count) {
  2124. lfs_dir_t cwd;
  2125. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2126. if (err) {
  2127. return err;
  2128. }
  2129. lfs_entry_t entry;
  2130. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2131. if (err) {
  2132. return err;
  2133. }
  2134. return lfs_dir_getattrs(lfs, &cwd, &entry, attrs, count);
  2135. }
  2136. int lfs_setattrs(lfs_t *lfs, const char *path,
  2137. const struct lfs_attr *attrs, int count) {
  2138. lfs_dir_t cwd;
  2139. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2140. if (err) {
  2141. return err;
  2142. }
  2143. lfs_entry_t entry;
  2144. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2145. if (err) {
  2146. return err;
  2147. }
  2148. return lfs_dir_setattrs(lfs, &cwd, &entry, attrs, count);
  2149. }
  2150. /// Filesystem operations ///
  2151. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2152. lfs->cfg = cfg;
  2153. // setup read cache
  2154. lfs->rcache.block = 0xffffffff;
  2155. if (lfs->cfg->read_buffer) {
  2156. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2157. } else {
  2158. lfs->rcache.buffer = lfs_malloc(lfs->cfg->read_size);
  2159. if (!lfs->rcache.buffer) {
  2160. return LFS_ERR_NOMEM;
  2161. }
  2162. }
  2163. // setup program cache
  2164. lfs->pcache.block = 0xffffffff;
  2165. if (lfs->cfg->prog_buffer) {
  2166. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2167. } else {
  2168. lfs->pcache.buffer = lfs_malloc(lfs->cfg->prog_size);
  2169. if (!lfs->pcache.buffer) {
  2170. return LFS_ERR_NOMEM;
  2171. }
  2172. }
  2173. // setup lookahead, round down to nearest 32-bits
  2174. LFS_ASSERT(lfs->cfg->lookahead % 32 == 0);
  2175. LFS_ASSERT(lfs->cfg->lookahead > 0);
  2176. if (lfs->cfg->lookahead_buffer) {
  2177. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2178. } else {
  2179. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead/8);
  2180. if (!lfs->free.buffer) {
  2181. return LFS_ERR_NOMEM;
  2182. }
  2183. }
  2184. // check that program and read sizes are multiples of the block size
  2185. LFS_ASSERT(lfs->cfg->prog_size % lfs->cfg->read_size == 0);
  2186. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->prog_size == 0);
  2187. // check that the block size is large enough to fit ctz pointers
  2188. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2189. <= lfs->cfg->block_size);
  2190. // check that the size limits are sane
  2191. LFS_ASSERT(lfs->cfg->inline_size <= LFS_INLINE_MAX);
  2192. LFS_ASSERT(lfs->cfg->inline_size <= lfs->cfg->read_size);
  2193. lfs->inline_size = lfs->cfg->inline_size;
  2194. if (!lfs->inline_size) {
  2195. lfs->inline_size = lfs_min(LFS_INLINE_MAX, lfs->cfg->read_size);
  2196. }
  2197. LFS_ASSERT(lfs->cfg->attrs_size <= LFS_ATTRS_MAX);
  2198. lfs->attrs_size = lfs->cfg->attrs_size;
  2199. if (!lfs->attrs_size) {
  2200. lfs->attrs_size = LFS_ATTRS_MAX;
  2201. }
  2202. LFS_ASSERT(lfs->cfg->name_size <= LFS_NAME_MAX);
  2203. lfs->name_size = lfs->cfg->name_size;
  2204. if (!lfs->name_size) {
  2205. lfs->name_size = LFS_NAME_MAX;
  2206. }
  2207. // setup default state
  2208. lfs->root[0] = 0xffffffff;
  2209. lfs->root[1] = 0xffffffff;
  2210. lfs->files = NULL;
  2211. lfs->dirs = NULL;
  2212. lfs->deorphaned = false;
  2213. return 0;
  2214. }
  2215. static int lfs_deinit(lfs_t *lfs) {
  2216. // free allocated memory
  2217. if (!lfs->cfg->read_buffer) {
  2218. lfs_free(lfs->rcache.buffer);
  2219. }
  2220. if (!lfs->cfg->prog_buffer) {
  2221. lfs_free(lfs->pcache.buffer);
  2222. }
  2223. if (!lfs->cfg->lookahead_buffer) {
  2224. lfs_free(lfs->free.buffer);
  2225. }
  2226. return 0;
  2227. }
  2228. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2229. int err = lfs_init(lfs, cfg);
  2230. if (err) {
  2231. return err;
  2232. }
  2233. // create free lookahead
  2234. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  2235. lfs->free.off = 0;
  2236. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->cfg->block_count);
  2237. lfs->free.i = 0;
  2238. lfs_alloc_ack(lfs);
  2239. // create superblock dir
  2240. lfs_dir_t superdir;
  2241. err = lfs_dir_alloc(lfs, &superdir);
  2242. if (err) {
  2243. return err;
  2244. }
  2245. // write root directory
  2246. lfs_dir_t root;
  2247. err = lfs_dir_alloc(lfs, &root);
  2248. if (err) {
  2249. return err;
  2250. }
  2251. err = lfs_dir_commit(lfs, &root, NULL, 0);
  2252. if (err) {
  2253. return err;
  2254. }
  2255. lfs->root[0] = root.pair[0];
  2256. lfs->root[1] = root.pair[1];
  2257. superdir.d.tail[0] = lfs->root[0];
  2258. superdir.d.tail[1] = lfs->root[1];
  2259. // write one superblock
  2260. lfs_superblock_t superblock;
  2261. superblock.d.version = LFS_DISK_VERSION,
  2262. superblock.d.root[0] = lfs->root[0];
  2263. superblock.d.root[1] = lfs->root[1];
  2264. superblock.d.block_size = lfs->cfg->block_size;
  2265. superblock.d.block_count = lfs->cfg->block_count;
  2266. superblock.d.inline_size = lfs->inline_size;
  2267. superblock.d.attrs_size = lfs->attrs_size;
  2268. superblock.d.name_size = lfs->name_size;
  2269. lfs_entry_t superentry;
  2270. superentry.d.type = LFS_STRUCT_DIR | LFS_TYPE_SUPERBLOCK;
  2271. superentry.d.elen = sizeof(superblock.d);
  2272. superentry.d.alen = 0;
  2273. superentry.d.nlen = strlen("littlefs");
  2274. superentry.off = sizeof(superdir.d);
  2275. superentry.size = 0;
  2276. lfs_entry_tole32(&superentry.d);
  2277. lfs_superblock_tole32(&superblock.d);
  2278. err = lfs_dir_set(lfs, &superdir, &superentry, (struct lfs_region[]){
  2279. {LFS_FROM_MEM, 0, 0, &superentry.d, 4},
  2280. {LFS_FROM_MEM, 0, 0, &superblock.d, sizeof(superblock.d)},
  2281. {LFS_FROM_MEM, 0, 0, "littlefs", superentry.d.nlen}}, 3);
  2282. if (err) {
  2283. return err;
  2284. }
  2285. // sanity check that fetch works
  2286. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  2287. if (err) {
  2288. return err;
  2289. }
  2290. return lfs_deinit(lfs);
  2291. }
  2292. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  2293. int err = lfs_init(lfs, cfg);
  2294. if (err) {
  2295. return err;
  2296. }
  2297. // setup free lookahead
  2298. lfs->free.off = 0;
  2299. lfs->free.size = 0;
  2300. lfs->free.i = 0;
  2301. lfs_alloc_ack(lfs);
  2302. // load superblock
  2303. lfs_dir_t dir;
  2304. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2305. if (err) {
  2306. if (err == LFS_ERR_CORRUPT) {
  2307. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  2308. }
  2309. return err;
  2310. }
  2311. lfs_entry_t entry = {.off = sizeof(dir.d)};
  2312. err = lfs_dir_get(lfs, &dir, entry.off, &entry.d, 4);
  2313. if (err) {
  2314. return err;
  2315. }
  2316. lfs_superblock_t superblock;
  2317. memset(&superblock.d, 0, sizeof(superblock.d));
  2318. err = lfs_dir_get(lfs, &dir,
  2319. sizeof(dir.d)+4, &superblock.d,
  2320. lfs_min(sizeof(superblock.d), lfs_entry_elen(&entry)));
  2321. lfs_superblock_fromle32(&superblock.d);
  2322. if (err) {
  2323. return err;
  2324. }
  2325. char magic[8];
  2326. err = lfs_dir_get(lfs, &dir,
  2327. sizeof(dir.d)+lfs_entry_size(&entry)-entry.d.nlen, magic,
  2328. lfs_min(sizeof(magic), entry.d.nlen));
  2329. if (err) {
  2330. return err;
  2331. }
  2332. if (memcmp(magic, "littlefs", 8) != 0) {
  2333. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  2334. return LFS_ERR_CORRUPT;
  2335. }
  2336. uint16_t major_version = (0xffff & (superblock.d.version >> 16));
  2337. uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
  2338. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  2339. minor_version > LFS_DISK_VERSION_MINOR)) {
  2340. LFS_ERROR("Invalid version %d.%d", major_version, minor_version);
  2341. return LFS_ERR_INVAL;
  2342. }
  2343. if (superblock.d.inline_size) {
  2344. if (superblock.d.inline_size > lfs->inline_size) {
  2345. LFS_ERROR("Unsupported inline size (%d > %d)",
  2346. superblock.d.inline_size, lfs->inline_size);
  2347. return LFS_ERR_INVAL;
  2348. }
  2349. lfs->inline_size = superblock.d.inline_size;
  2350. }
  2351. if (superblock.d.attrs_size) {
  2352. if (superblock.d.attrs_size > lfs->attrs_size) {
  2353. LFS_ERROR("Unsupported attrs size (%d > %d)",
  2354. superblock.d.attrs_size, lfs->attrs_size);
  2355. return LFS_ERR_INVAL;
  2356. }
  2357. lfs->attrs_size = superblock.d.attrs_size;
  2358. }
  2359. if (superblock.d.name_size) {
  2360. if (superblock.d.name_size > lfs->name_size) {
  2361. LFS_ERROR("Unsupported name size (%d > %d)",
  2362. superblock.d.name_size, lfs->name_size);
  2363. return LFS_ERR_INVAL;
  2364. }
  2365. lfs->name_size = superblock.d.name_size;
  2366. }
  2367. lfs->root[0] = superblock.d.root[0];
  2368. lfs->root[1] = superblock.d.root[1];
  2369. return 0;
  2370. }
  2371. int lfs_unmount(lfs_t *lfs) {
  2372. return lfs_deinit(lfs);
  2373. }
  2374. /// Internal filesystem filesystem operations ///
  2375. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  2376. if (lfs_pairisnull(lfs->root)) {
  2377. return 0;
  2378. }
  2379. // iterate over metadata pairs
  2380. lfs_block_t cwd[2] = {0, 1};
  2381. while (true) {
  2382. for (int i = 0; i < 2; i++) {
  2383. int err = cb(data, cwd[i]);
  2384. if (err) {
  2385. return err;
  2386. }
  2387. }
  2388. lfs_dir_t dir;
  2389. int err = lfs_dir_fetch(lfs, &dir, cwd);
  2390. if (err) {
  2391. return err;
  2392. }
  2393. // iterate over contents
  2394. lfs_entry_t entry;
  2395. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  2396. err = lfs_dir_get(lfs, &dir,
  2397. dir.off, &entry.d, sizeof(entry.d));
  2398. lfs_entry_fromle32(&entry.d);
  2399. if (err) {
  2400. return err;
  2401. }
  2402. dir.off += lfs_entry_size(&entry);
  2403. if ((0x70 & entry.d.type) == LFS_STRUCT_CTZ) {
  2404. err = lfs_ctz_traverse(lfs, &lfs->rcache, NULL,
  2405. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  2406. if (err) {
  2407. return err;
  2408. }
  2409. }
  2410. }
  2411. cwd[0] = dir.d.tail[0];
  2412. cwd[1] = dir.d.tail[1];
  2413. if (lfs_pairisnull(cwd)) {
  2414. break;
  2415. }
  2416. }
  2417. // iterate over any open files
  2418. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  2419. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  2420. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  2421. f->head, f->size, cb, data);
  2422. if (err) {
  2423. return err;
  2424. }
  2425. }
  2426. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  2427. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  2428. f->block, f->pos, cb, data);
  2429. if (err) {
  2430. return err;
  2431. }
  2432. }
  2433. }
  2434. return 0;
  2435. }
  2436. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir) {
  2437. if (lfs_pairisnull(lfs->root)) {
  2438. return 0;
  2439. }
  2440. // iterate over all directory directory entries
  2441. int err = lfs_dir_fetch(lfs, pdir, (const lfs_block_t[2]){0, 1});
  2442. if (err) {
  2443. return err;
  2444. }
  2445. while (!lfs_pairisnull(pdir->d.tail)) {
  2446. if (lfs_paircmp(pdir->d.tail, dir) == 0) {
  2447. return true;
  2448. }
  2449. err = lfs_dir_fetch(lfs, pdir, pdir->d.tail);
  2450. if (err) {
  2451. return err;
  2452. }
  2453. }
  2454. return false;
  2455. }
  2456. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  2457. lfs_dir_t *parent, lfs_entry_t *entry) {
  2458. if (lfs_pairisnull(lfs->root)) {
  2459. return 0;
  2460. }
  2461. parent->d.tail[0] = 0;
  2462. parent->d.tail[1] = 1;
  2463. // iterate over all directory directory entries
  2464. while (!lfs_pairisnull(parent->d.tail)) {
  2465. int err = lfs_dir_fetch(lfs, parent, parent->d.tail);
  2466. if (err) {
  2467. return err;
  2468. }
  2469. while (true) {
  2470. err = lfs_dir_next(lfs, parent, entry);
  2471. if (err && err != LFS_ERR_NOENT) {
  2472. return err;
  2473. }
  2474. if (err == LFS_ERR_NOENT) {
  2475. break;
  2476. }
  2477. if (((0x70 & entry->d.type) == LFS_STRUCT_DIR) &&
  2478. lfs_paircmp(entry->d.u.dir, dir) == 0) {
  2479. return true;
  2480. }
  2481. }
  2482. }
  2483. return false;
  2484. }
  2485. static int lfs_moved(lfs_t *lfs, const void *e) {
  2486. if (lfs_pairisnull(lfs->root)) {
  2487. return 0;
  2488. }
  2489. // skip superblock
  2490. lfs_dir_t cwd;
  2491. int err = lfs_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
  2492. if (err) {
  2493. return err;
  2494. }
  2495. // iterate over all directory directory entries
  2496. lfs_entry_t entry;
  2497. while (!lfs_pairisnull(cwd.d.tail)) {
  2498. err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2499. if (err) {
  2500. return err;
  2501. }
  2502. while (true) {
  2503. err = lfs_dir_next(lfs, &cwd, &entry);
  2504. if (err && err != LFS_ERR_NOENT) {
  2505. return err;
  2506. }
  2507. if (err == LFS_ERR_NOENT) {
  2508. break;
  2509. }
  2510. if (!(LFS_STRUCT_MOVED & entry.d.type) &&
  2511. memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
  2512. return true;
  2513. }
  2514. }
  2515. }
  2516. return false;
  2517. }
  2518. static int lfs_relocate(lfs_t *lfs,
  2519. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]) {
  2520. // find parent
  2521. lfs_dir_t parent;
  2522. lfs_entry_t entry;
  2523. int res = lfs_parent(lfs, oldpair, &parent, &entry);
  2524. if (res < 0) {
  2525. return res;
  2526. }
  2527. if (res) {
  2528. // update disk, this creates a desync
  2529. entry.d.u.dir[0] = newpair[0];
  2530. entry.d.u.dir[1] = newpair[1];
  2531. lfs_entry_tole32(&entry.d);
  2532. int err = lfs_dir_set(lfs, &parent, &entry, (struct lfs_region[]){
  2533. {LFS_FROM_MEM, 0, sizeof(entry.d),
  2534. &entry.d, sizeof(entry.d)}}, 1);
  2535. if (err) {
  2536. return err;
  2537. }
  2538. // update internal root
  2539. if (lfs_paircmp(oldpair, lfs->root) == 0) {
  2540. LFS_DEBUG("Relocating root %d %d", newpair[0], newpair[1]);
  2541. lfs->root[0] = newpair[0];
  2542. lfs->root[1] = newpair[1];
  2543. }
  2544. // clean up bad block, which should now be a desync
  2545. return lfs_deorphan(lfs);
  2546. }
  2547. // find pred
  2548. res = lfs_pred(lfs, oldpair, &parent);
  2549. if (res < 0) {
  2550. return res;
  2551. }
  2552. if (res) {
  2553. // just replace bad pair, no desync can occur
  2554. parent.d.tail[0] = newpair[0];
  2555. parent.d.tail[1] = newpair[1];
  2556. return lfs_dir_commit(lfs, &parent, NULL, 0);
  2557. }
  2558. // couldn't find dir, must be new
  2559. return 0;
  2560. }
  2561. int lfs_deorphan(lfs_t *lfs) {
  2562. lfs->deorphaned = true;
  2563. if (lfs_pairisnull(lfs->root)) {
  2564. return 0;
  2565. }
  2566. lfs_dir_t pdir = {.d.size = 0x80000000};
  2567. lfs_dir_t cwd = {.d.tail[0] = 0, .d.tail[1] = 1};
  2568. // iterate over all directory directory entries
  2569. while (!lfs_pairisnull(cwd.d.tail)) {
  2570. int err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2571. if (err) {
  2572. return err;
  2573. }
  2574. // check head blocks for orphans
  2575. if (!(0x80000000 & pdir.d.size)) {
  2576. // check if we have a parent
  2577. lfs_dir_t parent;
  2578. lfs_entry_t entry;
  2579. int res = lfs_parent(lfs, pdir.d.tail, &parent, &entry);
  2580. if (res < 0) {
  2581. return res;
  2582. }
  2583. if (!res) {
  2584. // we are an orphan
  2585. LFS_DEBUG("Found orphan %d %d",
  2586. pdir.d.tail[0], pdir.d.tail[1]);
  2587. pdir.d.tail[0] = cwd.d.tail[0];
  2588. pdir.d.tail[1] = cwd.d.tail[1];
  2589. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2590. if (err) {
  2591. return err;
  2592. }
  2593. break;
  2594. }
  2595. if (!lfs_pairsync(entry.d.u.dir, pdir.d.tail)) {
  2596. // we have desynced
  2597. LFS_DEBUG("Found desync %d %d",
  2598. entry.d.u.dir[0], entry.d.u.dir[1]);
  2599. pdir.d.tail[0] = entry.d.u.dir[0];
  2600. pdir.d.tail[1] = entry.d.u.dir[1];
  2601. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2602. if (err) {
  2603. return err;
  2604. }
  2605. break;
  2606. }
  2607. }
  2608. // check entries for moves
  2609. lfs_entry_t entry;
  2610. while (true) {
  2611. err = lfs_dir_next(lfs, &cwd, &entry);
  2612. if (err && err != LFS_ERR_NOENT) {
  2613. return err;
  2614. }
  2615. if (err == LFS_ERR_NOENT) {
  2616. break;
  2617. }
  2618. // found moved entry
  2619. if (entry.d.type & LFS_STRUCT_MOVED) {
  2620. int moved = lfs_moved(lfs, &entry.d.u);
  2621. if (moved < 0) {
  2622. return moved;
  2623. }
  2624. if (moved) {
  2625. LFS_DEBUG("Found move %d %d",
  2626. entry.d.u.dir[0], entry.d.u.dir[1]);
  2627. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  2628. {LFS_FROM_MEM, 0, entry.size, NULL, 0}}, 1);
  2629. if (err) {
  2630. return err;
  2631. }
  2632. } else {
  2633. LFS_DEBUG("Found partial move %d %d",
  2634. entry.d.u.dir[0], entry.d.u.dir[1]);
  2635. entry.d.type &= ~LFS_STRUCT_MOVED;
  2636. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  2637. {LFS_FROM_MEM, 0, 1, &entry.d, 1}}, 1);
  2638. if (err) {
  2639. return err;
  2640. }
  2641. }
  2642. }
  2643. }
  2644. memcpy(&pdir, &cwd, sizeof(pdir));
  2645. }
  2646. return 0;
  2647. }
  2648. /// External filesystem filesystem operations ///
  2649. int lfs_fs_getattrs(lfs_t *lfs, const struct lfs_attr *attrs, int count) {
  2650. lfs_dir_t dir;
  2651. int err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2652. if (err) {
  2653. return err;
  2654. }
  2655. lfs_entry_t entry = {.off = sizeof(dir.d)};
  2656. err = lfs_dir_get(lfs, &dir, entry.off, &entry.d, 4);
  2657. if (err) {
  2658. return err;
  2659. }
  2660. entry.size = lfs_entry_size(&entry);
  2661. return lfs_dir_getattrs(lfs, &dir, &entry, attrs, count);
  2662. }
  2663. int lfs_fs_setattrs(lfs_t *lfs, const struct lfs_attr *attrs, int count) {
  2664. lfs_dir_t dir;
  2665. int err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2666. if (err) {
  2667. return err;
  2668. }
  2669. lfs_entry_t entry = {.off = sizeof(dir.d)};
  2670. err = lfs_dir_get(lfs, &dir, entry.off, &entry.d, 4);
  2671. if (err) {
  2672. return err;
  2673. }
  2674. entry.size = lfs_entry_size(&entry);
  2675. return lfs_dir_setattrs(lfs, &dir, &entry, attrs, count);
  2676. }
  2677. static int lfs_fs_size_count(void *p, lfs_block_t block) {
  2678. lfs_size_t *size = p;
  2679. *size += 1;
  2680. return 0;
  2681. }
  2682. lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
  2683. lfs_size_t size = 0;
  2684. int err = lfs_traverse(lfs, lfs_fs_size_count, &size);
  2685. if (err) {
  2686. return err;
  2687. }
  2688. return size;
  2689. }