lfs.c 101 KB

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