super.c 57 KB

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