lfs.c 101 KB

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