lfs.c 106 KB

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