xref: /linux/fs/ubifs/super.c (revision bf4afc53b77aeaa48b5409da5c8da6bb4eff7f43)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * This file is part of UBIFS.
4  *
5  * Copyright (C) 2006-2008 Nokia Corporation.
6  *
7  * Authors: Artem Bityutskiy (Битюцкий Артём)
8  *          Adrian Hunter
9  */
10 
11 /*
12  * This file implements UBIFS initialization and VFS superblock operations. Some
13  * initialization stuff which is rather large and complex is placed at
14  * corresponding subsystems, but most of it is here.
15  */
16 
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/module.h>
20 #include <linux/ctype.h>
21 #include <linux/kthread.h>
22 #include <linux/fs_context.h>
23 #include <linux/fs_parser.h>
24 #include <linux/seq_file.h>
25 #include <linux/math64.h>
26 #include <linux/writeback.h>
27 #include "ubifs.h"
28 
ubifs_default_version_set(const char * val,const struct kernel_param * kp)29 static int ubifs_default_version_set(const char *val, const struct kernel_param *kp)
30 {
31 	int n = 0, ret;
32 
33 	ret = kstrtoint(val, 10, &n);
34 	if (ret != 0 || n < 4 || n > UBIFS_FORMAT_VERSION)
35 		return -EINVAL;
36 	return param_set_int(val, kp);
37 }
38 
39 static const struct kernel_param_ops ubifs_default_version_ops = {
40 	.set = ubifs_default_version_set,
41 	.get = param_get_int,
42 };
43 
44 int ubifs_default_version = UBIFS_FORMAT_VERSION;
45 module_param_cb(default_version, &ubifs_default_version_ops, &ubifs_default_version, 0600);
46 
47 /*
48  * Maximum amount of memory we may 'kmalloc()' without worrying that we are
49  * allocating too much.
50  */
51 #define UBIFS_KMALLOC_OK (128*1024)
52 
53 /* Slab cache for UBIFS inodes */
54 static struct kmem_cache *ubifs_inode_slab;
55 
56 /* UBIFS TNC shrinker description */
57 static struct shrinker *ubifs_shrinker_info;
58 
59 /**
60  * validate_inode - validate inode.
61  * @c: UBIFS file-system description object
62  * @inode: the inode to validate
63  *
64  * This is a helper function for 'ubifs_iget()' which validates various fields
65  * of a newly built inode to make sure they contain sane values and prevent
66  * possible vulnerabilities. Returns zero if the inode is all right and
67  * a non-zero error code if not.
68  */
validate_inode(struct ubifs_info * c,const struct inode * inode)69 static int validate_inode(struct ubifs_info *c, const struct inode *inode)
70 {
71 	int err;
72 	const struct ubifs_inode *ui = ubifs_inode(inode);
73 
74 	if (inode->i_size > c->max_inode_sz) {
75 		ubifs_err(c, "inode is too large (%lld)",
76 			  (long long)inode->i_size);
77 		return 1;
78 	}
79 
80 	if (ui->compr_type >= UBIFS_COMPR_TYPES_CNT) {
81 		ubifs_err(c, "unknown compression type %d", ui->compr_type);
82 		return 2;
83 	}
84 
85 	if (ui->xattr_names + ui->xattr_cnt > XATTR_LIST_MAX)
86 		return 3;
87 
88 	if (ui->data_len < 0 || ui->data_len > UBIFS_MAX_INO_DATA)
89 		return 4;
90 
91 	if (ui->xattr && !S_ISREG(inode->i_mode))
92 		return 5;
93 
94 	if (!ubifs_compr_present(c, ui->compr_type)) {
95 		ubifs_warn(c, "inode %lu uses '%s' compression, but it was not compiled in",
96 			   inode->i_ino, ubifs_compr_name(c, ui->compr_type));
97 	}
98 
99 	err = dbg_check_dir(c, inode);
100 	return err;
101 }
102 
ubifs_iget(struct super_block * sb,unsigned long inum)103 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum)
104 {
105 	int err;
106 	union ubifs_key key;
107 	struct ubifs_ino_node *ino;
108 	struct ubifs_info *c = sb->s_fs_info;
109 	struct inode *inode;
110 	struct ubifs_inode *ui;
111 
112 	dbg_gen("inode %lu", inum);
113 
114 	inode = iget_locked(sb, inum);
115 	if (!inode)
116 		return ERR_PTR(-ENOMEM);
117 	if (!(inode_state_read_once(inode) & I_NEW))
118 		return inode;
119 	ui = ubifs_inode(inode);
120 
121 	ino = kmalloc(UBIFS_MAX_INO_NODE_SZ, GFP_NOFS);
122 	if (!ino) {
123 		err = -ENOMEM;
124 		goto out;
125 	}
126 
127 	ino_key_init(c, &key, inode->i_ino);
128 
129 	err = ubifs_tnc_lookup(c, &key, ino);
130 	if (err)
131 		goto out_ino;
132 
133 	inode->i_flags |= S_NOCMTIME;
134 
135 	if (!IS_ENABLED(CONFIG_UBIFS_ATIME_SUPPORT))
136 		inode->i_flags |= S_NOATIME;
137 
138 	set_nlink(inode, le32_to_cpu(ino->nlink));
139 	i_uid_write(inode, le32_to_cpu(ino->uid));
140 	i_gid_write(inode, le32_to_cpu(ino->gid));
141 	inode_set_atime(inode, (int64_t)le64_to_cpu(ino->atime_sec),
142 			le32_to_cpu(ino->atime_nsec));
143 	inode_set_mtime(inode, (int64_t)le64_to_cpu(ino->mtime_sec),
144 			le32_to_cpu(ino->mtime_nsec));
145 	inode_set_ctime(inode, (int64_t)le64_to_cpu(ino->ctime_sec),
146 			le32_to_cpu(ino->ctime_nsec));
147 	inode->i_mode = le32_to_cpu(ino->mode);
148 	inode->i_size = le64_to_cpu(ino->size);
149 
150 	ui->data_len    = le32_to_cpu(ino->data_len);
151 	ui->flags       = le32_to_cpu(ino->flags);
152 	ui->compr_type  = le16_to_cpu(ino->compr_type);
153 	ui->creat_sqnum = le64_to_cpu(ino->creat_sqnum);
154 	ui->xattr_cnt   = le32_to_cpu(ino->xattr_cnt);
155 	ui->xattr_size  = le32_to_cpu(ino->xattr_size);
156 	ui->xattr_names = le32_to_cpu(ino->xattr_names);
157 	ui->synced_i_size = ui->ui_size = inode->i_size;
158 
159 	ui->xattr = (ui->flags & UBIFS_XATTR_FL) ? 1 : 0;
160 
161 	err = validate_inode(c, inode);
162 	if (err)
163 		goto out_invalid;
164 
165 	switch (inode->i_mode & S_IFMT) {
166 	case S_IFREG:
167 		inode->i_mapping->a_ops = &ubifs_file_address_operations;
168 		inode->i_op = &ubifs_file_inode_operations;
169 		inode->i_fop = &ubifs_file_operations;
170 		if (ui->xattr) {
171 			ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
172 			if (!ui->data) {
173 				err = -ENOMEM;
174 				goto out_ino;
175 			}
176 			memcpy(ui->data, ino->data, ui->data_len);
177 			((char *)ui->data)[ui->data_len] = '\0';
178 		} else if (ui->data_len != 0) {
179 			err = 10;
180 			goto out_invalid;
181 		}
182 		break;
183 	case S_IFDIR:
184 		inode->i_op  = &ubifs_dir_inode_operations;
185 		inode->i_fop = &ubifs_dir_operations;
186 		if (ui->data_len != 0) {
187 			err = 11;
188 			goto out_invalid;
189 		}
190 		break;
191 	case S_IFLNK:
192 		inode->i_op = &ubifs_symlink_inode_operations;
193 		if (ui->data_len <= 0 || ui->data_len > UBIFS_MAX_INO_DATA) {
194 			err = 12;
195 			goto out_invalid;
196 		}
197 		ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
198 		if (!ui->data) {
199 			err = -ENOMEM;
200 			goto out_ino;
201 		}
202 		memcpy(ui->data, ino->data, ui->data_len);
203 		((char *)ui->data)[ui->data_len] = '\0';
204 		break;
205 	case S_IFBLK:
206 	case S_IFCHR:
207 	{
208 		dev_t rdev;
209 		union ubifs_dev_desc *dev;
210 
211 		ui->data = kmalloc_obj(union ubifs_dev_desc, GFP_NOFS);
212 		if (!ui->data) {
213 			err = -ENOMEM;
214 			goto out_ino;
215 		}
216 
217 		dev = (union ubifs_dev_desc *)ino->data;
218 		if (ui->data_len == sizeof(dev->new))
219 			rdev = new_decode_dev(le32_to_cpu(dev->new));
220 		else if (ui->data_len == sizeof(dev->huge))
221 			rdev = huge_decode_dev(le64_to_cpu(dev->huge));
222 		else {
223 			err = 13;
224 			goto out_invalid;
225 		}
226 		memcpy(ui->data, ino->data, ui->data_len);
227 		inode->i_op = &ubifs_file_inode_operations;
228 		init_special_inode(inode, inode->i_mode, rdev);
229 		break;
230 	}
231 	case S_IFSOCK:
232 	case S_IFIFO:
233 		inode->i_op = &ubifs_file_inode_operations;
234 		init_special_inode(inode, inode->i_mode, 0);
235 		if (ui->data_len != 0) {
236 			err = 14;
237 			goto out_invalid;
238 		}
239 		break;
240 	default:
241 		err = 15;
242 		goto out_invalid;
243 	}
244 
245 	kfree(ino);
246 	ubifs_set_inode_flags(inode);
247 	unlock_new_inode(inode);
248 	return inode;
249 
250 out_invalid:
251 	ubifs_err(c, "inode %lu validation failed, error %d", inode->i_ino, err);
252 	ubifs_dump_node(c, ino, UBIFS_MAX_INO_NODE_SZ);
253 	ubifs_dump_inode(c, inode);
254 	err = -EINVAL;
255 out_ino:
256 	kfree(ino);
257 out:
258 	ubifs_err(c, "failed to read inode %lu, error %d", inode->i_ino, err);
259 	iget_failed(inode);
260 	return ERR_PTR(err);
261 }
262 
ubifs_alloc_inode(struct super_block * sb)263 static struct inode *ubifs_alloc_inode(struct super_block *sb)
264 {
265 	struct ubifs_inode *ui;
266 
267 	ui = alloc_inode_sb(sb, ubifs_inode_slab, GFP_NOFS);
268 	if (!ui)
269 		return NULL;
270 
271 	memset((void *)ui + sizeof(struct inode), 0,
272 	       sizeof(struct ubifs_inode) - sizeof(struct inode));
273 	mutex_init(&ui->ui_mutex);
274 	init_rwsem(&ui->xattr_sem);
275 	spin_lock_init(&ui->ui_lock);
276 	return &ui->vfs_inode;
277 };
278 
ubifs_free_inode(struct inode * inode)279 static void ubifs_free_inode(struct inode *inode)
280 {
281 	struct ubifs_inode *ui = ubifs_inode(inode);
282 
283 	kfree(ui->data);
284 	fscrypt_free_inode(inode);
285 
286 	kmem_cache_free(ubifs_inode_slab, ui);
287 }
288 
289 /*
290  * Note, Linux write-back code calls this without 'i_mutex'.
291  */
ubifs_write_inode(struct inode * inode,struct writeback_control * wbc)292 static int ubifs_write_inode(struct inode *inode, struct writeback_control *wbc)
293 {
294 	int err = 0;
295 	struct ubifs_info *c = inode->i_sb->s_fs_info;
296 	struct ubifs_inode *ui = ubifs_inode(inode);
297 
298 	ubifs_assert(c, !ui->xattr);
299 	if (is_bad_inode(inode))
300 		return 0;
301 
302 	mutex_lock(&ui->ui_mutex);
303 	/*
304 	 * Due to races between write-back forced by budgeting
305 	 * (see 'sync_some_inodes()') and background write-back, the inode may
306 	 * have already been synchronized, do not do this again. This might
307 	 * also happen if it was synchronized in an VFS operation, e.g.
308 	 * 'ubifs_link()'.
309 	 */
310 	if (!ui->dirty) {
311 		mutex_unlock(&ui->ui_mutex);
312 		return 0;
313 	}
314 
315 	/*
316 	 * As an optimization, do not write orphan inodes to the media just
317 	 * because this is not needed.
318 	 */
319 	dbg_gen("inode %lu, mode %#x, nlink %u",
320 		inode->i_ino, (int)inode->i_mode, inode->i_nlink);
321 	if (inode->i_nlink) {
322 		err = ubifs_jnl_write_inode(c, inode);
323 		if (err)
324 			ubifs_err(c, "can't write inode %lu, error %d",
325 				  inode->i_ino, err);
326 		else
327 			err = dbg_check_inode_size(c, inode, ui->ui_size);
328 	}
329 
330 	ui->dirty = 0;
331 	mutex_unlock(&ui->ui_mutex);
332 	ubifs_release_dirty_inode_budget(c, ui);
333 	return err;
334 }
335 
ubifs_drop_inode(struct inode * inode)336 static int ubifs_drop_inode(struct inode *inode)
337 {
338 	int drop = inode_generic_drop(inode);
339 
340 	if (!drop)
341 		drop = fscrypt_drop_inode(inode);
342 
343 	return drop;
344 }
345 
ubifs_evict_inode(struct inode * inode)346 static void ubifs_evict_inode(struct inode *inode)
347 {
348 	int err;
349 	struct ubifs_info *c = inode->i_sb->s_fs_info;
350 	struct ubifs_inode *ui = ubifs_inode(inode);
351 
352 	if (ui->xattr)
353 		/*
354 		 * Extended attribute inode deletions are fully handled in
355 		 * 'ubifs_removexattr()'. These inodes are special and have
356 		 * limited usage, so there is nothing to do here.
357 		 */
358 		goto out;
359 
360 	dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
361 	ubifs_assert(c, !icount_read(inode));
362 
363 	truncate_inode_pages_final(&inode->i_data);
364 
365 	if (inode->i_nlink)
366 		goto done;
367 
368 	if (is_bad_inode(inode))
369 		goto out;
370 
371 	ui->ui_size = inode->i_size = 0;
372 	err = ubifs_jnl_delete_inode(c, inode);
373 	if (err)
374 		/*
375 		 * Worst case we have a lost orphan inode wasting space, so a
376 		 * simple error message is OK here.
377 		 */
378 		ubifs_err(c, "can't delete inode %lu, error %d",
379 			  inode->i_ino, err);
380 
381 out:
382 	if (ui->dirty)
383 		ubifs_release_dirty_inode_budget(c, ui);
384 	else {
385 		/* We've deleted something - clean the "no space" flags */
386 		c->bi.nospace = c->bi.nospace_rp = 0;
387 		smp_wmb();
388 	}
389 done:
390 	clear_inode(inode);
391 	fscrypt_put_encryption_info(inode);
392 }
393 
ubifs_dirty_inode(struct inode * inode,int flags)394 static void ubifs_dirty_inode(struct inode *inode, int flags)
395 {
396 	struct ubifs_info *c = inode->i_sb->s_fs_info;
397 	struct ubifs_inode *ui = ubifs_inode(inode);
398 
399 	ubifs_assert(c, mutex_is_locked(&ui->ui_mutex));
400 	if (!ui->dirty) {
401 		ui->dirty = 1;
402 		dbg_gen("inode %lu",  inode->i_ino);
403 	}
404 }
405 
ubifs_statfs(struct dentry * dentry,struct kstatfs * buf)406 static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
407 {
408 	struct ubifs_info *c = dentry->d_sb->s_fs_info;
409 	unsigned long long free;
410 	__le32 *uuid = (__le32 *)c->uuid;
411 
412 	free = ubifs_get_free_space(c);
413 	dbg_gen("free space %lld bytes (%lld blocks)",
414 		free, free >> UBIFS_BLOCK_SHIFT);
415 
416 	buf->f_type = UBIFS_SUPER_MAGIC;
417 	buf->f_bsize = UBIFS_BLOCK_SIZE;
418 	buf->f_blocks = c->block_cnt;
419 	buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
420 	if (free > c->report_rp_size)
421 		buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
422 	else
423 		buf->f_bavail = 0;
424 	buf->f_files = 0;
425 	buf->f_ffree = 0;
426 	buf->f_namelen = UBIFS_MAX_NLEN;
427 	buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
428 	buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
429 	ubifs_assert(c, buf->f_bfree <= c->block_cnt);
430 	return 0;
431 }
432 
ubifs_show_options(struct seq_file * s,struct dentry * root)433 static int ubifs_show_options(struct seq_file *s, struct dentry *root)
434 {
435 	struct ubifs_info *c = root->d_sb->s_fs_info;
436 
437 	if (c->mount_opts.unmount_mode == 2)
438 		seq_puts(s, ",fast_unmount");
439 	else if (c->mount_opts.unmount_mode == 1)
440 		seq_puts(s, ",norm_unmount");
441 
442 	if (c->mount_opts.bulk_read == 2)
443 		seq_puts(s, ",bulk_read");
444 	else if (c->mount_opts.bulk_read == 1)
445 		seq_puts(s, ",no_bulk_read");
446 
447 	if (c->mount_opts.chk_data_crc == 2)
448 		seq_puts(s, ",chk_data_crc");
449 	else if (c->mount_opts.chk_data_crc == 1)
450 		seq_puts(s, ",no_chk_data_crc");
451 
452 	if (c->mount_opts.override_compr) {
453 		seq_printf(s, ",compr=%s",
454 			   ubifs_compr_name(c, c->mount_opts.compr_type));
455 	}
456 
457 	seq_printf(s, ",assert=%s", ubifs_assert_action_name(c));
458 	seq_printf(s, ",ubi=%d,vol=%d", c->vi.ubi_num, c->vi.vol_id);
459 
460 	return 0;
461 }
462 
ubifs_sync_fs(struct super_block * sb,int wait)463 static int ubifs_sync_fs(struct super_block *sb, int wait)
464 {
465 	int i, err;
466 	struct ubifs_info *c = sb->s_fs_info;
467 
468 	/*
469 	 * Zero @wait is just an advisory thing to help the file system shove
470 	 * lots of data into the queues, and there will be the second
471 	 * '->sync_fs()' call, with non-zero @wait.
472 	 */
473 	if (!wait)
474 		return 0;
475 
476 	/*
477 	 * Synchronize write buffers, because 'ubifs_run_commit()' does not
478 	 * do this if it waits for an already running commit.
479 	 */
480 	for (i = 0; i < c->jhead_cnt; i++) {
481 		err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
482 		if (err)
483 			return err;
484 	}
485 
486 	/*
487 	 * Strictly speaking, it is not necessary to commit the journal here,
488 	 * synchronizing write-buffers would be enough. But committing makes
489 	 * UBIFS free space predictions much more accurate, so we want to let
490 	 * the user be able to get more accurate results of 'statfs()' after
491 	 * they synchronize the file system.
492 	 */
493 	err = ubifs_run_commit(c);
494 	if (err)
495 		return err;
496 
497 	return ubi_sync(c->vi.ubi_num);
498 }
499 
500 /**
501  * init_constants_early - initialize UBIFS constants.
502  * @c: UBIFS file-system description object
503  *
504  * This function initialize UBIFS constants which do not need the superblock to
505  * be read. It also checks that the UBI volume satisfies basic UBIFS
506  * requirements. Returns zero in case of success and a negative error code in
507  * case of failure.
508  */
init_constants_early(struct ubifs_info * c)509 static int init_constants_early(struct ubifs_info *c)
510 {
511 	if (c->vi.corrupted) {
512 		ubifs_warn(c, "UBI volume is corrupted - read-only mode");
513 		c->ro_media = 1;
514 	}
515 
516 	if (c->di.ro_mode) {
517 		ubifs_msg(c, "read-only UBI device");
518 		c->ro_media = 1;
519 	}
520 
521 	if (c->vi.vol_type == UBI_STATIC_VOLUME) {
522 		ubifs_msg(c, "static UBI volume - read-only mode");
523 		c->ro_media = 1;
524 	}
525 
526 	c->leb_cnt = c->vi.size;
527 	c->leb_size = c->vi.usable_leb_size;
528 	c->leb_start = c->di.leb_start;
529 	c->half_leb_size = c->leb_size / 2;
530 	c->min_io_size = c->di.min_io_size;
531 	c->min_io_shift = fls(c->min_io_size) - 1;
532 	c->max_write_size = c->di.max_write_size;
533 	c->max_write_shift = fls(c->max_write_size) - 1;
534 
535 	if (c->leb_size < UBIFS_MIN_LEB_SZ) {
536 		ubifs_errc(c, "too small LEBs (%d bytes), min. is %d bytes",
537 			   c->leb_size, UBIFS_MIN_LEB_SZ);
538 		return -EINVAL;
539 	}
540 
541 	if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
542 		ubifs_errc(c, "too few LEBs (%d), min. is %d",
543 			   c->leb_cnt, UBIFS_MIN_LEB_CNT);
544 		return -EINVAL;
545 	}
546 
547 	if (!is_power_of_2(c->min_io_size)) {
548 		ubifs_errc(c, "bad min. I/O size %d", c->min_io_size);
549 		return -EINVAL;
550 	}
551 
552 	/*
553 	 * Maximum write size has to be greater or equivalent to min. I/O
554 	 * size, and be multiple of min. I/O size.
555 	 */
556 	if (c->max_write_size < c->min_io_size ||
557 	    c->max_write_size % c->min_io_size ||
558 	    !is_power_of_2(c->max_write_size)) {
559 		ubifs_errc(c, "bad write buffer size %d for %d min. I/O unit",
560 			   c->max_write_size, c->min_io_size);
561 		return -EINVAL;
562 	}
563 
564 	/*
565 	 * UBIFS aligns all node to 8-byte boundary, so to make function in
566 	 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
567 	 * less than 8.
568 	 */
569 	if (c->min_io_size < 8) {
570 		c->min_io_size = 8;
571 		c->min_io_shift = 3;
572 		if (c->max_write_size < c->min_io_size) {
573 			c->max_write_size = c->min_io_size;
574 			c->max_write_shift = c->min_io_shift;
575 		}
576 	}
577 
578 	c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
579 	c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
580 
581 	/*
582 	 * Initialize node length ranges which are mostly needed for node
583 	 * length validation.
584 	 */
585 	c->ranges[UBIFS_PAD_NODE].len  = UBIFS_PAD_NODE_SZ;
586 	c->ranges[UBIFS_SB_NODE].len   = UBIFS_SB_NODE_SZ;
587 	c->ranges[UBIFS_MST_NODE].len  = UBIFS_MST_NODE_SZ;
588 	c->ranges[UBIFS_REF_NODE].len  = UBIFS_REF_NODE_SZ;
589 	c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
590 	c->ranges[UBIFS_CS_NODE].len   = UBIFS_CS_NODE_SZ;
591 	c->ranges[UBIFS_AUTH_NODE].min_len = UBIFS_AUTH_NODE_SZ;
592 	c->ranges[UBIFS_AUTH_NODE].max_len = UBIFS_AUTH_NODE_SZ +
593 				UBIFS_MAX_HMAC_LEN;
594 	c->ranges[UBIFS_SIG_NODE].min_len = UBIFS_SIG_NODE_SZ;
595 	c->ranges[UBIFS_SIG_NODE].max_len = c->leb_size - UBIFS_SB_NODE_SZ;
596 
597 	c->ranges[UBIFS_INO_NODE].min_len  = UBIFS_INO_NODE_SZ;
598 	c->ranges[UBIFS_INO_NODE].max_len  = UBIFS_MAX_INO_NODE_SZ;
599 	c->ranges[UBIFS_ORPH_NODE].min_len =
600 				UBIFS_ORPH_NODE_SZ + sizeof(__le64);
601 	c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
602 	c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
603 	c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
604 	c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
605 	c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
606 	c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
607 	c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
608 	/*
609 	 * Minimum indexing node size is amended later when superblock is
610 	 * read and the key length is known.
611 	 */
612 	c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
613 	/*
614 	 * Maximum indexing node size is amended later when superblock is
615 	 * read and the fanout is known.
616 	 */
617 	c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
618 
619 	/*
620 	 * Initialize dead and dark LEB space watermarks. See gc.c for comments
621 	 * about these values.
622 	 */
623 	c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
624 	c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
625 
626 	/*
627 	 * Calculate how many bytes would be wasted at the end of LEB if it was
628 	 * fully filled with data nodes of maximum size. This is used in
629 	 * calculations when reporting free space.
630 	 */
631 	c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
632 
633 	/* Buffer size for bulk-reads */
634 	c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
635 	if (c->max_bu_buf_len > c->leb_size)
636 		c->max_bu_buf_len = c->leb_size;
637 
638 	/* Log is ready, preserve one LEB for commits. */
639 	c->min_log_bytes = c->leb_size;
640 
641 	return 0;
642 }
643 
644 /**
645  * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
646  * @c: UBIFS file-system description object
647  * @lnum: LEB the write-buffer was synchronized to
648  * @free: how many free bytes left in this LEB
649  * @pad: how many bytes were padded
650  *
651  * This is a callback function which is called by the I/O unit when the
652  * write-buffer is synchronized. We need this to correctly maintain space
653  * accounting in bud logical eraseblocks. This function returns zero in case of
654  * success and a negative error code in case of failure.
655  *
656  * This function actually belongs to the journal, but we keep it here because
657  * we want to keep it static.
658  */
bud_wbuf_callback(struct ubifs_info * c,int lnum,int free,int pad)659 static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
660 {
661 	return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
662 }
663 
664 /*
665  * init_constants_sb - initialize UBIFS constants.
666  * @c: UBIFS file-system description object
667  *
668  * This is a helper function which initializes various UBIFS constants after
669  * the superblock has been read. It also checks various UBIFS parameters and
670  * makes sure they are all right. Returns zero in case of success and a
671  * negative error code in case of failure.
672  */
init_constants_sb(struct ubifs_info * c)673 static int init_constants_sb(struct ubifs_info *c)
674 {
675 	int tmp, err;
676 	long long tmp64;
677 
678 	c->main_bytes = (long long)c->main_lebs * c->leb_size;
679 	c->max_znode_sz = sizeof(struct ubifs_znode) +
680 				c->fanout * sizeof(struct ubifs_zbranch);
681 
682 	tmp = ubifs_idx_node_sz(c, 1);
683 	c->ranges[UBIFS_IDX_NODE].min_len = tmp;
684 	c->min_idx_node_sz = ALIGN(tmp, 8);
685 
686 	tmp = ubifs_idx_node_sz(c, c->fanout);
687 	c->ranges[UBIFS_IDX_NODE].max_len = tmp;
688 	c->max_idx_node_sz = ALIGN(tmp, 8);
689 
690 	/* Make sure LEB size is large enough to fit full commit */
691 	tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
692 	tmp = ALIGN(tmp, c->min_io_size);
693 	if (tmp > c->leb_size) {
694 		ubifs_err(c, "too small LEB size %d, at least %d needed",
695 			  c->leb_size, tmp);
696 		return -EINVAL;
697 	}
698 
699 	/*
700 	 * Make sure that the log is large enough to fit reference nodes for
701 	 * all buds plus one reserved LEB.
702 	 */
703 	tmp64 = c->max_bud_bytes + c->leb_size - 1;
704 	c->max_bud_cnt = div_u64(tmp64, c->leb_size);
705 	tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
706 	tmp /= c->leb_size;
707 	tmp += 1;
708 	if (c->log_lebs < tmp) {
709 		ubifs_err(c, "too small log %d LEBs, required min. %d LEBs",
710 			  c->log_lebs, tmp);
711 		return -EINVAL;
712 	}
713 
714 	/*
715 	 * When budgeting we assume worst-case scenarios when the pages are not
716 	 * be compressed and direntries are of the maximum size.
717 	 *
718 	 * Note, data, which may be stored in inodes is budgeted separately, so
719 	 * it is not included into 'c->bi.inode_budget'.
720 	 */
721 	c->bi.page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
722 	c->bi.inode_budget = UBIFS_INO_NODE_SZ;
723 	c->bi.dent_budget = UBIFS_MAX_DENT_NODE_SZ;
724 
725 	/*
726 	 * When the amount of flash space used by buds becomes
727 	 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
728 	 * The writers are unblocked when the commit is finished. To avoid
729 	 * writers to be blocked UBIFS initiates background commit in advance,
730 	 * when number of bud bytes becomes above the limit defined below.
731 	 */
732 	c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
733 
734 	/*
735 	 * Ensure minimum journal size. All the bytes in the journal heads are
736 	 * considered to be used, when calculating the current journal usage.
737 	 * Consequently, if the journal is too small, UBIFS will treat it as
738 	 * always full.
739 	 */
740 	tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
741 	if (c->bg_bud_bytes < tmp64)
742 		c->bg_bud_bytes = tmp64;
743 	if (c->max_bud_bytes < tmp64 + c->leb_size)
744 		c->max_bud_bytes = tmp64 + c->leb_size;
745 
746 	err = ubifs_calc_lpt_geom(c);
747 	if (err)
748 		return err;
749 
750 	/* Initialize effective LEB size used in budgeting calculations */
751 	c->idx_leb_size = c->leb_size - c->max_idx_node_sz;
752 	return 0;
753 }
754 
755 /*
756  * init_constants_master - initialize UBIFS constants.
757  * @c: UBIFS file-system description object
758  *
759  * This is a helper function which initializes various UBIFS constants after
760  * the master node has been read. It also checks various UBIFS parameters and
761  * makes sure they are all right.
762  */
init_constants_master(struct ubifs_info * c)763 static void init_constants_master(struct ubifs_info *c)
764 {
765 	long long tmp64;
766 
767 	c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
768 	c->report_rp_size = ubifs_reported_space(c, c->rp_size);
769 
770 	/*
771 	 * Calculate total amount of FS blocks. This number is not used
772 	 * internally because it does not make much sense for UBIFS, but it is
773 	 * necessary to report something for the 'statfs()' call.
774 	 *
775 	 * Subtract the LEB reserved for GC, the LEB which is reserved for
776 	 * deletions, minimum LEBs for the index, the LEBs which are reserved
777 	 * for each journal head.
778 	 */
779 	tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt;
780 	tmp64 *= (long long)c->leb_size - c->leb_overhead;
781 	tmp64 = ubifs_reported_space(c, tmp64);
782 	c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
783 }
784 
785 /**
786  * take_gc_lnum - reserve GC LEB.
787  * @c: UBIFS file-system description object
788  *
789  * This function ensures that the LEB reserved for garbage collection is marked
790  * as "taken" in lprops. We also have to set free space to LEB size and dirty
791  * space to zero, because lprops may contain out-of-date information if the
792  * file-system was un-mounted before it has been committed. This function
793  * returns zero in case of success and a negative error code in case of
794  * failure.
795  */
take_gc_lnum(struct ubifs_info * c)796 static int take_gc_lnum(struct ubifs_info *c)
797 {
798 	int err;
799 
800 	if (c->gc_lnum == -1) {
801 		ubifs_err(c, "no LEB for GC");
802 		return -EINVAL;
803 	}
804 
805 	/* And we have to tell lprops that this LEB is taken */
806 	err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
807 				  LPROPS_TAKEN, 0, 0);
808 	return err;
809 }
810 
811 /**
812  * alloc_wbufs - allocate write-buffers.
813  * @c: UBIFS file-system description object
814  *
815  * This helper function allocates and initializes UBIFS write-buffers. Returns
816  * zero in case of success and %-ENOMEM in case of failure.
817  */
alloc_wbufs(struct ubifs_info * c)818 static int alloc_wbufs(struct ubifs_info *c)
819 {
820 	int i, err;
821 
822 	c->jheads = kzalloc_objs(struct ubifs_jhead, c->jhead_cnt);
823 	if (!c->jheads)
824 		return -ENOMEM;
825 
826 	/* Initialize journal heads */
827 	for (i = 0; i < c->jhead_cnt; i++) {
828 		INIT_LIST_HEAD(&c->jheads[i].buds_list);
829 		err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
830 		if (err)
831 			goto out_wbuf;
832 
833 		c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
834 		c->jheads[i].wbuf.jhead = i;
835 		c->jheads[i].grouped = 1;
836 		c->jheads[i].log_hash = ubifs_hash_get_desc(c);
837 		if (IS_ERR(c->jheads[i].log_hash)) {
838 			err = PTR_ERR(c->jheads[i].log_hash);
839 			goto out_log_hash;
840 		}
841 	}
842 
843 	/*
844 	 * Garbage Collector head does not need to be synchronized by timer.
845 	 * Also GC head nodes are not grouped.
846 	 */
847 	c->jheads[GCHD].wbuf.no_timer = 1;
848 	c->jheads[GCHD].grouped = 0;
849 
850 	return 0;
851 
852 out_log_hash:
853 	kfree(c->jheads[i].wbuf.buf);
854 	kfree(c->jheads[i].wbuf.inodes);
855 
856 out_wbuf:
857 	while (i--) {
858 		kfree(c->jheads[i].wbuf.buf);
859 		kfree(c->jheads[i].wbuf.inodes);
860 		kfree(c->jheads[i].log_hash);
861 	}
862 	kfree(c->jheads);
863 	c->jheads = NULL;
864 
865 	return err;
866 }
867 
868 /**
869  * free_wbufs - free write-buffers.
870  * @c: UBIFS file-system description object
871  */
free_wbufs(struct ubifs_info * c)872 static void free_wbufs(struct ubifs_info *c)
873 {
874 	int i;
875 
876 	if (c->jheads) {
877 		for (i = 0; i < c->jhead_cnt; i++) {
878 			kfree(c->jheads[i].wbuf.buf);
879 			kfree(c->jheads[i].wbuf.inodes);
880 			kfree(c->jheads[i].log_hash);
881 		}
882 		kfree(c->jheads);
883 		c->jheads = NULL;
884 	}
885 }
886 
887 /**
888  * free_orphans - free orphans.
889  * @c: UBIFS file-system description object
890  */
free_orphans(struct ubifs_info * c)891 static void free_orphans(struct ubifs_info *c)
892 {
893 	struct ubifs_orphan *orph;
894 
895 	while (c->orph_dnext) {
896 		orph = c->orph_dnext;
897 		c->orph_dnext = orph->dnext;
898 		list_del(&orph->list);
899 		kfree(orph);
900 	}
901 
902 	while (!list_empty(&c->orph_list)) {
903 		orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
904 		list_del(&orph->list);
905 		kfree(orph);
906 		ubifs_err(c, "orphan list not empty at unmount");
907 	}
908 
909 	vfree(c->orph_buf);
910 	c->orph_buf = NULL;
911 }
912 
913 /**
914  * free_buds - free per-bud objects.
915  * @c: UBIFS file-system description object
916  */
free_buds(struct ubifs_info * c)917 static void free_buds(struct ubifs_info *c)
918 {
919 	struct ubifs_bud *bud, *n;
920 
921 	rbtree_postorder_for_each_entry_safe(bud, n, &c->buds, rb) {
922 		kfree(bud->log_hash);
923 		kfree(bud);
924 	}
925 }
926 
927 /**
928  * check_volume_empty - check if the UBI volume is empty.
929  * @c: UBIFS file-system description object
930  *
931  * This function checks if the UBIFS volume is empty by looking if its LEBs are
932  * mapped or not. The result of checking is stored in the @c->empty variable.
933  * Returns zero in case of success and a negative error code in case of
934  * failure.
935  */
check_volume_empty(struct ubifs_info * c)936 static int check_volume_empty(struct ubifs_info *c)
937 {
938 	int lnum, err;
939 
940 	c->empty = 1;
941 	for (lnum = 0; lnum < c->leb_cnt; lnum++) {
942 		err = ubifs_is_mapped(c, lnum);
943 		if (unlikely(err < 0))
944 			return err;
945 		if (err == 1) {
946 			c->empty = 0;
947 			break;
948 		}
949 
950 		cond_resched();
951 	}
952 
953 	return 0;
954 }
955 
956 /*
957  * UBIFS mount options.
958  *
959  * Opt_fast_unmount: do not run a journal commit before un-mounting
960  * Opt_norm_unmount: run a journal commit before un-mounting
961  * Opt_bulk_read: enable bulk-reads
962  * Opt_no_bulk_read: disable bulk-reads
963  * Opt_chk_data_crc: check CRCs when reading data nodes
964  * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
965  * Opt_override_compr: override default compressor
966  * Opt_assert: set ubifs_assert() action
967  * Opt_auth_key: The key name used for authentication
968  * Opt_auth_hash_name: The hash type used for authentication
969  * Opt_err: just end of array marker
970  */
971 enum {
972 	Opt_fast_unmount,
973 	Opt_norm_unmount,
974 	Opt_bulk_read,
975 	Opt_no_bulk_read,
976 	Opt_chk_data_crc,
977 	Opt_no_chk_data_crc,
978 	Opt_override_compr,
979 	Opt_assert,
980 	Opt_auth_key,
981 	Opt_auth_hash_name,
982 	Opt_ignore,
983 };
984 
985 static const struct constant_table ubifs_param_compr[] = {
986 	{ "none",	UBIFS_COMPR_NONE },
987 	{ "lzo",	UBIFS_COMPR_LZO },
988 	{ "zlib",	UBIFS_COMPR_ZLIB },
989 	{ "zstd",	UBIFS_COMPR_ZSTD },
990 	{}
991 };
992 
993 static const struct constant_table ubifs_param_assert[] = {
994 	{ "report",	ASSACT_REPORT },
995 	{ "read-only",	ASSACT_RO },
996 	{ "panic",	ASSACT_PANIC },
997 	{}
998 };
999 
1000 static const struct fs_parameter_spec ubifs_fs_param_spec[] = {
1001 	fsparam_flag	("fast_unmount",	Opt_fast_unmount),
1002 	fsparam_flag	("norm_unmount",	Opt_norm_unmount),
1003 	fsparam_flag	("bulk_read",		Opt_bulk_read),
1004 	fsparam_flag	("no_bulk_read",	Opt_no_bulk_read),
1005 	fsparam_flag	("chk_data_crc",	Opt_chk_data_crc),
1006 	fsparam_flag	("no_chk_data_crc",	Opt_no_chk_data_crc),
1007 	fsparam_enum	("compr",		Opt_override_compr, ubifs_param_compr),
1008 	fsparam_enum	("assert",		Opt_assert, ubifs_param_assert),
1009 	fsparam_string	("auth_key",		Opt_auth_key),
1010 	fsparam_string	("auth_hash_name",	Opt_auth_hash_name),
1011 	fsparam_string	("ubi",			Opt_ignore),
1012 	fsparam_string	("vol",			Opt_ignore),
1013 	{}
1014 };
1015 
1016 struct ubifs_fs_context {
1017 	struct ubifs_mount_opts mount_opts;
1018 	char *auth_key_name;
1019 	char *auth_hash_name;
1020 	unsigned int no_chk_data_crc:1;
1021 	unsigned int bulk_read:1;
1022 	unsigned int default_compr:2;
1023 	unsigned int assert_action:2;
1024 };
1025 
1026 /**
1027  * ubifs_parse_param - parse a parameter.
1028  * @fc: the filesystem context
1029  * @param: the parameter to parse
1030  *
1031  * This function parses UBIFS mount options and returns zero in case success
1032  * and a negative error code in case of failure.
1033  */
ubifs_parse_param(struct fs_context * fc,struct fs_parameter * param)1034 static int ubifs_parse_param(struct fs_context *fc, struct fs_parameter *param)
1035 {
1036 	struct ubifs_fs_context *ctx = fc->fs_private;
1037 	struct fs_parse_result result;
1038 	bool is_remount = (fc->purpose & FS_CONTEXT_FOR_RECONFIGURE);
1039 	int opt;
1040 
1041 	opt = fs_parse(fc, ubifs_fs_param_spec, param, &result);
1042 	if (opt < 0)
1043 		return opt;
1044 
1045 	switch (opt) {
1046 		/*
1047 		 * %Opt_fast_unmount and %Opt_norm_unmount options are ignored.
1048 		 * We accept them in order to be backward-compatible. But this
1049 		 * should be removed at some point.
1050 		 */
1051 	case Opt_fast_unmount:
1052 		ctx->mount_opts.unmount_mode = 2;
1053 		break;
1054 	case Opt_norm_unmount:
1055 		ctx->mount_opts.unmount_mode = 1;
1056 		break;
1057 	case Opt_bulk_read:
1058 		ctx->mount_opts.bulk_read = 2;
1059 		ctx->bulk_read = 1;
1060 		break;
1061 	case Opt_no_bulk_read:
1062 		ctx->mount_opts.bulk_read = 1;
1063 		ctx->bulk_read = 0;
1064 		break;
1065 	case Opt_chk_data_crc:
1066 		ctx->mount_opts.chk_data_crc = 2;
1067 		ctx->no_chk_data_crc = 0;
1068 		break;
1069 	case Opt_no_chk_data_crc:
1070 		ctx->mount_opts.chk_data_crc = 1;
1071 		ctx->no_chk_data_crc = 1;
1072 		break;
1073 	case Opt_override_compr:
1074 		ctx->mount_opts.compr_type = result.uint_32;
1075 		ctx->mount_opts.override_compr = 1;
1076 		ctx->default_compr = ctx->mount_opts.compr_type;
1077 		break;
1078 	case Opt_assert:
1079 		ctx->assert_action = result.uint_32;
1080 		break;
1081 	case Opt_auth_key:
1082 		if (!is_remount) {
1083 			kfree(ctx->auth_key_name);
1084 			ctx->auth_key_name = param->string;
1085 			param->string = NULL;
1086 		}
1087 		break;
1088 	case Opt_auth_hash_name:
1089 		if (!is_remount) {
1090 			kfree(ctx->auth_hash_name);
1091 			ctx->auth_hash_name = param->string;
1092 			param->string = NULL;
1093 		}
1094 		break;
1095 	case Opt_ignore:
1096 		break;
1097 	}
1098 
1099 	return 0;
1100 }
1101 
1102 /*
1103  * ubifs_release_options - release mount parameters which have been dumped.
1104  * @c: UBIFS file-system description object
1105  */
ubifs_release_options(struct ubifs_info * c)1106 static void ubifs_release_options(struct ubifs_info *c)
1107 {
1108 	kfree(c->auth_key_name);
1109 	c->auth_key_name = NULL;
1110 	kfree(c->auth_hash_name);
1111 	c->auth_hash_name = NULL;
1112 }
1113 
1114 /**
1115  * destroy_journal - destroy journal data structures.
1116  * @c: UBIFS file-system description object
1117  *
1118  * This function destroys journal data structures including those that may have
1119  * been created by recovery functions.
1120  */
destroy_journal(struct ubifs_info * c)1121 static void destroy_journal(struct ubifs_info *c)
1122 {
1123 	while (!list_empty(&c->unclean_leb_list)) {
1124 		struct ubifs_unclean_leb *ucleb;
1125 
1126 		ucleb = list_entry(c->unclean_leb_list.next,
1127 				   struct ubifs_unclean_leb, list);
1128 		list_del(&ucleb->list);
1129 		kfree(ucleb);
1130 	}
1131 	while (!list_empty(&c->old_buds)) {
1132 		struct ubifs_bud *bud;
1133 
1134 		bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
1135 		list_del(&bud->list);
1136 		kfree(bud->log_hash);
1137 		kfree(bud);
1138 	}
1139 	ubifs_destroy_idx_gc(c);
1140 	ubifs_destroy_size_tree(c);
1141 	ubifs_tnc_close(c);
1142 	free_buds(c);
1143 }
1144 
1145 /**
1146  * bu_init - initialize bulk-read information.
1147  * @c: UBIFS file-system description object
1148  */
bu_init(struct ubifs_info * c)1149 static void bu_init(struct ubifs_info *c)
1150 {
1151 	ubifs_assert(c, c->bulk_read == 1);
1152 
1153 	if (c->bu.buf)
1154 		return; /* Already initialized */
1155 
1156 again:
1157 	c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
1158 	if (!c->bu.buf) {
1159 		if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
1160 			c->max_bu_buf_len = UBIFS_KMALLOC_OK;
1161 			goto again;
1162 		}
1163 
1164 		/* Just disable bulk-read */
1165 		ubifs_warn(c, "cannot allocate %d bytes of memory for bulk-read, disabling it",
1166 			   c->max_bu_buf_len);
1167 		c->mount_opts.bulk_read = 1;
1168 		c->bulk_read = 0;
1169 		return;
1170 	}
1171 }
1172 
1173 /**
1174  * check_free_space - check if there is enough free space to mount.
1175  * @c: UBIFS file-system description object
1176  *
1177  * This function makes sure UBIFS has enough free space to be mounted in
1178  * read/write mode. UBIFS must always have some free space to allow deletions.
1179  */
check_free_space(struct ubifs_info * c)1180 static int check_free_space(struct ubifs_info *c)
1181 {
1182 	ubifs_assert(c, c->dark_wm > 0);
1183 	if (c->lst.total_free + c->lst.total_dirty < c->dark_wm) {
1184 		ubifs_err(c, "insufficient free space to mount in R/W mode");
1185 		ubifs_dump_budg(c, &c->bi);
1186 		ubifs_dump_lprops(c);
1187 		return -ENOSPC;
1188 	}
1189 	return 0;
1190 }
1191 
1192 /**
1193  * mount_ubifs - mount UBIFS file-system.
1194  * @c: UBIFS file-system description object
1195  *
1196  * This function mounts UBIFS file system. Returns zero in case of success and
1197  * a negative error code in case of failure.
1198  */
mount_ubifs(struct ubifs_info * c)1199 static int mount_ubifs(struct ubifs_info *c)
1200 {
1201 	int err;
1202 	long long x, y;
1203 	size_t sz;
1204 
1205 	c->ro_mount = !!sb_rdonly(c->vfs_sb);
1206 	/* Suppress error messages while probing if SB_SILENT is set */
1207 	c->probing = !!(c->vfs_sb->s_flags & SB_SILENT);
1208 
1209 	err = init_constants_early(c);
1210 	if (err)
1211 		return err;
1212 
1213 	err = ubifs_debugging_init(c);
1214 	if (err)
1215 		return err;
1216 
1217 	err = ubifs_sysfs_register(c);
1218 	if (err)
1219 		goto out_debugging;
1220 
1221 	err = check_volume_empty(c);
1222 	if (err)
1223 		goto out_free;
1224 
1225 	if (c->empty && (c->ro_mount || c->ro_media)) {
1226 		/*
1227 		 * This UBI volume is empty, and read-only, or the file system
1228 		 * is mounted read-only - we cannot format it.
1229 		 */
1230 		ubifs_err(c, "can't format empty UBI volume: read-only %s",
1231 			  c->ro_media ? "UBI volume" : "mount");
1232 		err = -EROFS;
1233 		goto out_free;
1234 	}
1235 
1236 	if (c->ro_media && !c->ro_mount) {
1237 		ubifs_err(c, "cannot mount read-write - read-only media");
1238 		err = -EROFS;
1239 		goto out_free;
1240 	}
1241 
1242 	/*
1243 	 * The requirement for the buffer is that it should fit indexing B-tree
1244 	 * height amount of integers. We assume the height if the TNC tree will
1245 	 * never exceed 64.
1246 	 */
1247 	err = -ENOMEM;
1248 	c->bottom_up_buf = kmalloc_objs(int, BOTTOM_UP_HEIGHT);
1249 	if (!c->bottom_up_buf)
1250 		goto out_free;
1251 
1252 	c->sbuf = vmalloc(c->leb_size);
1253 	if (!c->sbuf)
1254 		goto out_free;
1255 
1256 	if (!c->ro_mount) {
1257 		c->ileb_buf = vmalloc(c->leb_size);
1258 		if (!c->ileb_buf)
1259 			goto out_free;
1260 	}
1261 
1262 	if (c->bulk_read == 1)
1263 		bu_init(c);
1264 
1265 	if (!c->ro_mount) {
1266 		c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ + \
1267 					       UBIFS_CIPHER_BLOCK_SIZE,
1268 					       GFP_KERNEL);
1269 		if (!c->write_reserve_buf)
1270 			goto out_free;
1271 	}
1272 
1273 	c->mounting = 1;
1274 
1275 	if (c->auth_key_name) {
1276 		if (IS_ENABLED(CONFIG_UBIFS_FS_AUTHENTICATION)) {
1277 			err = ubifs_init_authentication(c);
1278 			if (err)
1279 				goto out_free;
1280 		} else {
1281 			ubifs_err(c, "auth_key_name, but UBIFS is built without"
1282 				  " authentication support");
1283 			err = -EINVAL;
1284 			goto out_free;
1285 		}
1286 	}
1287 
1288 	err = ubifs_read_superblock(c);
1289 	if (err)
1290 		goto out_auth;
1291 
1292 	c->probing = 0;
1293 
1294 	/*
1295 	 * Make sure the compressor which is set as default in the superblock
1296 	 * or overridden by mount options is actually compiled in.
1297 	 */
1298 	if (!ubifs_compr_present(c, c->default_compr)) {
1299 		ubifs_err(c, "'compressor \"%s\" is not compiled in",
1300 			  ubifs_compr_name(c, c->default_compr));
1301 		err = -ENOTSUPP;
1302 		goto out_auth;
1303 	}
1304 
1305 	err = init_constants_sb(c);
1306 	if (err)
1307 		goto out_auth;
1308 
1309 	sz = ALIGN(c->max_idx_node_sz, c->min_io_size) * 2;
1310 	c->cbuf = kmalloc(sz, GFP_NOFS);
1311 	if (!c->cbuf) {
1312 		err = -ENOMEM;
1313 		goto out_auth;
1314 	}
1315 
1316 	err = alloc_wbufs(c);
1317 	if (err)
1318 		goto out_cbuf;
1319 
1320 	sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
1321 	if (!c->ro_mount) {
1322 		/* Create background thread */
1323 		c->bgt = kthread_run(ubifs_bg_thread, c, "%s", c->bgt_name);
1324 		if (IS_ERR(c->bgt)) {
1325 			err = PTR_ERR(c->bgt);
1326 			c->bgt = NULL;
1327 			ubifs_err(c, "cannot spawn \"%s\", error %d",
1328 				  c->bgt_name, err);
1329 			goto out_wbufs;
1330 		}
1331 	}
1332 
1333 	err = ubifs_read_master(c);
1334 	if (err)
1335 		goto out_master;
1336 
1337 	init_constants_master(c);
1338 
1339 	if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
1340 		ubifs_msg(c, "recovery needed");
1341 		c->need_recovery = 1;
1342 	}
1343 
1344 	if (c->need_recovery && !c->ro_mount) {
1345 		err = ubifs_recover_inl_heads(c, c->sbuf);
1346 		if (err)
1347 			goto out_master;
1348 	}
1349 
1350 	err = ubifs_lpt_init(c, 1, !c->ro_mount);
1351 	if (err)
1352 		goto out_master;
1353 
1354 	if (!c->ro_mount && c->space_fixup) {
1355 		err = ubifs_fixup_free_space(c);
1356 		if (err)
1357 			goto out_lpt;
1358 	}
1359 
1360 	if (!c->ro_mount && !c->need_recovery) {
1361 		/*
1362 		 * Set the "dirty" flag so that if we reboot uncleanly we
1363 		 * will notice this immediately on the next mount.
1364 		 */
1365 		c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1366 		err = ubifs_write_master(c);
1367 		if (err)
1368 			goto out_lpt;
1369 	}
1370 
1371 	/*
1372 	 * Handle offline signed images: Now that the master node is
1373 	 * written and its validation no longer depends on the hash
1374 	 * in the superblock, we can update the offline signed
1375 	 * superblock with a HMAC version,
1376 	 */
1377 	if (ubifs_authenticated(c) && ubifs_hmac_zero(c, c->sup_node->hmac)) {
1378 		err = ubifs_hmac_wkm(c, c->sup_node->hmac_wkm);
1379 		if (err)
1380 			goto out_lpt;
1381 		c->superblock_need_write = 1;
1382 	}
1383 
1384 	if (!c->ro_mount && c->superblock_need_write) {
1385 		err = ubifs_write_sb_node(c, c->sup_node);
1386 		if (err)
1387 			goto out_lpt;
1388 		c->superblock_need_write = 0;
1389 	}
1390 
1391 	err = dbg_check_idx_size(c, c->bi.old_idx_sz);
1392 	if (err)
1393 		goto out_lpt;
1394 
1395 	err = ubifs_replay_journal(c);
1396 	if (err)
1397 		goto out_journal;
1398 
1399 	/* Calculate 'min_idx_lebs' after journal replay */
1400 	c->bi.min_idx_lebs = ubifs_calc_min_idx_lebs(c);
1401 
1402 	err = ubifs_mount_orphans(c, c->need_recovery, c->ro_mount);
1403 	if (err)
1404 		goto out_orphans;
1405 
1406 	if (!c->ro_mount) {
1407 		int lnum;
1408 
1409 		err = check_free_space(c);
1410 		if (err)
1411 			goto out_orphans;
1412 
1413 		/* Check for enough log space */
1414 		lnum = c->lhead_lnum + 1;
1415 		if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1416 			lnum = UBIFS_LOG_LNUM;
1417 		if (lnum == c->ltail_lnum) {
1418 			err = ubifs_consolidate_log(c);
1419 			if (err)
1420 				goto out_orphans;
1421 		}
1422 
1423 		if (c->need_recovery) {
1424 			if (!ubifs_authenticated(c)) {
1425 				err = ubifs_recover_size(c, true);
1426 				if (err)
1427 					goto out_orphans;
1428 			}
1429 
1430 			err = ubifs_rcvry_gc_commit(c);
1431 			if (err)
1432 				goto out_orphans;
1433 
1434 			if (ubifs_authenticated(c)) {
1435 				err = ubifs_recover_size(c, false);
1436 				if (err)
1437 					goto out_orphans;
1438 			}
1439 		} else {
1440 			err = take_gc_lnum(c);
1441 			if (err)
1442 				goto out_orphans;
1443 
1444 			/*
1445 			 * GC LEB may contain garbage if there was an unclean
1446 			 * reboot, and it should be un-mapped.
1447 			 */
1448 			err = ubifs_leb_unmap(c, c->gc_lnum);
1449 			if (err)
1450 				goto out_orphans;
1451 		}
1452 
1453 		err = dbg_check_lprops(c);
1454 		if (err)
1455 			goto out_orphans;
1456 	} else if (c->need_recovery) {
1457 		err = ubifs_recover_size(c, false);
1458 		if (err)
1459 			goto out_orphans;
1460 	} else {
1461 		/*
1462 		 * Even if we mount read-only, we have to set space in GC LEB
1463 		 * to proper value because this affects UBIFS free space
1464 		 * reporting. We do not want to have a situation when
1465 		 * re-mounting from R/O to R/W changes amount of free space.
1466 		 */
1467 		err = take_gc_lnum(c);
1468 		if (err)
1469 			goto out_orphans;
1470 	}
1471 
1472 	spin_lock(&ubifs_infos_lock);
1473 	list_add_tail(&c->infos_list, &ubifs_infos);
1474 	spin_unlock(&ubifs_infos_lock);
1475 
1476 	if (c->need_recovery) {
1477 		if (c->ro_mount)
1478 			ubifs_msg(c, "recovery deferred");
1479 		else {
1480 			c->need_recovery = 0;
1481 			ubifs_msg(c, "recovery completed");
1482 			/*
1483 			 * GC LEB has to be empty and taken at this point. But
1484 			 * the journal head LEBs may also be accounted as
1485 			 * "empty taken" if they are empty.
1486 			 */
1487 			ubifs_assert(c, c->lst.taken_empty_lebs > 0);
1488 		}
1489 	} else
1490 		ubifs_assert(c, c->lst.taken_empty_lebs > 0);
1491 
1492 	err = dbg_check_filesystem(c);
1493 	if (err)
1494 		goto out_infos;
1495 
1496 	dbg_debugfs_init_fs(c);
1497 
1498 	c->mounting = 0;
1499 
1500 	ubifs_msg(c, "UBIFS: mounted UBI device %d, volume %d, name \"%s\"%s",
1501 		  c->vi.ubi_num, c->vi.vol_id, c->vi.name,
1502 		  c->ro_mount ? ", R/O mode" : "");
1503 	x = (long long)c->main_lebs * c->leb_size;
1504 	y = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
1505 	ubifs_msg(c, "LEB size: %d bytes (%d KiB), min./max. I/O unit sizes: %d bytes/%d bytes",
1506 		  c->leb_size, c->leb_size >> 10, c->min_io_size,
1507 		  c->max_write_size);
1508 	ubifs_msg(c, "FS size: %lld bytes (%lld MiB, %d LEBs), max %d LEBs, journal size %lld bytes (%lld MiB, %d LEBs)",
1509 		  x, x >> 20, c->main_lebs, c->max_leb_cnt,
1510 		  y, y >> 20, c->log_lebs + c->max_bud_cnt);
1511 	ubifs_msg(c, "reserved for root: %llu bytes (%llu KiB)",
1512 		  c->report_rp_size, c->report_rp_size >> 10);
1513 	ubifs_msg(c, "media format: w%d/r%d (latest is w%d/r%d), UUID %pUB%s",
1514 		  c->fmt_version, c->ro_compat_version,
1515 		  UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION, c->uuid,
1516 		  c->big_lpt ? ", big LPT model" : ", small LPT model");
1517 
1518 	dbg_gen("default compressor:  %s", ubifs_compr_name(c, c->default_compr));
1519 	dbg_gen("data journal heads:  %d",
1520 		c->jhead_cnt - NONDATA_JHEADS_CNT);
1521 	dbg_gen("log LEBs:            %d (%d - %d)",
1522 		c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
1523 	dbg_gen("LPT area LEBs:       %d (%d - %d)",
1524 		c->lpt_lebs, c->lpt_first, c->lpt_last);
1525 	dbg_gen("orphan area LEBs:    %d (%d - %d)",
1526 		c->orph_lebs, c->orph_first, c->orph_last);
1527 	dbg_gen("main area LEBs:      %d (%d - %d)",
1528 		c->main_lebs, c->main_first, c->leb_cnt - 1);
1529 	dbg_gen("index LEBs:          %d", c->lst.idx_lebs);
1530 	dbg_gen("total index bytes:   %llu (%llu KiB, %llu MiB)",
1531 		c->bi.old_idx_sz, c->bi.old_idx_sz >> 10,
1532 		c->bi.old_idx_sz >> 20);
1533 	dbg_gen("key hash type:       %d", c->key_hash_type);
1534 	dbg_gen("tree fanout:         %d", c->fanout);
1535 	dbg_gen("reserved GC LEB:     %d", c->gc_lnum);
1536 	dbg_gen("max. znode size      %d", c->max_znode_sz);
1537 	dbg_gen("max. index node size %d", c->max_idx_node_sz);
1538 	dbg_gen("node sizes:          data %zu, inode %zu, dentry %zu",
1539 		UBIFS_DATA_NODE_SZ, UBIFS_INO_NODE_SZ, UBIFS_DENT_NODE_SZ);
1540 	dbg_gen("node sizes:          trun %zu, sb %zu, master %zu",
1541 		UBIFS_TRUN_NODE_SZ, UBIFS_SB_NODE_SZ, UBIFS_MST_NODE_SZ);
1542 	dbg_gen("node sizes:          ref %zu, cmt. start %zu, orph %zu",
1543 		UBIFS_REF_NODE_SZ, UBIFS_CS_NODE_SZ, UBIFS_ORPH_NODE_SZ);
1544 	dbg_gen("max. node sizes:     data %zu, inode %zu dentry %zu, idx %d",
1545 		UBIFS_MAX_DATA_NODE_SZ, UBIFS_MAX_INO_NODE_SZ,
1546 		UBIFS_MAX_DENT_NODE_SZ, ubifs_idx_node_sz(c, c->fanout));
1547 	dbg_gen("dead watermark:      %d", c->dead_wm);
1548 	dbg_gen("dark watermark:      %d", c->dark_wm);
1549 	dbg_gen("LEB overhead:        %d", c->leb_overhead);
1550 	x = (long long)c->main_lebs * c->dark_wm;
1551 	dbg_gen("max. dark space:     %lld (%lld KiB, %lld MiB)",
1552 		x, x >> 10, x >> 20);
1553 	dbg_gen("maximum bud bytes:   %lld (%lld KiB, %lld MiB)",
1554 		c->max_bud_bytes, c->max_bud_bytes >> 10,
1555 		c->max_bud_bytes >> 20);
1556 	dbg_gen("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1557 		c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1558 		c->bg_bud_bytes >> 20);
1559 	dbg_gen("current bud bytes    %lld (%lld KiB, %lld MiB)",
1560 		c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
1561 	dbg_gen("max. seq. number:    %llu", c->max_sqnum);
1562 	dbg_gen("commit number:       %llu", c->cmt_no);
1563 	dbg_gen("max. xattrs per inode: %d", ubifs_xattr_max_cnt(c));
1564 	dbg_gen("max orphans:           %d", c->max_orphans);
1565 
1566 	return 0;
1567 
1568 out_infos:
1569 	spin_lock(&ubifs_infos_lock);
1570 	list_del(&c->infos_list);
1571 	spin_unlock(&ubifs_infos_lock);
1572 out_orphans:
1573 	free_orphans(c);
1574 out_journal:
1575 	destroy_journal(c);
1576 out_lpt:
1577 	ubifs_lpt_free(c, 0);
1578 out_master:
1579 	kfree(c->mst_node);
1580 	kfree(c->rcvrd_mst_node);
1581 	if (c->bgt)
1582 		kthread_stop(c->bgt);
1583 out_wbufs:
1584 	free_wbufs(c);
1585 out_cbuf:
1586 	kfree(c->cbuf);
1587 out_auth:
1588 	ubifs_exit_authentication(c);
1589 out_free:
1590 	kfree(c->write_reserve_buf);
1591 	kfree(c->bu.buf);
1592 	vfree(c->ileb_buf);
1593 	vfree(c->sbuf);
1594 	kfree(c->bottom_up_buf);
1595 	kfree(c->sup_node);
1596 	ubifs_sysfs_unregister(c);
1597 out_debugging:
1598 	ubifs_debugging_exit(c);
1599 	return err;
1600 }
1601 
1602 /**
1603  * ubifs_umount - un-mount UBIFS file-system.
1604  * @c: UBIFS file-system description object
1605  *
1606  * Note, this function is called to free allocated resourced when un-mounting,
1607  * as well as free resources when an error occurred while we were half way
1608  * through mounting (error path cleanup function). So it has to make sure the
1609  * resource was actually allocated before freeing it.
1610  */
ubifs_umount(struct ubifs_info * c)1611 static void ubifs_umount(struct ubifs_info *c)
1612 {
1613 	dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1614 		c->vi.vol_id);
1615 
1616 	dbg_debugfs_exit_fs(c);
1617 	spin_lock(&ubifs_infos_lock);
1618 	list_del(&c->infos_list);
1619 	spin_unlock(&ubifs_infos_lock);
1620 
1621 	if (c->bgt)
1622 		kthread_stop(c->bgt);
1623 
1624 	destroy_journal(c);
1625 	free_wbufs(c);
1626 	free_orphans(c);
1627 	ubifs_lpt_free(c, 0);
1628 	ubifs_exit_authentication(c);
1629 
1630 	ubifs_release_options(c);
1631 	kfree(c->cbuf);
1632 	kfree(c->rcvrd_mst_node);
1633 	kfree(c->mst_node);
1634 	kfree(c->write_reserve_buf);
1635 	kfree(c->bu.buf);
1636 	vfree(c->ileb_buf);
1637 	vfree(c->sbuf);
1638 	kfree(c->bottom_up_buf);
1639 	kfree(c->sup_node);
1640 	ubifs_debugging_exit(c);
1641 	ubifs_sysfs_unregister(c);
1642 }
1643 
1644 /**
1645  * ubifs_remount_rw - re-mount in read-write mode.
1646  * @c: UBIFS file-system description object
1647  *
1648  * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1649  * mode. This function allocates the needed resources and re-mounts UBIFS in
1650  * read-write mode.
1651  */
ubifs_remount_rw(struct ubifs_info * c)1652 static int ubifs_remount_rw(struct ubifs_info *c)
1653 {
1654 	int err, lnum;
1655 
1656 	if (c->rw_incompat) {
1657 		ubifs_err(c, "the file-system is not R/W-compatible");
1658 		ubifs_msg(c, "on-flash format version is w%d/r%d, but software only supports up to version w%d/r%d",
1659 			  c->fmt_version, c->ro_compat_version,
1660 			  UBIFS_FORMAT_VERSION, UBIFS_RO_COMPAT_VERSION);
1661 		return -EROFS;
1662 	}
1663 
1664 	mutex_lock(&c->umount_mutex);
1665 	dbg_save_space_info(c);
1666 	c->remounting_rw = 1;
1667 	c->ro_mount = 0;
1668 
1669 	if (c->space_fixup) {
1670 		err = ubifs_fixup_free_space(c);
1671 		if (err)
1672 			goto out;
1673 	}
1674 
1675 	err = check_free_space(c);
1676 	if (err)
1677 		goto out;
1678 
1679 	if (c->need_recovery) {
1680 		ubifs_msg(c, "completing deferred recovery");
1681 		err = ubifs_write_rcvrd_mst_node(c);
1682 		if (err)
1683 			goto out;
1684 		if (!ubifs_authenticated(c)) {
1685 			err = ubifs_recover_size(c, true);
1686 			if (err)
1687 				goto out;
1688 		}
1689 		err = ubifs_clean_lebs(c, c->sbuf);
1690 		if (err)
1691 			goto out;
1692 		err = ubifs_recover_inl_heads(c, c->sbuf);
1693 		if (err)
1694 			goto out;
1695 	} else {
1696 		/* A readonly mount is not allowed to have orphans */
1697 		ubifs_assert(c, c->tot_orphans == 0);
1698 		err = ubifs_clear_orphans(c);
1699 		if (err)
1700 			goto out;
1701 	}
1702 
1703 	if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1704 		c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1705 		err = ubifs_write_master(c);
1706 		if (err)
1707 			goto out;
1708 	}
1709 
1710 	if (c->superblock_need_write) {
1711 		struct ubifs_sb_node *sup = c->sup_node;
1712 
1713 		err = ubifs_write_sb_node(c, sup);
1714 		if (err)
1715 			goto out;
1716 
1717 		c->superblock_need_write = 0;
1718 	}
1719 
1720 	c->ileb_buf = vmalloc(c->leb_size);
1721 	if (!c->ileb_buf) {
1722 		err = -ENOMEM;
1723 		goto out;
1724 	}
1725 
1726 	c->write_reserve_buf = kmalloc(COMPRESSED_DATA_NODE_BUF_SZ + \
1727 				       UBIFS_CIPHER_BLOCK_SIZE, GFP_KERNEL);
1728 	if (!c->write_reserve_buf) {
1729 		err = -ENOMEM;
1730 		goto out;
1731 	}
1732 
1733 	err = ubifs_lpt_init(c, 0, 1);
1734 	if (err)
1735 		goto out;
1736 
1737 	/* Create background thread */
1738 	c->bgt = kthread_run(ubifs_bg_thread, c, "%s", c->bgt_name);
1739 	if (IS_ERR(c->bgt)) {
1740 		err = PTR_ERR(c->bgt);
1741 		c->bgt = NULL;
1742 		ubifs_err(c, "cannot spawn \"%s\", error %d",
1743 			  c->bgt_name, err);
1744 		goto out;
1745 	}
1746 
1747 	c->orph_buf = vmalloc(c->leb_size);
1748 	if (!c->orph_buf) {
1749 		err = -ENOMEM;
1750 		goto out;
1751 	}
1752 
1753 	/* Check for enough log space */
1754 	lnum = c->lhead_lnum + 1;
1755 	if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1756 		lnum = UBIFS_LOG_LNUM;
1757 	if (lnum == c->ltail_lnum) {
1758 		err = ubifs_consolidate_log(c);
1759 		if (err)
1760 			goto out;
1761 	}
1762 
1763 	if (c->need_recovery) {
1764 		err = ubifs_rcvry_gc_commit(c);
1765 		if (err)
1766 			goto out;
1767 
1768 		if (ubifs_authenticated(c)) {
1769 			err = ubifs_recover_size(c, false);
1770 			if (err)
1771 				goto out;
1772 		}
1773 	} else {
1774 		err = ubifs_leb_unmap(c, c->gc_lnum);
1775 	}
1776 	if (err)
1777 		goto out;
1778 
1779 	dbg_gen("re-mounted read-write");
1780 	c->remounting_rw = 0;
1781 
1782 	if (c->need_recovery) {
1783 		c->need_recovery = 0;
1784 		ubifs_msg(c, "deferred recovery completed");
1785 	} else {
1786 		/*
1787 		 * Do not run the debugging space check if the were doing
1788 		 * recovery, because when we saved the information we had the
1789 		 * file-system in a state where the TNC and lprops has been
1790 		 * modified in memory, but all the I/O operations (including a
1791 		 * commit) were deferred. So the file-system was in
1792 		 * "non-committed" state. Now the file-system is in committed
1793 		 * state, and of course the amount of free space will change
1794 		 * because, for example, the old index size was imprecise.
1795 		 */
1796 		err = dbg_check_space_info(c);
1797 	}
1798 
1799 	mutex_unlock(&c->umount_mutex);
1800 	return err;
1801 
1802 out:
1803 	c->ro_mount = 1;
1804 	vfree(c->orph_buf);
1805 	c->orph_buf = NULL;
1806 	if (c->bgt) {
1807 		kthread_stop(c->bgt);
1808 		c->bgt = NULL;
1809 	}
1810 	kfree(c->write_reserve_buf);
1811 	c->write_reserve_buf = NULL;
1812 	vfree(c->ileb_buf);
1813 	c->ileb_buf = NULL;
1814 	ubifs_lpt_free(c, 1);
1815 	c->remounting_rw = 0;
1816 	mutex_unlock(&c->umount_mutex);
1817 	return err;
1818 }
1819 
1820 /**
1821  * ubifs_remount_ro - re-mount in read-only mode.
1822  * @c: UBIFS file-system description object
1823  *
1824  * We assume VFS has stopped writing. Possibly the background thread could be
1825  * running a commit, however kthread_stop will wait in that case.
1826  */
ubifs_remount_ro(struct ubifs_info * c)1827 static void ubifs_remount_ro(struct ubifs_info *c)
1828 {
1829 	int i, err;
1830 
1831 	ubifs_assert(c, !c->need_recovery);
1832 	ubifs_assert(c, !c->ro_mount);
1833 
1834 	mutex_lock(&c->umount_mutex);
1835 	if (c->bgt) {
1836 		kthread_stop(c->bgt);
1837 		c->bgt = NULL;
1838 	}
1839 
1840 	dbg_save_space_info(c);
1841 
1842 	for (i = 0; i < c->jhead_cnt; i++) {
1843 		err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
1844 		if (err)
1845 			ubifs_ro_mode(c, err);
1846 	}
1847 
1848 	c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1849 	c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1850 	c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1851 	err = ubifs_write_master(c);
1852 	if (err)
1853 		ubifs_ro_mode(c, err);
1854 
1855 	vfree(c->orph_buf);
1856 	c->orph_buf = NULL;
1857 	kfree(c->write_reserve_buf);
1858 	c->write_reserve_buf = NULL;
1859 	vfree(c->ileb_buf);
1860 	c->ileb_buf = NULL;
1861 	ubifs_lpt_free(c, 1);
1862 	c->ro_mount = 1;
1863 	err = dbg_check_space_info(c);
1864 	if (err)
1865 		ubifs_ro_mode(c, err);
1866 	mutex_unlock(&c->umount_mutex);
1867 }
1868 
ubifs_put_super(struct super_block * sb)1869 static void ubifs_put_super(struct super_block *sb)
1870 {
1871 	int i;
1872 	struct ubifs_info *c = sb->s_fs_info;
1873 
1874 	ubifs_msg(c, "un-mount UBI device %d", c->vi.ubi_num);
1875 
1876 	/*
1877 	 * The following asserts are only valid if there has not been a failure
1878 	 * of the media. For example, there will be dirty inodes if we failed
1879 	 * to write them back because of I/O errors.
1880 	 */
1881 	if (!c->ro_error) {
1882 		ubifs_assert(c, c->bi.idx_growth == 0);
1883 		ubifs_assert(c, c->bi.dd_growth == 0);
1884 		ubifs_assert(c, c->bi.data_growth == 0);
1885 	}
1886 
1887 	/*
1888 	 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1889 	 * and file system un-mount. Namely, it prevents the shrinker from
1890 	 * picking this superblock for shrinking - it will be just skipped if
1891 	 * the mutex is locked.
1892 	 */
1893 	mutex_lock(&c->umount_mutex);
1894 	if (!c->ro_mount) {
1895 		/*
1896 		 * First of all kill the background thread to make sure it does
1897 		 * not interfere with un-mounting and freeing resources.
1898 		 */
1899 		if (c->bgt) {
1900 			kthread_stop(c->bgt);
1901 			c->bgt = NULL;
1902 		}
1903 
1904 		/*
1905 		 * On fatal errors c->ro_error is set to 1, in which case we do
1906 		 * not write the master node.
1907 		 */
1908 		if (!c->ro_error) {
1909 			int err;
1910 
1911 			/* Synchronize write-buffers */
1912 			for (i = 0; i < c->jhead_cnt; i++) {
1913 				err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
1914 				if (err)
1915 					ubifs_ro_mode(c, err);
1916 			}
1917 
1918 			/*
1919 			 * We are being cleanly unmounted which means the
1920 			 * orphans were killed - indicate this in the master
1921 			 * node. Also save the reserved GC LEB number.
1922 			 */
1923 			c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1924 			c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1925 			c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1926 			err = ubifs_write_master(c);
1927 			if (err)
1928 				/*
1929 				 * Recovery will attempt to fix the master area
1930 				 * next mount, so we just print a message and
1931 				 * continue to unmount normally.
1932 				 */
1933 				ubifs_err(c, "failed to write master node, error %d",
1934 					  err);
1935 		} else {
1936 			for (i = 0; i < c->jhead_cnt; i++)
1937 				/* Make sure write-buffer timers are canceled */
1938 				hrtimer_cancel(&c->jheads[i].wbuf.timer);
1939 		}
1940 	}
1941 
1942 	ubifs_umount(c);
1943 	ubi_close_volume(c->ubi);
1944 	mutex_unlock(&c->umount_mutex);
1945 }
1946 
ubifs_reconfigure(struct fs_context * fc)1947 static int ubifs_reconfigure(struct fs_context *fc)
1948 {
1949 	struct ubifs_fs_context *ctx = fc->fs_private;
1950 	struct super_block *sb = fc->root->d_sb;
1951 	int err;
1952 	struct ubifs_info *c = sb->s_fs_info;
1953 
1954 	sync_filesystem(sb);
1955 	dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, fc->sb_flags);
1956 
1957 	/*
1958 	 * Apply the mount option changes.
1959 	 * auth_key_name and auth_hash_name are ignored on remount.
1960 	 */
1961 	c->mount_opts		= ctx->mount_opts;
1962 	c->bulk_read		= ctx->bulk_read;
1963 	c->no_chk_data_crc	= ctx->no_chk_data_crc;
1964 	c->default_compr	= ctx->default_compr;
1965 	c->assert_action	= ctx->assert_action;
1966 
1967 	if (c->ro_mount && !(fc->sb_flags & SB_RDONLY)) {
1968 		if (c->ro_error) {
1969 			ubifs_msg(c, "cannot re-mount R/W due to prior errors");
1970 			return -EROFS;
1971 		}
1972 		if (c->ro_media) {
1973 			ubifs_msg(c, "cannot re-mount R/W - UBI volume is R/O");
1974 			return -EROFS;
1975 		}
1976 		err = ubifs_remount_rw(c);
1977 		if (err)
1978 			return err;
1979 	} else if (!c->ro_mount && (fc->sb_flags & SB_RDONLY)) {
1980 		if (c->ro_error) {
1981 			ubifs_msg(c, "cannot re-mount R/O due to prior errors");
1982 			return -EROFS;
1983 		}
1984 		ubifs_remount_ro(c);
1985 	}
1986 
1987 	if (c->bulk_read == 1)
1988 		bu_init(c);
1989 	else {
1990 		dbg_gen("disable bulk-read");
1991 		mutex_lock(&c->bu_mutex);
1992 		kfree(c->bu.buf);
1993 		c->bu.buf = NULL;
1994 		mutex_unlock(&c->bu_mutex);
1995 	}
1996 
1997 	if (!c->need_recovery)
1998 		ubifs_assert(c, c->lst.taken_empty_lebs > 0);
1999 
2000 	return 0;
2001 }
2002 
2003 const struct super_operations ubifs_super_operations = {
2004 	.alloc_inode   = ubifs_alloc_inode,
2005 	.free_inode    = ubifs_free_inode,
2006 	.put_super     = ubifs_put_super,
2007 	.write_inode   = ubifs_write_inode,
2008 	.drop_inode    = ubifs_drop_inode,
2009 	.evict_inode   = ubifs_evict_inode,
2010 	.statfs        = ubifs_statfs,
2011 	.dirty_inode   = ubifs_dirty_inode,
2012 	.show_options  = ubifs_show_options,
2013 	.sync_fs       = ubifs_sync_fs,
2014 };
2015 
2016 /**
2017  * open_ubi - parse UBI device name string and open the UBI device.
2018  * @fc: The filesystem context
2019  * @mode: UBI volume open mode
2020  *
2021  * The primary method of mounting UBIFS is by specifying the UBI volume
2022  * character device node path. However, UBIFS may also be mounted without any
2023  * character device node using one of the following methods:
2024  *
2025  * o ubiX_Y    - mount UBI device number X, volume Y;
2026  * o ubiY      - mount UBI device number 0, volume Y;
2027  * o ubiX:NAME - mount UBI device X, volume with name NAME;
2028  * o ubi:NAME  - mount UBI device 0, volume with name NAME.
2029  *
2030  * Alternative '!' separator may be used instead of ':' (because some shells
2031  * like busybox may interpret ':' as an NFS host name separator). This function
2032  * returns UBI volume description object in case of success and a negative
2033  * error code in case of failure.
2034  */
open_ubi(struct fs_context * fc,int mode)2035 static struct ubi_volume_desc *open_ubi(struct fs_context *fc, int mode)
2036 {
2037 	struct ubi_volume_desc *ubi;
2038 	const char *name = fc->source;
2039 	int dev, vol;
2040 	char *endptr;
2041 
2042 	/* First, try to open using the device node path method */
2043 	ubi = ubi_open_volume_path(name, mode);
2044 	if (!IS_ERR(ubi))
2045 		return ubi;
2046 
2047 	/* Try the "nodev" method */
2048 	if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
2049 		goto invalid_source;
2050 
2051 	/* ubi:NAME method */
2052 	if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
2053 		return ubi_open_volume_nm(0, name + 4, mode);
2054 
2055 	if (!isdigit(name[3]))
2056 		goto invalid_source;
2057 
2058 	dev = simple_strtoul(name + 3, &endptr, 0);
2059 
2060 	/* ubiY method */
2061 	if (*endptr == '\0')
2062 		return ubi_open_volume(0, dev, mode);
2063 
2064 	/* ubiX_Y method */
2065 	if (*endptr == '_' && isdigit(endptr[1])) {
2066 		vol = simple_strtoul(endptr + 1, &endptr, 0);
2067 		if (*endptr != '\0')
2068 			goto invalid_source;
2069 		return ubi_open_volume(dev, vol, mode);
2070 	}
2071 
2072 	/* ubiX:NAME method */
2073 	if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
2074 		return ubi_open_volume_nm(dev, ++endptr, mode);
2075 
2076 invalid_source:
2077 	return ERR_PTR(invalf(fc, "Invalid source name"));
2078 }
2079 
alloc_ubifs_info(struct ubi_volume_desc * ubi)2080 static struct ubifs_info *alloc_ubifs_info(struct ubi_volume_desc *ubi)
2081 {
2082 	struct ubifs_info *c;
2083 
2084 	c = kzalloc_obj(struct ubifs_info);
2085 	if (c) {
2086 		spin_lock_init(&c->cnt_lock);
2087 		spin_lock_init(&c->cs_lock);
2088 		spin_lock_init(&c->buds_lock);
2089 		spin_lock_init(&c->space_lock);
2090 		spin_lock_init(&c->orphan_lock);
2091 		init_rwsem(&c->commit_sem);
2092 		mutex_init(&c->lp_mutex);
2093 		mutex_init(&c->tnc_mutex);
2094 		mutex_init(&c->log_mutex);
2095 		mutex_init(&c->umount_mutex);
2096 		mutex_init(&c->bu_mutex);
2097 		mutex_init(&c->write_reserve_mutex);
2098 		init_waitqueue_head(&c->cmt_wq);
2099 		init_waitqueue_head(&c->reserve_space_wq);
2100 		atomic_set(&c->need_wait_space, 0);
2101 		c->buds = RB_ROOT;
2102 		c->old_idx = RB_ROOT;
2103 		c->size_tree = RB_ROOT;
2104 		c->orph_tree = RB_ROOT;
2105 		INIT_LIST_HEAD(&c->infos_list);
2106 		INIT_LIST_HEAD(&c->idx_gc);
2107 		INIT_LIST_HEAD(&c->replay_list);
2108 		INIT_LIST_HEAD(&c->replay_buds);
2109 		INIT_LIST_HEAD(&c->uncat_list);
2110 		INIT_LIST_HEAD(&c->empty_list);
2111 		INIT_LIST_HEAD(&c->freeable_list);
2112 		INIT_LIST_HEAD(&c->frdi_idx_list);
2113 		INIT_LIST_HEAD(&c->unclean_leb_list);
2114 		INIT_LIST_HEAD(&c->old_buds);
2115 		INIT_LIST_HEAD(&c->orph_list);
2116 		INIT_LIST_HEAD(&c->orph_new);
2117 		c->no_chk_data_crc = 1;
2118 		c->assert_action = ASSACT_RO;
2119 
2120 		c->highest_inum = UBIFS_FIRST_INO;
2121 		c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
2122 
2123 		ubi_get_volume_info(ubi, &c->vi);
2124 		ubi_get_device_info(c->vi.ubi_num, &c->di);
2125 	}
2126 	return c;
2127 }
2128 
ubifs_fill_super(struct super_block * sb,struct fs_context * fc)2129 static int ubifs_fill_super(struct super_block *sb, struct fs_context *fc)
2130 {
2131 	struct ubifs_info *c = sb->s_fs_info;
2132 	struct ubifs_fs_context *ctx = fc->fs_private;
2133 	struct inode *root;
2134 	int err;
2135 
2136 	c->vfs_sb = sb;
2137 	/* Re-open the UBI device in read-write mode */
2138 	c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
2139 	if (IS_ERR(c->ubi)) {
2140 		err = PTR_ERR(c->ubi);
2141 		goto out;
2142 	}
2143 
2144 	/* Copy in parsed mount options */
2145 	c->mount_opts		= ctx->mount_opts;
2146 	c->auth_key_name	= ctx->auth_key_name;
2147 	c->auth_hash_name	= ctx->auth_hash_name;
2148 	c->no_chk_data_crc	= ctx->no_chk_data_crc;
2149 	c->bulk_read		= ctx->bulk_read;
2150 	c->default_compr	= ctx->default_compr;
2151 	c->assert_action	= ctx->assert_action;
2152 
2153 	/* ubifs_info owns auth strings now */
2154 	ctx->auth_key_name = NULL;
2155 	ctx->auth_hash_name = NULL;
2156 
2157 	/*
2158 	 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
2159 	 * UBIFS, I/O is not deferred, it is done immediately in read_folio,
2160 	 * which means the user would have to wait not just for their own I/O
2161 	 * but the read-ahead I/O as well i.e. completely pointless.
2162 	 *
2163 	 * Read-ahead will be disabled because @sb->s_bdi->ra_pages is 0. Also
2164 	 * @sb->s_bdi->capabilities are initialized to 0 so there won't be any
2165 	 * writeback happening.
2166 	 */
2167 	err = super_setup_bdi_name(sb, "ubifs_%d_%d", c->vi.ubi_num,
2168 				   c->vi.vol_id);
2169 	if (err)
2170 		goto out_close;
2171 	sb->s_bdi->ra_pages = 0;
2172 	sb->s_bdi->io_pages = 0;
2173 
2174 	sb->s_fs_info = c;
2175 	sb->s_magic = UBIFS_SUPER_MAGIC;
2176 	sb->s_blocksize = UBIFS_BLOCK_SIZE;
2177 	sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
2178 	sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
2179 	if (c->max_inode_sz > MAX_LFS_FILESIZE)
2180 		sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
2181 	sb->s_op = &ubifs_super_operations;
2182 	sb->s_xattr = ubifs_xattr_handlers;
2183 	fscrypt_set_ops(sb, &ubifs_crypt_operations);
2184 
2185 	mutex_lock(&c->umount_mutex);
2186 	err = mount_ubifs(c);
2187 	if (err) {
2188 		ubifs_assert(c, err < 0);
2189 		goto out_unlock;
2190 	}
2191 
2192 	/* Read the root inode */
2193 	root = ubifs_iget(sb, UBIFS_ROOT_INO);
2194 	if (IS_ERR(root)) {
2195 		err = PTR_ERR(root);
2196 		goto out_umount;
2197 	}
2198 
2199 	generic_set_sb_d_ops(sb);
2200 	sb->s_root = d_make_root(root);
2201 	if (!sb->s_root) {
2202 		err = -ENOMEM;
2203 		goto out_umount;
2204 	}
2205 
2206 	super_set_uuid(sb, c->uuid, sizeof(c->uuid));
2207 	super_set_sysfs_name_generic(sb, UBIFS_DFS_DIR_NAME,
2208 				     c->vi.ubi_num, c->vi.vol_id);
2209 
2210 	mutex_unlock(&c->umount_mutex);
2211 	return 0;
2212 
2213 out_umount:
2214 	ubifs_umount(c);
2215 out_unlock:
2216 	mutex_unlock(&c->umount_mutex);
2217 out_close:
2218 	ubifs_release_options(c);
2219 	ubi_close_volume(c->ubi);
2220 out:
2221 	return err;
2222 }
2223 
sb_test(struct super_block * sb,struct fs_context * fc)2224 static int sb_test(struct super_block *sb, struct fs_context *fc)
2225 {
2226 	struct ubifs_info *c1 = fc->s_fs_info;
2227 	struct ubifs_info *c = sb->s_fs_info;
2228 
2229 	return c->vi.cdev == c1->vi.cdev;
2230 }
2231 
ubifs_get_tree(struct fs_context * fc)2232 static int ubifs_get_tree(struct fs_context *fc)
2233 {
2234 	struct ubi_volume_desc *ubi;
2235 	struct ubifs_info *c;
2236 	struct super_block *sb;
2237 	int err;
2238 
2239 	if (!fc->source || !*fc->source)
2240 		return invalf(fc, "No source specified");
2241 
2242 	dbg_gen("name %s, flags %#x", fc->source, fc->sb_flags);
2243 
2244 	/*
2245 	 * Get UBI device number and volume ID. Mount it read-only so far
2246 	 * because this might be a new mount point, and UBI allows only one
2247 	 * read-write user at a time.
2248 	 */
2249 	ubi = open_ubi(fc, UBI_READONLY);
2250 	if (IS_ERR(ubi)) {
2251 		err = PTR_ERR(ubi);
2252 		if (!(fc->sb_flags & SB_SILENT))
2253 			pr_err("UBIFS error (pid: %d): cannot open \"%s\", error %d",
2254 			       current->pid, fc->source, err);
2255 		return err;
2256 	}
2257 
2258 	c = alloc_ubifs_info(ubi);
2259 	if (!c) {
2260 		err = -ENOMEM;
2261 		goto out_close;
2262 	}
2263 	fc->s_fs_info = c;
2264 
2265 	dbg_gen("opened ubi%d_%d", c->vi.ubi_num, c->vi.vol_id);
2266 
2267 	sb = sget_fc(fc, sb_test, set_anon_super_fc);
2268 	if (IS_ERR(sb)) {
2269 		err = PTR_ERR(sb);
2270 		kfree(c);
2271 		goto out_close;
2272 	}
2273 
2274 	if (sb->s_root) {
2275 		struct ubifs_info *c1 = sb->s_fs_info;
2276 		kfree(c);
2277 		/* A new mount point for already mounted UBIFS */
2278 		dbg_gen("this ubi volume is already mounted");
2279 		if (!!(fc->sb_flags & SB_RDONLY) != c1->ro_mount) {
2280 			err = -EBUSY;
2281 			goto out_deact;
2282 		}
2283 	} else {
2284 		err = ubifs_fill_super(sb, fc);
2285 		if (err)
2286 			goto out_deact;
2287 		/* We do not support atime */
2288 		sb->s_flags |= SB_ACTIVE;
2289 		if (IS_ENABLED(CONFIG_UBIFS_ATIME_SUPPORT))
2290 			ubifs_msg(c, "full atime support is enabled.");
2291 		else
2292 			sb->s_flags |= SB_NOATIME;
2293 	}
2294 
2295 	/* 'fill_super()' opens ubi again so we must close it here */
2296 	ubi_close_volume(ubi);
2297 
2298 	fc->root = dget(sb->s_root);
2299 	return 0;
2300 
2301 out_deact:
2302 	deactivate_locked_super(sb);
2303 out_close:
2304 	ubi_close_volume(ubi);
2305 	return err;
2306 }
2307 
kill_ubifs_super(struct super_block * s)2308 static void kill_ubifs_super(struct super_block *s)
2309 {
2310 	struct ubifs_info *c = s->s_fs_info;
2311 	kill_anon_super(s);
2312 	kfree(c);
2313 }
2314 
ubifs_free_fc(struct fs_context * fc)2315 static void ubifs_free_fc(struct fs_context *fc)
2316 {
2317 	struct ubifs_fs_context *ctx = fc->fs_private;
2318 
2319 	if (ctx) {
2320 		kfree(ctx->auth_key_name);
2321 		kfree(ctx->auth_hash_name);
2322 		kfree(ctx);
2323 	}
2324 }
2325 
2326 static const struct fs_context_operations ubifs_context_ops = {
2327 	.free		= ubifs_free_fc,
2328 	.parse_param	= ubifs_parse_param,
2329 	.get_tree	= ubifs_get_tree,
2330 	.reconfigure	= ubifs_reconfigure,
2331 };
2332 
ubifs_init_fs_context(struct fs_context * fc)2333 static int ubifs_init_fs_context(struct fs_context *fc)
2334 {
2335 	struct ubifs_fs_context *ctx;
2336 
2337 	ctx = kzalloc_obj(struct ubifs_fs_context);
2338 	if (!ctx)
2339 		return -ENOMEM;
2340 
2341 	if (fc->purpose != FS_CONTEXT_FOR_RECONFIGURE) {
2342 		/* Iniitialize for first mount */
2343 		ctx->no_chk_data_crc = 1;
2344 		ctx->assert_action = ASSACT_RO;
2345 	} else {
2346 		struct ubifs_info *c = fc->root->d_sb->s_fs_info;
2347 
2348 		/*
2349 		 * Preserve existing options across remounts.
2350 		 * auth_key_name and auth_hash_name are not remountable.
2351 		 */
2352 		ctx->mount_opts		= c->mount_opts;
2353 		ctx->bulk_read		= c->bulk_read;
2354 		ctx->no_chk_data_crc	= c->no_chk_data_crc;
2355 		ctx->default_compr	= c->default_compr;
2356 		ctx->assert_action	= c->assert_action;
2357 	}
2358 
2359 	fc->ops = &ubifs_context_ops;
2360 	fc->fs_private = ctx;
2361 
2362 	return 0;
2363 }
2364 
2365 static struct file_system_type ubifs_fs_type = {
2366 	.name    = "ubifs",
2367 	.owner   = THIS_MODULE,
2368 	.init_fs_context = ubifs_init_fs_context,
2369 	.parameters	= ubifs_fs_param_spec,
2370 	.kill_sb = kill_ubifs_super,
2371 };
2372 MODULE_ALIAS_FS("ubifs");
2373 
2374 /*
2375  * Inode slab cache constructor.
2376  */
inode_slab_ctor(void * obj)2377 static void inode_slab_ctor(void *obj)
2378 {
2379 	struct ubifs_inode *ui = obj;
2380 	inode_init_once(&ui->vfs_inode);
2381 }
2382 
ubifs_init(void)2383 static int __init ubifs_init(void)
2384 {
2385 	int err = -ENOMEM;
2386 
2387 	BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2388 
2389 	/* Make sure node sizes are 8-byte aligned */
2390 	BUILD_BUG_ON(UBIFS_CH_SZ        & 7);
2391 	BUILD_BUG_ON(UBIFS_INO_NODE_SZ  & 7);
2392 	BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2393 	BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2394 	BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2395 	BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2396 	BUILD_BUG_ON(UBIFS_SB_NODE_SZ   & 7);
2397 	BUILD_BUG_ON(UBIFS_MST_NODE_SZ  & 7);
2398 	BUILD_BUG_ON(UBIFS_REF_NODE_SZ  & 7);
2399 	BUILD_BUG_ON(UBIFS_CS_NODE_SZ   & 7);
2400 	BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2401 
2402 	BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2403 	BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2404 	BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2405 	BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ  & 7);
2406 	BUILD_BUG_ON(UBIFS_MAX_NODE_SZ      & 7);
2407 	BUILD_BUG_ON(MIN_WRITE_SZ           & 7);
2408 
2409 	/* Check min. node size */
2410 	BUILD_BUG_ON(UBIFS_INO_NODE_SZ  < MIN_WRITE_SZ);
2411 	BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2412 	BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2413 	BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2414 
2415 	BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2416 	BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2417 	BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2418 	BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ  > UBIFS_MAX_NODE_SZ);
2419 
2420 	/* Defined node sizes */
2421 	BUILD_BUG_ON(UBIFS_SB_NODE_SZ  != 4096);
2422 	BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2423 	BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2424 	BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2425 
2426 	/*
2427 	 * We use 2 bit wide bit-fields to store compression type, which should
2428 	 * be amended if more compressors are added. The bit-fields are:
2429 	 * @compr_type in 'struct ubifs_inode', @default_compr in
2430 	 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
2431 	 */
2432 	BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2433 
2434 	/*
2435 	 * We require that PAGE_SIZE is greater-than-or-equal-to
2436 	 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2437 	 */
2438 	if (PAGE_SIZE < UBIFS_BLOCK_SIZE) {
2439 		pr_err("UBIFS error (pid %d): VFS page cache size is %u bytes, but UBIFS requires at least 4096 bytes",
2440 		       current->pid, (unsigned int)PAGE_SIZE);
2441 		return -EINVAL;
2442 	}
2443 
2444 	ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2445 				sizeof(struct ubifs_inode), 0,
2446 				SLAB_RECLAIM_ACCOUNT | SLAB_ACCOUNT,
2447 				&inode_slab_ctor);
2448 	if (!ubifs_inode_slab)
2449 		return -ENOMEM;
2450 
2451 	ubifs_shrinker_info = shrinker_alloc(0, "ubifs-slab");
2452 	if (!ubifs_shrinker_info)
2453 		goto out_slab;
2454 
2455 	ubifs_shrinker_info->count_objects = ubifs_shrink_count;
2456 	ubifs_shrinker_info->scan_objects = ubifs_shrink_scan;
2457 
2458 	shrinker_register(ubifs_shrinker_info);
2459 
2460 	err = ubifs_compressors_init();
2461 	if (err)
2462 		goto out_shrinker;
2463 
2464 	dbg_debugfs_init();
2465 
2466 	err = ubifs_sysfs_init();
2467 	if (err)
2468 		goto out_dbg;
2469 
2470 	err = register_filesystem(&ubifs_fs_type);
2471 	if (err) {
2472 		pr_err("UBIFS error (pid %d): cannot register file system, error %d",
2473 		       current->pid, err);
2474 		goto out_sysfs;
2475 	}
2476 	return 0;
2477 
2478 out_sysfs:
2479 	ubifs_sysfs_exit();
2480 out_dbg:
2481 	dbg_debugfs_exit();
2482 	ubifs_compressors_exit();
2483 out_shrinker:
2484 	shrinker_free(ubifs_shrinker_info);
2485 out_slab:
2486 	kmem_cache_destroy(ubifs_inode_slab);
2487 	return err;
2488 }
2489 /* late_initcall to let compressors initialize first */
2490 late_initcall(ubifs_init);
2491 
ubifs_exit(void)2492 static void __exit ubifs_exit(void)
2493 {
2494 	WARN_ON(!list_empty(&ubifs_infos));
2495 	WARN_ON(atomic_long_read(&ubifs_clean_zn_cnt) != 0);
2496 
2497 	dbg_debugfs_exit();
2498 	ubifs_sysfs_exit();
2499 	ubifs_compressors_exit();
2500 	shrinker_free(ubifs_shrinker_info);
2501 
2502 	/*
2503 	 * Make sure all delayed rcu free inodes are flushed before we
2504 	 * destroy cache.
2505 	 */
2506 	rcu_barrier();
2507 	kmem_cache_destroy(ubifs_inode_slab);
2508 	unregister_filesystem(&ubifs_fs_type);
2509 }
2510 module_exit(ubifs_exit);
2511 
2512 MODULE_LICENSE("GPL");
2513 MODULE_VERSION(__stringify(UBIFS_VERSION));
2514 MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2515 MODULE_DESCRIPTION("UBIFS - UBI File System");
2516