lfs.c 102 KB

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