lfs.c 104 KB

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