lfs.c 102 KB

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