lfs.c 107 KB

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