lfs.c 88 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212
  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_MEM,
  427. LFS_FROM_REGION,
  428. LFS_FROM_ATTRS,
  429. } type;
  430. lfs_off_t oldoff;
  431. lfs_size_t oldsize;
  432. const void *buffer;
  433. lfs_size_t newsize;
  434. };
  435. struct lfs_region_attrs {
  436. const struct lfs_attr *attrs;
  437. int count;
  438. };
  439. struct lfs_region_region {
  440. lfs_block_t block;
  441. lfs_off_t off;
  442. struct lfs_region *regions;
  443. int count;
  444. };
  445. static int lfs_commit_region(lfs_t *lfs, uint32_t *crc,
  446. lfs_block_t oldblock, lfs_off_t oldoff,
  447. lfs_block_t newblock, lfs_off_t newoff,
  448. lfs_off_t regionoff, lfs_size_t regionsize,
  449. const struct lfs_region *regions, int count) {
  450. int i = 0;
  451. lfs_size_t newend = newoff + regionsize;
  452. while (newoff < newend) {
  453. // commit from different types of regions
  454. if (i < count && regions[i].oldoff == oldoff - regionoff) {
  455. switch (regions[i].type) {
  456. case LFS_FROM_MEM: {
  457. lfs_crc(crc, regions[i].buffer, regions[i].newsize);
  458. int err = lfs_bd_prog(lfs, newblock, newoff,
  459. regions[i].buffer, regions[i].newsize);
  460. if (err) {
  461. return err;
  462. }
  463. newoff += regions[i].newsize;
  464. oldoff += regions[i].oldsize;
  465. break;
  466. }
  467. case LFS_FROM_REGION: {
  468. const struct lfs_region_region *disk = regions[i].buffer;
  469. int err = lfs_commit_region(lfs, crc,
  470. disk->block, disk->off,
  471. newblock, newoff,
  472. disk->off, regions[i].newsize,
  473. disk->regions, disk->count);
  474. if (err) {
  475. return err;
  476. }
  477. newoff += regions[i].newsize;
  478. oldoff -= regions[i].oldsize;
  479. break;
  480. }
  481. case LFS_FROM_ATTRS: {
  482. const struct lfs_region_attrs *attrs = regions[i].buffer;
  483. // order doesn't matter, so we write new attrs first. this
  484. // is still O(n^2) but only O(n) disk access
  485. for (int j = 0; j < attrs->count; j++) {
  486. if (attrs->attrs[j].size == 0) {
  487. continue;
  488. }
  489. lfs_entry_attr_t attr;
  490. attr.d.type = attrs->attrs[j].type;
  491. attr.d.len = attrs->attrs[j].size;
  492. lfs_crc(crc, &attr.d, sizeof(attr.d));
  493. int err = lfs_bd_prog(lfs, newblock, newoff,
  494. &attr.d, sizeof(attr.d));
  495. if (err) {
  496. return err;
  497. }
  498. lfs_crc(crc,
  499. attrs->attrs[j].buffer, attrs->attrs[j].size);
  500. err = lfs_bd_prog(lfs, newblock, newoff+sizeof(attr.d),
  501. attrs->attrs[j].buffer, attrs->attrs[j].size);
  502. if (err) {
  503. return err;
  504. }
  505. newoff += 2+attrs->attrs[j].size;
  506. }
  507. // copy over attributes without updates
  508. lfs_off_t oldend = oldoff + regions[i].oldsize;
  509. while (oldoff < oldend) {
  510. lfs_entry_attr_t attr;
  511. int err = lfs_bd_read(lfs, oldblock, oldoff,
  512. &attr.d, sizeof(attr.d));
  513. if (err) {
  514. return err;
  515. }
  516. bool updating = false;
  517. for (int j = 0; j < attrs->count; j++) {
  518. if (attr.d.type == attrs->attrs[j].type) {
  519. updating = true;
  520. }
  521. }
  522. if (!updating) {
  523. err = lfs_commit_region(lfs, crc,
  524. oldblock, oldoff,
  525. newblock, newoff,
  526. 0, 2+attr.d.len,
  527. NULL, 0);
  528. if (err) {
  529. return err;
  530. }
  531. newoff += 2+attr.d.len;
  532. }
  533. oldoff += 2+attr.d.len;
  534. }
  535. break;
  536. }
  537. }
  538. i += 1;
  539. } else {
  540. // copy data from old block if not covered by region
  541. uint8_t data;
  542. int err = lfs_bd_read(lfs, oldblock, oldoff, &data, 1);
  543. if (err) {
  544. return err;
  545. }
  546. lfs_crc(crc, &data, 1);
  547. err = lfs_bd_prog(lfs, newblock, newoff, &data, 1);
  548. if (err) {
  549. return err;
  550. }
  551. oldoff += 1;
  552. newoff += 1;
  553. }
  554. }
  555. // sanity check our commit math
  556. LFS_ASSERT(newoff == newend);
  557. return 0;
  558. }
  559. static int lfs_dir_commit(lfs_t *lfs, lfs_dir_t *dir,
  560. const struct lfs_region *regions, int count) {
  561. // state for copying over
  562. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  563. bool relocated = false;
  564. // increment revision count
  565. dir->d.rev += 1;
  566. // keep pairs in order such that pair[0] is most recent
  567. lfs_pairswap(dir->pair);
  568. for (int i = 0; i < count; i++) {
  569. dir->d.size += regions[i].newsize;
  570. dir->d.size -= regions[i].oldsize;
  571. }
  572. while (true) {
  573. if (true) {
  574. int err = lfs_bd_erase(lfs, dir->pair[0]);
  575. if (err) {
  576. if (err == LFS_ERR_CORRUPT) {
  577. goto relocate;
  578. }
  579. return err;
  580. }
  581. // commit header
  582. uint32_t crc = 0xffffffff;
  583. lfs_dir_tole32(&dir->d);
  584. lfs_crc(&crc, &dir->d, sizeof(dir->d));
  585. err = lfs_bd_prog(lfs, dir->pair[0], 0, &dir->d, sizeof(dir->d));
  586. lfs_dir_fromle32(&dir->d);
  587. if (err) {
  588. if (err == LFS_ERR_CORRUPT) {
  589. goto relocate;
  590. }
  591. return err;
  592. }
  593. // commit region
  594. err = lfs_commit_region(lfs, &crc,
  595. dir->pair[1], sizeof(dir->d),
  596. dir->pair[0], sizeof(dir->d),
  597. 0, (0x7fffffff & dir->d.size)-sizeof(dir->d)-4,
  598. regions, count);
  599. if (err) {
  600. if (err == LFS_ERR_CORRUPT) {
  601. goto relocate;
  602. }
  603. return err;
  604. }
  605. // commit crc
  606. crc = lfs_tole32(crc);
  607. err = lfs_bd_prog(lfs, dir->pair[0],
  608. (0x7fffffff & dir->d.size)-4, &crc, 4);
  609. crc = lfs_fromle32(crc);
  610. if (err) {
  611. if (err == LFS_ERR_CORRUPT) {
  612. goto relocate;
  613. }
  614. return err;
  615. }
  616. err = lfs_bd_sync(lfs);
  617. if (err) {
  618. if (err == LFS_ERR_CORRUPT) {
  619. goto relocate;
  620. }
  621. return err;
  622. }
  623. // successful commit, check checksum to make sure
  624. uint32_t ncrc = 0xffffffff;
  625. err = lfs_bd_crc(lfs, dir->pair[0], 0,
  626. (0x7fffffff & dir->d.size)-4, &ncrc);
  627. if (err) {
  628. return err;
  629. }
  630. if (ncrc != crc) {
  631. goto relocate;
  632. }
  633. }
  634. break;
  635. relocate:
  636. //commit was corrupted
  637. LFS_DEBUG("Bad block at %d", dir->pair[0]);
  638. // drop caches and prepare to relocate block
  639. relocated = true;
  640. lfs->pcache.block = 0xffffffff;
  641. // can't relocate superblock, filesystem is now frozen
  642. if (lfs_paircmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  643. LFS_WARN("Superblock %d has become unwritable", oldpair[0]);
  644. return LFS_ERR_CORRUPT;
  645. }
  646. // relocate half of pair
  647. int err = lfs_alloc(lfs, &dir->pair[0]);
  648. if (err) {
  649. return err;
  650. }
  651. }
  652. if (relocated) {
  653. // update references if we relocated
  654. LFS_DEBUG("Relocating %d %d to %d %d",
  655. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  656. int err = lfs_relocate(lfs, oldpair, dir->pair);
  657. if (err) {
  658. return err;
  659. }
  660. }
  661. // shift over any directories that are affected
  662. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  663. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  664. d->pair[0] = dir->pair[0];
  665. d->pair[1] = dir->pair[1];
  666. }
  667. }
  668. return 0;
  669. }
  670. static int lfs_dir_get(lfs_t *lfs, const lfs_dir_t *dir,
  671. lfs_off_t off, void *buffer, lfs_size_t size) {
  672. return lfs_bd_read(lfs, dir->pair[0], off, buffer, size);
  673. }
  674. static int lfs_dir_set(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry,
  675. struct lfs_region *regions, int count) {
  676. lfs_ssize_t diff = 0;
  677. for (int i = 0; i < count; i++) {
  678. diff += regions[i].newsize;
  679. diff -= regions[i].oldsize;
  680. }
  681. lfs_size_t oldsize = entry->size;
  682. if (entry->off == 0) {
  683. entry->off = (0x7fffffff & dir->d.size) - 4;
  684. }
  685. if ((0x7fffffff & dir->d.size) + diff > lfs->cfg->block_size) {
  686. lfs_dir_t olddir = *dir;
  687. lfs_off_t oldoff = entry->off;
  688. if (oldsize) {
  689. // mark as moving
  690. uint8_t type;
  691. int err = lfs_dir_get(lfs, &olddir, oldoff, &type, 1);
  692. if (err) {
  693. return err;
  694. }
  695. type |= LFS_STRUCT_MOVED;
  696. err = lfs_dir_commit(lfs, &olddir, (struct lfs_region[]){
  697. {LFS_FROM_MEM, oldoff, 1, &type, 1}}, 1);
  698. if (err) {
  699. return err;
  700. }
  701. }
  702. lfs_dir_t pdir = olddir;
  703. // find available block or create a new one
  704. while ((0x7fffffff & dir->d.size) + oldsize + diff
  705. > lfs->cfg->block_size) {
  706. // we need to allocate a new dir block
  707. if (!(0x80000000 & dir->d.size)) {
  708. pdir = *dir;
  709. int err = lfs_dir_alloc(lfs, dir);
  710. if (err) {
  711. return err;
  712. }
  713. dir->d.tail[0] = pdir.d.tail[0];
  714. dir->d.tail[1] = pdir.d.tail[1];
  715. break;
  716. }
  717. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  718. if (err) {
  719. return err;
  720. }
  721. }
  722. // writing out new entry
  723. entry->off = dir->d.size - 4;
  724. entry->size += diff;
  725. int err = lfs_dir_commit(lfs, dir, (struct lfs_region[]){
  726. {LFS_FROM_REGION, entry->off, 0, &(struct lfs_region_region){
  727. olddir.pair[0], oldoff,
  728. regions, count}, entry->size}}, 1);
  729. if (err) {
  730. return err;
  731. }
  732. // update pred dir, unless pred == old we can coalesce
  733. if (!oldsize || lfs_paircmp(pdir.pair, olddir.pair) != 0) {
  734. pdir.d.size |= 0x80000000;
  735. pdir.d.tail[0] = dir->pair[0];
  736. pdir.d.tail[1] = dir->pair[1];
  737. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  738. if (err) {
  739. return err;
  740. }
  741. } else if (oldsize) {
  742. olddir.d.size |= 0x80000000;
  743. olddir.d.tail[0] = dir->pair[0];
  744. olddir.d.tail[1] = dir->pair[1];
  745. }
  746. // remove old entry
  747. if (oldsize) {
  748. lfs_entry_t oldentry;
  749. oldentry.off = oldoff;
  750. err = lfs_dir_set(lfs, &olddir, &oldentry, (struct lfs_region[]){
  751. {LFS_FROM_MEM, 0, oldsize, NULL, 0}}, 1);
  752. if (err) {
  753. return err;
  754. }
  755. }
  756. goto shift;
  757. }
  758. if ((0x7fffffff & dir->d.size) + diff == sizeof(dir->d)+4) {
  759. lfs_dir_t pdir;
  760. int res = lfs_pred(lfs, dir->pair, &pdir);
  761. if (res < 0) {
  762. return res;
  763. }
  764. if (pdir.d.size & 0x80000000) {
  765. pdir.d.size &= dir->d.size | 0x7fffffff;
  766. pdir.d.tail[0] = dir->d.tail[0];
  767. pdir.d.tail[1] = dir->d.tail[1];
  768. int err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  769. if (err) {
  770. return err;
  771. }
  772. goto shift;
  773. }
  774. }
  775. for (int i = 0; i < count; i++) {
  776. regions[i].oldoff += entry->off;
  777. }
  778. int err = lfs_dir_commit(lfs, dir, regions, count);
  779. if (err) {
  780. return err;
  781. }
  782. entry->size += diff;
  783. shift:
  784. // shift over any files/directories that are affected
  785. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  786. if (lfs_paircmp(f->pair, dir->pair) == 0) {
  787. if (f->pairoff == entry->off && entry->size == 0) {
  788. f->pair[0] = 0xffffffff;
  789. f->pair[1] = 0xffffffff;
  790. } else if (f->pairoff > entry->off) {
  791. f->pairoff += diff;
  792. }
  793. }
  794. }
  795. for (lfs_dir_t *d = lfs->dirs; d; d = d->next) {
  796. if (lfs_paircmp(d->pair, dir->pair) == 0) {
  797. if (d->off > entry->off) {
  798. d->off += diff;
  799. d->pos += diff;
  800. }
  801. }
  802. }
  803. return 0;
  804. }
  805. static int lfs_dir_next(lfs_t *lfs, lfs_dir_t *dir, lfs_entry_t *entry) {
  806. while (dir->off >= (0x7fffffff & dir->d.size)-4) {
  807. if (!(0x80000000 & dir->d.size)) {
  808. entry->off = dir->off;
  809. return LFS_ERR_NOENT;
  810. }
  811. int err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  812. if (err) {
  813. return err;
  814. }
  815. dir->off = sizeof(dir->d);
  816. dir->pos += sizeof(dir->d) + 4;
  817. }
  818. int err = lfs_dir_get(lfs, dir, dir->off, &entry->d, sizeof(entry->d));
  819. lfs_entry_fromle32(&entry->d);
  820. if (err) {
  821. return err;
  822. }
  823. entry->off = dir->off;
  824. entry->size = lfs_entry_size(entry);
  825. dir->off += entry->size;
  826. dir->pos += entry->size;
  827. return 0;
  828. }
  829. static int lfs_dir_find(lfs_t *lfs, lfs_dir_t *dir,
  830. lfs_entry_t *entry, const char **path) {
  831. const char *pathname = *path;
  832. lfs_size_t pathlen;
  833. while (true) {
  834. nextname:
  835. // skip slashes
  836. pathname += strspn(pathname, "/");
  837. pathlen = strcspn(pathname, "/");
  838. // special case for root dir
  839. if (pathname[0] == '\0') {
  840. *entry = (lfs_entry_t){
  841. .d.type = LFS_STRUCT_DIR | LFS_TYPE_DIR,
  842. .d.u.dir[0] = lfs->root[0],
  843. .d.u.dir[1] = lfs->root[1],
  844. };
  845. return 0;
  846. }
  847. // skip '.' and root '..'
  848. if ((pathlen == 1 && memcmp(pathname, ".", 1) == 0) ||
  849. (pathlen == 2 && memcmp(pathname, "..", 2) == 0)) {
  850. pathname += pathlen;
  851. goto nextname;
  852. }
  853. // skip if matched by '..' in name
  854. const char *suffix = pathname + pathlen;
  855. lfs_size_t sufflen;
  856. int depth = 1;
  857. while (true) {
  858. suffix += strspn(suffix, "/");
  859. sufflen = strcspn(suffix, "/");
  860. if (sufflen == 0) {
  861. break;
  862. }
  863. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  864. depth -= 1;
  865. if (depth == 0) {
  866. pathname = suffix + sufflen;
  867. goto nextname;
  868. }
  869. } else {
  870. depth += 1;
  871. }
  872. suffix += sufflen;
  873. }
  874. // update what we've found
  875. *path = pathname;
  876. // find path
  877. while (true) {
  878. int err = lfs_dir_next(lfs, dir, entry);
  879. if (err) {
  880. return err;
  881. }
  882. if (((0xf & entry->d.type) != LFS_TYPE_REG &&
  883. (0xf & entry->d.type) != LFS_TYPE_DIR) ||
  884. entry->d.nlen != pathlen) {
  885. continue;
  886. }
  887. int res = lfs_bd_cmp(lfs, dir->pair[0],
  888. entry->off + entry->size - pathlen,
  889. pathname, pathlen);
  890. if (res < 0) {
  891. return res;
  892. }
  893. // found match
  894. if (res) {
  895. break;
  896. }
  897. }
  898. // check that entry has not been moved
  899. if (entry->d.type & LFS_STRUCT_MOVED) {
  900. int moved = lfs_moved(lfs, &entry->d.u);
  901. if (moved < 0 || moved) {
  902. return (moved < 0) ? moved : LFS_ERR_NOENT;
  903. }
  904. entry->d.type &= ~LFS_STRUCT_MOVED;
  905. }
  906. pathname += pathlen;
  907. pathname += strspn(pathname, "/");
  908. if (pathname[0] == '\0') {
  909. return 0;
  910. }
  911. // continue on if we hit a directory
  912. if ((0xf & entry->d.type) != LFS_TYPE_DIR) {
  913. return LFS_ERR_NOTDIR;
  914. }
  915. int err = lfs_dir_fetch(lfs, dir, entry->d.u.dir);
  916. if (err) {
  917. return err;
  918. }
  919. }
  920. }
  921. /// Internal attribute operations ///
  922. static int lfs_dir_getinfo(lfs_t *lfs,
  923. lfs_dir_t *dir, const lfs_entry_t *entry, struct lfs_info *info) {
  924. memset(info, 0, sizeof(*info));
  925. info->type = 0xf & entry->d.type;
  926. if (entry->d.type == (LFS_STRUCT_CTZ | LFS_TYPE_REG)) {
  927. info->size = entry->d.u.file.size;
  928. } else if (entry->d.type == (LFS_STRUCT_INLINE | LFS_TYPE_REG)) {
  929. info->size = lfs_entry_elen(entry);
  930. }
  931. if (lfs_paircmp(entry->d.u.dir, lfs->root) == 0) {
  932. strcpy(info->name, "/");
  933. } else {
  934. int err = lfs_dir_get(lfs, dir,
  935. entry->off + entry->size - entry->d.nlen,
  936. info->name, entry->d.nlen);
  937. if (err) {
  938. return err;
  939. }
  940. }
  941. return 0;
  942. }
  943. static int lfs_dir_getattrs(lfs_t *lfs,
  944. lfs_dir_t *dir, const lfs_entry_t *entry,
  945. const struct lfs_attr *attrs, int count) {
  946. // set to zero in case we can't find the attributes or size mismatch
  947. for (int j = 0; j < count; j++) {
  948. memset(attrs[j].buffer, 0, attrs[j].size);
  949. }
  950. // search for attribute in attribute region
  951. lfs_off_t off = entry->off + 4+lfs_entry_elen(entry);
  952. lfs_off_t end = off + lfs_entry_alen(entry);
  953. while (off < end) {
  954. lfs_entry_attr_t attr;
  955. int err = lfs_dir_get(lfs, dir, off, &attr.d, sizeof(attr.d));
  956. if (err) {
  957. return err;
  958. }
  959. for (int j = 0; j < count; j++) {
  960. if (attrs[j].type == attr.d.type) {
  961. if (attrs[j].size < attr.d.len) {
  962. return LFS_ERR_RANGE;
  963. }
  964. err = lfs_dir_get(lfs, dir, off+sizeof(attr.d),
  965. attrs[j].buffer, attr.d.len);
  966. if (err) {
  967. return err;
  968. }
  969. }
  970. }
  971. off += 2+attr.d.len;
  972. }
  973. return 0;
  974. }
  975. static lfs_ssize_t lfs_dir_checkattrs(lfs_t *lfs,
  976. lfs_dir_t *dir, lfs_entry_t *entry,
  977. const struct lfs_attr *attrs, int count) {
  978. // check that attributes fit
  979. // two separate passes so disk access is O(n)
  980. lfs_size_t nsize = 0;
  981. for (int j = 0; j < count; j++) {
  982. if (attrs[j].size > 0) {
  983. nsize += 2+attrs[j].size;
  984. }
  985. }
  986. lfs_off_t off = entry->off + 4+lfs_entry_elen(entry);
  987. lfs_off_t end = off + lfs_entry_alen(entry);
  988. while (off < end) {
  989. lfs_entry_attr_t attr;
  990. int err = lfs_dir_get(lfs, dir, off, &attr.d, sizeof(attr.d));
  991. if (err) {
  992. return err;
  993. }
  994. bool updated = false;
  995. for (int j = 0; j < count; j++) {
  996. if (attr.d.type == attrs[j].type) {
  997. updated = true;
  998. }
  999. }
  1000. if (!updated) {
  1001. nsize += 2+attr.d.len;
  1002. }
  1003. off += 2+attr.d.len;
  1004. }
  1005. if (nsize > lfs->attrs_size || (
  1006. lfs_entry_size(entry) - lfs_entry_alen(entry) + nsize
  1007. > lfs->cfg->block_size)) {
  1008. return LFS_ERR_NOSPC;
  1009. }
  1010. return nsize;
  1011. }
  1012. static int lfs_dir_setattrs(lfs_t *lfs,
  1013. lfs_dir_t *dir, lfs_entry_t *entry,
  1014. const struct lfs_attr *attrs, int count) {
  1015. // make sure attributes fit
  1016. lfs_size_t oldlen = lfs_entry_alen(entry);
  1017. lfs_ssize_t newlen = lfs_dir_checkattrs(lfs, dir, entry, attrs, count);
  1018. if (newlen < 0) {
  1019. return newlen;
  1020. }
  1021. // commit to entry, majority of work is in LFS_FROM_ATTRS
  1022. entry->d.alen = (0xc0 & entry->d.alen) | newlen;
  1023. return lfs_dir_set(lfs, dir, entry, (struct lfs_region[]){
  1024. {LFS_FROM_MEM, 0, 4, &entry->d, 4},
  1025. {LFS_FROM_ATTRS, 4+lfs_entry_elen(entry), oldlen,
  1026. &(struct lfs_region_attrs){attrs, count}, newlen}}, 2);
  1027. }
  1028. /// Top level directory operations ///
  1029. int lfs_mkdir(lfs_t *lfs, const char *path) {
  1030. // deorphan if we haven't yet, needed at most once after poweron
  1031. if (!lfs->deorphaned) {
  1032. int err = lfs_deorphan(lfs);
  1033. if (err) {
  1034. return err;
  1035. }
  1036. }
  1037. // fetch parent directory
  1038. lfs_dir_t cwd;
  1039. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1040. if (err) {
  1041. return err;
  1042. }
  1043. lfs_entry_t entry;
  1044. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1045. if (err != LFS_ERR_NOENT || strchr(path, '/') != NULL) {
  1046. return err ? err : LFS_ERR_EXIST;
  1047. }
  1048. // check that name fits
  1049. lfs_size_t nlen = strlen(path);
  1050. if (nlen > lfs->name_size) {
  1051. return LFS_ERR_NAMETOOLONG;
  1052. }
  1053. // build up new directory
  1054. lfs_alloc_ack(lfs);
  1055. lfs_dir_t dir;
  1056. err = lfs_dir_alloc(lfs, &dir);
  1057. if (err) {
  1058. return err;
  1059. }
  1060. dir.d.tail[0] = cwd.d.tail[0];
  1061. dir.d.tail[1] = cwd.d.tail[1];
  1062. err = lfs_dir_commit(lfs, &dir, NULL, 0);
  1063. if (err) {
  1064. return err;
  1065. }
  1066. entry.d.type = LFS_STRUCT_DIR | LFS_TYPE_DIR;
  1067. entry.d.elen = sizeof(entry.d) - 4;
  1068. entry.d.alen = 0;
  1069. entry.d.nlen = nlen;
  1070. entry.d.u.dir[0] = dir.pair[0];
  1071. entry.d.u.dir[1] = dir.pair[1];
  1072. entry.size = 0;
  1073. cwd.d.tail[0] = dir.pair[0];
  1074. cwd.d.tail[1] = dir.pair[1];
  1075. lfs_entry_tole32(&entry.d);
  1076. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1077. {LFS_FROM_MEM, 0, 0, &entry.d, sizeof(entry.d)},
  1078. {LFS_FROM_MEM, 0, 0, path, nlen}}, 2);
  1079. if (err) {
  1080. return err;
  1081. }
  1082. lfs_alloc_ack(lfs);
  1083. return 0;
  1084. }
  1085. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1086. dir->pair[0] = lfs->root[0];
  1087. dir->pair[1] = lfs->root[1];
  1088. int err = lfs_dir_fetch(lfs, dir, dir->pair);
  1089. if (err) {
  1090. return err;
  1091. }
  1092. lfs_entry_t entry;
  1093. err = lfs_dir_find(lfs, dir, &entry, &path);
  1094. if (err) {
  1095. return err;
  1096. } else if (entry.d.type != (LFS_STRUCT_DIR | LFS_TYPE_DIR)) {
  1097. return LFS_ERR_NOTDIR;
  1098. }
  1099. err = lfs_dir_fetch(lfs, dir, entry.d.u.dir);
  1100. if (err) {
  1101. return err;
  1102. }
  1103. // setup head dir
  1104. // special offset for '.' and '..'
  1105. dir->head[0] = dir->pair[0];
  1106. dir->head[1] = dir->pair[1];
  1107. dir->pos = sizeof(dir->d) - 2;
  1108. dir->off = sizeof(dir->d);
  1109. // add to list of directories
  1110. dir->next = lfs->dirs;
  1111. lfs->dirs = dir;
  1112. return 0;
  1113. }
  1114. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1115. // remove from list of directories
  1116. for (lfs_dir_t **p = &lfs->dirs; *p; p = &(*p)->next) {
  1117. if (*p == dir) {
  1118. *p = dir->next;
  1119. break;
  1120. }
  1121. }
  1122. return 0;
  1123. }
  1124. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1125. memset(info, 0, sizeof(*info));
  1126. // special offset for '.' and '..'
  1127. if (dir->pos == sizeof(dir->d) - 2) {
  1128. info->type = LFS_TYPE_DIR;
  1129. strcpy(info->name, ".");
  1130. dir->pos += 1;
  1131. return 1;
  1132. } else if (dir->pos == sizeof(dir->d) - 1) {
  1133. info->type = LFS_TYPE_DIR;
  1134. strcpy(info->name, "..");
  1135. dir->pos += 1;
  1136. return 1;
  1137. }
  1138. lfs_entry_t entry;
  1139. while (true) {
  1140. int err = lfs_dir_next(lfs, dir, &entry);
  1141. if (err) {
  1142. return (err == LFS_ERR_NOENT) ? 0 : err;
  1143. }
  1144. if ((0xf & entry.d.type) != LFS_TYPE_REG &&
  1145. (0xf & entry.d.type) != LFS_TYPE_DIR) {
  1146. continue;
  1147. }
  1148. // check that entry has not been moved
  1149. if (entry.d.type & LFS_STRUCT_MOVED) {
  1150. int moved = lfs_moved(lfs, &entry.d.u);
  1151. if (moved < 0) {
  1152. return moved;
  1153. }
  1154. if (moved) {
  1155. continue;
  1156. }
  1157. entry.d.type &= ~LFS_STRUCT_MOVED;
  1158. }
  1159. break;
  1160. }
  1161. int err = lfs_dir_getinfo(lfs, dir, &entry, info);
  1162. if (err) {
  1163. return err;
  1164. }
  1165. return 1;
  1166. }
  1167. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1168. // simply walk from head dir
  1169. int err = lfs_dir_rewind(lfs, dir);
  1170. if (err) {
  1171. return err;
  1172. }
  1173. dir->pos = off;
  1174. while (off > (0x7fffffff & dir->d.size)) {
  1175. off -= 0x7fffffff & dir->d.size;
  1176. if (!(0x80000000 & dir->d.size)) {
  1177. return LFS_ERR_INVAL;
  1178. }
  1179. err = lfs_dir_fetch(lfs, dir, dir->d.tail);
  1180. if (err) {
  1181. return err;
  1182. }
  1183. }
  1184. dir->off = off;
  1185. return 0;
  1186. }
  1187. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1188. (void)lfs;
  1189. return dir->pos;
  1190. }
  1191. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1192. // reload the head dir
  1193. int err = lfs_dir_fetch(lfs, dir, dir->head);
  1194. if (err) {
  1195. return err;
  1196. }
  1197. dir->pair[0] = dir->head[0];
  1198. dir->pair[1] = dir->head[1];
  1199. dir->pos = sizeof(dir->d) - 2;
  1200. dir->off = sizeof(dir->d);
  1201. return 0;
  1202. }
  1203. /// File index list operations ///
  1204. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1205. lfs_off_t size = *off;
  1206. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1207. lfs_off_t i = size / b;
  1208. if (i == 0) {
  1209. return 0;
  1210. }
  1211. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1212. *off = size - b*i - 4*lfs_popc(i);
  1213. return i;
  1214. }
  1215. static int lfs_ctz_find(lfs_t *lfs,
  1216. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1217. lfs_block_t head, lfs_size_t size,
  1218. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1219. if (size == 0) {
  1220. *block = 0xffffffff;
  1221. *off = 0;
  1222. return 0;
  1223. }
  1224. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1225. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1226. while (current > target) {
  1227. lfs_size_t skip = lfs_min(
  1228. lfs_npw2(current-target+1) - 1,
  1229. lfs_ctz(current));
  1230. int err = lfs_cache_read(lfs, rcache, pcache, head, 4*skip, &head, 4);
  1231. head = lfs_fromle32(head);
  1232. if (err) {
  1233. return err;
  1234. }
  1235. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1236. current -= 1 << skip;
  1237. }
  1238. *block = head;
  1239. *off = pos;
  1240. return 0;
  1241. }
  1242. static int lfs_ctz_extend(lfs_t *lfs,
  1243. lfs_cache_t *rcache, lfs_cache_t *pcache,
  1244. lfs_block_t head, lfs_size_t size,
  1245. lfs_block_t *block, lfs_off_t *off) {
  1246. while (true) {
  1247. // go ahead and grab a block
  1248. lfs_block_t nblock;
  1249. int err = lfs_alloc(lfs, &nblock);
  1250. if (err) {
  1251. return err;
  1252. }
  1253. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1254. if (true) {
  1255. err = lfs_bd_erase(lfs, nblock);
  1256. if (err) {
  1257. if (err == LFS_ERR_CORRUPT) {
  1258. goto relocate;
  1259. }
  1260. return err;
  1261. }
  1262. if (size == 0) {
  1263. *block = nblock;
  1264. *off = 0;
  1265. return 0;
  1266. }
  1267. size -= 1;
  1268. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1269. size += 1;
  1270. // just copy out the last block if it is incomplete
  1271. if (size != lfs->cfg->block_size) {
  1272. for (lfs_off_t i = 0; i < size; i++) {
  1273. uint8_t data;
  1274. err = lfs_cache_read(lfs, rcache, NULL,
  1275. head, i, &data, 1);
  1276. if (err) {
  1277. return err;
  1278. }
  1279. err = lfs_cache_prog(lfs, pcache, rcache,
  1280. nblock, i, &data, 1);
  1281. if (err) {
  1282. if (err == LFS_ERR_CORRUPT) {
  1283. goto relocate;
  1284. }
  1285. return err;
  1286. }
  1287. }
  1288. *block = nblock;
  1289. *off = size;
  1290. return 0;
  1291. }
  1292. // append block
  1293. index += 1;
  1294. lfs_size_t skips = lfs_ctz(index) + 1;
  1295. for (lfs_off_t i = 0; i < skips; i++) {
  1296. head = lfs_tole32(head);
  1297. err = lfs_cache_prog(lfs, pcache, rcache,
  1298. nblock, 4*i, &head, 4);
  1299. head = lfs_fromle32(head);
  1300. if (err) {
  1301. if (err == LFS_ERR_CORRUPT) {
  1302. goto relocate;
  1303. }
  1304. return err;
  1305. }
  1306. if (i != skips-1) {
  1307. err = lfs_cache_read(lfs, rcache, NULL,
  1308. head, 4*i, &head, 4);
  1309. head = lfs_fromle32(head);
  1310. if (err) {
  1311. return err;
  1312. }
  1313. }
  1314. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1315. }
  1316. *block = nblock;
  1317. *off = 4*skips;
  1318. return 0;
  1319. }
  1320. relocate:
  1321. LFS_DEBUG("Bad block at %d", nblock);
  1322. // just clear cache and try a new block
  1323. pcache->block = 0xffffffff;
  1324. }
  1325. }
  1326. static int lfs_ctz_traverse(lfs_t *lfs,
  1327. lfs_cache_t *rcache, const lfs_cache_t *pcache,
  1328. lfs_block_t head, lfs_size_t size,
  1329. int (*cb)(void*, lfs_block_t), void *data) {
  1330. if (size == 0) {
  1331. return 0;
  1332. }
  1333. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1334. while (true) {
  1335. int err = cb(data, head);
  1336. if (err) {
  1337. return err;
  1338. }
  1339. if (index == 0) {
  1340. return 0;
  1341. }
  1342. lfs_block_t heads[2];
  1343. int count = 2 - (index & 1);
  1344. err = lfs_cache_read(lfs, rcache, pcache, head, 0, &heads, count*4);
  1345. heads[0] = lfs_fromle32(heads[0]);
  1346. heads[1] = lfs_fromle32(heads[1]);
  1347. if (err) {
  1348. return err;
  1349. }
  1350. for (int i = 0; i < count-1; i++) {
  1351. err = cb(data, heads[i]);
  1352. if (err) {
  1353. return err;
  1354. }
  1355. }
  1356. head = heads[count-1];
  1357. index -= count;
  1358. }
  1359. }
  1360. /// Top level file operations ///
  1361. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1362. const char *path, int flags) {
  1363. // deorphan if we haven't yet, needed at most once after poweron
  1364. if ((flags & 3) != LFS_O_RDONLY && !lfs->deorphaned) {
  1365. int err = lfs_deorphan(lfs);
  1366. if (err) {
  1367. return err;
  1368. }
  1369. }
  1370. // allocate entry for file if it doesn't exist
  1371. lfs_dir_t cwd;
  1372. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1373. if (err) {
  1374. return err;
  1375. }
  1376. lfs_entry_t entry;
  1377. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1378. if (err && (err != LFS_ERR_NOENT || strchr(path, '/') != NULL)) {
  1379. return err;
  1380. }
  1381. if (err == LFS_ERR_NOENT) {
  1382. if (!(flags & LFS_O_CREAT)) {
  1383. return LFS_ERR_NOENT;
  1384. }
  1385. // check that name fits
  1386. lfs_size_t nlen = strlen(path);
  1387. if (nlen > lfs->name_size) {
  1388. return LFS_ERR_NAMETOOLONG;
  1389. }
  1390. // create entry to remember name
  1391. entry.d.type = LFS_STRUCT_INLINE | LFS_TYPE_REG;
  1392. entry.d.elen = 0;
  1393. entry.d.alen = 0;
  1394. entry.d.nlen = nlen;
  1395. entry.size = 0;
  1396. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1397. {LFS_FROM_MEM, 0, 0, &entry.d, 4},
  1398. {LFS_FROM_MEM, 0, 0, path, nlen}}, 2);
  1399. if (err) {
  1400. return err;
  1401. }
  1402. } else if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1403. return LFS_ERR_ISDIR;
  1404. } else if (flags & LFS_O_EXCL) {
  1405. return LFS_ERR_EXIST;
  1406. }
  1407. // allocate buffer if needed
  1408. file->cache.block = 0xffffffff;
  1409. if (lfs->cfg->file_buffer) {
  1410. file->cache.buffer = lfs->cfg->file_buffer;
  1411. } else if ((file->flags & 3) == LFS_O_RDONLY) {
  1412. file->cache.buffer = lfs_malloc(lfs->cfg->read_size);
  1413. if (!file->cache.buffer) {
  1414. return LFS_ERR_NOMEM;
  1415. }
  1416. } else {
  1417. file->cache.buffer = lfs_malloc(lfs->cfg->prog_size);
  1418. if (!file->cache.buffer) {
  1419. return LFS_ERR_NOMEM;
  1420. }
  1421. }
  1422. // setup file struct
  1423. file->pair[0] = cwd.pair[0];
  1424. file->pair[1] = cwd.pair[1];
  1425. file->pairoff = entry.off;
  1426. file->flags = flags;
  1427. file->pos = 0;
  1428. // calculate max inline size based on the size of the entry
  1429. file->inline_size = lfs_min(lfs->inline_size,
  1430. lfs->cfg->block_size - (sizeof(cwd.d)+4) -
  1431. (lfs_entry_size(&entry) - lfs_entry_elen(&entry)));
  1432. if ((0x70 & entry.d.type) == LFS_STRUCT_INLINE) {
  1433. // load inline files
  1434. file->head = 0xfffffffe;
  1435. file->size = lfs_entry_elen(&entry);
  1436. file->flags |= LFS_F_INLINE;
  1437. file->cache.block = file->head;
  1438. file->cache.off = 0;
  1439. err = lfs_dir_get(lfs, &cwd,
  1440. entry.off + 4,
  1441. file->cache.buffer, file->size);
  1442. if (err) {
  1443. lfs_free(file->cache.buffer);
  1444. return err;
  1445. }
  1446. } else {
  1447. // use ctz list from entry
  1448. file->head = entry.d.u.file.head;
  1449. file->size = entry.d.u.file.size;
  1450. }
  1451. // truncate if requested
  1452. if (flags & LFS_O_TRUNC) {
  1453. if (file->size != 0) {
  1454. file->flags |= LFS_F_DIRTY;
  1455. }
  1456. file->head = 0xfffffffe;
  1457. file->size = 0;
  1458. file->flags |= LFS_F_INLINE;
  1459. file->cache.block = file->head;
  1460. file->cache.off = 0;
  1461. }
  1462. // add to list of files
  1463. file->next = lfs->files;
  1464. lfs->files = file;
  1465. return 0;
  1466. }
  1467. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1468. int err = lfs_file_sync(lfs, file);
  1469. // remove from list of files
  1470. for (lfs_file_t **p = &lfs->files; *p; p = &(*p)->next) {
  1471. if (*p == file) {
  1472. *p = file->next;
  1473. break;
  1474. }
  1475. }
  1476. // clean up memory
  1477. if (!lfs->cfg->file_buffer) {
  1478. lfs_free(file->cache.buffer);
  1479. }
  1480. return err;
  1481. }
  1482. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1483. relocate:;
  1484. // just relocate what exists into new block
  1485. lfs_block_t nblock;
  1486. int err = lfs_alloc(lfs, &nblock);
  1487. if (err) {
  1488. return err;
  1489. }
  1490. err = lfs_bd_erase(lfs, nblock);
  1491. if (err) {
  1492. if (err == LFS_ERR_CORRUPT) {
  1493. goto relocate;
  1494. }
  1495. return err;
  1496. }
  1497. // either read from dirty cache or disk
  1498. for (lfs_off_t i = 0; i < file->off; i++) {
  1499. uint8_t data;
  1500. err = lfs_cache_read(lfs, &lfs->rcache, &file->cache,
  1501. file->block, i, &data, 1);
  1502. if (err) {
  1503. return err;
  1504. }
  1505. err = lfs_cache_prog(lfs, &lfs->pcache, &lfs->rcache,
  1506. nblock, i, &data, 1);
  1507. if (err) {
  1508. if (err == LFS_ERR_CORRUPT) {
  1509. goto relocate;
  1510. }
  1511. return err;
  1512. }
  1513. }
  1514. // copy over new state of file
  1515. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->prog_size);
  1516. file->cache.block = lfs->pcache.block;
  1517. file->cache.off = lfs->pcache.off;
  1518. lfs->pcache.block = 0xffffffff;
  1519. file->block = nblock;
  1520. return 0;
  1521. }
  1522. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  1523. if (file->flags & LFS_F_READING) {
  1524. file->flags &= ~LFS_F_READING;
  1525. }
  1526. if (file->flags & LFS_F_WRITING) {
  1527. lfs_off_t pos = file->pos;
  1528. if (!(file->flags & LFS_F_INLINE)) {
  1529. // copy over anything after current branch
  1530. lfs_file_t orig = {
  1531. .head = file->head,
  1532. .size = file->size,
  1533. .flags = LFS_O_RDONLY,
  1534. .pos = file->pos,
  1535. .cache = lfs->rcache,
  1536. };
  1537. lfs->rcache.block = 0xffffffff;
  1538. while (file->pos < file->size) {
  1539. // copy over a byte at a time, leave it up to caching
  1540. // to make this efficient
  1541. uint8_t data;
  1542. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  1543. if (res < 0) {
  1544. return res;
  1545. }
  1546. res = lfs_file_write(lfs, file, &data, 1);
  1547. if (res < 0) {
  1548. return res;
  1549. }
  1550. // keep our reference to the rcache in sync
  1551. if (lfs->rcache.block != 0xffffffff) {
  1552. orig.cache.block = 0xffffffff;
  1553. lfs->rcache.block = 0xffffffff;
  1554. }
  1555. }
  1556. // write out what we have
  1557. while (true) {
  1558. int err = lfs_cache_flush(lfs, &file->cache, &lfs->rcache);
  1559. if (err) {
  1560. if (err == LFS_ERR_CORRUPT) {
  1561. goto relocate;
  1562. }
  1563. return err;
  1564. }
  1565. break;
  1566. relocate:
  1567. LFS_DEBUG("Bad block at %d", file->block);
  1568. err = lfs_file_relocate(lfs, file);
  1569. if (err) {
  1570. return err;
  1571. }
  1572. }
  1573. } else {
  1574. file->size = lfs_max(file->pos, file->size);
  1575. }
  1576. // actual file updates
  1577. file->head = file->block;
  1578. file->size = file->pos;
  1579. file->flags &= ~LFS_F_WRITING;
  1580. file->flags |= LFS_F_DIRTY;
  1581. file->pos = pos;
  1582. }
  1583. return 0;
  1584. }
  1585. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  1586. int err = lfs_file_flush(lfs, file);
  1587. if (err) {
  1588. return err;
  1589. }
  1590. if ((file->flags & LFS_F_DIRTY) &&
  1591. !(file->flags & LFS_F_ERRED) &&
  1592. !lfs_pairisnull(file->pair)) {
  1593. // update dir entry
  1594. lfs_dir_t cwd;
  1595. err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1596. if (err) {
  1597. return err;
  1598. }
  1599. lfs_entry_t entry = {.off = file->pairoff};
  1600. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, 4);
  1601. if (err) {
  1602. return err;
  1603. }
  1604. entry.size = lfs_entry_size(&entry);
  1605. LFS_ASSERT((0xf & entry.d.type) == LFS_TYPE_REG);
  1606. lfs_size_t oldelen = lfs_entry_elen(&entry);
  1607. lfs_size_t oldalen = lfs_entry_alen(&entry);
  1608. const void *buffer;
  1609. lfs_size_t size;
  1610. // either update the references or inline the whole file
  1611. if (!(file->flags & LFS_F_INLINE)) {
  1612. entry.d.type = LFS_STRUCT_CTZ | LFS_TYPE_REG;
  1613. entry.d.u.file.head = file->head;
  1614. entry.d.u.file.size = file->size;
  1615. lfs_entry_tole32(&entry.d);
  1616. buffer = (const uint8_t *)&entry.d + 4;
  1617. size = sizeof(entry.d) - 4;
  1618. } else {
  1619. entry.d.type = LFS_STRUCT_INLINE | LFS_TYPE_REG;
  1620. buffer = file->cache.buffer;
  1621. size = file->size;
  1622. }
  1623. // get new alen from disk
  1624. lfs_ssize_t newalen = lfs_dir_checkattrs(lfs, &cwd, &entry,
  1625. file->attrs, file->attrcount);
  1626. if (newalen < 0) {
  1627. return newalen;
  1628. }
  1629. entry.d.elen = size & 0xff;
  1630. entry.d.alen = (newalen & 0x3f) | ((size >> 2) & 0xc0);
  1631. // write out update
  1632. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1633. {LFS_FROM_MEM, 0, 4, &entry.d, 4},
  1634. {LFS_FROM_MEM, 4, oldelen, buffer, size},
  1635. {LFS_FROM_ATTRS, 4+oldelen, oldalen,
  1636. &(struct lfs_region_attrs){file->attrs, file->attrcount},
  1637. newalen}}, 3);
  1638. if (err) {
  1639. return err;
  1640. }
  1641. file->flags &= ~LFS_F_DIRTY;
  1642. }
  1643. return 0;
  1644. }
  1645. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  1646. void *buffer, lfs_size_t size) {
  1647. uint8_t *data = buffer;
  1648. lfs_size_t nsize = size;
  1649. if ((file->flags & 3) == LFS_O_WRONLY) {
  1650. return LFS_ERR_BADF;
  1651. }
  1652. if (file->flags & LFS_F_WRITING) {
  1653. // flush out any writes
  1654. int err = lfs_file_flush(lfs, file);
  1655. if (err) {
  1656. return err;
  1657. }
  1658. }
  1659. if (file->pos >= file->size) {
  1660. // eof if past end
  1661. return 0;
  1662. }
  1663. size = lfs_min(size, file->size - file->pos);
  1664. nsize = size;
  1665. while (nsize > 0) {
  1666. // check if we need a new block
  1667. if (!(file->flags & LFS_F_READING) ||
  1668. file->off == lfs->cfg->block_size) {
  1669. if (!(file->flags & LFS_F_INLINE)) {
  1670. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1671. file->head, file->size,
  1672. file->pos, &file->block, &file->off);
  1673. if (err) {
  1674. return err;
  1675. }
  1676. } else {
  1677. file->block = 0xfffffffe;
  1678. file->off = file->pos;
  1679. }
  1680. file->flags |= LFS_F_READING;
  1681. }
  1682. // read as much as we can in current block
  1683. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1684. int err = lfs_cache_read(lfs, &file->cache, NULL,
  1685. file->block, file->off, data, diff);
  1686. if (err) {
  1687. return err;
  1688. }
  1689. file->pos += diff;
  1690. file->off += diff;
  1691. data += diff;
  1692. nsize -= diff;
  1693. }
  1694. return size;
  1695. }
  1696. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  1697. const void *buffer, lfs_size_t size) {
  1698. const uint8_t *data = buffer;
  1699. lfs_size_t nsize = size;
  1700. if ((file->flags & 3) == LFS_O_RDONLY) {
  1701. return LFS_ERR_BADF;
  1702. }
  1703. if (file->flags & LFS_F_READING) {
  1704. // drop any reads
  1705. int err = lfs_file_flush(lfs, file);
  1706. if (err) {
  1707. return err;
  1708. }
  1709. }
  1710. if ((file->flags & LFS_O_APPEND) && file->pos < file->size) {
  1711. file->pos = file->size;
  1712. }
  1713. if (!(file->flags & LFS_F_WRITING) && file->pos > file->size) {
  1714. // fill with zeros
  1715. lfs_off_t pos = file->pos;
  1716. file->pos = file->size;
  1717. while (file->pos < pos) {
  1718. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1719. if (res < 0) {
  1720. return res;
  1721. }
  1722. }
  1723. }
  1724. if ((file->flags & LFS_F_INLINE) &&
  1725. file->pos + nsize >= file->inline_size) {
  1726. // inline file doesn't fit anymore
  1727. file->block = 0xfffffffe;
  1728. file->off = file->pos;
  1729. lfs_alloc_ack(lfs);
  1730. int err = lfs_file_relocate(lfs, file);
  1731. if (err) {
  1732. file->flags |= LFS_F_ERRED;
  1733. return err;
  1734. }
  1735. file->flags &= ~LFS_F_INLINE;
  1736. file->flags |= LFS_F_WRITING;
  1737. }
  1738. while (nsize > 0) {
  1739. // check if we need a new block
  1740. if (!(file->flags & LFS_F_WRITING) ||
  1741. file->off == lfs->cfg->block_size) {
  1742. if (!(file->flags & LFS_F_INLINE)) {
  1743. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  1744. // find out which block we're extending from
  1745. int err = lfs_ctz_find(lfs, &file->cache, NULL,
  1746. file->head, file->size,
  1747. file->pos-1, &file->block, &file->off);
  1748. if (err) {
  1749. file->flags |= LFS_F_ERRED;
  1750. return err;
  1751. }
  1752. // mark cache as dirty since we may have read data into it
  1753. file->cache.block = 0xffffffff;
  1754. }
  1755. // extend file with new blocks
  1756. lfs_alloc_ack(lfs);
  1757. int err = lfs_ctz_extend(lfs, &lfs->rcache, &file->cache,
  1758. file->block, file->pos,
  1759. &file->block, &file->off);
  1760. if (err) {
  1761. file->flags |= LFS_F_ERRED;
  1762. return err;
  1763. }
  1764. } else {
  1765. file->block = 0xfffffffe;
  1766. file->off = file->pos;
  1767. }
  1768. file->flags |= LFS_F_WRITING;
  1769. }
  1770. // program as much as we can in current block
  1771. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  1772. while (true) {
  1773. int err = lfs_cache_prog(lfs, &file->cache, &lfs->rcache,
  1774. file->block, file->off, data, diff);
  1775. if (err) {
  1776. if (err == LFS_ERR_CORRUPT) {
  1777. goto relocate;
  1778. }
  1779. file->flags |= LFS_F_ERRED;
  1780. return err;
  1781. }
  1782. break;
  1783. relocate:
  1784. err = lfs_file_relocate(lfs, file);
  1785. if (err) {
  1786. file->flags |= LFS_F_ERRED;
  1787. return err;
  1788. }
  1789. }
  1790. file->pos += diff;
  1791. file->off += diff;
  1792. data += diff;
  1793. nsize -= diff;
  1794. lfs_alloc_ack(lfs);
  1795. }
  1796. file->flags &= ~LFS_F_ERRED;
  1797. return size;
  1798. }
  1799. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  1800. lfs_soff_t off, int whence) {
  1801. // write out everything beforehand, may be noop if rdonly
  1802. int err = lfs_file_flush(lfs, file);
  1803. if (err) {
  1804. return err;
  1805. }
  1806. // update pos
  1807. if (whence == LFS_SEEK_SET) {
  1808. file->pos = off;
  1809. } else if (whence == LFS_SEEK_CUR) {
  1810. if (off < 0 && (lfs_off_t)-off > file->pos) {
  1811. return LFS_ERR_INVAL;
  1812. }
  1813. file->pos = file->pos + off;
  1814. } else if (whence == LFS_SEEK_END) {
  1815. if (off < 0 && (lfs_off_t)-off > file->size) {
  1816. return LFS_ERR_INVAL;
  1817. }
  1818. file->pos = file->size + off;
  1819. }
  1820. return file->pos;
  1821. }
  1822. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  1823. if ((file->flags & 3) == LFS_O_RDONLY) {
  1824. return LFS_ERR_BADF;
  1825. }
  1826. lfs_off_t oldsize = lfs_file_size(lfs, file);
  1827. if (size < oldsize) {
  1828. // need to flush since directly changing metadata
  1829. int err = lfs_file_flush(lfs, file);
  1830. if (err) {
  1831. return err;
  1832. }
  1833. // lookup new head in ctz skip list
  1834. err = lfs_ctz_find(lfs, &file->cache, NULL,
  1835. file->head, file->size,
  1836. size, &file->head, &(lfs_off_t){0});
  1837. if (err) {
  1838. return err;
  1839. }
  1840. file->size = size;
  1841. file->flags |= LFS_F_DIRTY;
  1842. } else if (size > oldsize) {
  1843. lfs_off_t pos = file->pos;
  1844. // flush+seek if not already at end
  1845. if (file->pos != oldsize) {
  1846. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  1847. if (err < 0) {
  1848. return err;
  1849. }
  1850. }
  1851. // fill with zeros
  1852. while (file->pos < size) {
  1853. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  1854. if (res < 0) {
  1855. return res;
  1856. }
  1857. }
  1858. // restore pos
  1859. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  1860. if (err < 0) {
  1861. return err;
  1862. }
  1863. }
  1864. return 0;
  1865. }
  1866. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  1867. (void)lfs;
  1868. return file->pos;
  1869. }
  1870. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  1871. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  1872. if (res < 0) {
  1873. return res;
  1874. }
  1875. return 0;
  1876. }
  1877. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  1878. (void)lfs;
  1879. if (file->flags & LFS_F_WRITING) {
  1880. return lfs_max(file->pos, file->size);
  1881. } else {
  1882. return file->size;
  1883. }
  1884. }
  1885. int lfs_file_getattrs(lfs_t *lfs, lfs_file_t *file,
  1886. const struct lfs_attr *attrs, int count) {
  1887. // set to null in case we can't find the attrs (missing file?)
  1888. for (int j = 0; j < count; j++) {
  1889. memset(attrs[j].buffer, 0, attrs[j].size);
  1890. }
  1891. // load from disk if we haven't already been deleted
  1892. if (!lfs_pairisnull(file->pair)) {
  1893. lfs_dir_t cwd;
  1894. int err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1895. if (err) {
  1896. return err;
  1897. }
  1898. lfs_entry_t entry = {.off = file->pairoff};
  1899. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, 4);
  1900. if (err) {
  1901. return err;
  1902. }
  1903. entry.size = lfs_entry_size(&entry);
  1904. err = lfs_dir_getattrs(lfs, &cwd, &entry, attrs, count);
  1905. if (err) {
  1906. return err;
  1907. }
  1908. }
  1909. // override an attrs we have stored locally
  1910. for (int i = 0; i < file->attrcount; i++) {
  1911. for (int j = 0; j < count; j++) {
  1912. if (attrs[j].type == file->attrs[i].type) {
  1913. if (attrs[j].size < file->attrs[i].size) {
  1914. return LFS_ERR_RANGE;
  1915. }
  1916. memset(attrs[j].buffer, 0, attrs[j].size);
  1917. memcpy(attrs[j].buffer,
  1918. file->attrs[i].buffer, file->attrs[i].size);
  1919. }
  1920. }
  1921. }
  1922. return 0;
  1923. }
  1924. int lfs_file_setattrs(lfs_t *lfs, lfs_file_t *file,
  1925. const struct lfs_attr *attrs, int count) {
  1926. if ((file->flags & 3) == LFS_O_RDONLY) {
  1927. return LFS_ERR_BADF;
  1928. }
  1929. // at least make sure attributes fit
  1930. if (!lfs_pairisnull(file->pair)) {
  1931. lfs_dir_t cwd;
  1932. int err = lfs_dir_fetch(lfs, &cwd, file->pair);
  1933. if (err) {
  1934. return err;
  1935. }
  1936. lfs_entry_t entry = {.off = file->pairoff};
  1937. err = lfs_dir_get(lfs, &cwd, entry.off, &entry.d, 4);
  1938. if (err) {
  1939. return err;
  1940. }
  1941. entry.size = lfs_entry_size(&entry);
  1942. lfs_ssize_t res = lfs_dir_checkattrs(lfs, &cwd, &entry, attrs, count);
  1943. if (res < 0) {
  1944. return res;
  1945. }
  1946. }
  1947. // just tack to the file, will be written at sync time
  1948. file->attrs = attrs;
  1949. file->attrcount = count;
  1950. file->flags |= LFS_F_DIRTY;
  1951. return 0;
  1952. }
  1953. /// General fs operations ///
  1954. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  1955. lfs_dir_t cwd;
  1956. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1957. if (err) {
  1958. return err;
  1959. }
  1960. lfs_entry_t entry;
  1961. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1962. if (err) {
  1963. return err;
  1964. }
  1965. return lfs_dir_getinfo(lfs, &cwd, &entry, info);
  1966. }
  1967. int lfs_remove(lfs_t *lfs, const char *path) {
  1968. // deorphan if we haven't yet, needed at most once after poweron
  1969. if (!lfs->deorphaned) {
  1970. int err = lfs_deorphan(lfs);
  1971. if (err) {
  1972. return err;
  1973. }
  1974. }
  1975. lfs_dir_t cwd;
  1976. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  1977. if (err) {
  1978. return err;
  1979. }
  1980. lfs_entry_t entry;
  1981. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  1982. if (err) {
  1983. return err;
  1984. }
  1985. lfs_dir_t dir;
  1986. if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  1987. // must be empty before removal, checking size
  1988. // without masking top bit checks for any case where
  1989. // dir is not empty
  1990. err = lfs_dir_fetch(lfs, &dir, entry.d.u.dir);
  1991. if (err) {
  1992. return err;
  1993. } else if (dir.d.size != sizeof(dir.d)+4) {
  1994. return LFS_ERR_NOTEMPTY;
  1995. }
  1996. }
  1997. // remove the entry
  1998. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  1999. {LFS_FROM_MEM, 0, entry.size, NULL, 0}}, 1);
  2000. if (err) {
  2001. return err;
  2002. }
  2003. // if we were a directory, find pred, replace tail
  2004. if ((0xf & entry.d.type) == LFS_TYPE_DIR) {
  2005. int res = lfs_pred(lfs, dir.pair, &cwd);
  2006. if (res < 0) {
  2007. return res;
  2008. }
  2009. LFS_ASSERT(res); // must have pred
  2010. cwd.d.tail[0] = dir.d.tail[0];
  2011. cwd.d.tail[1] = dir.d.tail[1];
  2012. err = lfs_dir_commit(lfs, &cwd, NULL, 0);
  2013. if (err) {
  2014. return err;
  2015. }
  2016. }
  2017. return 0;
  2018. }
  2019. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  2020. // deorphan if we haven't yet, needed at most once after poweron
  2021. if (!lfs->deorphaned) {
  2022. int err = lfs_deorphan(lfs);
  2023. if (err) {
  2024. return err;
  2025. }
  2026. }
  2027. // find old entry
  2028. lfs_dir_t oldcwd;
  2029. int err = lfs_dir_fetch(lfs, &oldcwd, lfs->root);
  2030. if (err) {
  2031. return err;
  2032. }
  2033. lfs_entry_t oldentry;
  2034. err = lfs_dir_find(lfs, &oldcwd, &oldentry, &oldpath);
  2035. if (err) {
  2036. return err;
  2037. }
  2038. // allocate new entry
  2039. lfs_dir_t newcwd;
  2040. err = lfs_dir_fetch(lfs, &newcwd, lfs->root);
  2041. if (err) {
  2042. return err;
  2043. }
  2044. lfs_entry_t preventry;
  2045. err = lfs_dir_find(lfs, &newcwd, &preventry, &newpath);
  2046. if (err && (err != LFS_ERR_NOENT || strchr(newpath, '/') != NULL)) {
  2047. return err;
  2048. }
  2049. bool prevexists = (err != LFS_ERR_NOENT);
  2050. bool samepair = (lfs_paircmp(oldcwd.pair, newcwd.pair) == 0);
  2051. // check that name fits
  2052. lfs_size_t nlen = strlen(newpath);
  2053. if (nlen > lfs->name_size) {
  2054. return LFS_ERR_NAMETOOLONG;
  2055. }
  2056. if (oldentry.size - oldentry.d.nlen + nlen > lfs->cfg->block_size) {
  2057. return LFS_ERR_NOSPC;
  2058. }
  2059. // must have same type
  2060. if (prevexists && preventry.d.type != oldentry.d.type) {
  2061. return LFS_ERR_ISDIR;
  2062. }
  2063. lfs_dir_t dir;
  2064. if (prevexists && (0xf & preventry.d.type) == LFS_TYPE_DIR) {
  2065. // must be empty before removal, checking size
  2066. // without masking top bit checks for any case where
  2067. // dir is not empty
  2068. err = lfs_dir_fetch(lfs, &dir, preventry.d.u.dir);
  2069. if (err) {
  2070. return err;
  2071. } else if (dir.d.size != sizeof(dir.d)+4) {
  2072. return LFS_ERR_NOTEMPTY;
  2073. }
  2074. }
  2075. // mark as moving
  2076. oldentry.d.type |= LFS_STRUCT_MOVED;
  2077. err = lfs_dir_set(lfs, &oldcwd, &oldentry, (struct lfs_region[]){
  2078. {LFS_FROM_MEM, 0, 1, &oldentry.d.type, 1}}, 1);
  2079. oldentry.d.type &= ~LFS_STRUCT_MOVED;
  2080. if (err) {
  2081. return err;
  2082. }
  2083. // update pair if newcwd == oldcwd
  2084. if (samepair) {
  2085. newcwd = oldcwd;
  2086. }
  2087. // move to new location
  2088. lfs_entry_t newentry = preventry;
  2089. newentry.d = oldentry.d;
  2090. newentry.d.type &= ~LFS_STRUCT_MOVED;
  2091. newentry.d.nlen = nlen;
  2092. newentry.size = prevexists ? preventry.size : 0;
  2093. lfs_size_t newsize = oldentry.size - oldentry.d.nlen + newentry.d.nlen;
  2094. err = lfs_dir_set(lfs, &newcwd, &newentry, (struct lfs_region[]){
  2095. {LFS_FROM_REGION, 0, prevexists ? preventry.size : 0,
  2096. &(struct lfs_region_region){
  2097. oldcwd.pair[0], oldentry.off, (struct lfs_region[]){
  2098. {LFS_FROM_MEM, 0, 4, &newentry.d, 4},
  2099. {LFS_FROM_MEM, newsize-nlen, 0, newpath, nlen}}, 2},
  2100. newsize}}, 1);
  2101. if (err) {
  2102. return err;
  2103. }
  2104. // update pair if newcwd == oldcwd
  2105. if (samepair) {
  2106. oldcwd = newcwd;
  2107. }
  2108. // remove old entry
  2109. err = lfs_dir_set(lfs, &oldcwd, &oldentry, (struct lfs_region[]){
  2110. {LFS_FROM_MEM, 0, oldentry.size, NULL, 0}}, 1);
  2111. if (err) {
  2112. return err;
  2113. }
  2114. // if we were a directory, find pred, replace tail
  2115. if (prevexists && (0xf & preventry.d.type) == LFS_TYPE_DIR) {
  2116. int res = lfs_pred(lfs, dir.pair, &newcwd);
  2117. if (res < 0) {
  2118. return res;
  2119. }
  2120. LFS_ASSERT(res); // must have pred
  2121. newcwd.d.tail[0] = dir.d.tail[0];
  2122. newcwd.d.tail[1] = dir.d.tail[1];
  2123. err = lfs_dir_commit(lfs, &newcwd, NULL, 0);
  2124. if (err) {
  2125. return err;
  2126. }
  2127. }
  2128. return 0;
  2129. }
  2130. int lfs_getattrs(lfs_t *lfs, const char *path,
  2131. const struct lfs_attr *attrs, int count) {
  2132. lfs_dir_t cwd;
  2133. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2134. if (err) {
  2135. return err;
  2136. }
  2137. lfs_entry_t entry;
  2138. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2139. if (err) {
  2140. return err;
  2141. }
  2142. return lfs_dir_getattrs(lfs, &cwd, &entry, attrs, count);
  2143. }
  2144. int lfs_setattrs(lfs_t *lfs, const char *path,
  2145. const struct lfs_attr *attrs, int count) {
  2146. lfs_dir_t cwd;
  2147. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2148. if (err) {
  2149. return err;
  2150. }
  2151. lfs_entry_t entry;
  2152. err = lfs_dir_find(lfs, &cwd, &entry, &path);
  2153. if (err) {
  2154. return err;
  2155. }
  2156. return lfs_dir_setattrs(lfs, &cwd, &entry, attrs, count);
  2157. }
  2158. /// Filesystem operations ///
  2159. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2160. lfs->cfg = cfg;
  2161. // setup read cache
  2162. lfs->rcache.block = 0xffffffff;
  2163. if (lfs->cfg->read_buffer) {
  2164. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2165. } else {
  2166. lfs->rcache.buffer = lfs_malloc(lfs->cfg->read_size);
  2167. if (!lfs->rcache.buffer) {
  2168. return LFS_ERR_NOMEM;
  2169. }
  2170. }
  2171. // setup program cache
  2172. lfs->pcache.block = 0xffffffff;
  2173. if (lfs->cfg->prog_buffer) {
  2174. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2175. } else {
  2176. lfs->pcache.buffer = lfs_malloc(lfs->cfg->prog_size);
  2177. if (!lfs->pcache.buffer) {
  2178. return LFS_ERR_NOMEM;
  2179. }
  2180. }
  2181. // setup lookahead, round down to nearest 32-bits
  2182. LFS_ASSERT(lfs->cfg->lookahead % 32 == 0);
  2183. LFS_ASSERT(lfs->cfg->lookahead > 0);
  2184. if (lfs->cfg->lookahead_buffer) {
  2185. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2186. } else {
  2187. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead/8);
  2188. if (!lfs->free.buffer) {
  2189. return LFS_ERR_NOMEM;
  2190. }
  2191. }
  2192. // check that program and read sizes are multiples of the block size
  2193. LFS_ASSERT(lfs->cfg->prog_size % lfs->cfg->read_size == 0);
  2194. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->prog_size == 0);
  2195. // check that the block size is large enough to fit ctz pointers
  2196. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2197. <= lfs->cfg->block_size);
  2198. // check that the size limits are sane
  2199. LFS_ASSERT(lfs->cfg->inline_size <= LFS_INLINE_MAX);
  2200. LFS_ASSERT(lfs->cfg->inline_size <= lfs->cfg->read_size);
  2201. lfs->inline_size = lfs->cfg->inline_size;
  2202. if (!lfs->inline_size) {
  2203. lfs->inline_size = lfs_min(LFS_INLINE_MAX, lfs->cfg->read_size);
  2204. }
  2205. LFS_ASSERT(lfs->cfg->attrs_size <= LFS_ATTRS_MAX);
  2206. lfs->attrs_size = lfs->cfg->attrs_size;
  2207. if (!lfs->attrs_size) {
  2208. lfs->attrs_size = LFS_ATTRS_MAX;
  2209. }
  2210. LFS_ASSERT(lfs->cfg->name_size <= LFS_NAME_MAX);
  2211. lfs->name_size = lfs->cfg->name_size;
  2212. if (!lfs->name_size) {
  2213. lfs->name_size = LFS_NAME_MAX;
  2214. }
  2215. // setup default state
  2216. lfs->root[0] = 0xffffffff;
  2217. lfs->root[1] = 0xffffffff;
  2218. lfs->files = NULL;
  2219. lfs->dirs = NULL;
  2220. lfs->deorphaned = false;
  2221. return 0;
  2222. }
  2223. static int lfs_deinit(lfs_t *lfs) {
  2224. // free allocated memory
  2225. if (!lfs->cfg->read_buffer) {
  2226. lfs_free(lfs->rcache.buffer);
  2227. }
  2228. if (!lfs->cfg->prog_buffer) {
  2229. lfs_free(lfs->pcache.buffer);
  2230. }
  2231. if (!lfs->cfg->lookahead_buffer) {
  2232. lfs_free(lfs->free.buffer);
  2233. }
  2234. return 0;
  2235. }
  2236. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2237. int err = lfs_init(lfs, cfg);
  2238. if (err) {
  2239. return err;
  2240. }
  2241. // create free lookahead
  2242. memset(lfs->free.buffer, 0, lfs->cfg->lookahead/8);
  2243. lfs->free.off = 0;
  2244. lfs->free.size = lfs_min(lfs->cfg->lookahead, lfs->cfg->block_count);
  2245. lfs->free.i = 0;
  2246. lfs_alloc_ack(lfs);
  2247. // create superblock dir
  2248. lfs_dir_t superdir;
  2249. err = lfs_dir_alloc(lfs, &superdir);
  2250. if (err) {
  2251. return err;
  2252. }
  2253. // write root directory
  2254. lfs_dir_t root;
  2255. err = lfs_dir_alloc(lfs, &root);
  2256. if (err) {
  2257. return err;
  2258. }
  2259. err = lfs_dir_commit(lfs, &root, NULL, 0);
  2260. if (err) {
  2261. return err;
  2262. }
  2263. lfs->root[0] = root.pair[0];
  2264. lfs->root[1] = root.pair[1];
  2265. superdir.d.tail[0] = lfs->root[0];
  2266. superdir.d.tail[1] = lfs->root[1];
  2267. // write one superblock
  2268. lfs_superblock_t superblock;
  2269. superblock.d.version = LFS_DISK_VERSION,
  2270. superblock.d.root[0] = lfs->root[0];
  2271. superblock.d.root[1] = lfs->root[1];
  2272. superblock.d.block_size = lfs->cfg->block_size;
  2273. superblock.d.block_count = lfs->cfg->block_count;
  2274. superblock.d.inline_size = lfs->inline_size;
  2275. superblock.d.attrs_size = lfs->attrs_size;
  2276. superblock.d.name_size = lfs->name_size;
  2277. lfs_entry_t superentry;
  2278. superentry.d.type = LFS_STRUCT_DIR | LFS_TYPE_SUPERBLOCK;
  2279. superentry.d.elen = sizeof(superblock.d);
  2280. superentry.d.alen = 0;
  2281. superentry.d.nlen = strlen("littlefs");
  2282. superentry.off = sizeof(superdir.d);
  2283. superentry.size = 0;
  2284. lfs_entry_tole32(&superentry.d);
  2285. lfs_superblock_tole32(&superblock.d);
  2286. err = lfs_dir_set(lfs, &superdir, &superentry, (struct lfs_region[]){
  2287. {LFS_FROM_MEM, 0, 0, &superentry.d, 4},
  2288. {LFS_FROM_MEM, 0, 0, &superblock.d, sizeof(superblock.d)},
  2289. {LFS_FROM_MEM, 0, 0, "littlefs", superentry.d.nlen}}, 3);
  2290. if (err) {
  2291. return err;
  2292. }
  2293. // sanity check that fetch works
  2294. err = lfs_dir_fetch(lfs, &superdir, (const lfs_block_t[2]){0, 1});
  2295. if (err) {
  2296. return err;
  2297. }
  2298. return lfs_deinit(lfs);
  2299. }
  2300. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  2301. int err = lfs_init(lfs, cfg);
  2302. if (err) {
  2303. return err;
  2304. }
  2305. // setup free lookahead
  2306. lfs->free.off = 0;
  2307. lfs->free.size = 0;
  2308. lfs->free.i = 0;
  2309. lfs_alloc_ack(lfs);
  2310. // load superblock
  2311. lfs_dir_t dir;
  2312. err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2313. if (err) {
  2314. if (err == LFS_ERR_CORRUPT) {
  2315. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  2316. }
  2317. return err;
  2318. }
  2319. lfs_entry_t entry = {.off = sizeof(dir.d)};
  2320. err = lfs_dir_get(lfs, &dir, entry.off, &entry.d, 4);
  2321. if (err) {
  2322. return err;
  2323. }
  2324. lfs_superblock_t superblock;
  2325. memset(&superblock.d, 0, sizeof(superblock.d));
  2326. err = lfs_dir_get(lfs, &dir,
  2327. sizeof(dir.d)+4, &superblock.d,
  2328. lfs_min(sizeof(superblock.d), lfs_entry_elen(&entry)));
  2329. lfs_superblock_fromle32(&superblock.d);
  2330. if (err) {
  2331. return err;
  2332. }
  2333. char magic[8];
  2334. err = lfs_dir_get(lfs, &dir,
  2335. sizeof(dir.d)+lfs_entry_size(&entry)-entry.d.nlen, magic,
  2336. lfs_min(sizeof(magic), entry.d.nlen));
  2337. if (err) {
  2338. return err;
  2339. }
  2340. if (memcmp(magic, "littlefs", 8) != 0) {
  2341. LFS_ERROR("Invalid superblock at %d %d", 0, 1);
  2342. return LFS_ERR_CORRUPT;
  2343. }
  2344. uint16_t major_version = (0xffff & (superblock.d.version >> 16));
  2345. uint16_t minor_version = (0xffff & (superblock.d.version >> 0));
  2346. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  2347. minor_version > LFS_DISK_VERSION_MINOR)) {
  2348. LFS_ERROR("Invalid version %d.%d", major_version, minor_version);
  2349. return LFS_ERR_INVAL;
  2350. }
  2351. if (superblock.d.inline_size) {
  2352. if (superblock.d.inline_size > lfs->inline_size) {
  2353. LFS_ERROR("Unsupported inline size (%d > %d)",
  2354. superblock.d.inline_size, lfs->inline_size);
  2355. return LFS_ERR_INVAL;
  2356. }
  2357. lfs->inline_size = superblock.d.inline_size;
  2358. }
  2359. if (superblock.d.attrs_size) {
  2360. if (superblock.d.attrs_size > lfs->attrs_size) {
  2361. LFS_ERROR("Unsupported attrs size (%d > %d)",
  2362. superblock.d.attrs_size, lfs->attrs_size);
  2363. return LFS_ERR_INVAL;
  2364. }
  2365. lfs->attrs_size = superblock.d.attrs_size;
  2366. }
  2367. if (superblock.d.name_size) {
  2368. if (superblock.d.name_size > lfs->name_size) {
  2369. LFS_ERROR("Unsupported name size (%d > %d)",
  2370. superblock.d.name_size, lfs->name_size);
  2371. return LFS_ERR_INVAL;
  2372. }
  2373. lfs->name_size = superblock.d.name_size;
  2374. }
  2375. lfs->root[0] = superblock.d.root[0];
  2376. lfs->root[1] = superblock.d.root[1];
  2377. return 0;
  2378. }
  2379. int lfs_unmount(lfs_t *lfs) {
  2380. return lfs_deinit(lfs);
  2381. }
  2382. /// Internal filesystem filesystem operations ///
  2383. int lfs_traverse(lfs_t *lfs, int (*cb)(void*, lfs_block_t), void *data) {
  2384. if (lfs_pairisnull(lfs->root)) {
  2385. return 0;
  2386. }
  2387. // iterate over metadata pairs
  2388. lfs_block_t cwd[2] = {0, 1};
  2389. while (true) {
  2390. for (int i = 0; i < 2; i++) {
  2391. int err = cb(data, cwd[i]);
  2392. if (err) {
  2393. return err;
  2394. }
  2395. }
  2396. lfs_dir_t dir;
  2397. int err = lfs_dir_fetch(lfs, &dir, cwd);
  2398. if (err) {
  2399. return err;
  2400. }
  2401. // iterate over contents
  2402. lfs_entry_t entry;
  2403. while (dir.off + sizeof(entry.d) <= (0x7fffffff & dir.d.size)-4) {
  2404. err = lfs_dir_get(lfs, &dir,
  2405. dir.off, &entry.d, sizeof(entry.d));
  2406. lfs_entry_fromle32(&entry.d);
  2407. if (err) {
  2408. return err;
  2409. }
  2410. dir.off += lfs_entry_size(&entry);
  2411. if ((0x70 & entry.d.type) == LFS_STRUCT_CTZ) {
  2412. err = lfs_ctz_traverse(lfs, &lfs->rcache, NULL,
  2413. entry.d.u.file.head, entry.d.u.file.size, cb, data);
  2414. if (err) {
  2415. return err;
  2416. }
  2417. }
  2418. }
  2419. cwd[0] = dir.d.tail[0];
  2420. cwd[1] = dir.d.tail[1];
  2421. if (lfs_pairisnull(cwd)) {
  2422. break;
  2423. }
  2424. }
  2425. // iterate over any open files
  2426. for (lfs_file_t *f = lfs->files; f; f = f->next) {
  2427. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  2428. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  2429. f->head, f->size, cb, data);
  2430. if (err) {
  2431. return err;
  2432. }
  2433. }
  2434. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  2435. int err = lfs_ctz_traverse(lfs, &lfs->rcache, &f->cache,
  2436. f->block, f->pos, cb, data);
  2437. if (err) {
  2438. return err;
  2439. }
  2440. }
  2441. }
  2442. return 0;
  2443. }
  2444. static int lfs_pred(lfs_t *lfs, const lfs_block_t dir[2], lfs_dir_t *pdir) {
  2445. if (lfs_pairisnull(lfs->root)) {
  2446. return 0;
  2447. }
  2448. // iterate over all directory directory entries
  2449. int err = lfs_dir_fetch(lfs, pdir, (const lfs_block_t[2]){0, 1});
  2450. if (err) {
  2451. return err;
  2452. }
  2453. while (!lfs_pairisnull(pdir->d.tail)) {
  2454. if (lfs_paircmp(pdir->d.tail, dir) == 0) {
  2455. return true;
  2456. }
  2457. err = lfs_dir_fetch(lfs, pdir, pdir->d.tail);
  2458. if (err) {
  2459. return err;
  2460. }
  2461. }
  2462. return false;
  2463. }
  2464. static int lfs_parent(lfs_t *lfs, const lfs_block_t dir[2],
  2465. lfs_dir_t *parent, lfs_entry_t *entry) {
  2466. if (lfs_pairisnull(lfs->root)) {
  2467. return 0;
  2468. }
  2469. parent->d.tail[0] = 0;
  2470. parent->d.tail[1] = 1;
  2471. // iterate over all directory directory entries
  2472. while (!lfs_pairisnull(parent->d.tail)) {
  2473. int err = lfs_dir_fetch(lfs, parent, parent->d.tail);
  2474. if (err) {
  2475. return err;
  2476. }
  2477. while (true) {
  2478. err = lfs_dir_next(lfs, parent, entry);
  2479. if (err && err != LFS_ERR_NOENT) {
  2480. return err;
  2481. }
  2482. if (err == LFS_ERR_NOENT) {
  2483. break;
  2484. }
  2485. if (((0x70 & entry->d.type) == LFS_STRUCT_DIR) &&
  2486. lfs_paircmp(entry->d.u.dir, dir) == 0) {
  2487. return true;
  2488. }
  2489. }
  2490. }
  2491. return false;
  2492. }
  2493. static int lfs_moved(lfs_t *lfs, const void *e) {
  2494. if (lfs_pairisnull(lfs->root)) {
  2495. return 0;
  2496. }
  2497. // skip superblock
  2498. lfs_dir_t cwd;
  2499. int err = lfs_dir_fetch(lfs, &cwd, (const lfs_block_t[2]){0, 1});
  2500. if (err) {
  2501. return err;
  2502. }
  2503. // iterate over all directory directory entries
  2504. lfs_entry_t entry;
  2505. while (!lfs_pairisnull(cwd.d.tail)) {
  2506. err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2507. if (err) {
  2508. return err;
  2509. }
  2510. while (true) {
  2511. err = lfs_dir_next(lfs, &cwd, &entry);
  2512. if (err && err != LFS_ERR_NOENT) {
  2513. return err;
  2514. }
  2515. if (err == LFS_ERR_NOENT) {
  2516. break;
  2517. }
  2518. if (!(LFS_STRUCT_MOVED & entry.d.type) &&
  2519. memcmp(&entry.d.u, e, sizeof(entry.d.u)) == 0) {
  2520. return true;
  2521. }
  2522. }
  2523. }
  2524. return false;
  2525. }
  2526. static int lfs_relocate(lfs_t *lfs,
  2527. const lfs_block_t oldpair[2], const lfs_block_t newpair[2]) {
  2528. // find parent
  2529. lfs_dir_t parent;
  2530. lfs_entry_t entry;
  2531. int res = lfs_parent(lfs, oldpair, &parent, &entry);
  2532. if (res < 0) {
  2533. return res;
  2534. }
  2535. if (res) {
  2536. // update disk, this creates a desync
  2537. entry.d.u.dir[0] = newpair[0];
  2538. entry.d.u.dir[1] = newpair[1];
  2539. lfs_entry_tole32(&entry.d);
  2540. int err = lfs_dir_set(lfs, &parent, &entry, (struct lfs_region[]){
  2541. {LFS_FROM_MEM, 0, sizeof(entry.d),
  2542. &entry.d, sizeof(entry.d)}}, 1);
  2543. if (err) {
  2544. return err;
  2545. }
  2546. // update internal root
  2547. if (lfs_paircmp(oldpair, lfs->root) == 0) {
  2548. LFS_DEBUG("Relocating root %d %d", newpair[0], newpair[1]);
  2549. lfs->root[0] = newpair[0];
  2550. lfs->root[1] = newpair[1];
  2551. }
  2552. // clean up bad block, which should now be a desync
  2553. return lfs_deorphan(lfs);
  2554. }
  2555. // find pred
  2556. res = lfs_pred(lfs, oldpair, &parent);
  2557. if (res < 0) {
  2558. return res;
  2559. }
  2560. if (res) {
  2561. // just replace bad pair, no desync can occur
  2562. parent.d.tail[0] = newpair[0];
  2563. parent.d.tail[1] = newpair[1];
  2564. return lfs_dir_commit(lfs, &parent, NULL, 0);
  2565. }
  2566. // couldn't find dir, must be new
  2567. return 0;
  2568. }
  2569. int lfs_deorphan(lfs_t *lfs) {
  2570. lfs->deorphaned = true;
  2571. if (lfs_pairisnull(lfs->root)) {
  2572. return 0;
  2573. }
  2574. lfs_dir_t pdir = {.d.size = 0x80000000};
  2575. lfs_dir_t cwd = {.d.tail[0] = 0, .d.tail[1] = 1};
  2576. // iterate over all directory directory entries
  2577. while (!lfs_pairisnull(cwd.d.tail)) {
  2578. int err = lfs_dir_fetch(lfs, &cwd, cwd.d.tail);
  2579. if (err) {
  2580. return err;
  2581. }
  2582. // check head blocks for orphans
  2583. if (!(0x80000000 & pdir.d.size)) {
  2584. // check if we have a parent
  2585. lfs_dir_t parent;
  2586. lfs_entry_t entry;
  2587. int res = lfs_parent(lfs, pdir.d.tail, &parent, &entry);
  2588. if (res < 0) {
  2589. return res;
  2590. }
  2591. if (!res) {
  2592. // we are an orphan
  2593. LFS_DEBUG("Found orphan %d %d",
  2594. pdir.d.tail[0], pdir.d.tail[1]);
  2595. pdir.d.tail[0] = cwd.d.tail[0];
  2596. pdir.d.tail[1] = cwd.d.tail[1];
  2597. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2598. if (err) {
  2599. return err;
  2600. }
  2601. break;
  2602. }
  2603. if (!lfs_pairsync(entry.d.u.dir, pdir.d.tail)) {
  2604. // we have desynced
  2605. LFS_DEBUG("Found desync %d %d",
  2606. entry.d.u.dir[0], entry.d.u.dir[1]);
  2607. pdir.d.tail[0] = entry.d.u.dir[0];
  2608. pdir.d.tail[1] = entry.d.u.dir[1];
  2609. err = lfs_dir_commit(lfs, &pdir, NULL, 0);
  2610. if (err) {
  2611. return err;
  2612. }
  2613. break;
  2614. }
  2615. }
  2616. // check entries for moves
  2617. lfs_entry_t entry;
  2618. while (true) {
  2619. err = lfs_dir_next(lfs, &cwd, &entry);
  2620. if (err && err != LFS_ERR_NOENT) {
  2621. return err;
  2622. }
  2623. if (err == LFS_ERR_NOENT) {
  2624. break;
  2625. }
  2626. // found moved entry
  2627. if (entry.d.type & LFS_STRUCT_MOVED) {
  2628. int moved = lfs_moved(lfs, &entry.d.u);
  2629. if (moved < 0) {
  2630. return moved;
  2631. }
  2632. if (moved) {
  2633. LFS_DEBUG("Found move %d %d",
  2634. entry.d.u.dir[0], entry.d.u.dir[1]);
  2635. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  2636. {LFS_FROM_MEM, 0, entry.size, NULL, 0}}, 1);
  2637. if (err) {
  2638. return err;
  2639. }
  2640. } else {
  2641. LFS_DEBUG("Found partial move %d %d",
  2642. entry.d.u.dir[0], entry.d.u.dir[1]);
  2643. entry.d.type &= ~LFS_STRUCT_MOVED;
  2644. err = lfs_dir_set(lfs, &cwd, &entry, (struct lfs_region[]){
  2645. {LFS_FROM_MEM, 0, 1, &entry.d, 1}}, 1);
  2646. if (err) {
  2647. return err;
  2648. }
  2649. }
  2650. }
  2651. }
  2652. memcpy(&pdir, &cwd, sizeof(pdir));
  2653. }
  2654. return 0;
  2655. }
  2656. /// External filesystem filesystem operations ///
  2657. int lfs_fs_getattrs(lfs_t *lfs, const struct lfs_attr *attrs, int count) {
  2658. lfs_dir_t dir;
  2659. int err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2660. if (err) {
  2661. return err;
  2662. }
  2663. lfs_entry_t entry = {.off = sizeof(dir.d)};
  2664. err = lfs_dir_get(lfs, &dir, entry.off, &entry.d, 4);
  2665. if (err) {
  2666. return err;
  2667. }
  2668. entry.size = lfs_entry_size(&entry);
  2669. return lfs_dir_getattrs(lfs, &dir, &entry, attrs, count);
  2670. }
  2671. int lfs_fs_setattrs(lfs_t *lfs, const struct lfs_attr *attrs, int count) {
  2672. lfs_dir_t dir;
  2673. int err = lfs_dir_fetch(lfs, &dir, (const lfs_block_t[2]){0, 1});
  2674. if (err) {
  2675. return err;
  2676. }
  2677. lfs_entry_t entry = {.off = sizeof(dir.d)};
  2678. err = lfs_dir_get(lfs, &dir, entry.off, &entry.d, 4);
  2679. if (err) {
  2680. return err;
  2681. }
  2682. entry.size = lfs_entry_size(&entry);
  2683. return lfs_dir_setattrs(lfs, &dir, &entry, attrs, count);
  2684. }
  2685. static int lfs_fs_size_count(void *p, lfs_block_t block) {
  2686. lfs_size_t *size = p;
  2687. *size += 1;
  2688. return 0;
  2689. }
  2690. lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
  2691. lfs_size_t size = 0;
  2692. int err = lfs_traverse(lfs, lfs_fs_size_count, &size);
  2693. if (err) {
  2694. return err;
  2695. }
  2696. return size;
  2697. }