lfs.c 101 KB

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