lfs.c 110 KB

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