lfs.c 102 KB

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