lfs.c 101 KB

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