lfs.c 100 KB

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