lfs.c 97 KB

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