lfs.c 82 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026
  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, lfs_cache_t *rcache,
  22. const lfs_cache_t *pcache, lfs_block_t block,
  23. lfs_off_t off, void *buffer, lfs_size_t size) {
  24. uint8_t *data = buffer;
  25. LFS_ASSERT(block != 0xffffffff);
  26. while (size > 0) {
  27. if (pcache && block == pcache->block && off >= pcache->off &&
  28. off < pcache->off + lfs->cfg->prog_size) {
  29. // is already in pcache?
  30. lfs_size_t diff = lfs_min(size,
  31. lfs->cfg->prog_size - (off-pcache->off));
  32. memcpy(data, &pcache->buffer[off-pcache->off], diff);
  33. data += diff;
  34. off += diff;
  35. size -= diff;
  36. continue;
  37. }
  38. if (block == rcache->block && off >= rcache->off &&
  39. off < rcache->off + lfs->cfg->read_size) {
  40. // is already in rcache?
  41. lfs_size_t diff = lfs_min(size,
  42. lfs->cfg->read_size - (off-rcache->off));
  43. memcpy(data, &rcache->buffer[off-rcache->off], diff);
  44. data += diff;
  45. off += diff;
  46. size -= diff;
  47. continue;
  48. }
  49. if (off % lfs->cfg->read_size == 0 && size >= lfs->cfg->read_size) {
  50. // bypass cache?
  51. lfs_size_t diff = size - (size % lfs->cfg->read_size);
  52. int err = lfs->cfg->read(lfs->cfg, block, off, data, diff);
  53. if (err) {
  54. return err;
  55. }
  56. data += diff;
  57. off += diff;
  58. size -= diff;
  59. continue;
  60. }
  61. // load to cache, first condition can no longer fail
  62. LFS_ASSERT(block < lfs->cfg->block_count);
  63. rcache->block = block;
  64. rcache->off = off - (off % lfs->cfg->read_size);
  65. int err = lfs->cfg->read(lfs->cfg, rcache->block,
  66. rcache->off, rcache->buffer, lfs->cfg->read_size);
  67. if (err) {
  68. return err;
  69. }
  70. }
  71. return 0;
  72. }
  73. static int lfs_cache_cmp(lfs_t *lfs, lfs_cache_t *rcache,
  74. const lfs_cache_t *pcache, lfs_block_t block,
  75. lfs_off_t off, const void *buffer, lfs_size_t size) {
  76. const uint8_t *data = buffer;
  77. for (lfs_off_t i = 0; i < size; i++) {
  78. uint8_t c;
  79. int err = lfs_cache_read(lfs, rcache, pcache,
  80. block, off+i, &c, 1);
  81. if (err) {
  82. return err;
  83. }
  84. if (c != data[i]) {
  85. return false;
  86. }
  87. }
  88. return true;
  89. }
  90. static int lfs_cache_crc(lfs_t *lfs, lfs_cache_t *rcache,
  91. const lfs_cache_t *pcache, lfs_block_t block,
  92. lfs_off_t off, lfs_size_t size, uint32_t *crc) {
  93. for (lfs_off_t i = 0; i < size; i++) {
  94. uint8_t c;
  95. int err = lfs_cache_read(lfs, rcache, pcache,
  96. block, off+i, &c, 1);
  97. if (err) {
  98. return err;
  99. }
  100. lfs_crc(crc, &c, 1);
  101. }
  102. return 0;
  103. }
  104. static int lfs_cache_flush(lfs_t *lfs,
  105. lfs_cache_t *pcache, lfs_cache_t *rcache) {
  106. if (pcache->block != 0xffffffff) {
  107. LFS_ASSERT(pcache->block < lfs->cfg->block_count);
  108. int err = lfs->cfg->prog(lfs->cfg, pcache->block,
  109. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  110. if (err) {
  111. return err;
  112. }
  113. if (rcache) {
  114. int res = lfs_cache_cmp(lfs, rcache, NULL, pcache->block,
  115. pcache->off, pcache->buffer, lfs->cfg->prog_size);
  116. if (res < 0) {
  117. return res;
  118. }
  119. if (!res) {
  120. return LFS_ERR_CORRUPT;
  121. }
  122. }
  123. pcache->block = 0xffffffff;
  124. }
  125. return 0;
  126. }
  127. static int lfs_cache_prog(lfs_t *lfs, lfs_cache_t *pcache,
  128. lfs_cache_t *rcache, lfs_block_t block,
  129. lfs_off_t off, const void *buffer, lfs_size_t size) {
  130. const uint8_t *data = buffer;
  131. LFS_ASSERT(block != 0xffffffff);
  132. LFS_ASSERT(off + size <= lfs->cfg->block_size);
  133. while (size > 0) {
  134. if (block == pcache->block && off >= pcache->off &&
  135. off < pcache->off + lfs->cfg->prog_size) {
  136. // is already in pcache?
  137. lfs_size_t diff = lfs_min(size,
  138. lfs->cfg->prog_size - (off-pcache->off));
  139. memcpy(&pcache->buffer[off-pcache->off], data, diff);
  140. data += diff;
  141. off += diff;
  142. size -= diff;
  143. if (off % lfs->cfg->prog_size == 0) {
  144. // eagerly flush out pcache if we fill up
  145. int err = lfs_cache_flush(lfs, pcache, rcache);
  146. if (err) {
  147. return err;
  148. }
  149. }
  150. continue;
  151. }
  152. // pcache must have been flushed, either by programming and
  153. // entire block or manually flushing the pcache
  154. LFS_ASSERT(pcache->block == 0xffffffff);
  155. if (off % lfs->cfg->prog_size == 0 &&
  156. size >= lfs->cfg->prog_size) {
  157. // bypass pcache?
  158. LFS_ASSERT(block < lfs->cfg->block_count);
  159. lfs_size_t diff = size - (size % lfs->cfg->prog_size);
  160. int err = lfs->cfg->prog(lfs->cfg, block, off, data, diff);
  161. if (err) {
  162. return err;
  163. }
  164. if (rcache) {
  165. int res = lfs_cache_cmp(lfs, rcache, NULL,
  166. block, off, data, diff);
  167. if (res < 0) {
  168. return res;
  169. }
  170. if (!res) {
  171. return LFS_ERR_CORRUPT;
  172. }
  173. }
  174. data += diff;
  175. off += diff;
  176. size -= diff;
  177. continue;
  178. }
  179. // prepare pcache, first condition can no longer fail
  180. pcache->block = block;
  181. pcache->off = off - (off % lfs->cfg->prog_size);
  182. }
  183. return 0;
  184. }
  185. /// General lfs block device operations ///
  186. static int lfs_bd_read(lfs_t *lfs, lfs_block_t block,
  187. lfs_off_t off, void *buffer, lfs_size_t size) {
  188. // if we ever do more than writes to alternating pairs,
  189. // this may need to consider pcache
  190. return lfs_cache_read(lfs, &lfs->rcache, NULL,
  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, NULL,
  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, &lfs->rcache, NULL, block, off, buffer, size);
  201. }
  202. static int lfs_bd_crc(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, &lfs->rcache, NULL, 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->rcache.block = 0xffffffff;
  212. int err = lfs_cache_flush(lfs, &lfs->pcache, NULL);
  213. if (err) {
  214. return err;
  215. }
  216. return lfs->cfg->sync(lfs->cfg);
  217. }
  218. /// Internal operations predeclared here ///
  219. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data);
  220. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir);
  221. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  222. lfs_dir_t *parent, lfs_entry_t *entry);
  223. static int lfs_moved(lfs_t *lfs, const void *e);
  224. static int lfs_relocate(lfs_t *lfs,
  225. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]);
  226. int lfs_deorphan(lfs_t *lfs);
  227. /// Block allocator ///
  228. static int lfs_alloc_lookahead(void *p, lfs_block_t block) {
  229. lfs_t *lfs = p;
  230. lfs_block_t off = ((block - lfs->free.off)
  231. + lfs->cfg->block_count) % lfs->cfg->block_count;
  232. if (off < lfs->free.size) {
  233. lfs->free.buffer[off / 32] |= 1U << (off % 32);
  234. }
  235. return 0;
  236. }
  237. static int lfs_alloc(lfs_t *lfs, lfs_block_t *block) {
  238. while (true) {
  239. while (lfs->free.i != lfs->free.size) {
  240. lfs_block_t off = lfs->free.i;
  241. lfs->free.i += 1;
  242. lfs->free.ack -= 1;
  243. if (!(lfs->free.buffer[off / 32] & (1U << (off % 32)))) {
  244. // found a free block
  245. *block = (lfs->free.off + off) % lfs->cfg->block_count;
  246. // eagerly find next off so an alloc ack can
  247. // discredit old lookahead blocks
  248. while (lfs->free.i != lfs->free.size &&
  249. (lfs->free.buffer[lfs->free.i / 32]
  250. & (1U << (lfs->free.i % 32)))) {
  251. lfs->free.i += 1;
  252. lfs->free.ack -= 1;
  253. }
  254. return 0;
  255. }
  256. }
  257. // check if we have looked at all blocks since last ack
  258. if (lfs->free.ack == 0) {
  259. LFS_WARN("No more free space %d", lfs->free.i + lfs->free.off);
  260. return LFS_ERR_NOSPC;
  261. }
  262. lfs->free.off = (lfs->free.off + lfs->free.size)
  263. % lfs->cfg->block_count;
  264. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->free.ack);
  265. lfs->free.i = 0;
  266. // find mask of free blocks from tree
  267. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  268. int err = lfs_traverse(lfs, lfs_alloc_lookahead, lfs);
  269. if (err) {
  270. return err;
  271. }
  272. }
  273. }
  274. static void lfs_alloc_ack(lfs_t *lfs) {
  275. lfs->free.ack = lfs->cfg->block_count;
  276. }
  277. /// Endian swapping functions ///
  278. static void lfs_dir_fromle32(struct lfs_disk_dir *d) {
  279. d->rev = lfs_fromle32(d->rev);
  280. d->size = lfs_fromle32(d->size);
  281. d->tail[0] = lfs_fromle32(d->tail[0]);
  282. d->tail[1] = lfs_fromle32(d->tail[1]);
  283. }
  284. static void lfs_dir_tole32(struct lfs_disk_dir *d) {
  285. d->rev = lfs_tole32(d->rev);
  286. d->size = lfs_tole32(d->size);
  287. d->tail[0] = lfs_tole32(d->tail[0]);
  288. d->tail[1] = lfs_tole32(d->tail[1]);
  289. }
  290. static void lfs_entry_fromle32(struct lfs_disk_entry *d) {
  291. d->u.dir[0] = lfs_fromle32(d->u.dir[0]);
  292. d->u.dir[1] = lfs_fromle32(d->u.dir[1]);
  293. }
  294. static void lfs_entry_tole32(struct lfs_disk_entry *d) {
  295. d->u.dir[0] = lfs_tole32(d->u.dir[0]);
  296. d->u.dir[1] = lfs_tole32(d->u.dir[1]);
  297. }
  298. static void lfs_superblock_fromle32(struct lfs_disk_superblock *d) {
  299. d->root[0] = lfs_fromle32(d->root[0]);
  300. d->root[1] = lfs_fromle32(d->root[1]);
  301. d->block_size = lfs_fromle32(d->block_size);
  302. d->block_count = lfs_fromle32(d->block_count);
  303. d->version = lfs_fromle32(d->version);
  304. d->inline_size = lfs_fromle32(d->inline_size);
  305. d->attrs_size = lfs_fromle32(d->attrs_size);
  306. d->name_size = lfs_fromle32(d->name_size);
  307. }
  308. static void lfs_superblock_tole32(struct lfs_disk_superblock *d) {
  309. d->root[0] = lfs_tole32(d->root[0]);
  310. d->root[1] = lfs_tole32(d->root[1]);
  311. d->block_size = lfs_tole32(d->block_size);
  312. d->block_count = lfs_tole32(d->block_count);
  313. d->version = lfs_tole32(d->version);
  314. d->inline_size = lfs_tole32(d->inline_size);
  315. d->attrs_size = lfs_tole32(d->attrs_size);
  316. d->name_size = lfs_tole32(d->name_size);
  317. }
  318. /// Other struct functions ///
  319. static inline lfs_size_t lfs_entry_elen(const lfs_entry_t *entry) {
  320. return (lfs_size_t)(entry->d.elen) |
  321. ((lfs_size_t)(entry->d.alen & 0xc0) << 2);
  322. }
  323. static inline lfs_size_t lfs_entry_alen(const lfs_entry_t *entry) {
  324. return entry->d.alen & 0x3f;
  325. }
  326. static inline lfs_size_t lfs_entry_nlen(const lfs_entry_t *entry) {
  327. return entry->d.nlen;
  328. }
  329. static inline lfs_size_t lfs_entry_size(const lfs_entry_t *entry) {
  330. return 4 + lfs_entry_elen(entry) +
  331. lfs_entry_alen(entry) +
  332. lfs_entry_nlen(entry);
  333. }
  334. /// Metadata pair and directory operations ///
  335. static inline void lfs_pairswap(lfs_block_t pair[2]) {
  336. lfs_block_t t = pair[0];
  337. pair[0] = pair[1];
  338. pair[1] = t;
  339. }
  340. static inline bool lfs_pairisnull(const lfs_block_t pair[2]) {
  341. return pair[0] == 0xffffffff || pair[1] == 0xffffffff;
  342. }
  343. static inline int lfs_paircmp(
  344. const lfs_block_t paira[2],
  345. const lfs_block_t pairb[2]) {
  346. return !(paira[0] == pairb[0] || paira[1] == pairb[1] ||
  347. paira[0] == pairb[1] || paira[1] == pairb[0]);
  348. }
  349. static inline bool lfs_pairsync(
  350. const lfs_block_t paira[2],
  351. const lfs_block_t pairb[2]) {
  352. return (paira[0] == pairb[0] && paira[1] == pairb[1]) ||
  353. (paira[0] == pairb[1] && paira[1] == pairb[0]);
  354. }
  355. static int lfs_dir_alloc(lfs_t *lfs, lfs_dir_t *dir) {
  356. // allocate pair of dir blocks
  357. for (int i = 0; i < 2; i++) {
  358. int err = lfs_alloc(lfs, &dir->pair[i]);
  359. if (err) {
  360. return err;
  361. }
  362. }
  363. // rather than clobbering one of the blocks we just pretend
  364. // the revision may be valid
  365. int err = lfs_bd_read(lfs, dir->pair[0], 0, &dir->d.rev, 4);
  366. dir->d.rev = lfs_fromle32(dir->d.rev);
  367. if (err) {
  368. return err;
  369. }
  370. // set defaults
  371. dir->d.rev += 1;
  372. dir->d.size = sizeof(dir->d)+4;
  373. dir->d.tail[0] = 0xffffffff;
  374. dir->d.tail[1] = 0xffffffff;
  375. dir->off = sizeof(dir->d);
  376. // don't write out yet, let caller take care of that
  377. return 0;
  378. }
  379. static int lfs_dir_fetch(lfs_t *lfs,
  380. lfs_dir_t *dir, const lfs_block_t pair[2]) {
  381. // copy out pair, otherwise may be aliasing dir
  382. const lfs_block_t tpair[2] = {pair[0], pair[1]};
  383. bool valid = false;
  384. // check both blocks for the most recent revision
  385. for (int i = 0; i < 2; i++) {
  386. struct lfs_disk_dir test;
  387. int err = lfs_bd_read(lfs, tpair[i], 0, &test, sizeof(test));
  388. lfs_dir_fromle32(&test);
  389. if (err) {
  390. return err;
  391. }
  392. if (valid && lfs_scmp(test.rev, dir->d.rev) < 0) {
  393. continue;
  394. }
  395. if ((0x7fffffff & test.size) < sizeof(test)+4 ||
  396. (0x7fffffff & test.size) > lfs->cfg->block_size) {
  397. continue;
  398. }
  399. uint32_t crc = 0xffffffff;
  400. lfs_dir_tole32(&test);
  401. lfs_crc(&crc, &test, sizeof(test));
  402. lfs_dir_fromle32(&test);
  403. err = lfs_bd_crc(lfs, tpair[i], sizeof(test),
  404. (0x7fffffff & test.size) - sizeof(test), &crc);
  405. if (err) {
  406. return err;
  407. }
  408. if (crc != 0) {
  409. continue;
  410. }
  411. valid = true;
  412. // setup dir in case it's valid
  413. dir->pair[0] = tpair[(i+0) % 2];
  414. dir->pair[1] = tpair[(i+1) % 2];
  415. dir->off = sizeof(dir->d);
  416. dir->d = test;
  417. }
  418. if (!valid) {
  419. LFS_ERROR("Corrupted dir pair at %d %d", tpair[0], tpair[1]);
  420. return LFS_ERR_CORRUPT;
  421. }
  422. return 0;
  423. }
  424. struct lfs_region {
  425. enum {
  426. LFS_FROM_DROP,
  427. LFS_FROM_MEM,
  428. LFS_FROM_REGION,
  429. } type;
  430. lfs_off_t off;
  431. const void *buffer;
  432. lfs_ssize_t size;
  433. };
  434. struct lfs_region_region {
  435. lfs_block_t block;
  436. lfs_off_t off;
  437. struct lfs_region *regions;
  438. int count;
  439. };
  440. static int lfs_commit_region(lfs_t *lfs,
  441. lfs_block_t oldblock, lfs_off_t oldoff,
  442. lfs_block_t newblock, lfs_off_t newoff,
  443. lfs_off_t regionoff,
  444. const struct lfs_region *regions, int count,
  445. lfs_size_t size, uint32_t *crc) {
  446. int i = 0;
  447. lfs_size_t end = newoff + size;
  448. while (newoff < end) {
  449. // commit from different types of regions
  450. if (i < count && regions[i].off == oldoff - regionoff) {
  451. switch (regions[i].type) {
  452. case LFS_FROM_DROP: {
  453. oldoff -= regions[i].size;
  454. break;
  455. }
  456. case LFS_FROM_MEM: {
  457. lfs_crc(crc, regions[i].buffer, regions[i].size);
  458. int err = lfs_bd_prog(lfs, newblock, newoff,
  459. regions[i].buffer, regions[i].size);
  460. if (err) {
  461. return err;
  462. }
  463. newoff += regions[i].size;
  464. break;
  465. }
  466. case LFS_FROM_REGION: {
  467. const struct lfs_region_region *disk = regions[i].buffer;
  468. int err = lfs_commit_region(lfs,
  469. disk->block, disk->off,
  470. newblock, newoff,
  471. disk->off, disk->regions, disk->count,
  472. regions[i].size, crc);
  473. if (err) {
  474. return err;
  475. }
  476. newoff += regions[i].size;
  477. break;
  478. }
  479. }
  480. i += 1;
  481. } else {
  482. // copy data from old block if not covered by region
  483. uint8_t data;
  484. int err = lfs_bd_read(lfs, oldblock, oldoff, &data, 1);
  485. if (err) {
  486. return err;
  487. }
  488. lfs_crc(crc, &data, 1);
  489. err = lfs_bd_prog(lfs, newblock, newoff, &data, 1);
  490. if (err) {
  491. return err;
  492. }
  493. oldoff += 1;
  494. newoff += 1;
  495. }
  496. }
  497. return 0;
  498. }
  499. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  500. const struct lfs_region *regions, int count) {
  501. // state for copying over
  502. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  503. bool relocated = false;
  504. // increment revision count
  505. dir->d.rev += 1;
  506. // keep pairs in order such that pair[0] is most recent
  507. lfs_pairswap(dir->pair);
  508. for (int i = 0; i < count; i++) {
  509. dir->d.size += regions[i].size;
  510. }
  511. while (true) {
  512. if (true) {
  513. int err = lfs_bd_erase(lfs, dir->pair[0]);
  514. if (err) {
  515. if (err == LFS_ERR_CORRUPT) {
  516. goto relocate;
  517. }
  518. return err;
  519. }
  520. // commit header
  521. uint32_t crc = 0xffffffff;
  522. lfs_dir_tole32(&dir->d);
  523. lfs_crc(&crc, &dir->d, sizeof(dir->d));
  524. err = lfs_bd_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  525. lfs_dir_fromle32(&dir->d);
  526. if (err) {
  527. if (err == LFS_ERR_CORRUPT) {
  528. goto relocate;
  529. }
  530. return err;
  531. }
  532. // commit region
  533. err = lfs_commit_region(lfs,
  534. dir->pair[1], sizeof(dir->d),
  535. dir->pair[0], sizeof(dir->d),
  536. 0, regions, count,
  537. (0x7fffffff & dir->d.size)-sizeof(dir->d)-4,
  538. &crc);
  539. if (err) {
  540. if (err == LFS_ERR_CORRUPT) {
  541. goto relocate;
  542. }
  543. return err;
  544. }
  545. // commit crc
  546. crc = lfs_tole32(crc);
  547. err = lfs_bd_prog(lfs, dir->pair[0],
  548. (0x7fffffff & dir->d.size)-4, &crc, 4);
  549. crc = lfs_fromle32(crc);
  550. if (err) {
  551. if (err == LFS_ERR_CORRUPT) {
  552. goto relocate;
  553. }
  554. return err;
  555. }
  556. err = lfs_bd_sync(lfs);
  557. if (err) {
  558. if (err == LFS_ERR_CORRUPT) {
  559. goto relocate;
  560. }
  561. return err;
  562. }
  563. // successful commit, check checksum to make sure
  564. uint32_t ncrc = 0xffffffff;
  565. err = lfs_bd_crc(lfs, dir->pair[0], 0,
  566. (0x7fffffff & dir->d.size)-4, &ncrc);
  567. if (err) {
  568. return err;
  569. }
  570. if (ncrc != crc) {
  571. goto relocate;
  572. }
  573. }
  574. break;
  575. relocate:
  576. //commit was corrupted
  577. LFS_DEBUG("Bad block at %d", dir->pair[0]);
  578. // drop caches and prepare to relocate block
  579. relocated = true;
  580. lfs->pcache.block = 0xffffffff;
  581. // can't relocate superblock, filesystem is now frozen
  582. if (lfs_paircmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  583. LFS_WARN("Superblock %d has become unwritable", oldpair[0]);
  584. return LFS_ERR_CORRUPT;
  585. }
  586. // relocate half of pair
  587. int err = lfs_alloc(lfs, &dir->pair[0]);
  588. if (err) {
  589. return err;
  590. }
  591. }
  592. if (relocated) {
  593. // update references if we relocated
  594. LFS_DEBUG("Relocating %d %d to %d %d",
  595. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  596. int err = lfs_relocate(lfs, oldpair, dir->pair);
  597. if (err) {
  598. return err;
  599. }
  600. }
  601. // shift over any directories that are affected
  602. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  603. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  604. d->pair[0] = dir->pair[0];
  605. d->pair[1] = dir->pair[1];
  606. }
  607. }
  608. return 0;
  609. }
  610. static int lfs_dir_get(lfs_t *lfs, const lfs_dir_t *dir,
  611. lfs_off_t off, void *buffer, lfs_size_t size) {
  612. return lfs_bd_read(lfs, dir->pair[0], off, buffer, size);
  613. }
  614. static int lfs_dir_set(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry,
  615. struct lfs_region *regions, int count) {
  616. lfs_ssize_t diff = 0;
  617. for (int i = 0; i < count; i++) {
  618. diff += regions[i].size;
  619. }
  620. lfs_size_t oldsize = entry->size;
  621. if (entry->off == 0) {
  622. entry->off = (0x7fffffff & dir->d.size) - 4;
  623. }
  624. if ((0x7fffffff & dir->d.size) + diff > lfs->cfg->block_size) {
  625. lfs_dir_t olddir = *dir;
  626. lfs_off_t oldoff = entry->off;
  627. if (oldsize) {
  628. // mark as moving
  629. uint8_t type;
  630. int err = lfs_dir_get(lfs, &olddir, oldoff, &type, 1);
  631. if (err) {
  632. return err;
  633. }
  634. type |= LFS_STRUCT_MOVED;
  635. err = lfs_dir_commit(lfs, &olddir, (struct lfs_region[]){
  636. {LFS_FROM_MEM, oldoff, &type, 1},
  637. {LFS_FROM_DROP, oldoff, NULL, -1}}, 2);
  638. if (err) {
  639. return err;
  640. }
  641. }
  642. lfs_dir_t pdir = olddir;
  643. // find available block or create a new one
  644. while ((0x7fffffff & dir->d.size) + oldsize + diff
  645. > lfs->cfg->block_size) {
  646. // we need to allocate a new dir block
  647. if (!(0x80000000 & dir->d.size)) {
  648. pdir = *dir;
  649. int err = lfs_dir_alloc(lfs, dir);
  650. if (err) {
  651. return err;
  652. }
  653. dir->d.tail[0] = pdir.d.tail[0];
  654. dir->d.tail[1] = pdir.d.tail[1];
  655. break;
  656. }
  657. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  658. if (err) {
  659. return err;
  660. }
  661. }
  662. // writing out new entry
  663. entry->off = dir->d.size - 4;
  664. entry->size += diff;
  665. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  666. {LFS_FROM_REGION, entry->off, &(struct lfs_region_region){
  667. olddir.pair[0], oldoff,
  668. regions, count}, entry->size}}, 1);
  669. if (err) {
  670. return err;
  671. }
  672. // update pred dir, unless pred == old we can coalesce
  673. if (!oldsize || lfs_paircmp(pdir.pair, olddir.pair) != 0) {
  674. pdir.d.size |= 0x80000000;
  675. pdir.d.tail[0] = dir->pair[0];
  676. pdir.d.tail[1] = dir->pair[1];
  677. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  678. if (err) {
  679. return err;
  680. }
  681. } else if (oldsize) {
  682. olddir.d.size |= 0x80000000;
  683. olddir.d.tail[0] = dir->pair[0];
  684. olddir.d.tail[1] = dir->pair[1];
  685. }
  686. // remove old entry
  687. if (oldsize) {
  688. lfs_entry_t oldentry;
  689. oldentry.off = oldoff;
  690. err = lfs_dir_set(lfs, &olddir, &oldentry, (struct lfs_region[]){
  691. {LFS_FROM_DROP, 0, NULL, -oldsize}}, 1);
  692. if (err) {
  693. return err;
  694. }
  695. }
  696. goto shift;
  697. }
  698. if ((0x7fffffff & dir->d.size) + diff == sizeof(dir->d)+4) {
  699. lfs_dir_t pdir;
  700. int res = lfs_pred(lfs, dir->pair, &pdir);
  701. if (res < 0) {
  702. return res;
  703. }
  704. if (pdir.d.size & 0x80000000) {
  705. pdir.d.size &= dir->d.size | 0x7fffffff;
  706. pdir.d.tail[0] = dir->d.tail[0];
  707. pdir.d.tail[1] = dir->d.tail[1];
  708. int err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  709. if (err) {
  710. return err;
  711. }
  712. goto shift;
  713. }
  714. }
  715. for (int i = 0; i < count; i++) {
  716. regions[i].off += entry->off;
  717. }
  718. int err = lfs_dir_commit(lfs, dir, regions, count);
  719. if (err) {
  720. return err;
  721. }
  722. entry->size += diff;
  723. shift:
  724. // shift over any files/directories that are affected
  725. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  726. if (lfs_paircmp(f->pair, dir->pair) == 0) {
  727. if (f->poff == entry->off && entry->size == 0) {
  728. f->pair[0] = 0xffffffff;
  729. f->pair[1] = 0xffffffff;
  730. } else if (f->poff > entry->off) {
  731. f->poff += diff;
  732. }
  733. }
  734. }
  735. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  736. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  737. if (d->off > entry->off) {
  738. d->off += diff;
  739. d->pos += diff;
  740. }
  741. }
  742. }
  743. return 0;
  744. }
  745. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  746. while (dir->off >= (0x7fffffff & dir->d.size)-4) {
  747. if (!(0x80000000 & dir->d.size)) {
  748. entry->off = dir->off;
  749. return LFS_ERR_NOENT;
  750. }
  751. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  752. if (err) {
  753. return err;
  754. }
  755. dir->off = sizeof(dir->d);
  756. dir->pos += sizeof(dir->d) + 4;
  757. }
  758. int err = lfs_dir_get(lfs, dir, dir->off, &entry->d, sizeof(entry->d));
  759. lfs_entry_fromle32(&entry->d);
  760. if (err) {
  761. return err;
  762. }
  763. entry->off = dir->off;
  764. entry->size = lfs_entry_size(entry);
  765. dir->off += entry->size;
  766. dir->pos += entry->size;
  767. return 0;
  768. }
  769. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  770. lfs_entry_t *entry, const char **path) {
  771. const char *pathname = *path;
  772. lfs_size_t pathlen;
  773. while (true) {
  774. nextname:
  775. // skip slashes
  776. pathname += strspn(pathname, "/");
  777. pathlen = strcspn(pathname, "/");
  778. // special case for root dir
  779. if (pathname[0] == '\0') {
  780. *entry = (lfs_entry_t){
  781. .d.type = LFS_STRUCT_DIR | LFS_TYPE_DIR,
  782. .d.u.dir[0] = lfs->root[0],
  783. .d.u.dir[1] = lfs->root[1],
  784. };
  785. return 0;
  786. }
  787. // skip '.' and root '..'
  788. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  789. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  790. pathname += pathlen;
  791. goto nextname;
  792. }
  793. // skip if matched by '..' in name
  794. const char *suffix = pathname + pathlen;
  795. lfs_size_t sufflen;
  796. int depth = 1;
  797. while (true) {
  798. suffix += strspn(suffix, "/");
  799. sufflen = strcspn(suffix, "/");
  800. if (sufflen == 0) {
  801. break;
  802. }
  803. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  804. depth -= 1;
  805. if (depth == 0) {
  806. pathname = suffix + sufflen;
  807. goto nextname;
  808. }
  809. } else {
  810. depth += 1;
  811. }
  812. suffix += sufflen;
  813. }
  814. // update what we've found
  815. *path = pathname;
  816. // find path
  817. while (true) {
  818. int err = lfs_dir_next(lfs, dir, entry);
  819. if (err) {
  820. return err;
  821. }
  822. if (((0xf & entry->d.type) != LFS_TYPE_REG &&
  823. (0xf & entry->d.type) != LFS_TYPE_DIR) ||
  824. entry->d.nlen != pathlen) {
  825. continue;
  826. }
  827. int res = lfs_bd_cmp(lfs, dir->pair[0],
  828. entry->off + entry->size - pathlen,
  829. pathname, pathlen);
  830. if (res < 0) {
  831. return res;
  832. }
  833. // found match
  834. if (res) {
  835. break;
  836. }
  837. }
  838. // check that entry has not been moved
  839. if (entry->d.type & LFS_STRUCT_MOVED) {
  840. int moved = lfs_moved(lfs, &entry->d.u);
  841. if (moved < 0 || moved) {
  842. return (moved < 0) ? moved : LFS_ERR_NOENT;
  843. }
  844. entry->d.type &= ~LFS_STRUCT_MOVED;
  845. }
  846. pathname += pathlen;
  847. pathname += strspn(pathname, "/");
  848. if (pathname[0] == '\0') {
  849. return 0;
  850. }
  851. // continue on if we hit a directory
  852. if ((0xf & entry->d.type) != LFS_TYPE_DIR) {
  853. return LFS_ERR_NOTDIR;
  854. }
  855. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  856. if (err) {
  857. return err;
  858. }
  859. }
  860. }
  861. /// Internal attribute operations ///
  862. static int lfs_dir_getinfo(lfs_t *lfs,
  863. lfs_dir_t *dir, const lfs_entry_t *entry, struct lfs_info *info) {
  864. memset(info, 0, sizeof(*info));
  865. info->type = 0xf & entry->d.type;
  866. if (entry->d.type == (LFS_STRUCT_CTZ | LFS_TYPE_REG)) {
  867. info->size = entry->d.u.file.size;
  868. } else if (entry->d.type == (LFS_STRUCT_INLINE | LFS_TYPE_REG)) {
  869. info->size = lfs_entry_elen(entry);
  870. }
  871. if (lfs_paircmp(entry->d.u.dir, lfs->root) == 0) {
  872. strcpy(info->name, "/");
  873. } else {
  874. int err = lfs_dir_get(lfs, dir,
  875. entry->off + entry->size - entry->d.nlen,
  876. info->name, entry->d.nlen);
  877. if (err) {
  878. return err;
  879. }
  880. }
  881. return 0;
  882. }
  883. static int lfs_dir_getattr(lfs_t *lfs,
  884. lfs_dir_t *dir, const lfs_entry_t *entry,
  885. uint8_t type, void *buffer, lfs_size_t size) {
  886. // search for attribute in attribute region
  887. lfs_off_t off = sizeof(dir->d) + lfs_entry_elen(entry);
  888. lfs_off_t i = 0;
  889. while (i < lfs_entry_alen(entry)) {
  890. lfs_attr_t attr;
  891. int err = lfs_dir_get(lfs, dir,
  892. entry->off+off+i, &attr.d, sizeof(attr.d));
  893. if (err) {
  894. return err;
  895. }
  896. if (attr.d.type != type) {
  897. i += attr.d.len;
  898. continue;
  899. }
  900. if (attr.d.len > size) {
  901. return LFS_ERR_RANGE;
  902. }
  903. err = lfs_dir_get(lfs, dir,
  904. entry->off+off+i+sizeof(attr.d), buffer, attr.d.len);
  905. if (err) {
  906. return err;
  907. }
  908. return attr.d.len;
  909. }
  910. return LFS_ERR_NODATA;
  911. }
  912. static int lfs_dir_setattr(lfs_t *lfs,
  913. lfs_dir_t *dir, lfs_entry_t *entry,
  914. uint8_t type, const void *buffer, lfs_size_t size) {
  915. // search for attribute in attribute region
  916. lfs_off_t off = sizeof(dir->d) + lfs_entry_elen(entry);
  917. lfs_off_t i = 0;
  918. lfs_size_t oldlen = 0;
  919. while (i < lfs_entry_alen(entry)) {
  920. lfs_attr_t attr;
  921. int err = lfs_dir_get(lfs, dir,
  922. entry->off+off+i, &attr.d, sizeof(attr.d));
  923. if (err) {
  924. return err;
  925. }
  926. if (attr.d.type != type) {
  927. i += attr.d.len;
  928. continue;
  929. }
  930. oldlen = attr.d.len;
  931. break;
  932. }
  933. // make sure the attribute fits
  934. if (lfs_entry_elen(entry) - oldlen + size > lfs->attrs_size ||
  935. (0x7fffffff & dir->d.size) - oldlen + size > lfs->cfg->block_size) {
  936. return LFS_ERR_NOSPC;
  937. }
  938. lfs_attr_t attr;
  939. attr.d.type = type;
  940. attr.d.len = size;
  941. int err = lfs_dir_set(lfs, dir, entry, (struct lfs_region[]){
  942. {LFS_FROM_MEM, off+i, &attr.d, sizeof(attr.d)},
  943. {LFS_FROM_MEM, off+i, buffer, size},
  944. {LFS_FROM_DROP, off+i, NULL, -oldlen}}, 3);
  945. if (err) {
  946. return err;
  947. }
  948. return 0;
  949. }
  950. static int lfs_dir_removeattr(lfs_t *lfs,
  951. lfs_dir_t *dir, lfs_entry_t *entry, uint8_t type) {
  952. // search for attribute in attribute region
  953. lfs_off_t off = sizeof(dir->d) + lfs_entry_elen(entry);
  954. lfs_off_t i = 0;
  955. while (i < lfs_entry_alen(entry)) {
  956. lfs_attr_t attr;
  957. int err = lfs_dir_get(lfs, dir,
  958. entry->off+off+i, &attr.d, sizeof(attr.d));
  959. if (err) {
  960. return err;
  961. }
  962. if (attr.d.type != type) {
  963. i += attr.d.len;
  964. continue;
  965. }
  966. err = lfs_dir_set(lfs, dir, entry, (struct lfs_region[]){
  967. {LFS_FROM_DROP, off+i,
  968. NULL, -(sizeof(attr.d)+attr.d.len)}}, 1);
  969. if (err) {
  970. return err;
  971. }
  972. return 0;
  973. }
  974. return LFS_ERR_NODATA;
  975. }
  976. /// Top level directory operations ///
  977. int lfs_mkdir(lfs_t *lfs, const char *path) {
  978. // deorphan if we haven't yet, needed at most once after poweron
  979. if (!lfs->deorphaned) {
  980. int err = lfs_deorphan(lfs);
  981. if (err) {
  982. return err;
  983. }
  984. }
  985. // fetch parent directory
  986. lfs_dir_t cwd;
  987. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  988. if (err) {
  989. return err;
  990. }
  991. lfs_entry_t entry;
  992. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  993. if (err != LFS_ERR_NOENT || strchr(path, '/') != NULL) {
  994. return err ? err : LFS_ERR_EXIST;
  995. }
  996. // check that name fits
  997. lfs_size_t nlen = strlen(path);
  998. if (nlen > lfs->name_size) {
  999. return LFS_ERR_NAMETOOLONG;
  1000. }
  1001. // build up new directory
  1002. lfs_alloc_ack(lfs);
  1003. lfs_dir_t dir;
  1004. err = lfs_dir_alloc(lfs, &dir);
  1005. if (err) {
  1006. return err;
  1007. }
  1008. dir.d.tail[0] = cwd.d.tail[0];
  1009. dir.d.tail[1] = cwd.d.tail[1];
  1010. err = lfs_dir_commit(lfs, &dir, NULL, 0);
  1011. if (err) {
  1012. return err;
  1013. }
  1014. entry.d.type = LFS_STRUCT_DIR | LFS_TYPE_DIR;
  1015. entry.d.elen = sizeof(entry.d) - 4;
  1016. entry.d.alen = 0;
  1017. entry.d.nlen = nlen;
  1018. entry.d.u.dir[0] = dir.pair[0];
  1019. entry.d.u.dir[1] = dir.pair[1];
  1020. entry.size = 0;
  1021. cwd.d.tail[0] = dir.pair[0];
  1022. cwd.d.tail[1] = dir.pair[1];
  1023. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1024. {LFS_FROM_MEM, 0, &entry.d, sizeof(entry.d)},
  1025. {LFS_FROM_MEM, 0, path, nlen}}, 2);
  1026. if (err) {
  1027. return err;
  1028. }
  1029. lfs_alloc_ack(lfs);
  1030. return 0;
  1031. }
  1032. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1033. dir->pair[0] = lfs->root[0];
  1034. dir->pair[1] = lfs->root[1];
  1035. int err = lfs_dir_fetch(lfs, dir, dir->pair);
  1036. if (err) {
  1037. return err;
  1038. }
  1039. lfs_entry_t entry;
  1040. err = lfs_dir_find(lfs, dir, &entry, &path);
  1041. if (err) {
  1042. return err;
  1043. } else if (entry.d.type != (LFS_STRUCT_DIR | LFS_TYPE_DIR)) {
  1044. return LFS_ERR_NOTDIR;
  1045. }
  1046. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  1047. if (err) {
  1048. return err;
  1049. }
  1050. // setup head dir
  1051. // special offset for '.' and '..'
  1052. dir->head[0] = dir->pair[0];
  1053. dir->head[1] = dir->pair[1];
  1054. dir->pos = sizeof(dir->d) - 2;
  1055. dir->off = sizeof(dir->d);
  1056. // add to list of directories
  1057. dir->next = lfs->dirs;
  1058. lfs->dirs = dir;
  1059. return 0;
  1060. }
  1061. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1062. // remove from list of directories
  1063. for (lfs_dir_t **p = &lfs->dirs; *p; p = &(*p)->next) {
  1064. if (*p == dir) {
  1065. *p = dir->next;
  1066. break;
  1067. }
  1068. }
  1069. return 0;
  1070. }
  1071. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1072. memset(info, 0, sizeof(*info));
  1073. // special offset for '.' and '..'
  1074. if (dir->pos == sizeof(dir->d) - 2) {
  1075. info->type = LFS_TYPE_DIR;
  1076. strcpy(info->name, ".");
  1077. dir->pos += 1;
  1078. return 1;
  1079. } else if (dir->pos == sizeof(dir->d) - 1) {
  1080. info->type = LFS_TYPE_DIR;
  1081. strcpy(info->name, "..");
  1082. dir->pos += 1;
  1083. return 1;
  1084. }
  1085. lfs_entry_t entry;
  1086. while (true) {
  1087. int err = lfs_dir_next(lfs, dir, &entry);
  1088. if (err) {
  1089. return (err == LFS_ERR_NOENT) ? 0 : err;
  1090. }
  1091. if ((0xf & entry.d.type) != LFS_TYPE_REG &&
  1092. (0xf & entry.d.type) != LFS_TYPE_DIR) {
  1093. continue;
  1094. }
  1095. // check that entry has not been moved
  1096. if (entry.d.type & LFS_STRUCT_MOVED) {
  1097. int moved = lfs_moved(lfs, &entry.d.u);
  1098. if (moved < 0) {
  1099. return moved;
  1100. }
  1101. if (moved) {
  1102. continue;
  1103. }
  1104. entry.d.type &= ~LFS_STRUCT_MOVED;
  1105. }
  1106. break;
  1107. }
  1108. int err = lfs_dir_getinfo(lfs, dir, &entry, info);
  1109. if (err) {
  1110. return err;
  1111. }
  1112. return 1;
  1113. }
  1114. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1115. // simply walk from head dir
  1116. int err = lfs_dir_rewind(lfs, dir);
  1117. if (err) {
  1118. return err;
  1119. }
  1120. dir->pos = off;
  1121. while (off > (0x7fffffff & dir->d.size)) {
  1122. off -= 0x7fffffff & dir->d.size;
  1123. if (!(0x80000000 & dir->d.size)) {
  1124. return LFS_ERR_INVAL;
  1125. }
  1126. err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  1127. if (err) {
  1128. return err;
  1129. }
  1130. }
  1131. dir->off = off;
  1132. return 0;
  1133. }
  1134. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1135. (void)lfs;
  1136. return dir->pos;
  1137. }
  1138. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1139. // reload the head dir
  1140. int err = lfs_dir_fetch(lfs, dir, dir->head);
  1141. if (err) {
  1142. return err;
  1143. }
  1144. dir->pair[0] = dir->head[0];
  1145. dir->pair[1] = dir->head[1];
  1146. dir->pos = sizeof(dir->d) - 2;
  1147. dir->off = sizeof(dir->d);
  1148. return 0;
  1149. }
  1150. /// File index list operations ///
  1151. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1152. lfs_off_t size = *off;
  1153. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1154. lfs_off_t i = size / b;
  1155. if (i == 0) {
  1156. return 0;
  1157. }
  1158. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1159. *off = size - b*i - 4*lfs_popc(i);
  1160. return i;
  1161. }
  1162. static int lfs_ctz_find(lfs_t *lfs,
  1163. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1164. lfs_block_t head, lfs_size_t size,
  1165. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1166. if (size == 0) {
  1167. *block = 0xffffffff;
  1168. *off = 0;
  1169. return 0;
  1170. }
  1171. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1172. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1173. while (current > target) {
  1174. lfs_size_t skip = lfs_min(
  1175. lfs_npw2(current-target+1) - 1,
  1176. lfs_ctz(current));
  1177. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  1178. head = lfs_fromle32(head);
  1179. if (err) {
  1180. return err;
  1181. }
  1182. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1183. current -= 1 << skip;
  1184. }
  1185. *block = head;
  1186. *off = pos;
  1187. return 0;
  1188. }
  1189. static int lfs_ctz_extend(lfs_t *lfs,
  1190. lfs_cache_t *rcache, lfs_cache_t *pcache,
  1191. lfs_block_t head, lfs_size_t size,
  1192. lfs_block_t *block, lfs_off_t *off) {
  1193. while (true) {
  1194. // go ahead and grab a block
  1195. lfs_block_t nblock;
  1196. int err = lfs_alloc(lfs, &nblock);
  1197. if (err) {
  1198. return err;
  1199. }
  1200. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1201. if (true) {
  1202. err = lfs_bd_erase(lfs, nblock);
  1203. if (err) {
  1204. if (err == LFS_ERR_CORRUPT) {
  1205. goto relocate;
  1206. }
  1207. return err;
  1208. }
  1209. if (size == 0) {
  1210. *block = nblock;
  1211. *off = 0;
  1212. return 0;
  1213. }
  1214. size -= 1;
  1215. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1216. size += 1;
  1217. // just copy out the last block if it is incomplete
  1218. if (size != lfs->cfg->block_size) {
  1219. for (lfs_off_t i = 0; i < size; i++) {
  1220. uint8_t data;
  1221. err = lfs_cache_read(lfs, rcache, NULL,
  1222. head, i, &data, 1);
  1223. if (err) {
  1224. return err;
  1225. }
  1226. err = lfs_cache_prog(lfs, pcache, rcache,
  1227. nblock, i, &data, 1);
  1228. if (err) {
  1229. if (err == LFS_ERR_CORRUPT) {
  1230. goto relocate;
  1231. }
  1232. return err;
  1233. }
  1234. }
  1235. *block = nblock;
  1236. *off = size;
  1237. return 0;
  1238. }
  1239. // append block
  1240. index += 1;
  1241. lfs_size_t skips = lfs_ctz(index) + 1;
  1242. for (lfs_off_t i = 0; i < skips; i++) {
  1243. head = lfs_tole32(head);
  1244. err = lfs_cache_prog(lfs, pcache, rcache,
  1245. nblock, 4*i, &head, 4);
  1246. head = lfs_fromle32(head);
  1247. if (err) {
  1248. if (err == LFS_ERR_CORRUPT) {
  1249. goto relocate;
  1250. }
  1251. return err;
  1252. }
  1253. if (i != skips-1) {
  1254. err = lfs_cache_read(lfs, rcache, NULL,
  1255. head, 4*i, &head, 4);
  1256. head = lfs_fromle32(head);
  1257. if (err) {
  1258. return err;
  1259. }
  1260. }
  1261. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1262. }
  1263. *block = nblock;
  1264. *off = 4*skips;
  1265. return 0;
  1266. }
  1267. relocate:
  1268. LFS_DEBUG("Bad block at %d", nblock);
  1269. // just clear cache and try a new block
  1270. pcache->block = 0xffffffff;
  1271. }
  1272. }
  1273. static int lfs_ctz_traverse(lfs_t *lfs,
  1274. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1275. lfs_block_t head, lfs_size_t size,
  1276. int (*cb)(void*, lfs_block_t), void *data) {
  1277. if (size == 0) {
  1278. return 0;
  1279. }
  1280. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1281. while (true) {
  1282. int err = cb(data, head);
  1283. if (err) {
  1284. return err;
  1285. }
  1286. if (index == 0) {
  1287. return 0;
  1288. }
  1289. lfs_block_t heads[2];
  1290. int count = 2 - (index & 1);
  1291. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &heads, count*4);
  1292. heads[0] = lfs_fromle32(heads[0]);
  1293. heads[1] = lfs_fromle32(heads[1]);
  1294. if (err) {
  1295. return err;
  1296. }
  1297. for (int i = 0; i < count-1; i++) {
  1298. err = cb(data, heads[i]);
  1299. if (err) {
  1300. return err;
  1301. }
  1302. }
  1303. head = heads[count-1];
  1304. index -= count;
  1305. }
  1306. }
  1307. /// Top level file operations ///
  1308. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1309. const char *path, int flags) {
  1310. // deorphan if we haven't yet, needed at most once after poweron
  1311. if ((flags & 3) != LFS_O_RDONLY && !lfs->deorphaned) {
  1312. int err = lfs_deorphan(lfs);
  1313. if (err) {
  1314. return err;
  1315. }
  1316. }
  1317. // allocate entry for file if it doesn't exist
  1318. lfs_dir_t cwd;
  1319. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1320. if (err) {
  1321. return err;
  1322. }
  1323. lfs_entry_t entry;
  1324. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1325. if (err && (err != LFS_ERR_NOENT || strchr(path, '/') != NULL)) {
  1326. return err;
  1327. }
  1328. if (err == LFS_ERR_NOENT) {
  1329. if (!(flags & LFS_O_CREAT)) {
  1330. return LFS_ERR_NOENT;
  1331. }
  1332. // check that name fits
  1333. lfs_size_t nlen = strlen(path);
  1334. if (nlen > lfs->name_size) {
  1335. return LFS_ERR_NAMETOOLONG;
  1336. }
  1337. // create entry to remember name
  1338. entry.d.type = LFS_STRUCT_INLINE | LFS_TYPE_REG;
  1339. entry.d.elen = 0;
  1340. entry.d.alen = 0;
  1341. entry.d.nlen = nlen;
  1342. entry.size = 0;
  1343. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1344. {LFS_FROM_MEM, 0, &entry.d, 4},
  1345. {LFS_FROM_MEM, 0, path, nlen}}, 2);
  1346. if (err) {
  1347. return err;
  1348. }
  1349. } else if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1350. return LFS_ERR_ISDIR;
  1351. } else if (flags & LFS_O_EXCL) {
  1352. return LFS_ERR_EXIST;
  1353. }
  1354. // allocate buffer if needed
  1355. file->cache.block = 0xffffffff;
  1356. if (lfs->cfg->file_buffer) {
  1357. file->cache.buffer = lfs->cfg->file_buffer;
  1358. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  1359. file->cache.buffer = lfs_malloc(lfs->cfg->read_size);
  1360. if (!file->cache.buffer) {
  1361. return LFS_ERR_NOMEM;
  1362. }
  1363. } else {
  1364. file->cache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1365. if (!file->cache.buffer) {
  1366. return LFS_ERR_NOMEM;
  1367. }
  1368. }
  1369. // setup file struct
  1370. file->pair[0] = cwd.pair[0];
  1371. file->pair[1] = cwd.pair[1];
  1372. file->poff = entry.off;
  1373. file->flags = flags;
  1374. file->pos = 0;
  1375. // calculate max inline size based on the size of the entry
  1376. file->inline_size = lfs_min(lfs->inline_size,
  1377. lfs->cfg->block_size - (sizeof(cwd.d)+4) -
  1378. (lfs_entry_size(&entry) - lfs_entry_elen(&entry)));
  1379. if ((0x70 & entry.d.type) == LFS_STRUCT_INLINE) {
  1380. // load inline files
  1381. file->head = 0xfffffffe;
  1382. file->size = lfs_entry_elen(&entry);
  1383. file->flags |= LFS_F_INLINE;
  1384. file->cache.block = file->head;
  1385. file->cache.off = 0;
  1386. err = lfs_dir_get(lfs, &cwd,
  1387. entry.off + 4,
  1388. file->cache.buffer, file->size);
  1389. if (err) {
  1390. lfs_free(file->cache.buffer);
  1391. return err;
  1392. }
  1393. } else {
  1394. // use ctz list from entry
  1395. file->head = entry.d.u.file.head;
  1396. file->size = entry.d.u.file.size;
  1397. }
  1398. // truncate if requested
  1399. if (flags & LFS_O_TRUNC) {
  1400. if (file->size != 0) {
  1401. file->flags |= LFS_F_DIRTY;
  1402. }
  1403. file->head = 0xfffffffe;
  1404. file->size = 0;
  1405. file->flags |= LFS_F_INLINE;
  1406. file->cache.block = file->head;
  1407. file->cache.off = 0;
  1408. }
  1409. // add to list of files
  1410. file->next = lfs->files;
  1411. lfs->files = file;
  1412. return 0;
  1413. }
  1414. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1415. int err = lfs_file_sync(lfs, file);
  1416. // remove from list of files
  1417. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  1418. if (*p == file) {
  1419. *p = file->next;
  1420. break;
  1421. }
  1422. }
  1423. // clean up memory
  1424. if (!lfs->cfg->file_buffer) {
  1425. lfs_free(file->cache.buffer);
  1426. }
  1427. return err;
  1428. }
  1429. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1430. relocate:;
  1431. // just relocate what exists into new block
  1432. lfs_block_t nblock;
  1433. int err = lfs_alloc(lfs, &nblock);
  1434. if (err) {
  1435. return err;
  1436. }
  1437. err = lfs_bd_erase(lfs, nblock);
  1438. if (err) {
  1439. if (err == LFS_ERR_CORRUPT) {
  1440. goto relocate;
  1441. }
  1442. return err;
  1443. }
  1444. // either read from dirty cache or disk
  1445. for (lfs_off_t i = 0; i < file->off; i++) {
  1446. uint8_t data;
  1447. err = lfs_cache_read(lfs, &lfs->rcache, &file->cache,
  1448. file->block, i, &data, 1);
  1449. if (err) {
  1450. return err;
  1451. }
  1452. err = lfs_cache_prog(lfs, &lfs->pcache, &lfs->rcache,
  1453. nblock, i, &data, 1);
  1454. if (err) {
  1455. if (err == LFS_ERR_CORRUPT) {
  1456. goto relocate;
  1457. }
  1458. return err;
  1459. }
  1460. }
  1461. // copy over new state of file
  1462. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->prog_size);
  1463. file->cache.block = lfs->pcache.block;
  1464. file->cache.off = lfs->pcache.off;
  1465. lfs->pcache.block = 0xffffffff;
  1466. file->block = nblock;
  1467. return 0;
  1468. }
  1469. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  1470. if (file->flags & LFS_F_READING) {
  1471. file->flags &= ~LFS_F_READING;
  1472. }
  1473. if (file->flags & LFS_F_WRITING) {
  1474. lfs_off_t pos = file->pos;
  1475. if (!(file->flags & LFS_F_INLINE)) {
  1476. // copy over anything after current branch
  1477. lfs_file_t orig = {
  1478. .head = file->head,
  1479. .size = file->size,
  1480. .flags = LFS_O_RDONLY,
  1481. .pos = file->pos,
  1482. .cache = lfs->rcache,
  1483. };
  1484. lfs->rcache.block = 0xffffffff;
  1485. while (file->pos < file->size) {
  1486. // copy over a byte at a time, leave it up to caching
  1487. // to make this efficient
  1488. uint8_t data;
  1489. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  1490. if (res < 0) {
  1491. return res;
  1492. }
  1493. res = lfs_file_write(lfs, file, &data, 1);
  1494. if (res < 0) {
  1495. return res;
  1496. }
  1497. // keep our reference to the rcache in sync
  1498. if (lfs->rcache.block != 0xffffffff) {
  1499. orig.cache.block = 0xffffffff;
  1500. lfs->rcache.block = 0xffffffff;
  1501. }
  1502. }
  1503. // write out what we have
  1504. while (true) {
  1505. int err = lfs_cache_flush(lfs, &file->cache, &lfs->rcache);
  1506. if (err) {
  1507. if (err == LFS_ERR_CORRUPT) {
  1508. goto relocate;
  1509. }
  1510. return err;
  1511. }
  1512. break;
  1513. relocate:
  1514. LFS_DEBUG("Bad block at %d", file->block);
  1515. err = lfs_file_relocate(lfs, file);
  1516. if (err) {
  1517. return err;
  1518. }
  1519. }
  1520. } else {
  1521. file->size = lfs_max(file->pos, file->size);
  1522. }
  1523. // actual file updates
  1524. file->head = file->block;
  1525. file->size = file->pos;
  1526. file->flags &= ~LFS_F_WRITING;
  1527. file->flags |= LFS_F_DIRTY;
  1528. file->pos = pos;
  1529. }
  1530. return 0;
  1531. }
  1532. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  1533. int err = lfs_file_flush(lfs, file);
  1534. if (err) {
  1535. return err;
  1536. }
  1537. if ((file->flags & LFS_F_DIRTY) &&
  1538. !(file->flags & LFS_F_ERRED) &&
  1539. !lfs_pairisnull(file->pair)) {
  1540. // update dir entry
  1541. lfs_dir_t cwd;
  1542. err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1543. if (err) {
  1544. return err;
  1545. }
  1546. lfs_entry_t entry = {.off = file->poff};
  1547. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, sizeof(entry.d));
  1548. lfs_entry_fromle32(&entry.d);
  1549. if (err) {
  1550. return err;
  1551. }
  1552. LFS_ASSERT((0xf & entry.d.type) == LFS_TYPE_REG);
  1553. lfs_size_t oldlen = lfs_entry_elen(&entry);
  1554. entry.size = lfs_entry_size(&entry);
  1555. // either update the references or inline the whole file
  1556. if (!(file->flags & LFS_F_INLINE)) {
  1557. entry.d.type = LFS_STRUCT_CTZ | LFS_TYPE_REG;
  1558. entry.d.elen = sizeof(entry.d)-4;
  1559. entry.d.u.file.head = file->head;
  1560. entry.d.u.file.size = file->size;
  1561. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1562. {LFS_FROM_MEM, 0, &entry.d, sizeof(entry.d)},
  1563. {LFS_FROM_DROP, 0, NULL, -oldlen-4}}, 2);
  1564. if (err) {
  1565. return err;
  1566. }
  1567. } else {
  1568. entry.d.type = LFS_STRUCT_INLINE | LFS_TYPE_REG;
  1569. entry.d.elen = file->size & 0xff;
  1570. entry.d.alen = (entry.d.alen & 0x3f) | ((file->size >> 2) & 0xc0);
  1571. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1572. {LFS_FROM_MEM, 0, &entry.d, 4},
  1573. {LFS_FROM_MEM, 0, file->cache.buffer, file->size},
  1574. {LFS_FROM_DROP, 0, NULL, -oldlen-4}}, 3);
  1575. if (err) {
  1576. return err;
  1577. }
  1578. }
  1579. file->flags &= ~LFS_F_DIRTY;
  1580. }
  1581. return 0;
  1582. }
  1583. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  1584. void *buffer, lfs_size_t size) {
  1585. uint8_t *data = buffer;
  1586. lfs_size_t nsize = size;
  1587. if ((file->flags & 3) == LFS_O_WRONLY) {
  1588. return LFS_ERR_BADF;
  1589. }
  1590. if (file->flags & LFS_F_WRITING) {
  1591. // flush out any writes
  1592. int err = lfs_file_flush(lfs, file);
  1593. if (err) {
  1594. return err;
  1595. }
  1596. }
  1597. if (file->pos >= file->size) {
  1598. // eof if past end
  1599. return 0;
  1600. }
  1601. size = lfs_min(size, file->size - file->pos);
  1602. nsize = size;
  1603. while (nsize > 0) {
  1604. // check if we need a new block
  1605. if (!(file->flags & LFS_F_READING) ||
  1606. file->off == lfs->cfg->block_size) {
  1607. if (!(file->flags & LFS_F_INLINE)) {
  1608. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1609. file->head, file->size,
  1610. file->pos, &file->block, &file->off);
  1611. if (err) {
  1612. return err;
  1613. }
  1614. } else {
  1615. file->block = 0xfffffffe;
  1616. file->off = file->pos;
  1617. }
  1618. file->flags |= LFS_F_READING;
  1619. }
  1620. // read as much as we can in current block
  1621. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1622. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1623. file->block, file->off, data, diff);
  1624. if (err) {
  1625. return err;
  1626. }
  1627. file->pos += diff;
  1628. file->off += diff;
  1629. data += diff;
  1630. nsize -= diff;
  1631. }
  1632. return size;
  1633. }
  1634. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1635. const void *buffer, lfs_size_t size) {
  1636. const uint8_t *data = buffer;
  1637. lfs_size_t nsize = size;
  1638. if ((file->flags & 3) == LFS_O_RDONLY) {
  1639. return LFS_ERR_BADF;
  1640. }
  1641. if (file->flags & LFS_F_READING) {
  1642. // drop any reads
  1643. int err = lfs_file_flush(lfs, file);
  1644. if (err) {
  1645. return err;
  1646. }
  1647. }
  1648. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1649. file->pos = file->size;
  1650. }
  1651. if (!(file->flags & LFS_F_WRITING) && file->pos > file->size) {
  1652. // fill with zeros
  1653. lfs_off_t pos = file->pos;
  1654. file->pos = file->size;
  1655. while (file->pos < pos) {
  1656. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1657. if (res < 0) {
  1658. return res;
  1659. }
  1660. }
  1661. }
  1662. if ((file->flags & LFS_F_INLINE) &&
  1663. file->pos + nsize >= file->inline_size) {
  1664. // inline file doesn't fit anymore
  1665. file->block = 0xfffffffe;
  1666. file->off = file->pos;
  1667. lfs_alloc_ack(lfs);
  1668. int err = lfs_file_relocate(lfs, file);
  1669. if (err) {
  1670. file->flags |= LFS_F_ERRED;
  1671. return err;
  1672. }
  1673. file->flags &= ~LFS_F_INLINE;
  1674. file->flags |= LFS_F_WRITING;
  1675. }
  1676. while (nsize > 0) {
  1677. // check if we need a new block
  1678. if (!(file->flags & LFS_F_WRITING) ||
  1679. file->off == lfs->cfg->block_size) {
  1680. if (!(file->flags & LFS_F_INLINE)) {
  1681. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  1682. // find out which block we're extending from
  1683. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1684. file->head, file->size,
  1685. file->pos-1, &file->block, &file->off);
  1686. if (err) {
  1687. file->flags |= LFS_F_ERRED;
  1688. return err;
  1689. }
  1690. // mark cache as dirty since we may have read data into it
  1691. file->cache.block = 0xffffffff;
  1692. }
  1693. // extend file with new blocks
  1694. lfs_alloc_ack(lfs);
  1695. int err = lfs_ctz_extend(lfs, &lfs->rcache, &file->cache,
  1696. file->block, file->pos,
  1697. &file->block, &file->off);
  1698. if (err) {
  1699. file->flags |= LFS_F_ERRED;
  1700. return err;
  1701. }
  1702. } else {
  1703. file->block = 0xfffffffe;
  1704. file->off = file->pos;
  1705. }
  1706. file->flags |= LFS_F_WRITING;
  1707. }
  1708. // program as much as we can in current block
  1709. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1710. while (true) {
  1711. int err = lfs_cache_prog(lfs, &file->cache, &lfs->rcache,
  1712. file->block, file->off, data, diff);
  1713. if (err) {
  1714. if (err == LFS_ERR_CORRUPT) {
  1715. goto relocate;
  1716. }
  1717. file->flags |= LFS_F_ERRED;
  1718. return err;
  1719. }
  1720. break;
  1721. relocate:
  1722. err = lfs_file_relocate(lfs, file);
  1723. if (err) {
  1724. file->flags |= LFS_F_ERRED;
  1725. return err;
  1726. }
  1727. }
  1728. file->pos += diff;
  1729. file->off += diff;
  1730. data += diff;
  1731. nsize -= diff;
  1732. lfs_alloc_ack(lfs);
  1733. }
  1734. file->flags &= ~LFS_F_ERRED;
  1735. return size;
  1736. }
  1737. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1738. lfs_soff_t off, int whence) {
  1739. // write out everything beforehand, may be noop if rdonly
  1740. int err = lfs_file_flush(lfs, file);
  1741. if (err) {
  1742. return err;
  1743. }
  1744. // update pos
  1745. if (whence == LFS_SEEK_SET) {
  1746. file->pos = off;
  1747. } else if (whence == LFS_SEEK_CUR) {
  1748. if (off < 0 && (lfs_off_t)-off > file->pos) {
  1749. return LFS_ERR_INVAL;
  1750. }
  1751. file->pos = file->pos + off;
  1752. } else if (whence == LFS_SEEK_END) {
  1753. if (off < 0 && (lfs_off_t)-off > file->size) {
  1754. return LFS_ERR_INVAL;
  1755. }
  1756. file->pos = file->size + off;
  1757. }
  1758. return file->pos;
  1759. }
  1760. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  1761. if ((file->flags & 3) == LFS_O_RDONLY) {
  1762. return LFS_ERR_BADF;
  1763. }
  1764. lfs_off_t oldsize = lfs_file_size(lfs, file);
  1765. if (size < oldsize) {
  1766. // need to flush since directly changing metadata
  1767. int err = lfs_file_flush(lfs, file);
  1768. if (err) {
  1769. return err;
  1770. }
  1771. // lookup new head in ctz skip list
  1772. err = lfs_ctz_find(lfs, &file->cache, NULL,
  1773. file->head, file->size,
  1774. size, &file->head, &(lfs_off_t){0});
  1775. if (err) {
  1776. return err;
  1777. }
  1778. file->size = size;
  1779. file->flags |= LFS_F_DIRTY;
  1780. } else if (size > oldsize) {
  1781. lfs_off_t pos = file->pos;
  1782. // flush+seek if not already at end
  1783. if (file->pos != oldsize) {
  1784. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  1785. if (err < 0) {
  1786. return err;
  1787. }
  1788. }
  1789. // fill with zeros
  1790. while (file->pos < size) {
  1791. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1792. if (res < 0) {
  1793. return res;
  1794. }
  1795. }
  1796. // restore pos
  1797. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  1798. if (err < 0) {
  1799. return err;
  1800. }
  1801. }
  1802. return 0;
  1803. }
  1804. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1805. (void)lfs;
  1806. return file->pos;
  1807. }
  1808. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1809. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1810. if (res < 0) {
  1811. return res;
  1812. }
  1813. return 0;
  1814. }
  1815. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1816. (void)lfs;
  1817. if (file->flags & LFS_F_WRITING) {
  1818. return lfs_max(file->pos, file->size);
  1819. } else {
  1820. return file->size;
  1821. }
  1822. }
  1823. /// General fs operations ///
  1824. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1825. lfs_dir_t cwd;
  1826. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1827. if (err) {
  1828. return err;
  1829. }
  1830. lfs_entry_t entry;
  1831. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1832. if (err) {
  1833. return err;
  1834. }
  1835. return lfs_dir_getinfo(lfs, &cwd, &entry, info);
  1836. }
  1837. int lfs_remove(lfs_t *lfs, const char *path) {
  1838. // deorphan if we haven't yet, needed at most once after poweron
  1839. if (!lfs->deorphaned) {
  1840. int err = lfs_deorphan(lfs);
  1841. if (err) {
  1842. return err;
  1843. }
  1844. }
  1845. lfs_dir_t cwd;
  1846. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1847. if (err) {
  1848. return err;
  1849. }
  1850. lfs_entry_t entry;
  1851. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1852. if (err) {
  1853. return err;
  1854. }
  1855. lfs_dir_t dir;
  1856. if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1857. // must be empty before removal, checking size
  1858. // without masking top bit checks for any case where
  1859. // dir is not empty
  1860. err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1861. if (err) {
  1862. return err;
  1863. } else if (dir.d.size != sizeof(dir.d)+4) {
  1864. return LFS_ERR_NOTEMPTY;
  1865. }
  1866. }
  1867. // remove the entry
  1868. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1869. {LFS_FROM_DROP, 0, NULL, -entry.size}}, 1);
  1870. if (err) {
  1871. return err;
  1872. }
  1873. // if we were a directory, find pred, replace tail
  1874. if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1875. int res = lfs_pred(lfs, dir.pair, &cwd);
  1876. if (res < 0) {
  1877. return res;
  1878. }
  1879. LFS_ASSERT(res); // must have pred
  1880. cwd.d.tail[0] = dir.d.tail[0];
  1881. cwd.d.tail[1] = dir.d.tail[1];
  1882. err = lfs_dir_commit(lfs, &cwd, NULL, 0);
  1883. if (err) {
  1884. return err;
  1885. }
  1886. }
  1887. return 0;
  1888. }
  1889. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  1890. // deorphan if we haven't yet, needed at most once after poweron
  1891. if (!lfs->deorphaned) {
  1892. int err = lfs_deorphan(lfs);
  1893. if (err) {
  1894. return err;
  1895. }
  1896. }
  1897. // find old entry
  1898. lfs_dir_t oldcwd;
  1899. int err = lfs_dir_fetch(lfs, &oldcwd, lfs->root);
  1900. if (err) {
  1901. return err;
  1902. }
  1903. lfs_entry_t oldentry;
  1904. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  1905. if (err) {
  1906. return err;
  1907. }
  1908. // allocate new entry
  1909. lfs_dir_t newcwd;
  1910. err = lfs_dir_fetch(lfs, &newcwd, lfs->root);
  1911. if (err) {
  1912. return err;
  1913. }
  1914. lfs_entry_t preventry;
  1915. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  1916. if (err && (err != LFS_ERR_NOENT || strchr(newpath, '/') != NULL)) {
  1917. return err;
  1918. }
  1919. bool prevexists = (err != LFS_ERR_NOENT);
  1920. bool samepair = (lfs_paircmp(oldcwd.pair, newcwd.pair) == 0);
  1921. // check that name fits
  1922. lfs_size_t nlen = strlen(newpath);
  1923. if (nlen > lfs->name_size) {
  1924. return LFS_ERR_NAMETOOLONG;
  1925. }
  1926. // must have same type
  1927. if (prevexists && preventry.d.type != oldentry.d.type) {
  1928. return LFS_ERR_ISDIR;
  1929. }
  1930. lfs_dir_t dir;
  1931. if (prevexists && (0xf & preventry.d.type) == LFS_TYPE_DIR) {
  1932. // must be empty before removal, checking size
  1933. // without masking top bit checks for any case where
  1934. // dir is not empty
  1935. err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  1936. if (err) {
  1937. return err;
  1938. } else if (dir.d.size != sizeof(dir.d)+4) {
  1939. return LFS_ERR_NOTEMPTY;
  1940. }
  1941. }
  1942. // mark as moving
  1943. oldentry.d.type |= LFS_STRUCT_MOVED;
  1944. err = lfs_dir_set(lfs, &oldcwd, &oldentry, (struct lfs_region[]){
  1945. {LFS_FROM_MEM, 0, &oldentry.d.type, 1},
  1946. {LFS_FROM_DROP, 0, NULL, -1}}, 2);
  1947. oldentry.d.type &= ~LFS_STRUCT_MOVED;
  1948. if (err) {
  1949. return err;
  1950. }
  1951. // update pair if newcwd == oldcwd
  1952. if (samepair) {
  1953. newcwd = oldcwd;
  1954. }
  1955. // move to new location
  1956. lfs_entry_t newentry = preventry;
  1957. newentry.d = oldentry.d;
  1958. newentry.d.type &= ~LFS_STRUCT_MOVED;
  1959. newentry.d.nlen = nlen;
  1960. if (!prevexists) {
  1961. newentry.size = 0;
  1962. }
  1963. lfs_size_t newsize = oldentry.size - oldentry.d.nlen + newentry.d.nlen;
  1964. err = lfs_dir_set(lfs, &newcwd, &newentry, (struct lfs_region[]){
  1965. {LFS_FROM_REGION, 0, &(struct lfs_region_region){
  1966. oldcwd.pair[0], oldentry.off, (struct lfs_region[]){
  1967. {LFS_FROM_MEM, 0, &newentry.d, 4},
  1968. {LFS_FROM_DROP, 0, NULL, -4},
  1969. {LFS_FROM_MEM, newsize - nlen, newpath, nlen}}, 3},
  1970. newsize},
  1971. {LFS_FROM_DROP, 0, NULL, -preventry.size}}, prevexists ? 2 : 1);
  1972. if (err) {
  1973. return err;
  1974. }
  1975. // update pair if newcwd == oldcwd
  1976. if (samepair) {
  1977. oldcwd = newcwd;
  1978. }
  1979. // remove old entry
  1980. err = lfs_dir_set(lfs, &oldcwd, &oldentry, (struct lfs_region[]){
  1981. {LFS_FROM_DROP, 0, NULL, -oldentry.size}}, 1);
  1982. if (err) {
  1983. return err;
  1984. }
  1985. // if we were a directory, find pred, replace tail
  1986. if (prevexists && (0xf & preventry.d.type) == LFS_TYPE_DIR) {
  1987. int res = lfs_pred(lfs, dir.pair, &newcwd);
  1988. if (res < 0) {
  1989. return res;
  1990. }
  1991. LFS_ASSERT(res); // must have pred
  1992. newcwd.d.tail[0] = dir.d.tail[0];
  1993. newcwd.d.tail[1] = dir.d.tail[1];
  1994. err = lfs_dir_commit(lfs, &newcwd, NULL, 0);
  1995. if (err) {
  1996. return err;
  1997. }
  1998. }
  1999. return 0;
  2000. }
  2001. /// Attribute operations ///
  2002. int lfs_getattr(lfs_t *lfs, const char *path,
  2003. uint8_t type, void *buffer, lfs_size_t size) {
  2004. lfs_dir_t cwd;
  2005. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2006. if (err) {
  2007. return err;
  2008. }
  2009. lfs_entry_t entry;
  2010. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2011. if (err) {
  2012. return err;
  2013. }
  2014. return lfs_dir_getattr(lfs, &cwd, &entry, type, buffer, size);
  2015. }
  2016. int lfs_setattr(lfs_t *lfs, const char *path,
  2017. uint8_t type, const void *buffer, lfs_size_t size) {
  2018. lfs_dir_t cwd;
  2019. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2020. if (err) {
  2021. return err;
  2022. }
  2023. lfs_entry_t entry;
  2024. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2025. if (err) {
  2026. return err;
  2027. }
  2028. return lfs_dir_setattr(lfs, &cwd, &entry, type, buffer, size);
  2029. }
  2030. int lfs_removeattr(lfs_t *lfs, const char *path, uint8_t type) {
  2031. lfs_dir_t cwd;
  2032. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2033. if (err) {
  2034. return err;
  2035. }
  2036. lfs_entry_t entry;
  2037. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2038. if (err) {
  2039. return err;
  2040. }
  2041. return lfs_dir_removeattr(lfs, &cwd, &entry, type);
  2042. }
  2043. /// Filesystem operations ///
  2044. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2045. lfs->cfg = cfg;
  2046. // setup read cache
  2047. lfs->rcache.block = 0xffffffff;
  2048. if (lfs->cfg->read_buffer) {
  2049. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2050. } else {
  2051. lfs->rcache.buffer = lfs_malloc(lfs->cfg->read_size);
  2052. if (!lfs->rcache.buffer) {
  2053. return LFS_ERR_NOMEM;
  2054. }
  2055. }
  2056. // setup program cache
  2057. lfs->pcache.block = 0xffffffff;
  2058. if (lfs->cfg->prog_buffer) {
  2059. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2060. } else {
  2061. lfs->pcache.buffer = lfs_malloc(lfs->cfg->prog_size);
  2062. if (!lfs->pcache.buffer) {
  2063. return LFS_ERR_NOMEM;
  2064. }
  2065. }
  2066. // setup lookahead, round down to nearest 32-bits
  2067. LFS_ASSERT(lfs->cfg->lookahead % 32 == 0);
  2068. LFS_ASSERT(lfs->cfg->lookahead > 0);
  2069. if (lfs->cfg->lookahead_buffer) {
  2070. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2071. } else {
  2072. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead/8);
  2073. if (!lfs->free.buffer) {
  2074. return LFS_ERR_NOMEM;
  2075. }
  2076. }
  2077. // check that program and read sizes are multiples of the block size
  2078. LFS_ASSERT(lfs->cfg->prog_size % lfs->cfg->read_size == 0);
  2079. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->prog_size == 0);
  2080. // check that the block size is large enough to fit ctz pointers
  2081. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2082. <= lfs->cfg->block_size);
  2083. // check that the size limits are sane
  2084. LFS_ASSERT(lfs->cfg->inline_size <= LFS_INLINE_MAX);
  2085. LFS_ASSERT(lfs->cfg->inline_size <= lfs->cfg->read_size);
  2086. lfs->inline_size = lfs->cfg->inline_size;
  2087. if (!lfs->inline_size) {
  2088. lfs->inline_size = lfs_min(LFS_INLINE_MAX, lfs->cfg->read_size);
  2089. }
  2090. LFS_ASSERT(lfs->cfg->attrs_size <= LFS_ATTRS_MAX);
  2091. lfs->attrs_size = lfs->cfg->attrs_size;
  2092. if (!lfs->attrs_size) {
  2093. lfs->attrs_size = LFS_ATTRS_MAX;
  2094. }
  2095. LFS_ASSERT(lfs->cfg->name_size <= LFS_NAME_MAX);
  2096. lfs->name_size = lfs->cfg->name_size;
  2097. if (!lfs->name_size) {
  2098. lfs->name_size = LFS_NAME_MAX;
  2099. }
  2100. // setup default state
  2101. lfs->root[0] = 0xffffffff;
  2102. lfs->root[1] = 0xffffffff;
  2103. lfs->files = NULL;
  2104. lfs->dirs = NULL;
  2105. lfs->deorphaned = false;
  2106. return 0;
  2107. }
  2108. static int lfs_deinit(lfs_t *lfs) {
  2109. // free allocated memory
  2110. if (!lfs->cfg->read_buffer) {
  2111. lfs_free(lfs->rcache.buffer);
  2112. }
  2113. if (!lfs->cfg->prog_buffer) {
  2114. lfs_free(lfs->pcache.buffer);
  2115. }
  2116. if (!lfs->cfg->lookahead_buffer) {
  2117. lfs_free(lfs->free.buffer);
  2118. }
  2119. return 0;
  2120. }
  2121. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2122. int err = lfs_init(lfs, cfg);
  2123. if (err) {
  2124. return err;
  2125. }
  2126. // create free lookahead
  2127. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  2128. lfs->free.off = 0;
  2129. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->cfg->block_count);
  2130. lfs->free.i = 0;
  2131. lfs_alloc_ack(lfs);
  2132. // create superblock dir
  2133. lfs_dir_t superdir;
  2134. err = lfs_dir_alloc(lfs, &superdir);
  2135. if (err) {
  2136. return err;
  2137. }
  2138. // write root directory
  2139. lfs_dir_t root;
  2140. err = lfs_dir_alloc(lfs, &root);
  2141. if (err) {
  2142. return err;
  2143. }
  2144. err = lfs_dir_commit(lfs, &root, NULL, 0);
  2145. if (err) {
  2146. return err;
  2147. }
  2148. lfs->root[0] = root.pair[0];
  2149. lfs->root[1] = root.pair[1];
  2150. superdir.d.tail[0] = lfs->root[0];
  2151. superdir.d.tail[1] = lfs->root[1];
  2152. // write one superblock
  2153. lfs_superblock_t superblock;
  2154. superblock.d.version = LFS_DISK_VERSION,
  2155. superblock.d.root[0] = lfs->root[0];
  2156. superblock.d.root[1] = lfs->root[1];
  2157. superblock.d.block_size = lfs->cfg->block_size;
  2158. superblock.d.block_count = lfs->cfg->block_count;
  2159. superblock.d.inline_size = lfs->inline_size;
  2160. superblock.d.attrs_size = lfs->attrs_size;
  2161. superblock.d.name_size = lfs->name_size;
  2162. lfs_entry_t superentry;
  2163. superentry.d.type = LFS_STRUCT_DIR | LFS_TYPE_SUPERBLOCK;
  2164. superentry.d.elen = sizeof(superblock.d);
  2165. superentry.d.alen = 0;
  2166. superentry.d.nlen = strlen("littlefs");
  2167. superentry.off = sizeof(superdir.d);
  2168. superentry.size = 0;
  2169. lfs_entry_tole32(&superentry.d);
  2170. lfs_superblock_tole32(&superblock.d);
  2171. err = lfs_dir_set(lfs, &superdir, &superentry, (struct lfs_region[]){
  2172. {LFS_FROM_MEM, 0, &superentry.d, 4},
  2173. {LFS_FROM_MEM, 0, &superblock.d, sizeof(superblock.d)},
  2174. {LFS_FROM_MEM, 0, "littlefs", superentry.d.nlen}}, 3);
  2175. if (err) {
  2176. return err;
  2177. }
  2178. // sanity check that fetch works
  2179. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  2180. if (err) {
  2181. return err;
  2182. }
  2183. return lfs_deinit(lfs);
  2184. }
  2185. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  2186. int err = lfs_init(lfs, cfg);
  2187. if (err) {
  2188. return err;
  2189. }
  2190. // setup free lookahead
  2191. lfs->free.off = 0;
  2192. lfs->free.size = 0;
  2193. lfs->free.i = 0;
  2194. lfs_alloc_ack(lfs);
  2195. // load superblock
  2196. lfs_dir_t dir;
  2197. lfs_entry_t entry;
  2198. lfs_superblock_t superblock;
  2199. char magic[8];
  2200. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2201. if (err) {
  2202. if (err == LFS_ERR_CORRUPT) {
  2203. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  2204. }
  2205. return err;
  2206. }
  2207. err = lfs_dir_get(lfs, &dir, sizeof(dir.d), &entry.d, sizeof(entry.d));
  2208. if (err) {
  2209. return err;
  2210. }
  2211. memset(&superblock.d, 0, sizeof(superblock.d));
  2212. err = lfs_dir_get(lfs, &dir,
  2213. sizeof(dir.d)+4, &superblock.d,
  2214. lfs_min(sizeof(superblock.d), lfs_entry_elen(&entry)));
  2215. lfs_superblock_fromle32(&superblock.d);
  2216. if (err) {
  2217. return err;
  2218. }
  2219. err = lfs_dir_get(lfs, &dir,
  2220. sizeof(dir.d)+lfs_entry_size(&entry)-entry.d.nlen, magic,
  2221. lfs_min(sizeof(magic), entry.d.nlen));
  2222. if (err) {
  2223. return err;
  2224. }
  2225. if (memcmp(magic, "littlefs", 8) != 0) {
  2226. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  2227. return LFS_ERR_CORRUPT;
  2228. }
  2229. uint16_t major_version = (0xffff & (superblock.d.version >> 16));
  2230. uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
  2231. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  2232. minor_version > LFS_DISK_VERSION_MINOR)) {
  2233. LFS_ERROR("Invalid version %d.%d", major_version, minor_version);
  2234. return LFS_ERR_INVAL;
  2235. }
  2236. if (superblock.d.inline_size) {
  2237. if (superblock.d.inline_size > lfs->inline_size) {
  2238. LFS_ERROR("Unsupported inline size (%d > %d)",
  2239. superblock.d.inline_size, lfs->inline_size);
  2240. return LFS_ERR_INVAL;
  2241. }
  2242. lfs->inline_size = superblock.d.inline_size;
  2243. }
  2244. if (superblock.d.attrs_size) {
  2245. if (superblock.d.attrs_size > lfs->attrs_size) {
  2246. LFS_ERROR("Unsupported attrs size (%d > %d)",
  2247. superblock.d.attrs_size, lfs->attrs_size);
  2248. return LFS_ERR_INVAL;
  2249. }
  2250. lfs->attrs_size = superblock.d.attrs_size;
  2251. }
  2252. if (superblock.d.name_size) {
  2253. if (superblock.d.name_size > lfs->name_size) {
  2254. LFS_ERROR("Unsupported name size (%d > %d)",
  2255. superblock.d.name_size, lfs->name_size);
  2256. return LFS_ERR_INVAL;
  2257. }
  2258. lfs->name_size = superblock.d.name_size;
  2259. }
  2260. lfs->root[0] = superblock.d.root[0];
  2261. lfs->root[1] = superblock.d.root[1];
  2262. return 0;
  2263. }
  2264. int lfs_unmount(lfs_t *lfs) {
  2265. return lfs_deinit(lfs);
  2266. }
  2267. /// Littlefs specific operations ///
  2268. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  2269. if (lfs_pairisnull(lfs->root)) {
  2270. return 0;
  2271. }
  2272. // iterate over metadata pairs
  2273. lfs_block_t cwd[2] = {0, 1};
  2274. while (true) {
  2275. for (int i = 0; i < 2; i++) {
  2276. int err = cb(data, cwd[i]);
  2277. if (err) {
  2278. return err;
  2279. }
  2280. }
  2281. lfs_dir_t dir;
  2282. int err = lfs_dir_fetch(lfs, &dir, cwd);
  2283. if (err) {
  2284. return err;
  2285. }
  2286. // iterate over contents
  2287. lfs_entry_t entry;
  2288. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  2289. err = lfs_dir_get(lfs, &dir,
  2290. dir.off, &entry.d, sizeof(entry.d));
  2291. lfs_entry_fromle32(&entry.d);
  2292. if (err) {
  2293. return err;
  2294. }
  2295. dir.off += lfs_entry_size(&entry);
  2296. if ((0x70 & entry.d.type) == LFS_STRUCT_CTZ) {
  2297. err = lfs_ctz_traverse(lfs, &lfs->rcache, NULL,
  2298. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  2299. if (err) {
  2300. return err;
  2301. }
  2302. }
  2303. }
  2304. cwd[0] = dir.d.tail[0];
  2305. cwd[1] = dir.d.tail[1];
  2306. if (lfs_pairisnull(cwd)) {
  2307. break;
  2308. }
  2309. }
  2310. // iterate over any open files
  2311. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  2312. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  2313. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  2314. f->head, f->size, cb, data);
  2315. if (err) {
  2316. return err;
  2317. }
  2318. }
  2319. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  2320. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  2321. f->block, f->pos, cb, data);
  2322. if (err) {
  2323. return err;
  2324. }
  2325. }
  2326. }
  2327. return 0;
  2328. }
  2329. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir) {
  2330. if (lfs_pairisnull(lfs->root)) {
  2331. return 0;
  2332. }
  2333. // iterate over all directory directory entries
  2334. int err = lfs_dir_fetch(lfs, pdir, (const lfs_block_t[2]){0, 1});
  2335. if (err) {
  2336. return err;
  2337. }
  2338. while (!lfs_pairisnull(pdir->d.tail)) {
  2339. if (lfs_paircmp(pdir->d.tail, dir) == 0) {
  2340. return true;
  2341. }
  2342. err = lfs_dir_fetch(lfs, pdir, pdir->d.tail);
  2343. if (err) {
  2344. return err;
  2345. }
  2346. }
  2347. return false;
  2348. }
  2349. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  2350. lfs_dir_t *parent, lfs_entry_t *entry) {
  2351. if (lfs_pairisnull(lfs->root)) {
  2352. return 0;
  2353. }
  2354. parent->d.tail[0] = 0;
  2355. parent->d.tail[1] = 1;
  2356. // iterate over all directory directory entries
  2357. while (!lfs_pairisnull(parent->d.tail)) {
  2358. int err = lfs_dir_fetch(lfs, parent, parent->d.tail);
  2359. if (err) {
  2360. return err;
  2361. }
  2362. while (true) {
  2363. err = lfs_dir_next(lfs, parent, entry);
  2364. if (err && err != LFS_ERR_NOENT) {
  2365. return err;
  2366. }
  2367. if (err == LFS_ERR_NOENT) {
  2368. break;
  2369. }
  2370. if (((0x70 & entry->d.type) == LFS_STRUCT_DIR) &&
  2371. lfs_paircmp(entry->d.u.dir, dir) == 0) {
  2372. return true;
  2373. }
  2374. }
  2375. }
  2376. return false;
  2377. }
  2378. static int lfs_moved(lfs_t *lfs, const void *e) {
  2379. if (lfs_pairisnull(lfs->root)) {
  2380. return 0;
  2381. }
  2382. // skip superblock
  2383. lfs_dir_t cwd;
  2384. int err = lfs_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
  2385. if (err) {
  2386. return err;
  2387. }
  2388. // iterate over all directory directory entries
  2389. lfs_entry_t entry;
  2390. while (!lfs_pairisnull(cwd.d.tail)) {
  2391. err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2392. if (err) {
  2393. return err;
  2394. }
  2395. while (true) {
  2396. err = lfs_dir_next(lfs, &cwd, &entry);
  2397. if (err && err != LFS_ERR_NOENT) {
  2398. return err;
  2399. }
  2400. if (err == LFS_ERR_NOENT) {
  2401. break;
  2402. }
  2403. if (!(LFS_STRUCT_MOVED & entry.d.type) &&
  2404. memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
  2405. return true;
  2406. }
  2407. }
  2408. }
  2409. return false;
  2410. }
  2411. static int lfs_relocate(lfs_t *lfs,
  2412. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]) {
  2413. // find parent
  2414. lfs_dir_t parent;
  2415. lfs_entry_t entry;
  2416. int res = lfs_parent(lfs, oldpair, &parent, &entry);
  2417. if (res < 0) {
  2418. return res;
  2419. }
  2420. if (res) {
  2421. // update disk, this creates a desync
  2422. entry.d.u.dir[0] = newpair[0];
  2423. entry.d.u.dir[1] = newpair[1];
  2424. int err = lfs_dir_set(lfs, &parent, &entry, (struct lfs_region[]){
  2425. {LFS_FROM_MEM, 0, &entry.d, sizeof(entry.d)},
  2426. {LFS_FROM_DROP, 0, NULL, (lfs_ssize_t)-sizeof(entry.d)}}, 2);
  2427. if (err) {
  2428. return err;
  2429. }
  2430. // update internal root
  2431. if (lfs_paircmp(oldpair, lfs->root) == 0) {
  2432. LFS_DEBUG("Relocating root %d %d", newpair[0], newpair[1]);
  2433. lfs->root[0] = newpair[0];
  2434. lfs->root[1] = newpair[1];
  2435. }
  2436. // clean up bad block, which should now be a desync
  2437. return lfs_deorphan(lfs);
  2438. }
  2439. // find pred
  2440. res = lfs_pred(lfs, oldpair, &parent);
  2441. if (res < 0) {
  2442. return res;
  2443. }
  2444. if (res) {
  2445. // just replace bad pair, no desync can occur
  2446. parent.d.tail[0] = newpair[0];
  2447. parent.d.tail[1] = newpair[1];
  2448. return lfs_dir_commit(lfs, &parent, NULL, 0);
  2449. }
  2450. // couldn't find dir, must be new
  2451. return 0;
  2452. }
  2453. int lfs_deorphan(lfs_t *lfs) {
  2454. lfs->deorphaned = true;
  2455. if (lfs_pairisnull(lfs->root)) {
  2456. return 0;
  2457. }
  2458. lfs_dir_t pdir = {.d.size = 0x80000000};
  2459. lfs_dir_t cwd = {.d.tail[0] = 0, .d.tail[1] = 1};
  2460. // iterate over all directory directory entries
  2461. while (!lfs_pairisnull(cwd.d.tail)) {
  2462. int err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2463. if (err) {
  2464. return err;
  2465. }
  2466. // check head blocks for orphans
  2467. if (!(0x80000000 & pdir.d.size)) {
  2468. // check if we have a parent
  2469. lfs_dir_t parent;
  2470. lfs_entry_t entry;
  2471. int res = lfs_parent(lfs, pdir.d.tail, &parent, &entry);
  2472. if (res < 0) {
  2473. return res;
  2474. }
  2475. if (!res) {
  2476. // we are an orphan
  2477. LFS_DEBUG("Found orphan %d %d",
  2478. pdir.d.tail[0], pdir.d.tail[1]);
  2479. pdir.d.tail[0] = cwd.d.tail[0];
  2480. pdir.d.tail[1] = cwd.d.tail[1];
  2481. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2482. if (err) {
  2483. return err;
  2484. }
  2485. break;
  2486. }
  2487. if (!lfs_pairsync(entry.d.u.dir, pdir.d.tail)) {
  2488. // we have desynced
  2489. LFS_DEBUG("Found desync %d %d",
  2490. entry.d.u.dir[0], entry.d.u.dir[1]);
  2491. pdir.d.tail[0] = entry.d.u.dir[0];
  2492. pdir.d.tail[1] = entry.d.u.dir[1];
  2493. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2494. if (err) {
  2495. return err;
  2496. }
  2497. break;
  2498. }
  2499. }
  2500. // check entries for moves
  2501. lfs_entry_t entry;
  2502. while (true) {
  2503. err = lfs_dir_next(lfs, &cwd, &entry);
  2504. if (err && err != LFS_ERR_NOENT) {
  2505. return err;
  2506. }
  2507. if (err == LFS_ERR_NOENT) {
  2508. break;
  2509. }
  2510. // found moved entry
  2511. if (entry.d.type & LFS_STRUCT_MOVED) {
  2512. int moved = lfs_moved(lfs, &entry.d.u);
  2513. if (moved < 0) {
  2514. return moved;
  2515. }
  2516. if (moved) {
  2517. LFS_DEBUG("Found move %d %d",
  2518. entry.d.u.dir[0], entry.d.u.dir[1]);
  2519. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  2520. {LFS_FROM_DROP, 0, NULL, -entry.size}}, 1);
  2521. if (err) {
  2522. return err;
  2523. }
  2524. } else {
  2525. LFS_DEBUG("Found partial move %d %d",
  2526. entry.d.u.dir[0], entry.d.u.dir[1]);
  2527. entry.d.type &= ~LFS_STRUCT_MOVED;
  2528. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  2529. {LFS_FROM_MEM, 0, &entry.d, sizeof(entry.d)},
  2530. {LFS_FROM_DROP, 0, NULL,
  2531. (lfs_ssize_t)-sizeof(entry.d)}}, 2);
  2532. if (err) {
  2533. return err;
  2534. }
  2535. }
  2536. }
  2537. }
  2538. memcpy(&pdir, &cwd, sizeof(pdir));
  2539. }
  2540. return 0;
  2541. }