lfs.c 97 KB

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