lfs.c 102 KB

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