lfs.c 103 KB

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