lfs.c 100 KB

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