lfs.c 96 KB

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