super.c 58 KB

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