lfs.c 103 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639
  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 & 0x78000000) >> 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_CREATE) {
  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_CREATE) {
  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, 0x78000000,
  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_DIR, 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, 0x783fe000,
  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. return tag;
  760. }
  761. // a greater name found, exit early
  762. if (res > 1 && lfs_tag_type(tag) != LFS_TYPE_SUPERBLOCK) {
  763. return tag | 0x1fff;
  764. }
  765. // no match keep looking
  766. return 0;
  767. }
  768. static int lfs_dir_find(lfs_t *lfs, lfs_mdir_t *dir,
  769. const char **path, uint16_t *id) {
  770. // we reduce path to a single name if we can find it
  771. const char *name = *path;
  772. // default to root dir
  773. lfs_stag_t tag = LFS_MKTAG(LFS_TYPE_DIR, 0x1ff, 0);
  774. dir->tail[0] = lfs->root[0];
  775. dir->tail[1] = lfs->root[1];
  776. while (true) {
  777. nextname:
  778. // skip slashes
  779. name += strspn(name, "/");
  780. lfs_size_t namelen = strcspn(name, "/");
  781. // skip '.' and root '..'
  782. if ((namelen == 1 && memcmp(name, ".", 1) == 0) ||
  783. (namelen == 2 && memcmp(name, "..", 2) == 0)) {
  784. name += namelen;
  785. goto nextname;
  786. }
  787. // skip if matched by '..' in name
  788. const char *suffix = name + namelen;
  789. lfs_size_t sufflen;
  790. int depth = 1;
  791. while (true) {
  792. suffix += strspn(suffix, "/");
  793. sufflen = strcspn(suffix, "/");
  794. if (sufflen == 0) {
  795. break;
  796. }
  797. if (sufflen == 2 && memcmp(suffix, "..", 2) == 0) {
  798. depth -= 1;
  799. if (depth == 0) {
  800. name = suffix + sufflen;
  801. goto nextname;
  802. }
  803. } else {
  804. depth += 1;
  805. }
  806. suffix += sufflen;
  807. }
  808. // found path
  809. if (name[0] == '\0') {
  810. return tag;
  811. }
  812. // update what we've found so far
  813. *path = name;
  814. // only continue if we hit a directory
  815. if (lfs_tag_type(tag) != LFS_TYPE_DIR) {
  816. return LFS_ERR_NOTDIR;
  817. }
  818. // grab the entry data
  819. if (lfs_tag_id(tag) != 0x1ff) {
  820. lfs_stag_t res = lfs_dir_get(lfs, dir, 0x783fe000,
  821. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), dir->tail);
  822. if (res < 0) {
  823. return res;
  824. }
  825. lfs_pair_fromle32(dir->tail);
  826. }
  827. // find entry matching name
  828. while (true) {
  829. tag = lfs_dir_fetchmatch(lfs, dir, dir->tail,
  830. 0x7c000000, LFS_MKTAG(LFS_TYPE_DIR, 0, namelen),
  831. lfs_dir_find_match, &(struct lfs_dir_find_match){
  832. lfs, name, namelen});
  833. if (tag < 0) {
  834. return tag;
  835. }
  836. if (id) {
  837. if (strchr(name, '/') != NULL) {
  838. // if path is not only name we're not valid candidate
  839. // for creation
  840. *id = 0x1ff;
  841. } else if (tag) {
  842. *id = lfs_tag_id(tag);
  843. } else {
  844. *id = dir->count;
  845. }
  846. }
  847. if (tag && !lfs_tag_isdelete(tag)) {
  848. break;
  849. }
  850. if (lfs_tag_isdelete(tag) || !dir->split) {
  851. return LFS_ERR_NOENT;
  852. }
  853. }
  854. // to next name
  855. name += namelen;
  856. }
  857. }
  858. // commit logic
  859. struct lfs_commit {
  860. lfs_block_t block;
  861. lfs_off_t off;
  862. lfs_tag_t ptag;
  863. uint32_t crc;
  864. lfs_off_t begin;
  865. lfs_off_t end;
  866. lfs_off_t ack;
  867. };
  868. static int lfs_commit_prog(lfs_t *lfs, struct lfs_commit *commit,
  869. const void *buffer, lfs_size_t size) {
  870. lfs_off_t skip = lfs_min(lfs_max(commit->ack, commit->off)
  871. - commit->off, size);
  872. int err = lfs_bd_prog(lfs,
  873. &lfs->pcache, &lfs->rcache, false,
  874. commit->block, commit->off + skip,
  875. (const uint8_t*)buffer + skip, size - skip);
  876. if (err) {
  877. return err;
  878. }
  879. commit->crc = lfs_crc(commit->crc, buffer, size);
  880. commit->off += size;
  881. commit->ack = lfs_max(commit->off, commit->ack);
  882. return 0;
  883. }
  884. static int lfs_commit_attr(lfs_t *lfs, struct lfs_commit *commit,
  885. lfs_tag_t tag, const void *buffer);
  886. struct lfs_commit_move_match {
  887. lfs_t *lfs;
  888. struct lfs_commit *commit;
  889. int pass;
  890. };
  891. static int lfs_commit_move_match(void *data,
  892. lfs_tag_t tag, const void *buffer) {
  893. struct lfs_commit_move_match *move = data;
  894. lfs_t *lfs = move->lfs;
  895. struct lfs_commit *commit = move->commit;
  896. if (move->pass == 0) {
  897. if (lfs_tag_subtype(tag) != LFS_TYPE_CREATE) {
  898. return 0;
  899. }
  900. } else {
  901. // check if type has already been committed
  902. lfs_stag_t res = lfs_dir_traverse(lfs, &(const lfs_mdir_t){
  903. .pair[0] = commit->block,
  904. .off = commit->off,
  905. .etag = commit->ptag}, NULL,
  906. lfs_tag_isuser(tag) ? 0x7fffe000 : 0x783fe000, tag, 0,
  907. lfs_dir_get_match, &(struct lfs_dir_get_match){
  908. lfs, NULL, 0, true});
  909. if (res < 0 && res != LFS_ERR_NOENT) {
  910. return res;
  911. }
  912. if (res > 0) {
  913. return 0;
  914. }
  915. }
  916. // update id and commit, as we are currently unique
  917. return lfs_commit_attr(lfs, commit, tag, buffer);
  918. }
  919. static int lfs_commit_move(lfs_t *lfs, struct lfs_commit *commit, int pass,
  920. lfs_tag_t frommask, lfs_tag_t fromtag, lfs_stag_t fromdiff,
  921. const lfs_mdir_t *dir, const struct lfs_mattr *attrs) {
  922. return lfs_dir_traverse(lfs, dir, attrs,
  923. frommask, fromtag, fromdiff,
  924. lfs_commit_move_match, &(struct lfs_commit_move_match){
  925. lfs, commit, pass});
  926. }
  927. static int lfs_commit_userattrs(lfs_t *lfs, struct lfs_commit *commit,
  928. uint16_t id, const struct lfs_attr *attrs) {
  929. for (const struct lfs_attr *a = attrs; a; a = a->next) {
  930. int err = lfs_commit_attr(lfs, commit,
  931. LFS_MKTAG(0x100 | a->type, id, a->size), a->buffer);
  932. if (err) {
  933. return err;
  934. }
  935. }
  936. return 0;
  937. }
  938. static int lfs_commit_attr(lfs_t *lfs, struct lfs_commit *commit,
  939. lfs_tag_t tag, const void *buffer) {
  940. if (lfs_tag_type(tag) == LFS_FROM_MOVE) {
  941. // special case for moves
  942. return lfs_commit_move(lfs, commit, 1,
  943. 0x003fe000, LFS_MKTAG(0, lfs_tag_size(tag), 0),
  944. LFS_MKTAG(0, lfs_tag_id(tag), 0) -
  945. LFS_MKTAG(0, lfs_tag_size(tag), 0),
  946. buffer, NULL);
  947. } else if (lfs_tag_type(tag) == LFS_FROM_USERATTRS) {
  948. // special case for custom attributes
  949. return lfs_commit_userattrs(lfs, commit,
  950. lfs_tag_id(tag), buffer);
  951. }
  952. // check if we fit
  953. lfs_size_t dsize = lfs_tag_dsize(tag);
  954. if (commit->off + dsize > commit->end) {
  955. return LFS_ERR_NOSPC;
  956. }
  957. // write out tag
  958. lfs_tag_t ntag = lfs_tole32((tag & 0x7fffffff) ^ commit->ptag);
  959. int err = lfs_commit_prog(lfs, commit, &ntag, sizeof(ntag));
  960. if (err) {
  961. return err;
  962. }
  963. if (!(tag & 0x80000000)) {
  964. // from memory
  965. err = lfs_commit_prog(lfs, commit, buffer, dsize-sizeof(tag));
  966. if (err) {
  967. return err;
  968. }
  969. } else {
  970. // from disk
  971. const struct lfs_diskoff *disk = buffer;
  972. for (lfs_off_t i = 0; i < dsize-sizeof(tag); i++) {
  973. // rely on caching to make this efficient
  974. uint8_t dat;
  975. err = lfs_bd_read(lfs,
  976. &lfs->pcache, &lfs->rcache, dsize-sizeof(tag)-i,
  977. disk->block, disk->off+i, &dat, 1);
  978. if (err) {
  979. return err;
  980. }
  981. err = lfs_commit_prog(lfs, commit, &dat, 1);
  982. if (err) {
  983. return err;
  984. }
  985. }
  986. }
  987. commit->ptag = tag & 0x7fffffff;
  988. return 0;
  989. }
  990. static int lfs_commit_globals(lfs_t *lfs, struct lfs_commit *commit,
  991. struct lfs_globals *globals) {
  992. return lfs_commit_attr(lfs, commit,
  993. LFS_MKTAG(LFS_TYPE_GLOBALS + 2*globals->hasmove + globals->orphans,
  994. 0x1ff, 10), globals);
  995. }
  996. static int lfs_commit_crc(lfs_t *lfs, struct lfs_commit *commit,
  997. bool compacting) {
  998. // align to program units
  999. lfs_off_t off = lfs_alignup(commit->off + 2*sizeof(uint32_t),
  1000. lfs->cfg->prog_size);
  1001. // read erased state from next program unit
  1002. lfs_tag_t tag;
  1003. int err = lfs_bd_read(lfs,
  1004. &lfs->pcache, &lfs->rcache, sizeof(tag),
  1005. commit->block, off, &tag, sizeof(tag));
  1006. if (err && err != LFS_ERR_CORRUPT) {
  1007. return err;
  1008. }
  1009. // build crc tag
  1010. bool reset = ~lfs_fromle32(tag) >> 31;
  1011. tag = LFS_MKTAG(LFS_TYPE_CRC + 2*compacting + reset,
  1012. 0x1ff, off - (commit->off+sizeof(lfs_tag_t)));
  1013. // write out crc
  1014. uint32_t footer[2];
  1015. footer[0] = lfs_tole32(tag ^ commit->ptag);
  1016. commit->crc = lfs_crc(commit->crc, &footer[0], sizeof(footer[0]));
  1017. footer[1] = lfs_tole32(commit->crc);
  1018. err = lfs_bd_prog(lfs,
  1019. &lfs->pcache, &lfs->rcache, false,
  1020. commit->block, commit->off, &footer, sizeof(footer));
  1021. if (err) {
  1022. return err;
  1023. }
  1024. commit->off += sizeof(tag)+lfs_tag_size(tag);
  1025. commit->ptag = tag ^ (reset << 31);
  1026. // flush buffers
  1027. err = lfs_bd_sync(lfs, &lfs->pcache, &lfs->rcache, false);
  1028. if (err) {
  1029. return err;
  1030. }
  1031. // successful commit, check checksum to make sure
  1032. uint32_t crc = 0xffffffff;
  1033. lfs_size_t size = commit->off - lfs_tag_size(tag) - commit->begin;
  1034. for (lfs_off_t i = 0; i < size; i++) {
  1035. // leave it up to caching to make this efficient
  1036. uint8_t dat;
  1037. err = lfs_bd_read(lfs,
  1038. NULL, &lfs->rcache, size-i,
  1039. commit->block, commit->begin+i, &dat, 1);
  1040. if (err) {
  1041. return err;
  1042. }
  1043. crc = lfs_crc(crc, &dat, 1);
  1044. }
  1045. if (err) {
  1046. return err;
  1047. }
  1048. if (crc != commit->crc) {
  1049. return LFS_ERR_CORRUPT;
  1050. }
  1051. return 0;
  1052. }
  1053. static int lfs_dir_alloc(lfs_t *lfs, lfs_mdir_t *dir) {
  1054. // allocate pair of dir blocks (backwards, so we write block 1 first)
  1055. for (int i = 0; i < 2; i++) {
  1056. int err = lfs_alloc(lfs, &dir->pair[(i+1)%2]);
  1057. if (err) {
  1058. return err;
  1059. }
  1060. }
  1061. // rather than clobbering one of the blocks we just pretend
  1062. // the revision may be valid
  1063. int err = lfs_bd_read(lfs,
  1064. &lfs->pcache, &lfs->rcache, sizeof(dir->rev),
  1065. dir->pair[0], 0, &dir->rev, sizeof(dir->rev));
  1066. if (err) {
  1067. return err;
  1068. }
  1069. dir->rev = lfs_fromle32(dir->rev);
  1070. if (err && err != LFS_ERR_CORRUPT) {
  1071. return err;
  1072. }
  1073. // set defaults
  1074. dir->off = sizeof(dir->rev);
  1075. dir->etag = 0xffffffff;
  1076. dir->count = 0;
  1077. dir->tail[0] = 0xffffffff;
  1078. dir->tail[1] = 0xffffffff;
  1079. dir->erased = false;
  1080. dir->split = false;
  1081. // don't write out yet, let caller take care of that
  1082. return 0;
  1083. }
  1084. static int lfs_dir_drop(lfs_t *lfs, lfs_mdir_t *dir, const lfs_mdir_t *tail) {
  1085. // steal tail
  1086. dir->tail[0] = tail->tail[0];
  1087. dir->tail[1] = tail->tail[1];
  1088. dir->split = tail->split;
  1089. // steal state
  1090. int err = lfs_dir_getglobals(lfs, tail, &lfs->locals);
  1091. if (err) {
  1092. return err;
  1093. }
  1094. // update pred's tail
  1095. return lfs_dir_commit(lfs, dir,
  1096. LFS_MKATTR(LFS_TYPE_TAIL + dir->split,
  1097. 0x1ff, dir->tail, sizeof(dir->tail),
  1098. NULL));
  1099. }
  1100. static int lfs_dir_compact(lfs_t *lfs,
  1101. lfs_mdir_t *dir, const struct lfs_mattr *attrs,
  1102. lfs_mdir_t *source, uint16_t begin, uint16_t end) {
  1103. // save some state in case block is bad
  1104. const lfs_block_t oldpair[2] = {dir->pair[1], dir->pair[0]};
  1105. bool relocated = false;
  1106. // There's nothing special about our global delta, so feed it back
  1107. // into the global global delta
  1108. int err = lfs_dir_getglobals(lfs, dir, &lfs->locals);
  1109. if (err) {
  1110. return err;
  1111. }
  1112. // begin loop to commit compaction to blocks until a compact sticks
  1113. while (true) {
  1114. // setup compaction
  1115. bool splitted = false;
  1116. bool exhausted = false;
  1117. bool overcompacting = false;
  1118. struct lfs_commit commit;
  1119. commit.block = dir->pair[1];
  1120. commit.ack = 0;
  1121. commit:
  1122. // setup erase state
  1123. exhausted = false;
  1124. dir->count = end - begin;
  1125. int16_t ackid = -1;
  1126. // setup commit state
  1127. commit.off = 0;
  1128. commit.crc = 0xffffffff;
  1129. commit.ptag = 0xffffffff;
  1130. // space is complicated, we need room for tail, crc, globals,
  1131. // cleanup delete, and we cap at half a block to give room
  1132. // for metadata updates
  1133. commit.begin = 0;
  1134. commit.end = lfs->cfg->block_size - 38;
  1135. if (!overcompacting) {
  1136. commit.end = lfs_min(commit.end,
  1137. lfs_alignup(lfs->cfg->block_size/2, lfs->cfg->prog_size));
  1138. }
  1139. if (!splitted) {
  1140. // increment revision count
  1141. dir->rev += 1;
  1142. if (lfs->cfg->block_cycles &&
  1143. dir->rev % lfs->cfg->block_cycles == 0) {
  1144. if (lfs_pair_cmp(dir->pair,
  1145. (const lfs_block_t[2]){0, 1}) == 0) {
  1146. // we're writing too much to the superblock,
  1147. // should we expand?
  1148. lfs_stag_t res = lfs_fs_size(lfs);
  1149. if (res < 0) {
  1150. return res;
  1151. }
  1152. // do we have enough space to expand?
  1153. if (res < lfs->cfg->block_count/2) {
  1154. LFS_DEBUG("Expanding superblock at rev %"PRIu32,
  1155. dir->rev);
  1156. exhausted = true;
  1157. goto split;
  1158. }
  1159. } else {
  1160. // we're writing too much, time to relocate
  1161. exhausted = true;
  1162. goto relocate;
  1163. }
  1164. }
  1165. // erase block to write to
  1166. err = lfs_bd_erase(lfs, dir->pair[1]);
  1167. if (err) {
  1168. if (err == LFS_ERR_CORRUPT) {
  1169. goto relocate;
  1170. }
  1171. return err;
  1172. }
  1173. }
  1174. // write out header
  1175. uint32_t rev = lfs_tole32(dir->rev);
  1176. err = lfs_commit_prog(lfs, &commit, &rev, sizeof(rev));
  1177. if (err) {
  1178. if (err == LFS_ERR_CORRUPT) {
  1179. goto relocate;
  1180. }
  1181. return err;
  1182. }
  1183. // commit with a move
  1184. for (uint16_t id = begin; id < end || commit.off < commit.ack; id++) {
  1185. for (int pass = 0; pass < 2; pass++) {
  1186. err = lfs_commit_move(lfs, &commit, pass,
  1187. 0x003fe000, LFS_MKTAG(0, id, 0),
  1188. -LFS_MKTAG(0, begin, 0),
  1189. source, attrs);
  1190. if (err && !(splitted && !overcompacting &&
  1191. err == LFS_ERR_NOSPC)) {
  1192. if (!overcompacting && err == LFS_ERR_NOSPC) {
  1193. goto split;
  1194. } else if (err == LFS_ERR_CORRUPT) {
  1195. goto relocate;
  1196. }
  1197. return err;
  1198. }
  1199. }
  1200. ackid = id;
  1201. }
  1202. // reopen reserved space at the end
  1203. commit.end = lfs->cfg->block_size - 8;
  1204. if (ackid >= end) {
  1205. // extra garbage attributes were written out during split,
  1206. // need to clean up
  1207. err = lfs_commit_attr(lfs, &commit,
  1208. LFS_MKTAG(LFS_TYPE_DELETE, ackid, 0), NULL);
  1209. if (err) {
  1210. if (err == LFS_ERR_CORRUPT) {
  1211. goto relocate;
  1212. }
  1213. return err;
  1214. }
  1215. }
  1216. if (!relocated && !lfs_global_iszero(&lfs->locals)) {
  1217. // commit any globals, unless we're relocating,
  1218. // in which case our parent will steal our globals
  1219. err = lfs_commit_globals(lfs, &commit, &lfs->locals);
  1220. if (err) {
  1221. if (err == LFS_ERR_CORRUPT) {
  1222. goto relocate;
  1223. }
  1224. return err;
  1225. }
  1226. }
  1227. if (!lfs_pair_isnull(dir->tail)) {
  1228. // commit tail, which may be new after last size check
  1229. lfs_pair_tole32(dir->tail);
  1230. err = lfs_commit_attr(lfs, &commit,
  1231. LFS_MKTAG(LFS_TYPE_TAIL + dir->split,
  1232. 0x1ff, sizeof(dir->tail)), dir->tail);
  1233. lfs_pair_fromle32(dir->tail);
  1234. if (err) {
  1235. if (err == LFS_ERR_CORRUPT) {
  1236. goto relocate;
  1237. }
  1238. return err;
  1239. }
  1240. }
  1241. err = lfs_commit_crc(lfs, &commit, true);
  1242. if (err) {
  1243. if (err == LFS_ERR_CORRUPT) {
  1244. goto relocate;
  1245. }
  1246. return err;
  1247. }
  1248. // successful compaction, swap dir pair to indicate most recent
  1249. lfs_pair_swap(dir->pair);
  1250. dir->off = commit.off;
  1251. dir->etag = commit.ptag;
  1252. dir->erased = true;
  1253. break;
  1254. split:
  1255. // commit no longer fits, need to split dir,
  1256. // drop caches and create tail
  1257. splitted = !exhausted;
  1258. if (lfs->pcache.block != 0xffffffff) {
  1259. commit.ack -= lfs->pcache.size;
  1260. lfs_cache_drop(lfs, &lfs->pcache);
  1261. }
  1262. if (!exhausted && ackid < 0) {
  1263. // If we can't fit in this block, we won't fit in next block
  1264. return LFS_ERR_NOSPC;
  1265. }
  1266. lfs_mdir_t tail;
  1267. err = lfs_dir_alloc(lfs, &tail);
  1268. if (err) {
  1269. if (err == LFS_ERR_NOSPC) {
  1270. // No space to expand? Try overcompacting
  1271. overcompacting = true;
  1272. goto commit;
  1273. }
  1274. return err;
  1275. }
  1276. tail.split = dir->split;
  1277. tail.tail[0] = dir->tail[0];
  1278. tail.tail[1] = dir->tail[1];
  1279. err = lfs_dir_compact(lfs, &tail, attrs, source, ackid+1, end);
  1280. if (err) {
  1281. return err;
  1282. }
  1283. end = ackid+1;
  1284. dir->tail[0] = tail.pair[0];
  1285. dir->tail[1] = tail.pair[1];
  1286. dir->split = true;
  1287. if (exhausted) {
  1288. lfs->root[0] = tail.pair[0];
  1289. lfs->root[1] = tail.pair[1];
  1290. }
  1291. goto commit;
  1292. relocate:
  1293. // commit was corrupted, drop caches and prepare to relocate block
  1294. relocated = true;
  1295. lfs_cache_drop(lfs, &lfs->pcache);
  1296. if (!exhausted) {
  1297. LFS_DEBUG("Bad block at %"PRIu32, dir->pair[1]);
  1298. }
  1299. // can't relocate superblock, filesystem is now frozen
  1300. if (lfs_pair_cmp(oldpair, (const lfs_block_t[2]){0, 1}) == 0) {
  1301. LFS_WARN("Superblock %"PRIu32" has become unwritable", oldpair[1]);
  1302. return LFS_ERR_NOSPC;
  1303. }
  1304. // relocate half of pair
  1305. err = lfs_alloc(lfs, &dir->pair[1]);
  1306. if (err && (err != LFS_ERR_NOSPC && !exhausted)) {
  1307. return err;
  1308. }
  1309. continue;
  1310. }
  1311. if (!relocated) {
  1312. // successful commit, update globals
  1313. lfs_global_zero(&lfs->locals);
  1314. } else {
  1315. // update references if we relocated
  1316. LFS_DEBUG("Relocating %"PRIu32" %"PRIu32" to %"PRIu32" %"PRIu32,
  1317. oldpair[0], oldpair[1], dir->pair[0], dir->pair[1]);
  1318. err = lfs_fs_relocate(lfs, oldpair, dir->pair);
  1319. if (err) {
  1320. return err;
  1321. }
  1322. }
  1323. return 0;
  1324. }
  1325. static int lfs_dir_commit(lfs_t *lfs, lfs_mdir_t *dir,
  1326. const struct lfs_mattr *attrs) {
  1327. struct lfs_mattr cancelattr;
  1328. struct lfs_globals cancels;
  1329. lfs_global_zero(&cancels);
  1330. if (lfs->globals.hasmove &&
  1331. lfs_pair_cmp(dir->pair, lfs->globals.pair) == 0) {
  1332. // Wait, we have the move? Just cancel this out here
  1333. // We need to, or else the move can become outdated
  1334. cancelattr.tag = LFS_MKTAG(LFS_TYPE_DELETE, lfs->globals.id, 0);
  1335. cancelattr.next = attrs;
  1336. attrs = &cancelattr;
  1337. cancels.hasmove = lfs->globals.hasmove;
  1338. cancels.pair[0] = lfs->globals.pair[0];
  1339. cancels.pair[1] = lfs->globals.pair[1];
  1340. cancels.id = lfs->globals.id;
  1341. lfs_global_fromle32(&lfs->locals);
  1342. lfs_global_xor(&lfs->locals, &cancels);
  1343. lfs_global_tole32(&lfs->locals);
  1344. }
  1345. // calculate new directory size
  1346. lfs_tag_t deletetag = 0xffffffff;
  1347. lfs_tag_t createtag = 0xffffffff;
  1348. int attrcount = 0;
  1349. for (const struct lfs_mattr *a = attrs; a; a = a->next) {
  1350. if (lfs_tag_subtype(a->tag) == LFS_TYPE_CREATE) {
  1351. dir->count += 1;
  1352. createtag = a->tag;
  1353. } else if (lfs_tag_subtype(a->tag) == LFS_TYPE_DELETE) {
  1354. LFS_ASSERT(dir->count > 0);
  1355. dir->count -= 1;
  1356. deletetag = a->tag;
  1357. if (dir->count == 0) {
  1358. // should we actually drop the directory block?
  1359. lfs_mdir_t pdir;
  1360. int err = lfs_fs_pred(lfs, dir->pair, &pdir);
  1361. if (err && err != LFS_ERR_NOENT) {
  1362. return err;
  1363. }
  1364. if (err != LFS_ERR_NOENT && pdir.split) {
  1365. return lfs_dir_drop(lfs, &pdir, dir);
  1366. }
  1367. }
  1368. }
  1369. attrcount += 1;
  1370. }
  1371. while (true) {
  1372. if (!dir->erased) {
  1373. goto compact;
  1374. }
  1375. // try to commit
  1376. struct lfs_commit commit = {
  1377. .block = dir->pair[0],
  1378. .off = dir->off,
  1379. .crc = 0xffffffff,
  1380. .ptag = dir->etag,
  1381. .begin = dir->off,
  1382. .end = lfs->cfg->block_size - 8,
  1383. .ack = 0,
  1384. };
  1385. // iterate over commits backwards, this lets us "append" commits
  1386. for (int i = 0; i < attrcount; i++) {
  1387. const struct lfs_mattr *a = attrs;
  1388. for (int j = 0; j < attrcount-i-1; j++) {
  1389. a = a->next;
  1390. }
  1391. lfs_pair_tole32(dir->tail);
  1392. int err = lfs_commit_attr(lfs, &commit, a->tag, a->buffer);
  1393. lfs_pair_fromle32(dir->tail);
  1394. if (err) {
  1395. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1396. goto compact;
  1397. }
  1398. return err;
  1399. }
  1400. }
  1401. // commit any global diffs if we have any
  1402. if (!lfs_global_iszero(&lfs->locals)) {
  1403. struct lfs_globals locals = lfs->locals;
  1404. int err = lfs_dir_getglobals(lfs, dir, &locals);
  1405. if (err) {
  1406. return err;
  1407. }
  1408. err = lfs_commit_globals(lfs, &commit, &locals);
  1409. if (err) {
  1410. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1411. goto compact;
  1412. }
  1413. return err;
  1414. }
  1415. }
  1416. // finalize commit with the crc
  1417. int err = lfs_commit_crc(lfs, &commit, false);
  1418. if (err) {
  1419. if (err == LFS_ERR_NOSPC || err == LFS_ERR_CORRUPT) {
  1420. goto compact;
  1421. }
  1422. return err;
  1423. }
  1424. // successful commit, update dir
  1425. dir->off = commit.off;
  1426. dir->etag = commit.ptag;
  1427. // successful commit, update globals
  1428. lfs_global_zero(&lfs->locals);
  1429. break;
  1430. compact:
  1431. // fall back to compaction
  1432. lfs_cache_drop(lfs, &lfs->pcache);
  1433. err = lfs_dir_compact(lfs, dir, attrs, dir, 0, dir->count);
  1434. if (err) {
  1435. return err;
  1436. }
  1437. break;
  1438. }
  1439. // update globals that are affected
  1440. lfs_global_xor(&lfs->globals, &cancels);
  1441. // update any directories that are affected
  1442. lfs_mdir_t copy = *dir;
  1443. // two passes, once for things that aren't us, and one
  1444. // for things that are
  1445. for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
  1446. if (lfs_pair_cmp(d->m.pair, copy.pair) == 0) {
  1447. d->m = *dir;
  1448. if (d->id == lfs_tag_id(deletetag)) {
  1449. d->m.pair[0] = 0xffffffff;
  1450. d->m.pair[1] = 0xffffffff;
  1451. } else if (d->id > lfs_tag_id(deletetag)) {
  1452. d->id -= 1;
  1453. if (d->type == LFS_TYPE_DIR) {
  1454. ((lfs_dir_t*)d)->pos -= 1;
  1455. }
  1456. } else if (&d->m != dir && d->id >= lfs_tag_id(createtag)) {
  1457. d->id += 1;
  1458. if (d->type == LFS_TYPE_DIR) {
  1459. ((lfs_dir_t*)d)->pos += 1;
  1460. }
  1461. }
  1462. while (d->id >= d->m.count && d->m.split) {
  1463. // we split and id is on tail now
  1464. d->id -= d->m.count;
  1465. int err = lfs_dir_fetch(lfs, &d->m, d->m.tail);
  1466. if (err) {
  1467. return err;
  1468. }
  1469. }
  1470. }
  1471. }
  1472. return 0;
  1473. }
  1474. /// Top level directory operations ///
  1475. int lfs_mkdir(lfs_t *lfs, const char *path) {
  1476. // deorphan if we haven't yet, needed at most once after poweron
  1477. int err = lfs_fs_forceconsistency(lfs);
  1478. if (err) {
  1479. return err;
  1480. }
  1481. lfs_mdir_t cwd;
  1482. uint16_t id;
  1483. err = lfs_dir_find(lfs, &cwd, &path, &id);
  1484. if (!(err == LFS_ERR_NOENT && id != 0x1ff)) {
  1485. return (err < 0) ? err : LFS_ERR_EXIST;
  1486. }
  1487. // check that name fits
  1488. lfs_size_t nlen = strlen(path);
  1489. if (nlen > lfs->name_max) {
  1490. return LFS_ERR_NAMETOOLONG;
  1491. }
  1492. // build up new directory
  1493. lfs_alloc_ack(lfs);
  1494. lfs_mdir_t dir;
  1495. err = lfs_dir_alloc(lfs, &dir);
  1496. if (err) {
  1497. return err;
  1498. }
  1499. // find end of list
  1500. lfs_mdir_t pred = cwd;
  1501. while (pred.split) {
  1502. err = lfs_dir_fetch(lfs, &pred, pred.tail);
  1503. if (err) {
  1504. return err;
  1505. }
  1506. }
  1507. // setup dir
  1508. dir.tail[0] = pred.tail[0];
  1509. dir.tail[1] = pred.tail[1];
  1510. err = lfs_dir_commit(lfs, &dir, NULL);
  1511. if (err) {
  1512. return err;
  1513. }
  1514. // current block end of list?
  1515. if (!cwd.split) {
  1516. // update atomically
  1517. cwd.tail[0] = dir.pair[0];
  1518. cwd.tail[1] = dir.pair[1];
  1519. } else {
  1520. // update tails, this creates a desync
  1521. pred.tail[0] = dir.pair[0];
  1522. pred.tail[1] = dir.pair[1];
  1523. lfs_global_orphans(lfs, +1);
  1524. err = lfs_dir_commit(lfs, &pred,
  1525. LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x1ff,
  1526. pred.tail, sizeof(pred.tail),
  1527. NULL));
  1528. if (err) {
  1529. return err;
  1530. }
  1531. lfs_global_orphans(lfs, -1);
  1532. }
  1533. // now insert into our parent block
  1534. lfs_pair_tole32(dir.pair);
  1535. err = lfs_dir_commit(lfs, &cwd,
  1536. LFS_MKATTR(LFS_TYPE_DIRSTRUCT, id, dir.pair, sizeof(dir.pair),
  1537. LFS_MKATTR(LFS_TYPE_DIR, id, path, nlen,
  1538. (!cwd.split)
  1539. ? LFS_MKATTR(LFS_TYPE_SOFTTAIL, 0x1ff,
  1540. cwd.tail, sizeof(cwd.tail), NULL)
  1541. : NULL)));
  1542. lfs_pair_fromle32(dir.pair);
  1543. if (err) {
  1544. return err;
  1545. }
  1546. return 0;
  1547. }
  1548. int lfs_dir_open(lfs_t *lfs, lfs_dir_t *dir, const char *path) {
  1549. lfs_stag_t tag = lfs_dir_find(lfs, &dir->m, &path, NULL);
  1550. if (tag < 0) {
  1551. return tag;
  1552. }
  1553. if (lfs_tag_type(tag) != LFS_TYPE_DIR) {
  1554. return LFS_ERR_NOTDIR;
  1555. }
  1556. lfs_block_t pair[2];
  1557. if (lfs_tag_id(tag) == 0x1ff) {
  1558. // handle root dir separately
  1559. pair[0] = lfs->root[0];
  1560. pair[1] = lfs->root[1];
  1561. } else {
  1562. // get dir pair from parent
  1563. lfs_stag_t res = lfs_dir_get(lfs, &dir->m, 0x783fe000,
  1564. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  1565. if (res < 0) {
  1566. return res;
  1567. }
  1568. lfs_pair_fromle32(pair);
  1569. }
  1570. // fetch first pair
  1571. int err = lfs_dir_fetch(lfs, &dir->m, pair);
  1572. if (err) {
  1573. return err;
  1574. }
  1575. // setup entry
  1576. dir->head[0] = dir->m.pair[0];
  1577. dir->head[1] = dir->m.pair[1];
  1578. dir->id = 0;
  1579. dir->pos = 0;
  1580. // add to list of mdirs
  1581. dir->type = LFS_TYPE_DIR;
  1582. dir->next = (lfs_dir_t*)lfs->mlist;
  1583. lfs->mlist = (struct lfs_mlist*)dir;
  1584. return 0;
  1585. }
  1586. int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir) {
  1587. // remove from list of mdirs
  1588. for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
  1589. if (*p == (struct lfs_mlist*)dir) {
  1590. *p = (*p)->next;
  1591. break;
  1592. }
  1593. }
  1594. return 0;
  1595. }
  1596. int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info) {
  1597. memset(info, 0, sizeof(*info));
  1598. // special offset for '.' and '..'
  1599. if (dir->pos == 0) {
  1600. info->type = LFS_TYPE_DIR;
  1601. strcpy(info->name, ".");
  1602. dir->pos += 1;
  1603. return 1;
  1604. } else if (dir->pos == 1) {
  1605. info->type = LFS_TYPE_DIR;
  1606. strcpy(info->name, "..");
  1607. dir->pos += 1;
  1608. return 1;
  1609. }
  1610. while (true) {
  1611. if (dir->id == dir->m.count) {
  1612. if (!dir->m.split) {
  1613. return false;
  1614. }
  1615. int err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1616. if (err) {
  1617. return err;
  1618. }
  1619. dir->id = 0;
  1620. }
  1621. int err = lfs_dir_getinfo(lfs, &dir->m, dir->id, info);
  1622. if (err && err != LFS_ERR_NOENT) {
  1623. return err;
  1624. }
  1625. dir->id += 1;
  1626. if (err != LFS_ERR_NOENT) {
  1627. break;
  1628. }
  1629. }
  1630. dir->pos += 1;
  1631. return true;
  1632. }
  1633. int lfs_dir_seek(lfs_t *lfs, lfs_dir_t *dir, lfs_off_t off) {
  1634. // simply walk from head dir
  1635. int err = lfs_dir_rewind(lfs, dir);
  1636. if (err) {
  1637. return err;
  1638. }
  1639. // first two for ./..
  1640. dir->pos = lfs_min(2, off);
  1641. off -= dir->pos;
  1642. while (off != 0) {
  1643. dir->id = lfs_min(dir->m.count, off);
  1644. dir->pos += dir->id;
  1645. off -= dir->id;
  1646. if (dir->id == dir->m.count) {
  1647. if (!dir->m.split) {
  1648. return LFS_ERR_INVAL;
  1649. }
  1650. err = lfs_dir_fetch(lfs, &dir->m, dir->m.tail);
  1651. if (err) {
  1652. return err;
  1653. }
  1654. }
  1655. }
  1656. return 0;
  1657. }
  1658. lfs_soff_t lfs_dir_tell(lfs_t *lfs, lfs_dir_t *dir) {
  1659. (void)lfs;
  1660. return dir->pos;
  1661. }
  1662. int lfs_dir_rewind(lfs_t *lfs, lfs_dir_t *dir) {
  1663. // reload the head dir
  1664. int err = lfs_dir_fetch(lfs, &dir->m, dir->head);
  1665. if (err) {
  1666. return err;
  1667. }
  1668. dir->m.pair[0] = dir->head[0];
  1669. dir->m.pair[1] = dir->head[1];
  1670. dir->id = 0;
  1671. dir->pos = 0;
  1672. return 0;
  1673. }
  1674. /// File index list operations ///
  1675. static int lfs_ctz_index(lfs_t *lfs, lfs_off_t *off) {
  1676. lfs_off_t size = *off;
  1677. lfs_off_t b = lfs->cfg->block_size - 2*4;
  1678. lfs_off_t i = size / b;
  1679. if (i == 0) {
  1680. return 0;
  1681. }
  1682. i = (size - 4*(lfs_popc(i-1)+2)) / b;
  1683. *off = size - b*i - 4*lfs_popc(i);
  1684. return i;
  1685. }
  1686. static int lfs_ctz_find(lfs_t *lfs,
  1687. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1688. lfs_block_t head, lfs_size_t size,
  1689. lfs_size_t pos, lfs_block_t *block, lfs_off_t *off) {
  1690. if (size == 0) {
  1691. *block = 0xffffffff;
  1692. *off = 0;
  1693. return 0;
  1694. }
  1695. lfs_off_t current = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1696. lfs_off_t target = lfs_ctz_index(lfs, &pos);
  1697. while (current > target) {
  1698. lfs_size_t skip = lfs_min(
  1699. lfs_npw2(current-target+1) - 1,
  1700. lfs_ctz(current));
  1701. int err = lfs_bd_read(lfs,
  1702. pcache, rcache, sizeof(head),
  1703. head, 4*skip, &head, sizeof(head));
  1704. head = lfs_fromle32(head);
  1705. if (err) {
  1706. return err;
  1707. }
  1708. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1709. current -= 1 << skip;
  1710. }
  1711. *block = head;
  1712. *off = pos;
  1713. return 0;
  1714. }
  1715. static int lfs_ctz_extend(lfs_t *lfs,
  1716. lfs_cache_t *pcache, lfs_cache_t *rcache,
  1717. lfs_block_t head, lfs_size_t size,
  1718. lfs_block_t *block, lfs_off_t *off) {
  1719. while (true) {
  1720. // go ahead and grab a block
  1721. lfs_block_t nblock;
  1722. int err = lfs_alloc(lfs, &nblock);
  1723. if (err) {
  1724. return err;
  1725. }
  1726. LFS_ASSERT(nblock >= 2 && nblock <= lfs->cfg->block_count);
  1727. err = lfs_bd_erase(lfs, nblock);
  1728. if (err) {
  1729. if (err == LFS_ERR_CORRUPT) {
  1730. goto relocate;
  1731. }
  1732. return err;
  1733. }
  1734. if (size == 0) {
  1735. *block = nblock;
  1736. *off = 0;
  1737. return 0;
  1738. }
  1739. size -= 1;
  1740. lfs_off_t index = lfs_ctz_index(lfs, &size);
  1741. size += 1;
  1742. // just copy out the last block if it is incomplete
  1743. if (size != lfs->cfg->block_size) {
  1744. for (lfs_off_t i = 0; i < size; i++) {
  1745. uint8_t data;
  1746. err = lfs_bd_read(lfs,
  1747. NULL, rcache, size-i,
  1748. head, i, &data, 1);
  1749. if (err) {
  1750. return err;
  1751. }
  1752. err = lfs_bd_prog(lfs,
  1753. pcache, rcache, true,
  1754. nblock, i, &data, 1);
  1755. if (err) {
  1756. if (err == LFS_ERR_CORRUPT) {
  1757. goto relocate;
  1758. }
  1759. return err;
  1760. }
  1761. }
  1762. *block = nblock;
  1763. *off = size;
  1764. return 0;
  1765. }
  1766. // append block
  1767. index += 1;
  1768. lfs_size_t skips = lfs_ctz(index) + 1;
  1769. for (lfs_off_t i = 0; i < skips; i++) {
  1770. head = lfs_tole32(head);
  1771. err = lfs_bd_prog(lfs, pcache, rcache, true,
  1772. nblock, 4*i, &head, 4);
  1773. head = lfs_fromle32(head);
  1774. if (err) {
  1775. if (err == LFS_ERR_CORRUPT) {
  1776. goto relocate;
  1777. }
  1778. return err;
  1779. }
  1780. if (i != skips-1) {
  1781. err = lfs_bd_read(lfs,
  1782. NULL, rcache, sizeof(head),
  1783. head, 4*i, &head, sizeof(head));
  1784. head = lfs_fromle32(head);
  1785. if (err) {
  1786. return err;
  1787. }
  1788. }
  1789. LFS_ASSERT(head >= 2 && head <= lfs->cfg->block_count);
  1790. }
  1791. *block = nblock;
  1792. *off = 4*skips;
  1793. return 0;
  1794. relocate:
  1795. LFS_DEBUG("Bad block at %"PRIu32, nblock);
  1796. // just clear cache and try a new block
  1797. lfs_cache_drop(lfs, pcache);
  1798. }
  1799. }
  1800. static int lfs_ctz_traverse(lfs_t *lfs,
  1801. const lfs_cache_t *pcache, lfs_cache_t *rcache,
  1802. lfs_block_t head, lfs_size_t size,
  1803. int (*cb)(void*, lfs_block_t), void *data) {
  1804. if (size == 0) {
  1805. return 0;
  1806. }
  1807. lfs_off_t index = lfs_ctz_index(lfs, &(lfs_off_t){size-1});
  1808. while (true) {
  1809. int err = cb(data, head);
  1810. if (err) {
  1811. return err;
  1812. }
  1813. if (index == 0) {
  1814. return 0;
  1815. }
  1816. lfs_block_t heads[2];
  1817. int count = 2 - (index & 1);
  1818. err = lfs_bd_read(lfs,
  1819. pcache, rcache, count*sizeof(head),
  1820. head, 0, &heads, count*sizeof(head));
  1821. heads[0] = lfs_fromle32(heads[0]);
  1822. heads[1] = lfs_fromle32(heads[1]);
  1823. if (err) {
  1824. return err;
  1825. }
  1826. for (int i = 0; i < count-1; i++) {
  1827. err = cb(data, heads[i]);
  1828. if (err) {
  1829. return err;
  1830. }
  1831. }
  1832. head = heads[count-1];
  1833. index -= count;
  1834. }
  1835. }
  1836. /// Top level file operations ///
  1837. int lfs_file_opencfg(lfs_t *lfs, lfs_file_t *file,
  1838. const char *path, int flags,
  1839. const struct lfs_file_config *cfg) {
  1840. // deorphan if we haven't yet, needed at most once after poweron
  1841. if ((flags & 3) != LFS_O_RDONLY) {
  1842. int err = lfs_fs_forceconsistency(lfs);
  1843. if (err) {
  1844. return err;
  1845. }
  1846. }
  1847. // setup simple file details
  1848. int err;
  1849. file->cfg = cfg;
  1850. file->flags = flags;
  1851. file->pos = 0;
  1852. file->cache.buffer = NULL;
  1853. // allocate entry for file if it doesn't exist
  1854. lfs_stag_t tag = lfs_dir_find(lfs, &file->m, &path, &file->id);
  1855. if (tag < 0 && !(tag == LFS_ERR_NOENT && file->id != 0x1ff)) {
  1856. err = tag;
  1857. goto cleanup;
  1858. }
  1859. // get id, add to list of mdirs to catch update changes
  1860. file->type = LFS_TYPE_REG;
  1861. file->next = (lfs_file_t*)lfs->mlist;
  1862. lfs->mlist = (struct lfs_mlist*)file;
  1863. if (tag == LFS_ERR_NOENT) {
  1864. if (!(flags & LFS_O_CREAT)) {
  1865. err = LFS_ERR_NOENT;
  1866. goto cleanup;
  1867. }
  1868. // check that name fits
  1869. lfs_size_t nlen = strlen(path);
  1870. if (nlen > lfs->name_max) {
  1871. err = LFS_ERR_NAMETOOLONG;
  1872. goto cleanup;
  1873. }
  1874. // get next slot and create entry to remember name
  1875. err = lfs_dir_commit(lfs, &file->m,
  1876. LFS_MKATTR(LFS_TYPE_INLINESTRUCT, file->id, NULL, 0,
  1877. LFS_MKATTR(LFS_TYPE_REG, file->id, path, nlen,
  1878. NULL)));
  1879. if (err) {
  1880. err = LFS_ERR_NAMETOOLONG;
  1881. goto cleanup;
  1882. }
  1883. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, 0);
  1884. } else if (flags & LFS_O_EXCL) {
  1885. err = LFS_ERR_EXIST;
  1886. goto cleanup;
  1887. } else if (lfs_tag_type(tag) != LFS_TYPE_REG) {
  1888. err = LFS_ERR_ISDIR;
  1889. goto cleanup;
  1890. } else if (flags & LFS_O_TRUNC) {
  1891. // truncate if requested
  1892. tag = LFS_MKTAG(LFS_TYPE_INLINESTRUCT, file->id, 0);
  1893. file->flags |= LFS_F_DIRTY;
  1894. } else {
  1895. // try to load what's on disk, if it's inlined we'll fix it later
  1896. tag = lfs_dir_get(lfs, &file->m, 0x783fe000,
  1897. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, 8), &file->ctz);
  1898. if (tag < 0) {
  1899. err = tag;
  1900. goto cleanup;
  1901. }
  1902. lfs_ctz_fromle32(&file->ctz);
  1903. }
  1904. // fetch attrs
  1905. for (const struct lfs_attr *a = file->cfg->attrs; a; a = a->next) {
  1906. if ((file->flags & 3) != LFS_O_WRONLY) {
  1907. lfs_stag_t res = lfs_dir_get(lfs, &file->m, 0x7fffe000,
  1908. LFS_MKTAG(0x100 | a->type, file->id, a->size), a->buffer);
  1909. if (res < 0 && res != LFS_ERR_NOENT) {
  1910. err = res;
  1911. goto cleanup;
  1912. }
  1913. }
  1914. if ((file->flags & 3) != LFS_O_RDONLY) {
  1915. if (a->size > lfs->attr_max) {
  1916. err = LFS_ERR_NOSPC;
  1917. goto cleanup;
  1918. }
  1919. file->flags |= LFS_F_DIRTY;
  1920. }
  1921. }
  1922. // allocate buffer if needed
  1923. if (file->cfg->buffer) {
  1924. file->cache.buffer = file->cfg->buffer;
  1925. } else {
  1926. file->cache.buffer = lfs_malloc(lfs->cfg->cache_size);
  1927. if (!file->cache.buffer) {
  1928. err = LFS_ERR_NOMEM;
  1929. goto cleanup;
  1930. }
  1931. }
  1932. // zero to avoid information leak
  1933. lfs_cache_zero(lfs, &file->cache);
  1934. if (lfs_tag_type(tag) == LFS_TYPE_INLINESTRUCT) {
  1935. // load inline files
  1936. file->ctz.head = 0xfffffffe;
  1937. file->ctz.size = lfs_tag_size(tag);
  1938. file->flags |= LFS_F_INLINE;
  1939. file->cache.block = file->ctz.head;
  1940. file->cache.off = 0;
  1941. file->cache.size = lfs->cfg->cache_size;
  1942. // don't always read (may be new/trunc file)
  1943. if (file->ctz.size > 0) {
  1944. lfs_stag_t res = lfs_dir_get(lfs, &file->m, 0x783fe000,
  1945. LFS_MKTAG(LFS_TYPE_STRUCT, file->id, file->ctz.size),
  1946. file->cache.buffer);
  1947. if (res < 0) {
  1948. err = res;
  1949. goto cleanup;
  1950. }
  1951. }
  1952. }
  1953. return 0;
  1954. cleanup:
  1955. // clean up lingering resources
  1956. file->flags |= LFS_F_ERRED;
  1957. lfs_file_close(lfs, file);
  1958. return err;
  1959. }
  1960. int lfs_file_open(lfs_t *lfs, lfs_file_t *file,
  1961. const char *path, int flags) {
  1962. static const struct lfs_file_config defaults = {0};
  1963. return lfs_file_opencfg(lfs, file, path, flags, &defaults);
  1964. }
  1965. int lfs_file_close(lfs_t *lfs, lfs_file_t *file) {
  1966. int err = lfs_file_sync(lfs, file);
  1967. // remove from list of mdirs
  1968. for (struct lfs_mlist **p = &lfs->mlist; *p; p = &(*p)->next) {
  1969. if (*p == (struct lfs_mlist*)file) {
  1970. *p = (*p)->next;
  1971. break;
  1972. }
  1973. }
  1974. // clean up memory
  1975. if (!file->cfg->buffer) {
  1976. lfs_free(file->cache.buffer);
  1977. }
  1978. return err;
  1979. }
  1980. static int lfs_file_relocate(lfs_t *lfs, lfs_file_t *file) {
  1981. while (true) {
  1982. // just relocate what exists into new block
  1983. lfs_block_t nblock;
  1984. int err = lfs_alloc(lfs, &nblock);
  1985. if (err) {
  1986. return err;
  1987. }
  1988. err = lfs_bd_erase(lfs, nblock);
  1989. if (err) {
  1990. if (err == LFS_ERR_CORRUPT) {
  1991. goto relocate;
  1992. }
  1993. return err;
  1994. }
  1995. // either read from dirty cache or disk
  1996. for (lfs_off_t i = 0; i < file->off; i++) {
  1997. uint8_t data;
  1998. err = lfs_bd_read(lfs,
  1999. &file->cache, &lfs->rcache, file->off-i,
  2000. file->block, i, &data, 1);
  2001. if (err) {
  2002. return err;
  2003. }
  2004. err = lfs_bd_prog(lfs,
  2005. &lfs->pcache, &lfs->rcache, true,
  2006. nblock, i, &data, 1);
  2007. if (err) {
  2008. if (err == LFS_ERR_CORRUPT) {
  2009. goto relocate;
  2010. }
  2011. return err;
  2012. }
  2013. }
  2014. // copy over new state of file
  2015. memcpy(file->cache.buffer, lfs->pcache.buffer, lfs->cfg->cache_size);
  2016. file->cache.block = lfs->pcache.block;
  2017. file->cache.off = lfs->pcache.off;
  2018. file->cache.size = lfs->pcache.size;
  2019. lfs_cache_zero(lfs, &lfs->pcache);
  2020. file->block = nblock;
  2021. return 0;
  2022. relocate:
  2023. LFS_DEBUG("Bad block at %"PRIu32, nblock);
  2024. // just clear cache and try a new block
  2025. lfs_cache_drop(lfs, &lfs->pcache);
  2026. }
  2027. }
  2028. static int lfs_file_flush(lfs_t *lfs, lfs_file_t *file) {
  2029. if (file->flags & LFS_F_READING) {
  2030. file->flags &= ~LFS_F_READING;
  2031. }
  2032. if (file->flags & LFS_F_WRITING) {
  2033. lfs_off_t pos = file->pos;
  2034. if (!(file->flags & LFS_F_INLINE)) {
  2035. // copy over anything after current branch
  2036. lfs_file_t orig = {
  2037. .ctz.head = file->ctz.head,
  2038. .ctz.size = file->ctz.size,
  2039. .flags = LFS_O_RDONLY,
  2040. .pos = file->pos,
  2041. .cache = lfs->rcache,
  2042. };
  2043. lfs_cache_drop(lfs, &lfs->rcache);
  2044. while (file->pos < file->ctz.size) {
  2045. // copy over a byte at a time, leave it up to caching
  2046. // to make this efficient
  2047. uint8_t data;
  2048. lfs_ssize_t res = lfs_file_read(lfs, &orig, &data, 1);
  2049. if (res < 0) {
  2050. return res;
  2051. }
  2052. res = lfs_file_write(lfs, file, &data, 1);
  2053. if (res < 0) {
  2054. return res;
  2055. }
  2056. // keep our reference to the rcache in sync
  2057. if (lfs->rcache.block != 0xffffffff) {
  2058. lfs_cache_drop(lfs, &orig.cache);
  2059. lfs_cache_drop(lfs, &lfs->rcache);
  2060. }
  2061. }
  2062. // write out what we have
  2063. while (true) {
  2064. int err = lfs_bd_flush(lfs,
  2065. &file->cache, &lfs->rcache, true);
  2066. if (err) {
  2067. if (err == LFS_ERR_CORRUPT) {
  2068. goto relocate;
  2069. }
  2070. return err;
  2071. }
  2072. break;
  2073. relocate:
  2074. LFS_DEBUG("Bad block at %"PRIu32, file->block);
  2075. err = lfs_file_relocate(lfs, file);
  2076. if (err) {
  2077. return err;
  2078. }
  2079. }
  2080. } else {
  2081. file->ctz.size = lfs_max(file->pos, file->ctz.size);
  2082. }
  2083. // actual file updates
  2084. file->ctz.head = file->block;
  2085. file->ctz.size = file->pos;
  2086. file->flags &= ~LFS_F_WRITING;
  2087. file->flags |= LFS_F_DIRTY;
  2088. file->pos = pos;
  2089. }
  2090. return 0;
  2091. }
  2092. int lfs_file_sync(lfs_t *lfs, lfs_file_t *file) {
  2093. while (true) {
  2094. int err = lfs_file_flush(lfs, file);
  2095. if (err) {
  2096. return err;
  2097. }
  2098. if ((file->flags & LFS_F_DIRTY) &&
  2099. !(file->flags & LFS_F_ERRED) &&
  2100. !lfs_pair_isnull(file->m.pair)) {
  2101. // update dir entry
  2102. uint16_t type;
  2103. const void *buffer;
  2104. lfs_size_t size;
  2105. struct lfs_ctz ctz;
  2106. if (file->flags & LFS_F_INLINE) {
  2107. // inline the whole file
  2108. type = LFS_TYPE_INLINESTRUCT;
  2109. buffer = file->cache.buffer;
  2110. size = file->ctz.size;
  2111. } else {
  2112. // update the ctz reference
  2113. type = LFS_TYPE_CTZSTRUCT;
  2114. // copy ctz so alloc will work during a relocate
  2115. ctz = file->ctz;
  2116. lfs_ctz_tole32(&ctz);
  2117. buffer = &ctz;
  2118. size = sizeof(ctz);
  2119. }
  2120. // commit file data and attributes
  2121. err = lfs_dir_commit(lfs, &file->m,
  2122. LFS_MKATTR(LFS_FROM_USERATTRS,
  2123. file->id, file->cfg->attrs, 0,
  2124. LFS_MKATTR(type, file->id, buffer, size,
  2125. NULL)));
  2126. if (err) {
  2127. if (err == LFS_ERR_NOSPC && (file->flags & LFS_F_INLINE)) {
  2128. goto relocate;
  2129. }
  2130. return err;
  2131. }
  2132. file->flags &= ~LFS_F_DIRTY;
  2133. }
  2134. return 0;
  2135. relocate:
  2136. // inline file doesn't fit anymore
  2137. file->block = 0xfffffffe;
  2138. file->off = file->pos;
  2139. lfs_alloc_ack(lfs);
  2140. err = lfs_file_relocate(lfs, file);
  2141. if (err) {
  2142. return err;
  2143. }
  2144. file->flags &= ~LFS_F_INLINE;
  2145. file->flags |= LFS_F_WRITING;
  2146. }
  2147. }
  2148. lfs_ssize_t lfs_file_read(lfs_t *lfs, lfs_file_t *file,
  2149. void *buffer, lfs_size_t size) {
  2150. uint8_t *data = buffer;
  2151. lfs_size_t nsize = size;
  2152. if ((file->flags & 3) == LFS_O_WRONLY) {
  2153. return LFS_ERR_BADF;
  2154. }
  2155. if (file->flags & LFS_F_WRITING) {
  2156. // flush out any writes
  2157. int err = lfs_file_flush(lfs, file);
  2158. if (err) {
  2159. return err;
  2160. }
  2161. }
  2162. if (file->pos >= file->ctz.size) {
  2163. // eof if past end
  2164. return 0;
  2165. }
  2166. size = lfs_min(size, file->ctz.size - file->pos);
  2167. nsize = size;
  2168. while (nsize > 0) {
  2169. // check if we need a new block
  2170. if (!(file->flags & LFS_F_READING) ||
  2171. file->off == lfs->cfg->block_size) {
  2172. if (!(file->flags & LFS_F_INLINE)) {
  2173. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2174. file->ctz.head, file->ctz.size,
  2175. file->pos, &file->block, &file->off);
  2176. if (err) {
  2177. return err;
  2178. }
  2179. } else {
  2180. file->block = 0xfffffffe;
  2181. file->off = file->pos;
  2182. }
  2183. file->flags |= LFS_F_READING;
  2184. }
  2185. // read as much as we can in current block
  2186. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2187. int err = lfs_bd_read(lfs,
  2188. NULL, &file->cache, lfs->cfg->block_size,
  2189. file->block, file->off, data, diff);
  2190. if (err) {
  2191. return err;
  2192. }
  2193. file->pos += diff;
  2194. file->off += diff;
  2195. data += diff;
  2196. nsize -= diff;
  2197. }
  2198. return size;
  2199. }
  2200. lfs_ssize_t lfs_file_write(lfs_t *lfs, lfs_file_t *file,
  2201. const void *buffer, lfs_size_t size) {
  2202. const uint8_t *data = buffer;
  2203. lfs_size_t nsize = size;
  2204. if ((file->flags & 3) == LFS_O_RDONLY) {
  2205. return LFS_ERR_BADF;
  2206. }
  2207. if (file->flags & LFS_F_READING) {
  2208. // drop any reads
  2209. int err = lfs_file_flush(lfs, file);
  2210. if (err) {
  2211. return err;
  2212. }
  2213. }
  2214. if ((file->flags & LFS_O_APPEND) && file->pos < file->ctz.size) {
  2215. file->pos = file->ctz.size;
  2216. }
  2217. if (!(file->flags & LFS_F_WRITING) && file->pos > file->ctz.size) {
  2218. // fill with zeros
  2219. lfs_off_t pos = file->pos;
  2220. file->pos = file->ctz.size;
  2221. while (file->pos < pos) {
  2222. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2223. if (res < 0) {
  2224. return res;
  2225. }
  2226. }
  2227. }
  2228. if ((file->flags & LFS_F_INLINE) &&
  2229. file->pos + nsize > lfs->inline_max) {
  2230. // inline file doesn't fit anymore
  2231. file->block = 0xfffffffe;
  2232. file->off = file->pos;
  2233. lfs_alloc_ack(lfs);
  2234. int err = lfs_file_relocate(lfs, file);
  2235. if (err) {
  2236. file->flags |= LFS_F_ERRED;
  2237. return err;
  2238. }
  2239. file->flags &= ~LFS_F_INLINE;
  2240. file->flags |= LFS_F_WRITING;
  2241. }
  2242. while (nsize > 0) {
  2243. // check if we need a new block
  2244. if (!(file->flags & LFS_F_WRITING) ||
  2245. file->off == lfs->cfg->block_size) {
  2246. if (!(file->flags & LFS_F_INLINE)) {
  2247. if (!(file->flags & LFS_F_WRITING) && file->pos > 0) {
  2248. // find out which block we're extending from
  2249. int err = lfs_ctz_find(lfs, NULL, &file->cache,
  2250. file->ctz.head, file->ctz.size,
  2251. file->pos-1, &file->block, &file->off);
  2252. if (err) {
  2253. file->flags |= LFS_F_ERRED;
  2254. return err;
  2255. }
  2256. // mark cache as dirty since we may have read data into it
  2257. lfs_cache_zero(lfs, &file->cache);
  2258. }
  2259. // extend file with new blocks
  2260. lfs_alloc_ack(lfs);
  2261. int err = lfs_ctz_extend(lfs, &file->cache, &lfs->rcache,
  2262. file->block, file->pos,
  2263. &file->block, &file->off);
  2264. if (err) {
  2265. file->flags |= LFS_F_ERRED;
  2266. return err;
  2267. }
  2268. } else {
  2269. file->block = 0xfffffffe;
  2270. file->off = file->pos;
  2271. }
  2272. file->flags |= LFS_F_WRITING;
  2273. }
  2274. // program as much as we can in current block
  2275. lfs_size_t diff = lfs_min(nsize, lfs->cfg->block_size - file->off);
  2276. while (true) {
  2277. int err = lfs_bd_prog(lfs, &file->cache, &lfs->rcache, true,
  2278. file->block, file->off, data, diff);
  2279. if (err) {
  2280. if (err == LFS_ERR_CORRUPT) {
  2281. goto relocate;
  2282. }
  2283. file->flags |= LFS_F_ERRED;
  2284. return err;
  2285. }
  2286. break;
  2287. relocate:
  2288. err = lfs_file_relocate(lfs, file);
  2289. if (err) {
  2290. file->flags |= LFS_F_ERRED;
  2291. return err;
  2292. }
  2293. }
  2294. file->pos += diff;
  2295. file->off += diff;
  2296. data += diff;
  2297. nsize -= diff;
  2298. lfs_alloc_ack(lfs);
  2299. }
  2300. file->flags &= ~LFS_F_ERRED;
  2301. return size;
  2302. }
  2303. lfs_soff_t lfs_file_seek(lfs_t *lfs, lfs_file_t *file,
  2304. lfs_soff_t off, int whence) {
  2305. // write out everything beforehand, may be noop if rdonly
  2306. int err = lfs_file_flush(lfs, file);
  2307. if (err) {
  2308. return err;
  2309. }
  2310. // update pos
  2311. if (whence == LFS_SEEK_SET) {
  2312. file->pos = off;
  2313. } else if (whence == LFS_SEEK_CUR) {
  2314. if (off < 0 && (lfs_off_t)-off > file->pos) {
  2315. return LFS_ERR_INVAL;
  2316. }
  2317. file->pos = file->pos + off;
  2318. } else if (whence == LFS_SEEK_END) {
  2319. if (off < 0 && (lfs_off_t)-off > file->ctz.size) {
  2320. return LFS_ERR_INVAL;
  2321. }
  2322. file->pos = file->ctz.size + off;
  2323. }
  2324. return file->pos;
  2325. }
  2326. int lfs_file_truncate(lfs_t *lfs, lfs_file_t *file, lfs_off_t size) {
  2327. if ((file->flags & 3) == LFS_O_RDONLY) {
  2328. return LFS_ERR_BADF;
  2329. }
  2330. lfs_off_t oldsize = lfs_file_size(lfs, file);
  2331. if (size < oldsize) {
  2332. // need to flush since directly changing metadata
  2333. int err = lfs_file_flush(lfs, file);
  2334. if (err) {
  2335. return err;
  2336. }
  2337. // lookup new head in ctz skip list
  2338. err = lfs_ctz_find(lfs, NULL, &file->cache,
  2339. file->ctz.head, file->ctz.size,
  2340. size, &file->ctz.head, &(lfs_off_t){0});
  2341. if (err) {
  2342. return err;
  2343. }
  2344. file->ctz.size = size;
  2345. file->flags |= LFS_F_DIRTY;
  2346. } else if (size > oldsize) {
  2347. lfs_off_t pos = file->pos;
  2348. // flush+seek if not already at end
  2349. if (file->pos != oldsize) {
  2350. int err = lfs_file_seek(lfs, file, 0, LFS_SEEK_END);
  2351. if (err < 0) {
  2352. return err;
  2353. }
  2354. }
  2355. // fill with zeros
  2356. while (file->pos < size) {
  2357. lfs_ssize_t res = lfs_file_write(lfs, file, &(uint8_t){0}, 1);
  2358. if (res < 0) {
  2359. return res;
  2360. }
  2361. }
  2362. // restore pos
  2363. int err = lfs_file_seek(lfs, file, pos, LFS_SEEK_SET);
  2364. if (err < 0) {
  2365. return err;
  2366. }
  2367. }
  2368. return 0;
  2369. }
  2370. lfs_soff_t lfs_file_tell(lfs_t *lfs, lfs_file_t *file) {
  2371. (void)lfs;
  2372. return file->pos;
  2373. }
  2374. int lfs_file_rewind(lfs_t *lfs, lfs_file_t *file) {
  2375. lfs_soff_t res = lfs_file_seek(lfs, file, 0, LFS_SEEK_SET);
  2376. if (res < 0) {
  2377. return res;
  2378. }
  2379. return 0;
  2380. }
  2381. lfs_soff_t lfs_file_size(lfs_t *lfs, lfs_file_t *file) {
  2382. (void)lfs;
  2383. if (file->flags & LFS_F_WRITING) {
  2384. return lfs_max(file->pos, file->ctz.size);
  2385. } else {
  2386. return file->ctz.size;
  2387. }
  2388. }
  2389. /// General fs operations ///
  2390. int lfs_stat(lfs_t *lfs, const char *path, struct lfs_info *info) {
  2391. lfs_mdir_t cwd;
  2392. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2393. if (tag < 0) {
  2394. return tag;
  2395. }
  2396. return lfs_dir_getinfo(lfs, &cwd, lfs_tag_id(tag), info);
  2397. }
  2398. int lfs_remove(lfs_t *lfs, const char *path) {
  2399. // deorphan if we haven't yet, needed at most once after poweron
  2400. int err = lfs_fs_forceconsistency(lfs);
  2401. if (err) {
  2402. return err;
  2403. }
  2404. lfs_mdir_t cwd;
  2405. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2406. if (tag < 0) {
  2407. return tag;
  2408. }
  2409. lfs_mdir_t dir;
  2410. if (lfs_tag_type(tag) == LFS_TYPE_DIR) {
  2411. // must be empty before removal
  2412. lfs_block_t pair[2];
  2413. lfs_stag_t res = lfs_dir_get(lfs, &cwd, 0x783fe000,
  2414. LFS_MKTAG(LFS_TYPE_STRUCT, lfs_tag_id(tag), 8), pair);
  2415. if (res < 0) {
  2416. return res;
  2417. }
  2418. lfs_pair_fromle32(pair);
  2419. err = lfs_dir_fetch(lfs, &dir, pair);
  2420. if (err) {
  2421. return err;
  2422. }
  2423. if (dir.count > 0 || dir.split) {
  2424. return LFS_ERR_NOTEMPTY;
  2425. }
  2426. // mark fs as orphaned
  2427. lfs_global_orphans(lfs, +1);
  2428. }
  2429. // delete the entry
  2430. err = lfs_dir_commit(lfs, &cwd,
  2431. LFS_MKATTR(LFS_TYPE_DELETE, lfs_tag_id(tag), NULL, 0,
  2432. NULL));
  2433. if (err) {
  2434. return err;
  2435. }
  2436. if (lfs_tag_type(tag) == LFS_TYPE_DIR) {
  2437. // fix orphan
  2438. lfs_global_orphans(lfs, -1);
  2439. err = lfs_fs_pred(lfs, dir.pair, &cwd);
  2440. if (err) {
  2441. return err;
  2442. }
  2443. err = lfs_dir_drop(lfs, &cwd, &dir);
  2444. if (err) {
  2445. return err;
  2446. }
  2447. }
  2448. return 0;
  2449. }
  2450. int lfs_rename(lfs_t *lfs, const char *oldpath, const char *newpath) {
  2451. // deorphan if we haven't yet, needed at most once after poweron
  2452. int err = lfs_fs_forceconsistency(lfs);
  2453. if (err) {
  2454. return err;
  2455. }
  2456. // find old entry
  2457. lfs_mdir_t oldcwd;
  2458. lfs_stag_t oldtag = lfs_dir_find(lfs, &oldcwd, &oldpath, NULL);
  2459. if (oldtag < 0) {
  2460. return oldtag;
  2461. }
  2462. // find new entry
  2463. lfs_mdir_t newcwd;
  2464. uint16_t newid;
  2465. lfs_stag_t prevtag = lfs_dir_find(lfs, &newcwd, &newpath, &newid);
  2466. if (prevtag < 0 && !(prevtag == LFS_ERR_NOENT && newid != 0x1ff)) {
  2467. return err;
  2468. }
  2469. lfs_mdir_t prevdir;
  2470. if (prevtag == LFS_ERR_NOENT) {
  2471. // check that name fits
  2472. lfs_size_t nlen = strlen(newpath);
  2473. if (nlen > lfs->name_max) {
  2474. return LFS_ERR_NAMETOOLONG;
  2475. }
  2476. } else if (lfs_tag_type(prevtag) != lfs_tag_type(oldtag)) {
  2477. return LFS_ERR_ISDIR;
  2478. } else if (lfs_tag_type(prevtag) == LFS_TYPE_DIR) {
  2479. // must be empty before removal
  2480. lfs_block_t prevpair[2];
  2481. lfs_stag_t res = lfs_dir_get(lfs, &newcwd, 0x783fe000,
  2482. LFS_MKTAG(LFS_TYPE_STRUCT, newid, 8), prevpair);
  2483. if (res < 0) {
  2484. return res;
  2485. }
  2486. lfs_pair_fromle32(prevpair);
  2487. // must be empty before removal
  2488. err = lfs_dir_fetch(lfs, &prevdir, prevpair);
  2489. if (err) {
  2490. return err;
  2491. }
  2492. if (prevdir.count > 0 || prevdir.split) {
  2493. return LFS_ERR_NOTEMPTY;
  2494. }
  2495. // mark fs as orphaned
  2496. lfs_global_orphans(lfs, +1);
  2497. }
  2498. // create move to fix later
  2499. lfs_global_move(lfs, true, oldcwd.pair, lfs_tag_id(oldtag));
  2500. // move over all attributes
  2501. err = lfs_dir_commit(lfs, &newcwd,
  2502. LFS_MKATTR(LFS_FROM_MOVE, newid, &oldcwd, lfs_tag_id(oldtag),
  2503. LFS_MKATTR(lfs_tag_type(oldtag), newid, newpath, strlen(newpath),
  2504. (prevtag != LFS_ERR_NOENT)
  2505. ? LFS_MKATTR(LFS_TYPE_DELETE, newid, NULL, 0, NULL)
  2506. : NULL)));
  2507. if (err) {
  2508. return err;
  2509. }
  2510. // let commit clean up after move (if we're different! otherwise move
  2511. // logic already fixed it for us)
  2512. if (lfs_pair_cmp(oldcwd.pair, newcwd.pair) != 0) {
  2513. err = lfs_dir_commit(lfs, &oldcwd, NULL);
  2514. if (err) {
  2515. return err;
  2516. }
  2517. }
  2518. if (prevtag != LFS_ERR_NOENT && lfs_tag_type(prevtag) == LFS_TYPE_DIR) {
  2519. // fix orphan
  2520. lfs_global_orphans(lfs, -1);
  2521. err = lfs_fs_pred(lfs, prevdir.pair, &newcwd);
  2522. if (err) {
  2523. return err;
  2524. }
  2525. err = lfs_dir_drop(lfs, &newcwd, &prevdir);
  2526. if (err) {
  2527. return err;
  2528. }
  2529. }
  2530. return 0;
  2531. }
  2532. lfs_ssize_t lfs_getattr(lfs_t *lfs, const char *path,
  2533. uint8_t type, 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. tag = lfs_dir_get(lfs, &cwd, 0x7fffe000,
  2549. LFS_MKTAG(0x100 | type, id, lfs_min(size, lfs->attr_max)),
  2550. buffer);
  2551. if (tag < 0) {
  2552. if (tag == LFS_ERR_NOENT) {
  2553. return LFS_ERR_NOATTR;
  2554. }
  2555. return tag;
  2556. }
  2557. return lfs_tag_size(tag);
  2558. }
  2559. static int lfs_commitattr(lfs_t *lfs, const char *path,
  2560. uint8_t type, const void *buffer, lfs_size_t size) {
  2561. lfs_mdir_t cwd;
  2562. lfs_stag_t tag = lfs_dir_find(lfs, &cwd, &path, NULL);
  2563. if (tag < 0) {
  2564. return tag;
  2565. }
  2566. uint16_t id = lfs_tag_id(tag);
  2567. if (id == 0x1ff) {
  2568. // special case for root
  2569. id = 0;
  2570. int err = lfs_dir_fetch(lfs, &cwd, lfs->root);
  2571. if (err) {
  2572. return err;
  2573. }
  2574. }
  2575. return lfs_dir_commit(lfs, &cwd,
  2576. LFS_MKATTR(0x100 | type, id, buffer, size,
  2577. NULL));
  2578. }
  2579. int lfs_setattr(lfs_t *lfs, const char *path,
  2580. uint8_t type, const void *buffer, lfs_size_t size) {
  2581. if (size > lfs->attr_max) {
  2582. return LFS_ERR_NOSPC;
  2583. }
  2584. return lfs_commitattr(lfs, path, type, buffer, size);
  2585. }
  2586. int lfs_removeattr(lfs_t *lfs, const char *path, uint8_t type) {
  2587. return lfs_commitattr(lfs, path, type, NULL, 0x1fff);
  2588. }
  2589. /// Filesystem operations ///
  2590. static int lfs_init(lfs_t *lfs, const struct lfs_config *cfg) {
  2591. lfs->cfg = cfg;
  2592. int err = 0;
  2593. // check that block size is a multiple of cache size is a multiple
  2594. // of prog and read sizes
  2595. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->read_size == 0);
  2596. LFS_ASSERT(lfs->cfg->cache_size % lfs->cfg->prog_size == 0);
  2597. LFS_ASSERT(lfs->cfg->block_size % lfs->cfg->cache_size == 0);
  2598. // check that the block size is large enough to fit ctz pointers
  2599. LFS_ASSERT(4*lfs_npw2(0xffffffff / (lfs->cfg->block_size-2*4))
  2600. <= lfs->cfg->block_size);
  2601. // setup read cache
  2602. if (lfs->cfg->read_buffer) {
  2603. lfs->rcache.buffer = lfs->cfg->read_buffer;
  2604. } else {
  2605. lfs->rcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2606. if (!lfs->rcache.buffer) {
  2607. err = LFS_ERR_NOMEM;
  2608. goto cleanup;
  2609. }
  2610. }
  2611. // setup program cache
  2612. if (lfs->cfg->prog_buffer) {
  2613. lfs->pcache.buffer = lfs->cfg->prog_buffer;
  2614. } else {
  2615. lfs->pcache.buffer = lfs_malloc(lfs->cfg->cache_size);
  2616. if (!lfs->pcache.buffer) {
  2617. err = LFS_ERR_NOMEM;
  2618. goto cleanup;
  2619. }
  2620. }
  2621. // zero to avoid information leaks
  2622. lfs_cache_zero(lfs, &lfs->rcache);
  2623. lfs_cache_zero(lfs, &lfs->pcache);
  2624. // setup lookahead, must be multiple of 32-bits
  2625. LFS_ASSERT(lfs->cfg->lookahead_size % 4 == 0);
  2626. LFS_ASSERT(lfs->cfg->lookahead_size > 0);
  2627. if (lfs->cfg->lookahead_buffer) {
  2628. lfs->free.buffer = lfs->cfg->lookahead_buffer;
  2629. } else {
  2630. lfs->free.buffer = lfs_malloc(lfs->cfg->lookahead_size);
  2631. if (!lfs->free.buffer) {
  2632. err = LFS_ERR_NOMEM;
  2633. goto cleanup;
  2634. }
  2635. }
  2636. // check that the size limits are sane
  2637. LFS_ASSERT(lfs->cfg->name_max <= LFS_NAME_MAX);
  2638. lfs->name_max = lfs->cfg->name_max;
  2639. if (!lfs->name_max) {
  2640. lfs->name_max = LFS_NAME_MAX;
  2641. }
  2642. LFS_ASSERT(lfs->cfg->inline_max <= LFS_INLINE_MAX);
  2643. LFS_ASSERT(lfs->cfg->inline_max <= lfs->cfg->cache_size);
  2644. lfs->inline_max = lfs->cfg->inline_max;
  2645. if (!lfs->inline_max) {
  2646. lfs->inline_max = lfs_min(LFS_INLINE_MAX, lfs->cfg->cache_size);
  2647. }
  2648. LFS_ASSERT(lfs->cfg->attr_max <= LFS_ATTR_MAX);
  2649. lfs->attr_max = lfs->cfg->attr_max;
  2650. if (!lfs->attr_max) {
  2651. lfs->attr_max = LFS_ATTR_MAX;
  2652. }
  2653. // setup default state
  2654. lfs->root[0] = 0xffffffff;
  2655. lfs->root[1] = 0xffffffff;
  2656. lfs->mlist = NULL;
  2657. lfs->seed = 0;
  2658. lfs_global_zero(&lfs->globals);
  2659. lfs_global_zero(&lfs->locals);
  2660. return 0;
  2661. cleanup:
  2662. lfs_deinit(lfs);
  2663. return err;
  2664. }
  2665. static int lfs_deinit(lfs_t *lfs) {
  2666. // free allocated memory
  2667. if (!lfs->cfg->read_buffer) {
  2668. lfs_free(lfs->rcache.buffer);
  2669. }
  2670. if (!lfs->cfg->prog_buffer) {
  2671. lfs_free(lfs->pcache.buffer);
  2672. }
  2673. if (!lfs->cfg->lookahead_buffer) {
  2674. lfs_free(lfs->free.buffer);
  2675. }
  2676. return 0;
  2677. }
  2678. int lfs_format(lfs_t *lfs, const struct lfs_config *cfg) {
  2679. int err = lfs_init(lfs, cfg);
  2680. if (err) {
  2681. return err;
  2682. }
  2683. // create free lookahead
  2684. memset(lfs->free.buffer, 0, lfs->cfg->lookahead_size);
  2685. lfs->free.off = 0;
  2686. lfs->free.size = lfs_min(8*lfs->cfg->lookahead_size,
  2687. lfs->cfg->block_count);
  2688. lfs->free.i = 0;
  2689. lfs_alloc_ack(lfs);
  2690. // create root dir
  2691. lfs_mdir_t root;
  2692. err = lfs_dir_alloc(lfs, &root);
  2693. if (err) {
  2694. goto cleanup;
  2695. }
  2696. // write one superblock
  2697. lfs_superblock_t superblock = {
  2698. .version = LFS_DISK_VERSION,
  2699. .block_size = lfs->cfg->block_size,
  2700. .block_count = lfs->cfg->block_count,
  2701. .name_max = lfs->name_max,
  2702. .inline_max = lfs->inline_max,
  2703. .attr_max = lfs->attr_max,
  2704. };
  2705. lfs_superblock_tole32(&superblock);
  2706. err = lfs_dir_commit(lfs, &root,
  2707. LFS_MKATTR(LFS_TYPE_INLINESTRUCT, 0,
  2708. &superblock, sizeof(superblock),
  2709. LFS_MKATTR(LFS_TYPE_SUPERBLOCK, 0, "littlefs", 8,
  2710. NULL)));
  2711. if (err) {
  2712. goto cleanup;
  2713. }
  2714. // sanity check that fetch works
  2715. err = lfs_dir_fetch(lfs, &root, (const lfs_block_t[2]){0, 1});
  2716. if (err) {
  2717. goto cleanup;
  2718. }
  2719. cleanup:
  2720. lfs_deinit(lfs);
  2721. return err;
  2722. }
  2723. int lfs_mount(lfs_t *lfs, const struct lfs_config *cfg) {
  2724. int err = lfs_init(lfs, cfg);
  2725. if (err) {
  2726. return err;
  2727. }
  2728. // scan directory blocks for superblock and any global updates
  2729. lfs_mdir_t dir = {.tail = {0, 1}};
  2730. while (!lfs_pair_isnull(dir.tail)) {
  2731. // fetch next block in tail list
  2732. lfs_stag_t tag = lfs_dir_fetchmatch(lfs, &dir, dir.tail, 0x7fffe000,
  2733. LFS_MKTAG(LFS_TYPE_SUPERBLOCK, 0, 8),
  2734. lfs_dir_find_match, &(struct lfs_dir_find_match){
  2735. lfs, "littlefs", 8});
  2736. if (tag < 0) {
  2737. err = tag;
  2738. goto cleanup;
  2739. }
  2740. // has superblock?
  2741. if (tag && !lfs_tag_isdelete(tag)) {
  2742. // update root
  2743. lfs->root[0] = dir.pair[0];
  2744. lfs->root[1] = dir.pair[1];
  2745. // grab superblock
  2746. lfs_superblock_t superblock;
  2747. tag = lfs_dir_get(lfs, &dir, 0x7fffe000,
  2748. LFS_MKTAG(LFS_TYPE_INLINESTRUCT, 0, sizeof(superblock)),
  2749. &superblock);
  2750. if (tag < 0) {
  2751. err = tag;
  2752. goto cleanup;
  2753. }
  2754. lfs_superblock_fromle32(&superblock);
  2755. // check version
  2756. uint16_t major_version = (0xffff & (superblock.version >> 16));
  2757. uint16_t minor_version = (0xffff & (superblock.version >> 0));
  2758. if ((major_version != LFS_DISK_VERSION_MAJOR ||
  2759. minor_version > LFS_DISK_VERSION_MINOR)) {
  2760. LFS_ERROR("Invalid version %"PRIu32".%"PRIu32,
  2761. major_version, minor_version);
  2762. err = LFS_ERR_INVAL;
  2763. goto cleanup;
  2764. }
  2765. // check superblock configuration
  2766. if (superblock.name_max) {
  2767. if (superblock.name_max > lfs->name_max) {
  2768. LFS_ERROR("Unsupported name_max (%"PRIu32" > %"PRIu32")",
  2769. superblock.name_max, lfs->name_max);
  2770. err = LFS_ERR_INVAL;
  2771. goto cleanup;
  2772. }
  2773. lfs->name_max = superblock.name_max;
  2774. }
  2775. if (superblock.inline_max) {
  2776. if (superblock.inline_max > lfs->inline_max) {
  2777. LFS_ERROR("Unsupported inline_max (%"PRIu32" > %"PRIu32")",
  2778. superblock.inline_max, lfs->inline_max);
  2779. err = LFS_ERR_INVAL;
  2780. goto cleanup;
  2781. }
  2782. lfs->inline_max = superblock.inline_max;
  2783. }
  2784. if (superblock.attr_max) {
  2785. if (superblock.attr_max > lfs->attr_max) {
  2786. LFS_ERROR("Unsupported attr_max (%"PRIu32" > %"PRIu32")",
  2787. superblock.attr_max, lfs->attr_max);
  2788. err = LFS_ERR_INVAL;
  2789. goto cleanup;
  2790. }
  2791. lfs->attr_max = superblock.attr_max;
  2792. }
  2793. }
  2794. // has globals?
  2795. err = lfs_dir_getglobals(lfs, &dir, &lfs->locals);
  2796. if (err) {
  2797. return err;
  2798. }
  2799. }
  2800. // found superblock?
  2801. if (lfs_pair_isnull(lfs->root)) {
  2802. err = LFS_ERR_INVAL;
  2803. goto cleanup;
  2804. }
  2805. // update littlefs with globals
  2806. lfs_global_fromle32(&lfs->locals);
  2807. lfs_global_xor(&lfs->globals, &lfs->locals);
  2808. lfs_global_zero(&lfs->locals);
  2809. if (lfs->globals.hasmove) {
  2810. LFS_DEBUG("Found move %"PRIu32" %"PRIu32" %"PRIu32,
  2811. lfs->globals.pair[0], lfs->globals.pair[1], lfs->globals.id);
  2812. }
  2813. // setup free lookahead
  2814. lfs->free.off = lfs->seed % lfs->cfg->block_size;
  2815. lfs->free.size = 0;
  2816. lfs->free.i = 0;
  2817. lfs_alloc_ack(lfs);
  2818. return 0;
  2819. cleanup:
  2820. lfs_unmount(lfs);
  2821. return err;
  2822. }
  2823. int lfs_unmount(lfs_t *lfs) {
  2824. return lfs_deinit(lfs);
  2825. }
  2826. /// Filesystem filesystem operations ///
  2827. int lfs_fs_traverse(lfs_t *lfs,
  2828. int (*cb)(void *data, lfs_block_t block), void *data) {
  2829. // iterate over metadata pairs
  2830. lfs_mdir_t dir = {.tail = {0, 1}};
  2831. while (!lfs_pair_isnull(dir.tail)) {
  2832. for (int i = 0; i < 2; i++) {
  2833. int err = cb(data, dir.tail[i]);
  2834. if (err) {
  2835. return err;
  2836. }
  2837. }
  2838. // iterate through ids in directory
  2839. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  2840. if (err) {
  2841. return err;
  2842. }
  2843. for (uint16_t id = 0; id < dir.count; id++) {
  2844. struct lfs_ctz ctz;
  2845. lfs_stag_t tag = lfs_dir_get(lfs, &dir, 0x783fe000,
  2846. LFS_MKTAG(LFS_TYPE_STRUCT, id, sizeof(ctz)), &ctz);
  2847. if (tag < 0) {
  2848. if (tag == LFS_ERR_NOENT) {
  2849. continue;
  2850. }
  2851. return tag;
  2852. }
  2853. lfs_ctz_fromle32(&ctz);
  2854. if (lfs_tag_type(tag) == LFS_TYPE_CTZSTRUCT) {
  2855. err = lfs_ctz_traverse(lfs, NULL, &lfs->rcache,
  2856. ctz.head, ctz.size, cb, data);
  2857. if (err) {
  2858. return err;
  2859. }
  2860. }
  2861. }
  2862. }
  2863. // iterate over any open files
  2864. for (lfs_file_t *f = (lfs_file_t*)lfs->mlist; f; f = f->next) {
  2865. if (f->type != LFS_TYPE_REG) {
  2866. continue;
  2867. }
  2868. if ((f->flags & LFS_F_DIRTY) && !(f->flags & LFS_F_INLINE)) {
  2869. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  2870. f->ctz.head, f->ctz.size, cb, data);
  2871. if (err) {
  2872. return err;
  2873. }
  2874. }
  2875. if ((f->flags & LFS_F_WRITING) && !(f->flags & LFS_F_INLINE)) {
  2876. int err = lfs_ctz_traverse(lfs, &f->cache, &lfs->rcache,
  2877. f->block, f->pos, cb, data);
  2878. if (err) {
  2879. return err;
  2880. }
  2881. }
  2882. }
  2883. return 0;
  2884. }
  2885. static int lfs_fs_pred(lfs_t *lfs,
  2886. const lfs_block_t pair[2], lfs_mdir_t *pdir) {
  2887. // iterate over all directory directory entries
  2888. pdir->tail[0] = 0;
  2889. pdir->tail[1] = 1;
  2890. while (!lfs_pair_isnull(pdir->tail)) {
  2891. if (lfs_pair_cmp(pdir->tail, pair) == 0) {
  2892. return 0;
  2893. }
  2894. int err = lfs_dir_fetch(lfs, pdir, pdir->tail);
  2895. if (err) {
  2896. return err;
  2897. }
  2898. }
  2899. return LFS_ERR_NOENT;
  2900. }
  2901. struct lfs_fs_parent_match {
  2902. lfs_t *lfs;
  2903. const lfs_block_t pair[2];
  2904. };
  2905. static int lfs_fs_parent_match(void *data,
  2906. lfs_tag_t tag, const void *buffer) {
  2907. struct lfs_fs_parent_match *find = data;
  2908. lfs_t *lfs = find->lfs;
  2909. const struct lfs_diskoff *disk = buffer;
  2910. (void)tag;
  2911. lfs_block_t child[2];
  2912. int err = lfs_bd_read(lfs,
  2913. &lfs->pcache, &lfs->rcache, lfs->cfg->block_size,
  2914. disk->block, disk->off, &child, sizeof(child));
  2915. if (err) {
  2916. return err;
  2917. }
  2918. lfs_pair_fromle32(child);
  2919. return (lfs_pair_cmp(child, find->pair) == 0) ? tag : 0;
  2920. }
  2921. static lfs_stag_t lfs_fs_parent(lfs_t *lfs, const lfs_block_t pair[2],
  2922. lfs_mdir_t *parent) {
  2923. // use fetchmatch with callback to find pairs
  2924. parent->tail[0] = 0;
  2925. parent->tail[1] = 1;
  2926. while (!lfs_pair_isnull(parent->tail)) {
  2927. lfs_stag_t tag = lfs_dir_fetchmatch(lfs, parent, parent->tail,
  2928. 0x7fc01fff, LFS_MKTAG(LFS_TYPE_DIRSTRUCT, 0, 8),
  2929. lfs_fs_parent_match, &(struct lfs_fs_parent_match){
  2930. lfs, {pair[0], pair[1]}});
  2931. if (tag) {
  2932. return tag;
  2933. }
  2934. }
  2935. return LFS_ERR_NOENT;
  2936. }
  2937. static int lfs_fs_relocate(lfs_t *lfs,
  2938. const lfs_block_t oldpair[2], lfs_block_t newpair[2]) {
  2939. // update internal root
  2940. if (lfs_pair_cmp(oldpair, lfs->root) == 0) {
  2941. LFS_DEBUG("Relocating root %"PRIu32" %"PRIu32,
  2942. newpair[0], newpair[1]);
  2943. lfs->root[0] = newpair[0];
  2944. lfs->root[1] = newpair[1];
  2945. }
  2946. // update internally tracked dirs
  2947. for (struct lfs_mlist *d = lfs->mlist; d; d = d->next) {
  2948. if (lfs_pair_cmp(oldpair, d->m.pair) == 0) {
  2949. d->m.pair[0] = newpair[0];
  2950. d->m.pair[1] = newpair[1];
  2951. }
  2952. }
  2953. // find parent
  2954. lfs_mdir_t parent;
  2955. lfs_stag_t tag = lfs_fs_parent(lfs, oldpair, &parent);
  2956. if (tag < 0 && tag != LFS_ERR_NOENT) {
  2957. return tag;
  2958. }
  2959. if (tag != LFS_ERR_NOENT) {
  2960. // update disk, this creates a desync
  2961. lfs_global_orphans(lfs, +1);
  2962. lfs_pair_tole32(newpair);
  2963. int err = lfs_dir_commit(lfs, &parent,
  2964. &(struct lfs_mattr){.tag=tag, .buffer=newpair});
  2965. lfs_pair_fromle32(newpair);
  2966. if (err) {
  2967. return err;
  2968. }
  2969. // next step, clean up orphans
  2970. lfs_global_orphans(lfs, -1);
  2971. }
  2972. // find pred
  2973. int err = lfs_fs_pred(lfs, oldpair, &parent);
  2974. if (err && err != LFS_ERR_NOENT) {
  2975. return err;
  2976. }
  2977. // if we can't find dir, it must be new
  2978. if (err != LFS_ERR_NOENT) {
  2979. // replace bad pair, either we clean up desync, or no desync occured
  2980. parent.tail[0] = newpair[0];
  2981. parent.tail[1] = newpair[1];
  2982. err = lfs_dir_commit(lfs, &parent,
  2983. LFS_MKATTR(LFS_TYPE_TAIL + parent.split,
  2984. 0x1ff, parent.tail, sizeof(parent.tail),
  2985. NULL));
  2986. if (err) {
  2987. return err;
  2988. }
  2989. }
  2990. return 0;
  2991. }
  2992. static int lfs_fs_demove(lfs_t *lfs) {
  2993. if (!lfs->globals.hasmove) {
  2994. return 0;
  2995. }
  2996. // Fix bad moves
  2997. LFS_DEBUG("Fixing move %"PRIu32" %"PRIu32" %"PRIu32,
  2998. lfs->globals.pair[0], lfs->globals.pair[1], lfs->globals.id);
  2999. // fetch and delete the moved entry
  3000. lfs_mdir_t movedir;
  3001. int err = lfs_dir_fetch(lfs, &movedir, lfs->globals.pair);
  3002. if (err) {
  3003. return err;
  3004. }
  3005. // rely on cancel logic inside commit
  3006. err = lfs_dir_commit(lfs, &movedir, NULL);
  3007. if (err) {
  3008. return err;
  3009. }
  3010. return 0;
  3011. }
  3012. static int lfs_fs_deorphan(lfs_t *lfs) {
  3013. if (!lfs->globals.orphans) {
  3014. return 0;
  3015. }
  3016. // Fix any orphans
  3017. lfs_mdir_t pdir = {.split = true};
  3018. lfs_mdir_t dir = {.tail = {0, 1}};
  3019. // iterate over all directory directory entries
  3020. while (!lfs_pair_isnull(dir.tail)) {
  3021. int err = lfs_dir_fetch(lfs, &dir, dir.tail);
  3022. if (err) {
  3023. return err;
  3024. }
  3025. // check head blocks for orphans
  3026. if (!pdir.split) {
  3027. // check if we have a parent
  3028. lfs_mdir_t parent;
  3029. lfs_stag_t tag = lfs_fs_parent(lfs, pdir.tail, &parent);
  3030. if (tag < 0 && tag != LFS_ERR_NOENT) {
  3031. return tag;
  3032. }
  3033. if (tag == LFS_ERR_NOENT) {
  3034. // we are an orphan
  3035. LFS_DEBUG("Fixing orphan %"PRIu32" %"PRIu32,
  3036. pdir.tail[0], pdir.tail[1]);
  3037. err = lfs_dir_drop(lfs, &pdir, &dir);
  3038. if (err) {
  3039. return err;
  3040. }
  3041. break;
  3042. }
  3043. lfs_block_t pair[2];
  3044. lfs_stag_t res = lfs_dir_get(lfs, &parent, 0x7fffe000, tag, pair);
  3045. if (res < 0) {
  3046. return res;
  3047. }
  3048. lfs_pair_fromle32(pair);
  3049. if (!lfs_pair_sync(pair, pdir.tail)) {
  3050. // we have desynced
  3051. LFS_DEBUG("Fixing half-orphan %"PRIu32" %"PRIu32,
  3052. pair[0], pair[1]);
  3053. pdir.tail[0] = pair[0];
  3054. pdir.tail[1] = pair[1];
  3055. err = lfs_dir_commit(lfs, &pdir,
  3056. LFS_MKATTR(LFS_TYPE_SOFTTAIL,
  3057. 0x1ff, pdir.tail, sizeof(pdir.tail),
  3058. NULL));
  3059. if (err) {
  3060. return err;
  3061. }
  3062. break;
  3063. }
  3064. }
  3065. memcpy(&pdir, &dir, sizeof(pdir));
  3066. }
  3067. // mark orphans as fixed
  3068. lfs_global_orphans(lfs, -lfs->globals.orphans);
  3069. return 0;
  3070. }
  3071. static int lfs_fs_forceconsistency(lfs_t *lfs) {
  3072. int err = lfs_fs_demove(lfs);
  3073. if (err) {
  3074. return err;
  3075. }
  3076. err = lfs_fs_deorphan(lfs);
  3077. if (err) {
  3078. return err;
  3079. }
  3080. return 0;
  3081. }
  3082. static int lfs_fs_size_count(void *p, lfs_block_t block) {
  3083. (void)block;
  3084. lfs_size_t *size = p;
  3085. *size += 1;
  3086. return 0;
  3087. }
  3088. lfs_ssize_t lfs_fs_size(lfs_t *lfs) {
  3089. lfs_size_t size = 0;
  3090. int err = lfs_fs_traverse(lfs, lfs_fs_size_count, &size);
  3091. if (err) {
  3092. return err;
  3093. }
  3094. return size;
  3095. }