super.c 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157
  1. /*
  2. * This file is part of UBIFS.
  3. *
  4. * Copyright (C) 2006-2008 Nokia Corporation.
  5. *
  6. * This program is free software; you can redistribute it and/or modify it
  7. * under the terms of the GNU General Public License version 2 as published by
  8. * the Free Software Foundation.
  9. *
  10. * This program is distributed in the hope that it will be useful, but WITHOUT
  11. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12. * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13. * more details.
  14. *
  15. * You should have received a copy of the GNU General Public License along with
  16. * this program; if not, write to the Free Software Foundation, Inc., 51
  17. * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18. *
  19. * Authors: Artem Bityutskiy (Битюцкий Артём)
  20. * Adrian Hunter
  21. */
  22. /*
  23. * This file implements UBIFS initialization and VFS superblock operations. Some
  24. * initialization stuff which is rather large and complex is placed at
  25. * corresponding subsystems, but most of it is here.
  26. */
  27. #include <linux/init.h>
  28. #include <linux/slab.h>
  29. #include <linux/module.h>
  30. #include <linux/ctype.h>
  31. #include <linux/kthread.h>
  32. #include <linux/parser.h>
  33. #include <linux/seq_file.h>
  34. #include <linux/mount.h>
  35. #include <linux/math64.h>
  36. #include <linux/writeback.h>
  37. #include "ubifs.h"
  38. /*
  39. * Maximum amount of memory we may 'kmalloc()' without worrying that we are
  40. * allocating too much.
  41. */
  42. #define UBIFS_KMALLOC_OK (128*1024)
  43. /* Slab cache for UBIFS inodes */
  44. struct kmem_cache *ubifs_inode_slab;
  45. /* UBIFS TNC shrinker description */
  46. static struct shrinker ubifs_shrinker_info = {
  47. .shrink = ubifs_shrinker,
  48. .seeks = DEFAULT_SEEKS,
  49. };
  50. /**
  51. * validate_inode - validate inode.
  52. * @c: UBIFS file-system description object
  53. * @inode: the inode to validate
  54. *
  55. * This is a helper function for 'ubifs_iget()' which validates various fields
  56. * of a newly built inode to make sure they contain sane values and prevent
  57. * possible vulnerabilities. Returns zero if the inode is all right and
  58. * a non-zero error code if not.
  59. */
  60. static int validate_inode(struct ubifs_info *c, const struct inode *inode)
  61. {
  62. int err;
  63. const struct ubifs_inode *ui = ubifs_inode(inode);
  64. if (inode->i_size > c->max_inode_sz) {
  65. ubifs_err("inode is too large (%lld)",
  66. (long long)inode->i_size);
  67. return 1;
  68. }
  69. if (ui->compr_type < 0 || ui->compr_type >= UBIFS_COMPR_TYPES_CNT) {
  70. ubifs_err("unknown compression type %d", ui->compr_type);
  71. return 2;
  72. }
  73. if (ui->xattr_names + ui->xattr_cnt > XATTR_LIST_MAX)
  74. return 3;
  75. if (ui->data_len < 0 || ui->data_len > UBIFS_MAX_INO_DATA)
  76. return 4;
  77. if (ui->xattr && (inode->i_mode & S_IFMT) != S_IFREG)
  78. return 5;
  79. if (!ubifs_compr_present(ui->compr_type)) {
  80. ubifs_warn("inode %lu uses '%s' compression, but it was not "
  81. "compiled in", inode->i_ino,
  82. ubifs_compr_name(ui->compr_type));
  83. }
  84. err = dbg_check_dir_size(c, inode);
  85. return err;
  86. }
  87. struct inode *ubifs_iget(struct super_block *sb, unsigned long inum)
  88. {
  89. int err;
  90. union ubifs_key key;
  91. struct ubifs_ino_node *ino;
  92. struct ubifs_info *c = sb->s_fs_info;
  93. struct inode *inode;
  94. struct ubifs_inode *ui;
  95. dbg_gen("inode %lu", inum);
  96. inode = iget_locked(sb, inum);
  97. if (!inode)
  98. return ERR_PTR(-ENOMEM);
  99. if (!(inode->i_state & I_NEW))
  100. return inode;
  101. ui = ubifs_inode(inode);
  102. ino = kmalloc(UBIFS_MAX_INO_NODE_SZ, GFP_NOFS);
  103. if (!ino) {
  104. err = -ENOMEM;
  105. goto out;
  106. }
  107. ino_key_init(c, &key, inode->i_ino);
  108. err = ubifs_tnc_lookup(c, &key, ino);
  109. if (err)
  110. goto out_ino;
  111. inode->i_flags |= (S_NOCMTIME | S_NOATIME);
  112. inode->i_nlink = le32_to_cpu(ino->nlink);
  113. inode->i_uid = le32_to_cpu(ino->uid);
  114. inode->i_gid = le32_to_cpu(ino->gid);
  115. inode->i_atime.tv_sec = (int64_t)le64_to_cpu(ino->atime_sec);
  116. inode->i_atime.tv_nsec = le32_to_cpu(ino->atime_nsec);
  117. inode->i_mtime.tv_sec = (int64_t)le64_to_cpu(ino->mtime_sec);
  118. inode->i_mtime.tv_nsec = le32_to_cpu(ino->mtime_nsec);
  119. inode->i_ctime.tv_sec = (int64_t)le64_to_cpu(ino->ctime_sec);
  120. inode->i_ctime.tv_nsec = le32_to_cpu(ino->ctime_nsec);
  121. inode->i_mode = le32_to_cpu(ino->mode);
  122. inode->i_size = le64_to_cpu(ino->size);
  123. ui->data_len = le32_to_cpu(ino->data_len);
  124. ui->flags = le32_to_cpu(ino->flags);
  125. ui->compr_type = le16_to_cpu(ino->compr_type);
  126. ui->creat_sqnum = le64_to_cpu(ino->creat_sqnum);
  127. ui->xattr_cnt = le32_to_cpu(ino->xattr_cnt);
  128. ui->xattr_size = le32_to_cpu(ino->xattr_size);
  129. ui->xattr_names = le32_to_cpu(ino->xattr_names);
  130. ui->synced_i_size = ui->ui_size = inode->i_size;
  131. ui->xattr = (ui->flags & UBIFS_XATTR_FL) ? 1 : 0;
  132. err = validate_inode(c, inode);
  133. if (err)
  134. goto out_invalid;
  135. /* Disable read-ahead */
  136. inode->i_mapping->backing_dev_info = &c->bdi;
  137. switch (inode->i_mode & S_IFMT) {
  138. case S_IFREG:
  139. inode->i_mapping->a_ops = &ubifs_file_address_operations;
  140. inode->i_op = &ubifs_file_inode_operations;
  141. inode->i_fop = &ubifs_file_operations;
  142. if (ui->xattr) {
  143. ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
  144. if (!ui->data) {
  145. err = -ENOMEM;
  146. goto out_ino;
  147. }
  148. memcpy(ui->data, ino->data, ui->data_len);
  149. ((char *)ui->data)[ui->data_len] = '\0';
  150. } else if (ui->data_len != 0) {
  151. err = 10;
  152. goto out_invalid;
  153. }
  154. break;
  155. case S_IFDIR:
  156. inode->i_op = &ubifs_dir_inode_operations;
  157. inode->i_fop = &ubifs_dir_operations;
  158. if (ui->data_len != 0) {
  159. err = 11;
  160. goto out_invalid;
  161. }
  162. break;
  163. case S_IFLNK:
  164. inode->i_op = &ubifs_symlink_inode_operations;
  165. if (ui->data_len <= 0 || ui->data_len > UBIFS_MAX_INO_DATA) {
  166. err = 12;
  167. goto out_invalid;
  168. }
  169. ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
  170. if (!ui->data) {
  171. err = -ENOMEM;
  172. goto out_ino;
  173. }
  174. memcpy(ui->data, ino->data, ui->data_len);
  175. ((char *)ui->data)[ui->data_len] = '\0';
  176. break;
  177. case S_IFBLK:
  178. case S_IFCHR:
  179. {
  180. dev_t rdev;
  181. union ubifs_dev_desc *dev;
  182. ui->data = kmalloc(sizeof(union ubifs_dev_desc), GFP_NOFS);
  183. if (!ui->data) {
  184. err = -ENOMEM;
  185. goto out_ino;
  186. }
  187. dev = (union ubifs_dev_desc *)ino->data;
  188. if (ui->data_len == sizeof(dev->new))
  189. rdev = new_decode_dev(le32_to_cpu(dev->new));
  190. else if (ui->data_len == sizeof(dev->huge))
  191. rdev = huge_decode_dev(le64_to_cpu(dev->huge));
  192. else {
  193. err = 13;
  194. goto out_invalid;
  195. }
  196. memcpy(ui->data, ino->data, ui->data_len);
  197. inode->i_op = &ubifs_file_inode_operations;
  198. init_special_inode(inode, inode->i_mode, rdev);
  199. break;
  200. }
  201. case S_IFSOCK:
  202. case S_IFIFO:
  203. inode->i_op = &ubifs_file_inode_operations;
  204. init_special_inode(inode, inode->i_mode, 0);
  205. if (ui->data_len != 0) {
  206. err = 14;
  207. goto out_invalid;
  208. }
  209. break;
  210. default:
  211. err = 15;
  212. goto out_invalid;
  213. }
  214. kfree(ino);
  215. ubifs_set_inode_flags(inode);
  216. unlock_new_inode(inode);
  217. return inode;
  218. out_invalid:
  219. ubifs_err("inode %lu validation failed, error %d", inode->i_ino, err);
  220. dbg_dump_node(c, ino);
  221. dbg_dump_inode(c, inode);
  222. err = -EINVAL;
  223. out_ino:
  224. kfree(ino);
  225. out:
  226. ubifs_err("failed to read inode %lu, error %d", inode->i_ino, err);
  227. iget_failed(inode);
  228. return ERR_PTR(err);
  229. }
  230. static struct inode *ubifs_alloc_inode(struct super_block *sb)
  231. {
  232. struct ubifs_inode *ui;
  233. ui = kmem_cache_alloc(ubifs_inode_slab, GFP_NOFS);
  234. if (!ui)
  235. return NULL;
  236. memset((void *)ui + sizeof(struct inode), 0,
  237. sizeof(struct ubifs_inode) - sizeof(struct inode));
  238. mutex_init(&ui->ui_mutex);
  239. spin_lock_init(&ui->ui_lock);
  240. return &ui->vfs_inode;
  241. };
  242. static void ubifs_destroy_inode(struct inode *inode)
  243. {
  244. struct ubifs_inode *ui = ubifs_inode(inode);
  245. kfree(ui->data);
  246. kmem_cache_free(ubifs_inode_slab, inode);
  247. }
  248. /*
  249. * Note, Linux write-back code calls this without 'i_mutex'.
  250. */
  251. static int ubifs_write_inode(struct inode *inode, int wait)
  252. {
  253. int err = 0;
  254. struct ubifs_info *c = inode->i_sb->s_fs_info;
  255. struct ubifs_inode *ui = ubifs_inode(inode);
  256. ubifs_assert(!ui->xattr);
  257. if (is_bad_inode(inode))
  258. return 0;
  259. mutex_lock(&ui->ui_mutex);
  260. /*
  261. * Due to races between write-back forced by budgeting
  262. * (see 'sync_some_inodes()') and pdflush write-back, the inode may
  263. * have already been synchronized, do not do this again. This might
  264. * also happen if it was synchronized in an VFS operation, e.g.
  265. * 'ubifs_link()'.
  266. */
  267. if (!ui->dirty) {
  268. mutex_unlock(&ui->ui_mutex);
  269. return 0;
  270. }
  271. /*
  272. * As an optimization, do not write orphan inodes to the media just
  273. * because this is not needed.
  274. */
  275. dbg_gen("inode %lu, mode %#x, nlink %u",
  276. inode->i_ino, (int)inode->i_mode, inode->i_nlink);
  277. if (inode->i_nlink) {
  278. err = ubifs_jnl_write_inode(c, inode);
  279. if (err)
  280. ubifs_err("can't write inode %lu, error %d",
  281. inode->i_ino, err);
  282. }
  283. ui->dirty = 0;
  284. mutex_unlock(&ui->ui_mutex);
  285. ubifs_release_dirty_inode_budget(c, ui);
  286. return err;
  287. }
  288. static void ubifs_delete_inode(struct inode *inode)
  289. {
  290. int err;
  291. struct ubifs_info *c = inode->i_sb->s_fs_info;
  292. struct ubifs_inode *ui = ubifs_inode(inode);
  293. if (ui->xattr)
  294. /*
  295. * Extended attribute inode deletions are fully handled in
  296. * 'ubifs_removexattr()'. These inodes are special and have
  297. * limited usage, so there is nothing to do here.
  298. */
  299. goto out;
  300. dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
  301. ubifs_assert(!atomic_read(&inode->i_count));
  302. ubifs_assert(inode->i_nlink == 0);
  303. truncate_inode_pages(&inode->i_data, 0);
  304. if (is_bad_inode(inode))
  305. goto out;
  306. ui->ui_size = inode->i_size = 0;
  307. err = ubifs_jnl_delete_inode(c, inode);
  308. if (err)
  309. /*
  310. * Worst case we have a lost orphan inode wasting space, so a
  311. * simple error message is OK here.
  312. */
  313. ubifs_err("can't delete inode %lu, error %d",
  314. inode->i_ino, err);
  315. out:
  316. if (ui->dirty)
  317. ubifs_release_dirty_inode_budget(c, ui);
  318. clear_inode(inode);
  319. }
  320. static void ubifs_dirty_inode(struct inode *inode)
  321. {
  322. struct ubifs_inode *ui = ubifs_inode(inode);
  323. ubifs_assert(mutex_is_locked(&ui->ui_mutex));
  324. if (!ui->dirty) {
  325. ui->dirty = 1;
  326. dbg_gen("inode %lu", inode->i_ino);
  327. }
  328. }
  329. static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
  330. {
  331. struct ubifs_info *c = dentry->d_sb->s_fs_info;
  332. unsigned long long free;
  333. __le32 *uuid = (__le32 *)c->uuid;
  334. free = ubifs_get_free_space(c);
  335. dbg_gen("free space %lld bytes (%lld blocks)",
  336. free, free >> UBIFS_BLOCK_SHIFT);
  337. buf->f_type = UBIFS_SUPER_MAGIC;
  338. buf->f_bsize = UBIFS_BLOCK_SIZE;
  339. buf->f_blocks = c->block_cnt;
  340. buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
  341. if (free > c->report_rp_size)
  342. buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
  343. else
  344. buf->f_bavail = 0;
  345. buf->f_files = 0;
  346. buf->f_ffree = 0;
  347. buf->f_namelen = UBIFS_MAX_NLEN;
  348. buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
  349. buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
  350. return 0;
  351. }
  352. static int ubifs_show_options(struct seq_file *s, struct vfsmount *mnt)
  353. {
  354. struct ubifs_info *c = mnt->mnt_sb->s_fs_info;
  355. if (c->mount_opts.unmount_mode == 2)
  356. seq_printf(s, ",fast_unmount");
  357. else if (c->mount_opts.unmount_mode == 1)
  358. seq_printf(s, ",norm_unmount");
  359. if (c->mount_opts.bulk_read == 2)
  360. seq_printf(s, ",bulk_read");
  361. else if (c->mount_opts.bulk_read == 1)
  362. seq_printf(s, ",no_bulk_read");
  363. if (c->mount_opts.chk_data_crc == 2)
  364. seq_printf(s, ",chk_data_crc");
  365. else if (c->mount_opts.chk_data_crc == 1)
  366. seq_printf(s, ",no_chk_data_crc");
  367. if (c->mount_opts.override_compr) {
  368. seq_printf(s, ",compr=");
  369. seq_printf(s, ubifs_compr_name(c->mount_opts.compr_type));
  370. }
  371. return 0;
  372. }
  373. static int ubifs_sync_fs(struct super_block *sb, int wait)
  374. {
  375. struct ubifs_info *c = sb->s_fs_info;
  376. int i, ret = 0, err;
  377. long long bud_bytes;
  378. struct writeback_control wbc = {
  379. .sync_mode = wait ? WB_SYNC_ALL : WB_SYNC_HOLD,
  380. .range_start = 0,
  381. .range_end = LLONG_MAX,
  382. .nr_to_write = LONG_MAX,
  383. };
  384. /*
  385. * VFS calls '->sync_fs()' before synchronizing all dirty inodes and
  386. * pages, so synchronize them first, then commit the journal. Strictly
  387. * speaking, it is not necessary to commit the journal here,
  388. * synchronizing write-buffers would be enough. But committing makes
  389. * UBIFS free space predictions much more accurate, so we want to let
  390. * the user be able to get more accurate results of 'statfs()' after
  391. * they synchronize the file system.
  392. */
  393. generic_sync_sb_inodes(sb, &wbc);
  394. if (c->jheads) {
  395. for (i = 0; i < c->jhead_cnt; i++) {
  396. err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
  397. if (err && !ret)
  398. ret = err;
  399. }
  400. /* Commit the journal unless it has too little data */
  401. spin_lock(&c->buds_lock);
  402. bud_bytes = c->bud_bytes;
  403. spin_unlock(&c->buds_lock);
  404. if (bud_bytes > c->leb_size) {
  405. err = ubifs_run_commit(c);
  406. if (err)
  407. return err;
  408. }
  409. }
  410. /*
  411. * We ought to call sync for c->ubi but it does not have one. If it had
  412. * it would in turn call mtd->sync, however mtd operations are
  413. * synchronous anyway, so we don't lose any sleep here.
  414. */
  415. return ret;
  416. }
  417. /**
  418. * init_constants_early - initialize UBIFS constants.
  419. * @c: UBIFS file-system description object
  420. *
  421. * This function initialize UBIFS constants which do not need the superblock to
  422. * be read. It also checks that the UBI volume satisfies basic UBIFS
  423. * requirements. Returns zero in case of success and a negative error code in
  424. * case of failure.
  425. */
  426. static int init_constants_early(struct ubifs_info *c)
  427. {
  428. if (c->vi.corrupted) {
  429. ubifs_warn("UBI volume is corrupted - read-only mode");
  430. c->ro_media = 1;
  431. }
  432. if (c->di.ro_mode) {
  433. ubifs_msg("read-only UBI device");
  434. c->ro_media = 1;
  435. }
  436. if (c->vi.vol_type == UBI_STATIC_VOLUME) {
  437. ubifs_msg("static UBI volume - read-only mode");
  438. c->ro_media = 1;
  439. }
  440. c->leb_cnt = c->vi.size;
  441. c->leb_size = c->vi.usable_leb_size;
  442. c->half_leb_size = c->leb_size / 2;
  443. c->min_io_size = c->di.min_io_size;
  444. c->min_io_shift = fls(c->min_io_size) - 1;
  445. if (c->leb_size < UBIFS_MIN_LEB_SZ) {
  446. ubifs_err("too small LEBs (%d bytes), min. is %d bytes",
  447. c->leb_size, UBIFS_MIN_LEB_SZ);
  448. return -EINVAL;
  449. }
  450. if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
  451. ubifs_err("too few LEBs (%d), min. is %d",
  452. c->leb_cnt, UBIFS_MIN_LEB_CNT);
  453. return -EINVAL;
  454. }
  455. if (!is_power_of_2(c->min_io_size)) {
  456. ubifs_err("bad min. I/O size %d", c->min_io_size);
  457. return -EINVAL;
  458. }
  459. /*
  460. * UBIFS aligns all node to 8-byte boundary, so to make function in
  461. * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
  462. * less than 8.
  463. */
  464. if (c->min_io_size < 8) {
  465. c->min_io_size = 8;
  466. c->min_io_shift = 3;
  467. }
  468. c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
  469. c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
  470. /*
  471. * Initialize node length ranges which are mostly needed for node
  472. * length validation.
  473. */
  474. c->ranges[UBIFS_PAD_NODE].len = UBIFS_PAD_NODE_SZ;
  475. c->ranges[UBIFS_SB_NODE].len = UBIFS_SB_NODE_SZ;
  476. c->ranges[UBIFS_MST_NODE].len = UBIFS_MST_NODE_SZ;
  477. c->ranges[UBIFS_REF_NODE].len = UBIFS_REF_NODE_SZ;
  478. c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
  479. c->ranges[UBIFS_CS_NODE].len = UBIFS_CS_NODE_SZ;
  480. c->ranges[UBIFS_INO_NODE].min_len = UBIFS_INO_NODE_SZ;
  481. c->ranges[UBIFS_INO_NODE].max_len = UBIFS_MAX_INO_NODE_SZ;
  482. c->ranges[UBIFS_ORPH_NODE].min_len =
  483. UBIFS_ORPH_NODE_SZ + sizeof(__le64);
  484. c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
  485. c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
  486. c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
  487. c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
  488. c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
  489. c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
  490. c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
  491. /*
  492. * Minimum indexing node size is amended later when superblock is
  493. * read and the key length is known.
  494. */
  495. c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
  496. /*
  497. * Maximum indexing node size is amended later when superblock is
  498. * read and the fanout is known.
  499. */
  500. c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
  501. /*
  502. * Initialize dead and dark LEB space watermarks.
  503. *
  504. * Dead space is the space which cannot be used. Its watermark is
  505. * equivalent to min. I/O unit or minimum node size if it is greater
  506. * then min. I/O unit.
  507. *
  508. * Dark space is the space which might be used, or might not, depending
  509. * on which node should be written to the LEB. Its watermark is
  510. * equivalent to maximum UBIFS node size.
  511. */
  512. c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
  513. c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
  514. /*
  515. * Calculate how many bytes would be wasted at the end of LEB if it was
  516. * fully filled with data nodes of maximum size. This is used in
  517. * calculations when reporting free space.
  518. */
  519. c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
  520. /* Buffer size for bulk-reads */
  521. c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
  522. if (c->max_bu_buf_len > c->leb_size)
  523. c->max_bu_buf_len = c->leb_size;
  524. return 0;
  525. }
  526. /**
  527. * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
  528. * @c: UBIFS file-system description object
  529. * @lnum: LEB the write-buffer was synchronized to
  530. * @free: how many free bytes left in this LEB
  531. * @pad: how many bytes were padded
  532. *
  533. * This is a callback function which is called by the I/O unit when the
  534. * write-buffer is synchronized. We need this to correctly maintain space
  535. * accounting in bud logical eraseblocks. This function returns zero in case of
  536. * success and a negative error code in case of failure.
  537. *
  538. * This function actually belongs to the journal, but we keep it here because
  539. * we want to keep it static.
  540. */
  541. static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
  542. {
  543. return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
  544. }
  545. /*
  546. * init_constants_sb - initialize UBIFS constants.
  547. * @c: UBIFS file-system description object
  548. *
  549. * This is a helper function which initializes various UBIFS constants after
  550. * the superblock has been read. It also checks various UBIFS parameters and
  551. * makes sure they are all right. Returns zero in case of success and a
  552. * negative error code in case of failure.
  553. */
  554. static int init_constants_sb(struct ubifs_info *c)
  555. {
  556. int tmp, err;
  557. long long tmp64;
  558. c->main_bytes = (long long)c->main_lebs * c->leb_size;
  559. c->max_znode_sz = sizeof(struct ubifs_znode) +
  560. c->fanout * sizeof(struct ubifs_zbranch);
  561. tmp = ubifs_idx_node_sz(c, 1);
  562. c->ranges[UBIFS_IDX_NODE].min_len = tmp;
  563. c->min_idx_node_sz = ALIGN(tmp, 8);
  564. tmp = ubifs_idx_node_sz(c, c->fanout);
  565. c->ranges[UBIFS_IDX_NODE].max_len = tmp;
  566. c->max_idx_node_sz = ALIGN(tmp, 8);
  567. /* Make sure LEB size is large enough to fit full commit */
  568. tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
  569. tmp = ALIGN(tmp, c->min_io_size);
  570. if (tmp > c->leb_size) {
  571. dbg_err("too small LEB size %d, at least %d needed",
  572. c->leb_size, tmp);
  573. return -EINVAL;
  574. }
  575. /*
  576. * Make sure that the log is large enough to fit reference nodes for
  577. * all buds plus one reserved LEB.
  578. */
  579. tmp64 = c->max_bud_bytes + c->leb_size - 1;
  580. c->max_bud_cnt = div_u64(tmp64, c->leb_size);
  581. tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
  582. tmp /= c->leb_size;
  583. tmp += 1;
  584. if (c->log_lebs < tmp) {
  585. dbg_err("too small log %d LEBs, required min. %d LEBs",
  586. c->log_lebs, tmp);
  587. return -EINVAL;
  588. }
  589. /*
  590. * When budgeting we assume worst-case scenarios when the pages are not
  591. * be compressed and direntries are of the maximum size.
  592. *
  593. * Note, data, which may be stored in inodes is budgeted separately, so
  594. * it is not included into 'c->inode_budget'.
  595. */
  596. c->page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
  597. c->inode_budget = UBIFS_INO_NODE_SZ;
  598. c->dent_budget = UBIFS_MAX_DENT_NODE_SZ;
  599. /*
  600. * When the amount of flash space used by buds becomes
  601. * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
  602. * The writers are unblocked when the commit is finished. To avoid
  603. * writers to be blocked UBIFS initiates background commit in advance,
  604. * when number of bud bytes becomes above the limit defined below.
  605. */
  606. c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
  607. /*
  608. * Ensure minimum journal size. All the bytes in the journal heads are
  609. * considered to be used, when calculating the current journal usage.
  610. * Consequently, if the journal is too small, UBIFS will treat it as
  611. * always full.
  612. */
  613. tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
  614. if (c->bg_bud_bytes < tmp64)
  615. c->bg_bud_bytes = tmp64;
  616. if (c->max_bud_bytes < tmp64 + c->leb_size)
  617. c->max_bud_bytes = tmp64 + c->leb_size;
  618. err = ubifs_calc_lpt_geom(c);
  619. if (err)
  620. return err;
  621. return 0;
  622. }
  623. /*
  624. * init_constants_master - initialize UBIFS constants.
  625. * @c: UBIFS file-system description object
  626. *
  627. * This is a helper function which initializes various UBIFS constants after
  628. * the master node has been read. It also checks various UBIFS parameters and
  629. * makes sure they are all right.
  630. */
  631. static void init_constants_master(struct ubifs_info *c)
  632. {
  633. long long tmp64;
  634. c->min_idx_lebs = ubifs_calc_min_idx_lebs(c);
  635. /*
  636. * Calculate total amount of FS blocks. This number is not used
  637. * internally because it does not make much sense for UBIFS, but it is
  638. * necessary to report something for the 'statfs()' call.
  639. *
  640. * Subtract the LEB reserved for GC, the LEB which is reserved for
  641. * deletions, minimum LEBs for the index, and assume only one journal
  642. * head is available.
  643. */
  644. tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt + 1;
  645. tmp64 *= (long long)c->leb_size - c->leb_overhead;
  646. tmp64 = ubifs_reported_space(c, tmp64);
  647. c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
  648. }
  649. /**
  650. * take_gc_lnum - reserve GC LEB.
  651. * @c: UBIFS file-system description object
  652. *
  653. * This function ensures that the LEB reserved for garbage collection is
  654. * unmapped and is marked as "taken" in lprops. We also have to set free space
  655. * to LEB size and dirty space to zero, because lprops may contain out-of-date
  656. * information if the file-system was un-mounted before it has been committed.
  657. * This function returns zero in case of success and a negative error code in
  658. * case of failure.
  659. */
  660. static int take_gc_lnum(struct ubifs_info *c)
  661. {
  662. int err;
  663. if (c->gc_lnum == -1) {
  664. ubifs_err("no LEB for GC");
  665. return -EINVAL;
  666. }
  667. err = ubifs_leb_unmap(c, c->gc_lnum);
  668. if (err)
  669. return err;
  670. /* And we have to tell lprops that this LEB is taken */
  671. err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
  672. LPROPS_TAKEN, 0, 0);
  673. return err;
  674. }
  675. /**
  676. * alloc_wbufs - allocate write-buffers.
  677. * @c: UBIFS file-system description object
  678. *
  679. * This helper function allocates and initializes UBIFS write-buffers. Returns
  680. * zero in case of success and %-ENOMEM in case of failure.
  681. */
  682. static int alloc_wbufs(struct ubifs_info *c)
  683. {
  684. int i, err;
  685. c->jheads = kzalloc(c->jhead_cnt * sizeof(struct ubifs_jhead),
  686. GFP_KERNEL);
  687. if (!c->jheads)
  688. return -ENOMEM;
  689. /* Initialize journal heads */
  690. for (i = 0; i < c->jhead_cnt; i++) {
  691. INIT_LIST_HEAD(&c->jheads[i].buds_list);
  692. err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
  693. if (err)
  694. return err;
  695. c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
  696. c->jheads[i].wbuf.jhead = i;
  697. }
  698. c->jheads[BASEHD].wbuf.dtype = UBI_SHORTTERM;
  699. /*
  700. * Garbage Collector head likely contains long-term data and
  701. * does not need to be synchronized by timer.
  702. */
  703. c->jheads[GCHD].wbuf.dtype = UBI_LONGTERM;
  704. c->jheads[GCHD].wbuf.timeout = 0;
  705. return 0;
  706. }
  707. /**
  708. * free_wbufs - free write-buffers.
  709. * @c: UBIFS file-system description object
  710. */
  711. static void free_wbufs(struct ubifs_info *c)
  712. {
  713. int i;
  714. if (c->jheads) {
  715. for (i = 0; i < c->jhead_cnt; i++) {
  716. kfree(c->jheads[i].wbuf.buf);
  717. kfree(c->jheads[i].wbuf.inodes);
  718. }
  719. kfree(c->jheads);
  720. c->jheads = NULL;
  721. }
  722. }
  723. /**
  724. * free_orphans - free orphans.
  725. * @c: UBIFS file-system description object
  726. */
  727. static void free_orphans(struct ubifs_info *c)
  728. {
  729. struct ubifs_orphan *orph;
  730. while (c->orph_dnext) {
  731. orph = c->orph_dnext;
  732. c->orph_dnext = orph->dnext;
  733. list_del(&orph->list);
  734. kfree(orph);
  735. }
  736. while (!list_empty(&c->orph_list)) {
  737. orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
  738. list_del(&orph->list);
  739. kfree(orph);
  740. dbg_err("orphan list not empty at unmount");
  741. }
  742. vfree(c->orph_buf);
  743. c->orph_buf = NULL;
  744. }
  745. /**
  746. * free_buds - free per-bud objects.
  747. * @c: UBIFS file-system description object
  748. */
  749. static void free_buds(struct ubifs_info *c)
  750. {
  751. struct rb_node *this = c->buds.rb_node;
  752. struct ubifs_bud *bud;
  753. while (this) {
  754. if (this->rb_left)
  755. this = this->rb_left;
  756. else if (this->rb_right)
  757. this = this->rb_right;
  758. else {
  759. bud = rb_entry(this, struct ubifs_bud, rb);
  760. this = rb_parent(this);
  761. if (this) {
  762. if (this->rb_left == &bud->rb)
  763. this->rb_left = NULL;
  764. else
  765. this->rb_right = NULL;
  766. }
  767. kfree(bud);
  768. }
  769. }
  770. }
  771. /**
  772. * check_volume_empty - check if the UBI volume is empty.
  773. * @c: UBIFS file-system description object
  774. *
  775. * This function checks if the UBIFS volume is empty by looking if its LEBs are
  776. * mapped or not. The result of checking is stored in the @c->empty variable.
  777. * Returns zero in case of success and a negative error code in case of
  778. * failure.
  779. */
  780. static int check_volume_empty(struct ubifs_info *c)
  781. {
  782. int lnum, err;
  783. c->empty = 1;
  784. for (lnum = 0; lnum < c->leb_cnt; lnum++) {
  785. err = ubi_is_mapped(c->ubi, lnum);
  786. if (unlikely(err < 0))
  787. return err;
  788. if (err == 1) {
  789. c->empty = 0;
  790. break;
  791. }
  792. cond_resched();
  793. }
  794. return 0;
  795. }
  796. /*
  797. * UBIFS mount options.
  798. *
  799. * Opt_fast_unmount: do not run a journal commit before un-mounting
  800. * Opt_norm_unmount: run a journal commit before un-mounting
  801. * Opt_bulk_read: enable bulk-reads
  802. * Opt_no_bulk_read: disable bulk-reads
  803. * Opt_chk_data_crc: check CRCs when reading data nodes
  804. * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
  805. * Opt_override_compr: override default compressor
  806. * Opt_err: just end of array marker
  807. */
  808. enum {
  809. Opt_fast_unmount,
  810. Opt_norm_unmount,
  811. Opt_bulk_read,
  812. Opt_no_bulk_read,
  813. Opt_chk_data_crc,
  814. Opt_no_chk_data_crc,
  815. Opt_override_compr,
  816. Opt_err,
  817. };
  818. static const match_table_t tokens = {
  819. {Opt_fast_unmount, "fast_unmount"},
  820. {Opt_norm_unmount, "norm_unmount"},
  821. {Opt_bulk_read, "bulk_read"},
  822. {Opt_no_bulk_read, "no_bulk_read"},
  823. {Opt_chk_data_crc, "chk_data_crc"},
  824. {Opt_no_chk_data_crc, "no_chk_data_crc"},
  825. {Opt_override_compr, "compr=%s"},
  826. {Opt_err, NULL},
  827. };
  828. /**
  829. * ubifs_parse_options - parse mount parameters.
  830. * @c: UBIFS file-system description object
  831. * @options: parameters to parse
  832. * @is_remount: non-zero if this is FS re-mount
  833. *
  834. * This function parses UBIFS mount options and returns zero in case success
  835. * and a negative error code in case of failure.
  836. */
  837. static int ubifs_parse_options(struct ubifs_info *c, char *options,
  838. int is_remount)
  839. {
  840. char *p;
  841. substring_t args[MAX_OPT_ARGS];
  842. if (!options)
  843. return 0;
  844. while ((p = strsep(&options, ","))) {
  845. int token;
  846. if (!*p)
  847. continue;
  848. token = match_token(p, tokens, args);
  849. switch (token) {
  850. case Opt_fast_unmount:
  851. c->mount_opts.unmount_mode = 2;
  852. c->fast_unmount = 1;
  853. break;
  854. case Opt_norm_unmount:
  855. c->mount_opts.unmount_mode = 1;
  856. c->fast_unmount = 0;
  857. break;
  858. case Opt_bulk_read:
  859. c->mount_opts.bulk_read = 2;
  860. c->bulk_read = 1;
  861. break;
  862. case Opt_no_bulk_read:
  863. c->mount_opts.bulk_read = 1;
  864. c->bulk_read = 0;
  865. break;
  866. case Opt_chk_data_crc:
  867. c->mount_opts.chk_data_crc = 2;
  868. c->no_chk_data_crc = 0;
  869. break;
  870. case Opt_no_chk_data_crc:
  871. c->mount_opts.chk_data_crc = 1;
  872. c->no_chk_data_crc = 1;
  873. break;
  874. case Opt_override_compr:
  875. {
  876. char *name = match_strdup(&args[0]);
  877. if (!name)
  878. return -ENOMEM;
  879. if (!strcmp(name, "none"))
  880. c->mount_opts.compr_type = UBIFS_COMPR_NONE;
  881. else if (!strcmp(name, "lzo"))
  882. c->mount_opts.compr_type = UBIFS_COMPR_LZO;
  883. else if (!strcmp(name, "zlib"))
  884. c->mount_opts.compr_type = UBIFS_COMPR_ZLIB;
  885. else {
  886. ubifs_err("unknown compressor \"%s\"", name);
  887. kfree(name);
  888. return -EINVAL;
  889. }
  890. kfree(name);
  891. c->mount_opts.override_compr = 1;
  892. c->default_compr = c->mount_opts.compr_type;
  893. break;
  894. }
  895. default:
  896. ubifs_err("unrecognized mount option \"%s\" "
  897. "or missing value", p);
  898. return -EINVAL;
  899. }
  900. }
  901. return 0;
  902. }
  903. /**
  904. * destroy_journal - destroy journal data structures.
  905. * @c: UBIFS file-system description object
  906. *
  907. * This function destroys journal data structures including those that may have
  908. * been created by recovery functions.
  909. */
  910. static void destroy_journal(struct ubifs_info *c)
  911. {
  912. while (!list_empty(&c->unclean_leb_list)) {
  913. struct ubifs_unclean_leb *ucleb;
  914. ucleb = list_entry(c->unclean_leb_list.next,
  915. struct ubifs_unclean_leb, list);
  916. list_del(&ucleb->list);
  917. kfree(ucleb);
  918. }
  919. while (!list_empty(&c->old_buds)) {
  920. struct ubifs_bud *bud;
  921. bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
  922. list_del(&bud->list);
  923. kfree(bud);
  924. }
  925. ubifs_destroy_idx_gc(c);
  926. ubifs_destroy_size_tree(c);
  927. ubifs_tnc_close(c);
  928. free_buds(c);
  929. }
  930. /**
  931. * bu_init - initialize bulk-read information.
  932. * @c: UBIFS file-system description object
  933. */
  934. static void bu_init(struct ubifs_info *c)
  935. {
  936. ubifs_assert(c->bulk_read == 1);
  937. if (c->bu.buf)
  938. return; /* Already initialized */
  939. again:
  940. c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
  941. if (!c->bu.buf) {
  942. if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
  943. c->max_bu_buf_len = UBIFS_KMALLOC_OK;
  944. goto again;
  945. }
  946. /* Just disable bulk-read */
  947. ubifs_warn("Cannot allocate %d bytes of memory for bulk-read, "
  948. "disabling it", c->max_bu_buf_len);
  949. c->mount_opts.bulk_read = 1;
  950. c->bulk_read = 0;
  951. return;
  952. }
  953. }
  954. /**
  955. * mount_ubifs - mount UBIFS file-system.
  956. * @c: UBIFS file-system description object
  957. *
  958. * This function mounts UBIFS file system. Returns zero in case of success and
  959. * a negative error code in case of failure.
  960. *
  961. * Note, the function does not de-allocate resources it it fails half way
  962. * through, and the caller has to do this instead.
  963. */
  964. static int mount_ubifs(struct ubifs_info *c)
  965. {
  966. struct super_block *sb = c->vfs_sb;
  967. int err, mounted_read_only = (sb->s_flags & MS_RDONLY);
  968. long long x;
  969. size_t sz;
  970. err = init_constants_early(c);
  971. if (err)
  972. return err;
  973. err = ubifs_debugging_init(c);
  974. if (err)
  975. return err;
  976. err = check_volume_empty(c);
  977. if (err)
  978. goto out_free;
  979. if (c->empty && (mounted_read_only || c->ro_media)) {
  980. /*
  981. * This UBI volume is empty, and read-only, or the file system
  982. * is mounted read-only - we cannot format it.
  983. */
  984. ubifs_err("can't format empty UBI volume: read-only %s",
  985. c->ro_media ? "UBI volume" : "mount");
  986. err = -EROFS;
  987. goto out_free;
  988. }
  989. if (c->ro_media && !mounted_read_only) {
  990. ubifs_err("cannot mount read-write - read-only media");
  991. err = -EROFS;
  992. goto out_free;
  993. }
  994. /*
  995. * The requirement for the buffer is that it should fit indexing B-tree
  996. * height amount of integers. We assume the height if the TNC tree will
  997. * never exceed 64.
  998. */
  999. err = -ENOMEM;
  1000. c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
  1001. if (!c->bottom_up_buf)
  1002. goto out_free;
  1003. c->sbuf = vmalloc(c->leb_size);
  1004. if (!c->sbuf)
  1005. goto out_free;
  1006. if (!mounted_read_only) {
  1007. c->ileb_buf = vmalloc(c->leb_size);
  1008. if (!c->ileb_buf)
  1009. goto out_free;
  1010. }
  1011. if (c->bulk_read == 1)
  1012. bu_init(c);
  1013. /*
  1014. * We have to check all CRCs, even for data nodes, when we mount the FS
  1015. * (specifically, when we are replaying).
  1016. */
  1017. c->always_chk_crc = 1;
  1018. err = ubifs_read_superblock(c);
  1019. if (err)
  1020. goto out_free;
  1021. /*
  1022. * Make sure the compressor which is set as default in the superblock
  1023. * or overriden by mount options is actually compiled in.
  1024. */
  1025. if (!ubifs_compr_present(c->default_compr)) {
  1026. ubifs_err("'compressor \"%s\" is not compiled in",
  1027. ubifs_compr_name(c->default_compr));
  1028. goto out_free;
  1029. }
  1030. err = init_constants_sb(c);
  1031. if (err)
  1032. goto out_free;
  1033. sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
  1034. sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
  1035. c->cbuf = kmalloc(sz, GFP_NOFS);
  1036. if (!c->cbuf) {
  1037. err = -ENOMEM;
  1038. goto out_free;
  1039. }
  1040. sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
  1041. if (!mounted_read_only) {
  1042. err = alloc_wbufs(c);
  1043. if (err)
  1044. goto out_cbuf;
  1045. /* Create background thread */
  1046. c->bgt = kthread_create(ubifs_bg_thread, c, c->bgt_name);
  1047. if (IS_ERR(c->bgt)) {
  1048. err = PTR_ERR(c->bgt);
  1049. c->bgt = NULL;
  1050. ubifs_err("cannot spawn \"%s\", error %d",
  1051. c->bgt_name, err);
  1052. goto out_wbufs;
  1053. }
  1054. wake_up_process(c->bgt);
  1055. }
  1056. err = ubifs_read_master(c);
  1057. if (err)
  1058. goto out_master;
  1059. init_constants_master(c);
  1060. if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
  1061. ubifs_msg("recovery needed");
  1062. c->need_recovery = 1;
  1063. if (!mounted_read_only) {
  1064. err = ubifs_recover_inl_heads(c, c->sbuf);
  1065. if (err)
  1066. goto out_master;
  1067. }
  1068. } else if (!mounted_read_only) {
  1069. /*
  1070. * Set the "dirty" flag so that if we reboot uncleanly we
  1071. * will notice this immediately on the next mount.
  1072. */
  1073. c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
  1074. err = ubifs_write_master(c);
  1075. if (err)
  1076. goto out_master;
  1077. }
  1078. err = ubifs_lpt_init(c, 1, !mounted_read_only);
  1079. if (err)
  1080. goto out_lpt;
  1081. err = dbg_check_idx_size(c, c->old_idx_sz);
  1082. if (err)
  1083. goto out_lpt;
  1084. err = ubifs_replay_journal(c);
  1085. if (err)
  1086. goto out_journal;
  1087. err = ubifs_mount_orphans(c, c->need_recovery, mounted_read_only);
  1088. if (err)
  1089. goto out_orphans;
  1090. if (!mounted_read_only) {
  1091. int lnum;
  1092. /* Check for enough free space */
  1093. if (ubifs_calc_available(c, c->min_idx_lebs) <= 0) {
  1094. ubifs_err("insufficient available space");
  1095. err = -EINVAL;
  1096. goto out_orphans;
  1097. }
  1098. /* Check for enough log space */
  1099. lnum = c->lhead_lnum + 1;
  1100. if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
  1101. lnum = UBIFS_LOG_LNUM;
  1102. if (lnum == c->ltail_lnum) {
  1103. err = ubifs_consolidate_log(c);
  1104. if (err)
  1105. goto out_orphans;
  1106. }
  1107. if (c->need_recovery) {
  1108. err = ubifs_recover_size(c);
  1109. if (err)
  1110. goto out_orphans;
  1111. err = ubifs_rcvry_gc_commit(c);
  1112. } else
  1113. err = take_gc_lnum(c);
  1114. if (err)
  1115. goto out_orphans;
  1116. err = dbg_check_lprops(c);
  1117. if (err)
  1118. goto out_orphans;
  1119. } else if (c->need_recovery) {
  1120. err = ubifs_recover_size(c);
  1121. if (err)
  1122. goto out_orphans;
  1123. }
  1124. spin_lock(&ubifs_infos_lock);
  1125. list_add_tail(&c->infos_list, &ubifs_infos);
  1126. spin_unlock(&ubifs_infos_lock);
  1127. if (c->need_recovery) {
  1128. if (mounted_read_only)
  1129. ubifs_msg("recovery deferred");
  1130. else {
  1131. c->need_recovery = 0;
  1132. ubifs_msg("recovery completed");
  1133. }
  1134. }
  1135. err = dbg_debugfs_init_fs(c);
  1136. if (err)
  1137. goto out_infos;
  1138. err = dbg_check_filesystem(c);
  1139. if (err)
  1140. goto out_infos;
  1141. c->always_chk_crc = 0;
  1142. ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
  1143. c->vi.ubi_num, c->vi.vol_id, c->vi.name);
  1144. if (mounted_read_only)
  1145. ubifs_msg("mounted read-only");
  1146. x = (long long)c->main_lebs * c->leb_size;
  1147. ubifs_msg("file system size: %lld bytes (%lld KiB, %lld MiB, %d "
  1148. "LEBs)", x, x >> 10, x >> 20, c->main_lebs);
  1149. x = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
  1150. ubifs_msg("journal size: %lld bytes (%lld KiB, %lld MiB, %d "
  1151. "LEBs)", x, x >> 10, x >> 20, c->log_lebs + c->max_bud_cnt);
  1152. ubifs_msg("media format: %d (latest is %d)",
  1153. c->fmt_version, UBIFS_FORMAT_VERSION);
  1154. ubifs_msg("default compressor: %s", ubifs_compr_name(c->default_compr));
  1155. ubifs_msg("reserved for root: %llu bytes (%llu KiB)",
  1156. c->report_rp_size, c->report_rp_size >> 10);
  1157. dbg_msg("compiled on: " __DATE__ " at " __TIME__);
  1158. dbg_msg("min. I/O unit size: %d bytes", c->min_io_size);
  1159. dbg_msg("LEB size: %d bytes (%d KiB)",
  1160. c->leb_size, c->leb_size >> 10);
  1161. dbg_msg("data journal heads: %d",
  1162. c->jhead_cnt - NONDATA_JHEADS_CNT);
  1163. dbg_msg("UUID: %02X%02X%02X%02X-%02X%02X"
  1164. "-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
  1165. c->uuid[0], c->uuid[1], c->uuid[2], c->uuid[3],
  1166. c->uuid[4], c->uuid[5], c->uuid[6], c->uuid[7],
  1167. c->uuid[8], c->uuid[9], c->uuid[10], c->uuid[11],
  1168. c->uuid[12], c->uuid[13], c->uuid[14], c->uuid[15]);
  1169. dbg_msg("fast unmount: %d", c->fast_unmount);
  1170. dbg_msg("big_lpt %d", c->big_lpt);
  1171. dbg_msg("log LEBs: %d (%d - %d)",
  1172. c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
  1173. dbg_msg("LPT area LEBs: %d (%d - %d)",
  1174. c->lpt_lebs, c->lpt_first, c->lpt_last);
  1175. dbg_msg("orphan area LEBs: %d (%d - %d)",
  1176. c->orph_lebs, c->orph_first, c->orph_last);
  1177. dbg_msg("main area LEBs: %d (%d - %d)",
  1178. c->main_lebs, c->main_first, c->leb_cnt - 1);
  1179. dbg_msg("index LEBs: %d", c->lst.idx_lebs);
  1180. dbg_msg("total index bytes: %lld (%lld KiB, %lld MiB)",
  1181. c->old_idx_sz, c->old_idx_sz >> 10, c->old_idx_sz >> 20);
  1182. dbg_msg("key hash type: %d", c->key_hash_type);
  1183. dbg_msg("tree fanout: %d", c->fanout);
  1184. dbg_msg("reserved GC LEB: %d", c->gc_lnum);
  1185. dbg_msg("first main LEB: %d", c->main_first);
  1186. dbg_msg("dead watermark: %d", c->dead_wm);
  1187. dbg_msg("dark watermark: %d", c->dark_wm);
  1188. x = (long long)c->main_lebs * c->dark_wm;
  1189. dbg_msg("max. dark space: %lld (%lld KiB, %lld MiB)",
  1190. x, x >> 10, x >> 20);
  1191. dbg_msg("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
  1192. c->max_bud_bytes, c->max_bud_bytes >> 10,
  1193. c->max_bud_bytes >> 20);
  1194. dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
  1195. c->bg_bud_bytes, c->bg_bud_bytes >> 10,
  1196. c->bg_bud_bytes >> 20);
  1197. dbg_msg("current bud bytes %lld (%lld KiB, %lld MiB)",
  1198. c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
  1199. dbg_msg("max. seq. number: %llu", c->max_sqnum);
  1200. dbg_msg("commit number: %llu", c->cmt_no);
  1201. return 0;
  1202. out_infos:
  1203. spin_lock(&ubifs_infos_lock);
  1204. list_del(&c->infos_list);
  1205. spin_unlock(&ubifs_infos_lock);
  1206. out_orphans:
  1207. free_orphans(c);
  1208. out_journal:
  1209. destroy_journal(c);
  1210. out_lpt:
  1211. ubifs_lpt_free(c, 0);
  1212. out_master:
  1213. kfree(c->mst_node);
  1214. kfree(c->rcvrd_mst_node);
  1215. if (c->bgt)
  1216. kthread_stop(c->bgt);
  1217. out_wbufs:
  1218. free_wbufs(c);
  1219. out_cbuf:
  1220. kfree(c->cbuf);
  1221. out_free:
  1222. kfree(c->bu.buf);
  1223. vfree(c->ileb_buf);
  1224. vfree(c->sbuf);
  1225. kfree(c->bottom_up_buf);
  1226. ubifs_debugging_exit(c);
  1227. return err;
  1228. }
  1229. /**
  1230. * ubifs_umount - un-mount UBIFS file-system.
  1231. * @c: UBIFS file-system description object
  1232. *
  1233. * Note, this function is called to free allocated resourced when un-mounting,
  1234. * as well as free resources when an error occurred while we were half way
  1235. * through mounting (error path cleanup function). So it has to make sure the
  1236. * resource was actually allocated before freeing it.
  1237. */
  1238. static void ubifs_umount(struct ubifs_info *c)
  1239. {
  1240. dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
  1241. c->vi.vol_id);
  1242. dbg_debugfs_exit_fs(c);
  1243. spin_lock(&ubifs_infos_lock);
  1244. list_del(&c->infos_list);
  1245. spin_unlock(&ubifs_infos_lock);
  1246. if (c->bgt)
  1247. kthread_stop(c->bgt);
  1248. destroy_journal(c);
  1249. free_wbufs(c);
  1250. free_orphans(c);
  1251. ubifs_lpt_free(c, 0);
  1252. kfree(c->cbuf);
  1253. kfree(c->rcvrd_mst_node);
  1254. kfree(c->mst_node);
  1255. kfree(c->bu.buf);
  1256. vfree(c->ileb_buf);
  1257. vfree(c->sbuf);
  1258. kfree(c->bottom_up_buf);
  1259. ubifs_debugging_exit(c);
  1260. }
  1261. /**
  1262. * ubifs_remount_rw - re-mount in read-write mode.
  1263. * @c: UBIFS file-system description object
  1264. *
  1265. * UBIFS avoids allocating many unnecessary resources when mounted in read-only
  1266. * mode. This function allocates the needed resources and re-mounts UBIFS in
  1267. * read-write mode.
  1268. */
  1269. static int ubifs_remount_rw(struct ubifs_info *c)
  1270. {
  1271. int err, lnum;
  1272. if (c->ro_media)
  1273. return -EINVAL;
  1274. mutex_lock(&c->umount_mutex);
  1275. c->remounting_rw = 1;
  1276. c->always_chk_crc = 1;
  1277. /* Check for enough free space */
  1278. if (ubifs_calc_available(c, c->min_idx_lebs) <= 0) {
  1279. ubifs_err("insufficient available space");
  1280. err = -EINVAL;
  1281. goto out;
  1282. }
  1283. if (c->old_leb_cnt != c->leb_cnt) {
  1284. struct ubifs_sb_node *sup;
  1285. sup = ubifs_read_sb_node(c);
  1286. if (IS_ERR(sup)) {
  1287. err = PTR_ERR(sup);
  1288. goto out;
  1289. }
  1290. sup->leb_cnt = cpu_to_le32(c->leb_cnt);
  1291. err = ubifs_write_sb_node(c, sup);
  1292. if (err)
  1293. goto out;
  1294. }
  1295. if (c->need_recovery) {
  1296. ubifs_msg("completing deferred recovery");
  1297. err = ubifs_write_rcvrd_mst_node(c);
  1298. if (err)
  1299. goto out;
  1300. err = ubifs_recover_size(c);
  1301. if (err)
  1302. goto out;
  1303. err = ubifs_clean_lebs(c, c->sbuf);
  1304. if (err)
  1305. goto out;
  1306. err = ubifs_recover_inl_heads(c, c->sbuf);
  1307. if (err)
  1308. goto out;
  1309. }
  1310. if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
  1311. c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
  1312. err = ubifs_write_master(c);
  1313. if (err)
  1314. goto out;
  1315. }
  1316. c->ileb_buf = vmalloc(c->leb_size);
  1317. if (!c->ileb_buf) {
  1318. err = -ENOMEM;
  1319. goto out;
  1320. }
  1321. err = ubifs_lpt_init(c, 0, 1);
  1322. if (err)
  1323. goto out;
  1324. err = alloc_wbufs(c);
  1325. if (err)
  1326. goto out;
  1327. ubifs_create_buds_lists(c);
  1328. /* Create background thread */
  1329. c->bgt = kthread_create(ubifs_bg_thread, c, c->bgt_name);
  1330. if (IS_ERR(c->bgt)) {
  1331. err = PTR_ERR(c->bgt);
  1332. c->bgt = NULL;
  1333. ubifs_err("cannot spawn \"%s\", error %d",
  1334. c->bgt_name, err);
  1335. goto out;
  1336. }
  1337. wake_up_process(c->bgt);
  1338. c->orph_buf = vmalloc(c->leb_size);
  1339. if (!c->orph_buf) {
  1340. err = -ENOMEM;
  1341. goto out;
  1342. }
  1343. /* Check for enough log space */
  1344. lnum = c->lhead_lnum + 1;
  1345. if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
  1346. lnum = UBIFS_LOG_LNUM;
  1347. if (lnum == c->ltail_lnum) {
  1348. err = ubifs_consolidate_log(c);
  1349. if (err)
  1350. goto out;
  1351. }
  1352. if (c->need_recovery)
  1353. err = ubifs_rcvry_gc_commit(c);
  1354. else
  1355. err = take_gc_lnum(c);
  1356. if (err)
  1357. goto out;
  1358. if (c->need_recovery) {
  1359. c->need_recovery = 0;
  1360. ubifs_msg("deferred recovery completed");
  1361. }
  1362. dbg_gen("re-mounted read-write");
  1363. c->vfs_sb->s_flags &= ~MS_RDONLY;
  1364. c->remounting_rw = 0;
  1365. c->always_chk_crc = 0;
  1366. mutex_unlock(&c->umount_mutex);
  1367. return 0;
  1368. out:
  1369. vfree(c->orph_buf);
  1370. c->orph_buf = NULL;
  1371. if (c->bgt) {
  1372. kthread_stop(c->bgt);
  1373. c->bgt = NULL;
  1374. }
  1375. free_wbufs(c);
  1376. vfree(c->ileb_buf);
  1377. c->ileb_buf = NULL;
  1378. ubifs_lpt_free(c, 1);
  1379. c->remounting_rw = 0;
  1380. c->always_chk_crc = 0;
  1381. mutex_unlock(&c->umount_mutex);
  1382. return err;
  1383. }
  1384. /**
  1385. * commit_on_unmount - commit the journal when un-mounting.
  1386. * @c: UBIFS file-system description object
  1387. *
  1388. * This function is called during un-mounting and re-mounting, and it commits
  1389. * the journal unless the "fast unmount" mode is enabled. It also avoids
  1390. * committing the journal if it contains too few data.
  1391. */
  1392. static void commit_on_unmount(struct ubifs_info *c)
  1393. {
  1394. if (!c->fast_unmount) {
  1395. long long bud_bytes;
  1396. spin_lock(&c->buds_lock);
  1397. bud_bytes = c->bud_bytes;
  1398. spin_unlock(&c->buds_lock);
  1399. if (bud_bytes > c->leb_size)
  1400. ubifs_run_commit(c);
  1401. }
  1402. }
  1403. /**
  1404. * ubifs_remount_ro - re-mount in read-only mode.
  1405. * @c: UBIFS file-system description object
  1406. *
  1407. * We rely on VFS to have stopped writing. Possibly the background thread could
  1408. * be running a commit, however kthread_stop will wait in that case.
  1409. */
  1410. static void ubifs_remount_ro(struct ubifs_info *c)
  1411. {
  1412. int i, err;
  1413. ubifs_assert(!c->need_recovery);
  1414. commit_on_unmount(c);
  1415. mutex_lock(&c->umount_mutex);
  1416. if (c->bgt) {
  1417. kthread_stop(c->bgt);
  1418. c->bgt = NULL;
  1419. }
  1420. for (i = 0; i < c->jhead_cnt; i++) {
  1421. ubifs_wbuf_sync(&c->jheads[i].wbuf);
  1422. del_timer_sync(&c->jheads[i].wbuf.timer);
  1423. }
  1424. if (!c->ro_media) {
  1425. c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
  1426. c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
  1427. c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
  1428. err = ubifs_write_master(c);
  1429. if (err)
  1430. ubifs_ro_mode(c, err);
  1431. }
  1432. ubifs_destroy_idx_gc(c);
  1433. free_wbufs(c);
  1434. vfree(c->orph_buf);
  1435. c->orph_buf = NULL;
  1436. vfree(c->ileb_buf);
  1437. c->ileb_buf = NULL;
  1438. ubifs_lpt_free(c, 1);
  1439. mutex_unlock(&c->umount_mutex);
  1440. }
  1441. static void ubifs_put_super(struct super_block *sb)
  1442. {
  1443. int i;
  1444. struct ubifs_info *c = sb->s_fs_info;
  1445. ubifs_msg("un-mount UBI device %d, volume %d", c->vi.ubi_num,
  1446. c->vi.vol_id);
  1447. /*
  1448. * The following asserts are only valid if there has not been a failure
  1449. * of the media. For example, there will be dirty inodes if we failed
  1450. * to write them back because of I/O errors.
  1451. */
  1452. ubifs_assert(atomic_long_read(&c->dirty_pg_cnt) == 0);
  1453. ubifs_assert(c->budg_idx_growth == 0);
  1454. ubifs_assert(c->budg_dd_growth == 0);
  1455. ubifs_assert(c->budg_data_growth == 0);
  1456. /*
  1457. * The 'c->umount_lock' prevents races between UBIFS memory shrinker
  1458. * and file system un-mount. Namely, it prevents the shrinker from
  1459. * picking this superblock for shrinking - it will be just skipped if
  1460. * the mutex is locked.
  1461. */
  1462. mutex_lock(&c->umount_mutex);
  1463. if (!(c->vfs_sb->s_flags & MS_RDONLY)) {
  1464. /*
  1465. * First of all kill the background thread to make sure it does
  1466. * not interfere with un-mounting and freeing resources.
  1467. */
  1468. if (c->bgt) {
  1469. kthread_stop(c->bgt);
  1470. c->bgt = NULL;
  1471. }
  1472. /* Synchronize write-buffers */
  1473. if (c->jheads)
  1474. for (i = 0; i < c->jhead_cnt; i++) {
  1475. ubifs_wbuf_sync(&c->jheads[i].wbuf);
  1476. del_timer_sync(&c->jheads[i].wbuf.timer);
  1477. }
  1478. /*
  1479. * On fatal errors c->ro_media is set to 1, in which case we do
  1480. * not write the master node.
  1481. */
  1482. if (!c->ro_media) {
  1483. /*
  1484. * We are being cleanly unmounted which means the
  1485. * orphans were killed - indicate this in the master
  1486. * node. Also save the reserved GC LEB number.
  1487. */
  1488. int err;
  1489. c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
  1490. c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
  1491. c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
  1492. err = ubifs_write_master(c);
  1493. if (err)
  1494. /*
  1495. * Recovery will attempt to fix the master area
  1496. * next mount, so we just print a message and
  1497. * continue to unmount normally.
  1498. */
  1499. ubifs_err("failed to write master node, "
  1500. "error %d", err);
  1501. }
  1502. }
  1503. ubifs_umount(c);
  1504. bdi_destroy(&c->bdi);
  1505. ubi_close_volume(c->ubi);
  1506. mutex_unlock(&c->umount_mutex);
  1507. kfree(c);
  1508. }
  1509. static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
  1510. {
  1511. int err;
  1512. struct ubifs_info *c = sb->s_fs_info;
  1513. dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
  1514. err = ubifs_parse_options(c, data, 1);
  1515. if (err) {
  1516. ubifs_err("invalid or unknown remount parameter");
  1517. return err;
  1518. }
  1519. if ((sb->s_flags & MS_RDONLY) && !(*flags & MS_RDONLY)) {
  1520. err = ubifs_remount_rw(c);
  1521. if (err)
  1522. return err;
  1523. } else if (!(sb->s_flags & MS_RDONLY) && (*flags & MS_RDONLY))
  1524. ubifs_remount_ro(c);
  1525. if (c->bulk_read == 1)
  1526. bu_init(c);
  1527. else {
  1528. dbg_gen("disable bulk-read");
  1529. kfree(c->bu.buf);
  1530. c->bu.buf = NULL;
  1531. }
  1532. return 0;
  1533. }
  1534. struct super_operations ubifs_super_operations = {
  1535. .alloc_inode = ubifs_alloc_inode,
  1536. .destroy_inode = ubifs_destroy_inode,
  1537. .put_super = ubifs_put_super,
  1538. .write_inode = ubifs_write_inode,
  1539. .delete_inode = ubifs_delete_inode,
  1540. .statfs = ubifs_statfs,
  1541. .dirty_inode = ubifs_dirty_inode,
  1542. .remount_fs = ubifs_remount_fs,
  1543. .show_options = ubifs_show_options,
  1544. .sync_fs = ubifs_sync_fs,
  1545. };
  1546. /**
  1547. * open_ubi - parse UBI device name string and open the UBI device.
  1548. * @name: UBI volume name
  1549. * @mode: UBI volume open mode
  1550. *
  1551. * There are several ways to specify UBI volumes when mounting UBIFS:
  1552. * o ubiX_Y - UBI device number X, volume Y;
  1553. * o ubiY - UBI device number 0, volume Y;
  1554. * o ubiX:NAME - mount UBI device X, volume with name NAME;
  1555. * o ubi:NAME - mount UBI device 0, volume with name NAME.
  1556. *
  1557. * Alternative '!' separator may be used instead of ':' (because some shells
  1558. * like busybox may interpret ':' as an NFS host name separator). This function
  1559. * returns ubi volume object in case of success and a negative error code in
  1560. * case of failure.
  1561. */
  1562. static struct ubi_volume_desc *open_ubi(const char *name, int mode)
  1563. {
  1564. int dev, vol;
  1565. char *endptr;
  1566. if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
  1567. return ERR_PTR(-EINVAL);
  1568. /* ubi:NAME method */
  1569. if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
  1570. return ubi_open_volume_nm(0, name + 4, mode);
  1571. if (!isdigit(name[3]))
  1572. return ERR_PTR(-EINVAL);
  1573. dev = simple_strtoul(name + 3, &endptr, 0);
  1574. /* ubiY method */
  1575. if (*endptr == '\0')
  1576. return ubi_open_volume(0, dev, mode);
  1577. /* ubiX_Y method */
  1578. if (*endptr == '_' && isdigit(endptr[1])) {
  1579. vol = simple_strtoul(endptr + 1, &endptr, 0);
  1580. if (*endptr != '\0')
  1581. return ERR_PTR(-EINVAL);
  1582. return ubi_open_volume(dev, vol, mode);
  1583. }
  1584. /* ubiX:NAME method */
  1585. if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
  1586. return ubi_open_volume_nm(dev, ++endptr, mode);
  1587. return ERR_PTR(-EINVAL);
  1588. }
  1589. static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
  1590. {
  1591. struct ubi_volume_desc *ubi = sb->s_fs_info;
  1592. struct ubifs_info *c;
  1593. struct inode *root;
  1594. int err;
  1595. c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
  1596. if (!c)
  1597. return -ENOMEM;
  1598. spin_lock_init(&c->cnt_lock);
  1599. spin_lock_init(&c->cs_lock);
  1600. spin_lock_init(&c->buds_lock);
  1601. spin_lock_init(&c->space_lock);
  1602. spin_lock_init(&c->orphan_lock);
  1603. init_rwsem(&c->commit_sem);
  1604. mutex_init(&c->lp_mutex);
  1605. mutex_init(&c->tnc_mutex);
  1606. mutex_init(&c->log_mutex);
  1607. mutex_init(&c->mst_mutex);
  1608. mutex_init(&c->umount_mutex);
  1609. mutex_init(&c->bu_mutex);
  1610. init_waitqueue_head(&c->cmt_wq);
  1611. c->buds = RB_ROOT;
  1612. c->old_idx = RB_ROOT;
  1613. c->size_tree = RB_ROOT;
  1614. c->orph_tree = RB_ROOT;
  1615. INIT_LIST_HEAD(&c->infos_list);
  1616. INIT_LIST_HEAD(&c->idx_gc);
  1617. INIT_LIST_HEAD(&c->replay_list);
  1618. INIT_LIST_HEAD(&c->replay_buds);
  1619. INIT_LIST_HEAD(&c->uncat_list);
  1620. INIT_LIST_HEAD(&c->empty_list);
  1621. INIT_LIST_HEAD(&c->freeable_list);
  1622. INIT_LIST_HEAD(&c->frdi_idx_list);
  1623. INIT_LIST_HEAD(&c->unclean_leb_list);
  1624. INIT_LIST_HEAD(&c->old_buds);
  1625. INIT_LIST_HEAD(&c->orph_list);
  1626. INIT_LIST_HEAD(&c->orph_new);
  1627. c->highest_inum = UBIFS_FIRST_INO;
  1628. c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
  1629. ubi_get_volume_info(ubi, &c->vi);
  1630. ubi_get_device_info(c->vi.ubi_num, &c->di);
  1631. /* Re-open the UBI device in read-write mode */
  1632. c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
  1633. if (IS_ERR(c->ubi)) {
  1634. err = PTR_ERR(c->ubi);
  1635. goto out_free;
  1636. }
  1637. /*
  1638. * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
  1639. * UBIFS, I/O is not deferred, it is done immediately in readpage,
  1640. * which means the user would have to wait not just for their own I/O
  1641. * but the read-ahead I/O as well i.e. completely pointless.
  1642. *
  1643. * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
  1644. */
  1645. c->bdi.capabilities = BDI_CAP_MAP_COPY;
  1646. c->bdi.unplug_io_fn = default_unplug_io_fn;
  1647. err = bdi_init(&c->bdi);
  1648. if (err)
  1649. goto out_close;
  1650. err = ubifs_parse_options(c, data, 0);
  1651. if (err)
  1652. goto out_bdi;
  1653. c->vfs_sb = sb;
  1654. sb->s_fs_info = c;
  1655. sb->s_magic = UBIFS_SUPER_MAGIC;
  1656. sb->s_blocksize = UBIFS_BLOCK_SIZE;
  1657. sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
  1658. sb->s_dev = c->vi.cdev;
  1659. sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
  1660. if (c->max_inode_sz > MAX_LFS_FILESIZE)
  1661. sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
  1662. sb->s_op = &ubifs_super_operations;
  1663. mutex_lock(&c->umount_mutex);
  1664. err = mount_ubifs(c);
  1665. if (err) {
  1666. ubifs_assert(err < 0);
  1667. goto out_unlock;
  1668. }
  1669. /* Read the root inode */
  1670. root = ubifs_iget(sb, UBIFS_ROOT_INO);
  1671. if (IS_ERR(root)) {
  1672. err = PTR_ERR(root);
  1673. goto out_umount;
  1674. }
  1675. sb->s_root = d_alloc_root(root);
  1676. if (!sb->s_root)
  1677. goto out_iput;
  1678. mutex_unlock(&c->umount_mutex);
  1679. return 0;
  1680. out_iput:
  1681. iput(root);
  1682. out_umount:
  1683. ubifs_umount(c);
  1684. out_unlock:
  1685. mutex_unlock(&c->umount_mutex);
  1686. out_bdi:
  1687. bdi_destroy(&c->bdi);
  1688. out_close:
  1689. ubi_close_volume(c->ubi);
  1690. out_free:
  1691. kfree(c);
  1692. return err;
  1693. }
  1694. static int sb_test(struct super_block *sb, void *data)
  1695. {
  1696. dev_t *dev = data;
  1697. return sb->s_dev == *dev;
  1698. }
  1699. static int sb_set(struct super_block *sb, void *data)
  1700. {
  1701. dev_t *dev = data;
  1702. sb->s_dev = *dev;
  1703. return 0;
  1704. }
  1705. static int ubifs_get_sb(struct file_system_type *fs_type, int flags,
  1706. const char *name, void *data, struct vfsmount *mnt)
  1707. {
  1708. struct ubi_volume_desc *ubi;
  1709. struct ubi_volume_info vi;
  1710. struct super_block *sb;
  1711. int err;
  1712. dbg_gen("name %s, flags %#x", name, flags);
  1713. /*
  1714. * Get UBI device number and volume ID. Mount it read-only so far
  1715. * because this might be a new mount point, and UBI allows only one
  1716. * read-write user at a time.
  1717. */
  1718. ubi = open_ubi(name, UBI_READONLY);
  1719. if (IS_ERR(ubi)) {
  1720. ubifs_err("cannot open \"%s\", error %d",
  1721. name, (int)PTR_ERR(ubi));
  1722. return PTR_ERR(ubi);
  1723. }
  1724. ubi_get_volume_info(ubi, &vi);
  1725. dbg_gen("opened ubi%d_%d", vi.ubi_num, vi.vol_id);
  1726. sb = sget(fs_type, &sb_test, &sb_set, &vi.cdev);
  1727. if (IS_ERR(sb)) {
  1728. err = PTR_ERR(sb);
  1729. goto out_close;
  1730. }
  1731. if (sb->s_root) {
  1732. /* A new mount point for already mounted UBIFS */
  1733. dbg_gen("this ubi volume is already mounted");
  1734. if ((flags ^ sb->s_flags) & MS_RDONLY) {
  1735. err = -EBUSY;
  1736. goto out_deact;
  1737. }
  1738. } else {
  1739. sb->s_flags = flags;
  1740. /*
  1741. * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
  1742. * replaced by 'c'.
  1743. */
  1744. sb->s_fs_info = ubi;
  1745. err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
  1746. if (err)
  1747. goto out_deact;
  1748. /* We do not support atime */
  1749. sb->s_flags |= MS_ACTIVE | MS_NOATIME;
  1750. }
  1751. /* 'fill_super()' opens ubi again so we must close it here */
  1752. ubi_close_volume(ubi);
  1753. return simple_set_mnt(mnt, sb);
  1754. out_deact:
  1755. up_write(&sb->s_umount);
  1756. deactivate_super(sb);
  1757. out_close:
  1758. ubi_close_volume(ubi);
  1759. return err;
  1760. }
  1761. static void ubifs_kill_sb(struct super_block *sb)
  1762. {
  1763. struct ubifs_info *c = sb->s_fs_info;
  1764. /*
  1765. * We do 'commit_on_unmount()' here instead of 'ubifs_put_super()'
  1766. * in order to be outside BKL.
  1767. */
  1768. if (sb->s_root && !(sb->s_flags & MS_RDONLY))
  1769. commit_on_unmount(c);
  1770. /* The un-mount routine is actually done in put_super() */
  1771. generic_shutdown_super(sb);
  1772. }
  1773. static struct file_system_type ubifs_fs_type = {
  1774. .name = "ubifs",
  1775. .owner = THIS_MODULE,
  1776. .get_sb = ubifs_get_sb,
  1777. .kill_sb = ubifs_kill_sb
  1778. };
  1779. /*
  1780. * Inode slab cache constructor.
  1781. */
  1782. static void inode_slab_ctor(void *obj)
  1783. {
  1784. struct ubifs_inode *ui = obj;
  1785. inode_init_once(&ui->vfs_inode);
  1786. }
  1787. static int __init ubifs_init(void)
  1788. {
  1789. int err;
  1790. BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
  1791. /* Make sure node sizes are 8-byte aligned */
  1792. BUILD_BUG_ON(UBIFS_CH_SZ & 7);
  1793. BUILD_BUG_ON(UBIFS_INO_NODE_SZ & 7);
  1794. BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
  1795. BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
  1796. BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
  1797. BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
  1798. BUILD_BUG_ON(UBIFS_SB_NODE_SZ & 7);
  1799. BUILD_BUG_ON(UBIFS_MST_NODE_SZ & 7);
  1800. BUILD_BUG_ON(UBIFS_REF_NODE_SZ & 7);
  1801. BUILD_BUG_ON(UBIFS_CS_NODE_SZ & 7);
  1802. BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
  1803. BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
  1804. BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
  1805. BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
  1806. BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ & 7);
  1807. BUILD_BUG_ON(UBIFS_MAX_NODE_SZ & 7);
  1808. BUILD_BUG_ON(MIN_WRITE_SZ & 7);
  1809. /* Check min. node size */
  1810. BUILD_BUG_ON(UBIFS_INO_NODE_SZ < MIN_WRITE_SZ);
  1811. BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
  1812. BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
  1813. BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
  1814. BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
  1815. BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
  1816. BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
  1817. BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ > UBIFS_MAX_NODE_SZ);
  1818. /* Defined node sizes */
  1819. BUILD_BUG_ON(UBIFS_SB_NODE_SZ != 4096);
  1820. BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
  1821. BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
  1822. BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
  1823. /*
  1824. * We use 2 bit wide bit-fields to store compression type, which should
  1825. * be amended if more compressors are added. The bit-fields are:
  1826. * @compr_type in 'struct ubifs_inode', @default_compr in
  1827. * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
  1828. */
  1829. BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
  1830. /*
  1831. * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
  1832. * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
  1833. */
  1834. if (PAGE_CACHE_SIZE < UBIFS_BLOCK_SIZE) {
  1835. ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
  1836. " at least 4096 bytes",
  1837. (unsigned int)PAGE_CACHE_SIZE);
  1838. return -EINVAL;
  1839. }
  1840. err = register_filesystem(&ubifs_fs_type);
  1841. if (err) {
  1842. ubifs_err("cannot register file system, error %d", err);
  1843. return err;
  1844. }
  1845. err = -ENOMEM;
  1846. ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
  1847. sizeof(struct ubifs_inode), 0,
  1848. SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT,
  1849. &inode_slab_ctor);
  1850. if (!ubifs_inode_slab)
  1851. goto out_reg;
  1852. register_shrinker(&ubifs_shrinker_info);
  1853. err = ubifs_compressors_init();
  1854. if (err)
  1855. goto out_shrinker;
  1856. err = dbg_debugfs_init();
  1857. if (err)
  1858. goto out_compr;
  1859. return 0;
  1860. out_compr:
  1861. ubifs_compressors_exit();
  1862. out_shrinker:
  1863. unregister_shrinker(&ubifs_shrinker_info);
  1864. kmem_cache_destroy(ubifs_inode_slab);
  1865. out_reg:
  1866. unregister_filesystem(&ubifs_fs_type);
  1867. return err;
  1868. }
  1869. /* late_initcall to let compressors initialize first */
  1870. late_initcall(ubifs_init);
  1871. static void __exit ubifs_exit(void)
  1872. {
  1873. ubifs_assert(list_empty(&ubifs_infos));
  1874. ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
  1875. dbg_debugfs_exit();
  1876. ubifs_compressors_exit();
  1877. unregister_shrinker(&ubifs_shrinker_info);
  1878. kmem_cache_destroy(ubifs_inode_slab);
  1879. unregister_filesystem(&ubifs_fs_type);
  1880. }
  1881. module_exit(ubifs_exit);
  1882. MODULE_LICENSE("GPL");
  1883. MODULE_VERSION(__stringify(UBIFS_VERSION));
  1884. MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
  1885. MODULE_DESCRIPTION("UBIFS - UBI File System");