lfs.c 100 KB

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