2 * This file is part of UBIFS.
4 * Copyright (C) 2006-2008 Nokia Corporation.
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.
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
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
19 * Authors: Artem Bityutskiy (Битюцкий Артём)
24 * This file implements UBIFS initialization and VFS superblock operations. Some
25 * initialization stuff which is rather large and complex is placed at
26 * corresponding subsystems, but most of it is here.
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/module.h>
32 #include <linux/ctype.h>
33 #include <linux/kthread.h>
34 #include <linux/parser.h>
35 #include <linux/seq_file.h>
36 #include <linux/mount.h>
37 #include <linux/math64.h>
38 #include <linux/writeback.h>
42 * Maximum amount of memory we may 'kmalloc()' without worrying that we are
43 * allocating too much.
45 #define UBIFS_KMALLOC_OK (128*1024)
47 /* Slab cache for UBIFS inodes */
48 struct kmem_cache *ubifs_inode_slab;
50 /* UBIFS TNC shrinker description */
51 static struct shrinker ubifs_shrinker_info = {
52 .shrink = ubifs_shrinker,
53 .seeks = DEFAULT_SEEKS,
57 * validate_inode - validate inode.
58 * @c: UBIFS file-system description object
59 * @inode: the inode to validate
61 * This is a helper function for 'ubifs_iget()' which validates various fields
62 * of a newly built inode to make sure they contain sane values and prevent
63 * possible vulnerabilities. Returns zero if the inode is all right and
64 * a non-zero error code if not.
66 static int validate_inode(struct ubifs_info *c, const struct inode *inode)
69 const struct ubifs_inode *ui = ubifs_inode(inode);
71 if (inode->i_size > c->max_inode_sz) {
72 ubifs_err("inode is too large (%lld)",
73 (long long)inode->i_size);
77 if (ui->compr_type < 0 || ui->compr_type >= UBIFS_COMPR_TYPES_CNT) {
78 ubifs_err("unknown compression type %d", ui->compr_type);
82 if (ui->xattr_names + ui->xattr_cnt > XATTR_LIST_MAX)
85 if (ui->data_len < 0 || ui->data_len > UBIFS_MAX_INO_DATA)
88 if (ui->xattr && (inode->i_mode & S_IFMT) != S_IFREG)
91 if (!ubifs_compr_present(ui->compr_type)) {
92 ubifs_warn("inode %lu uses '%s' compression, but it was not "
93 "compiled in", inode->i_ino,
94 ubifs_compr_name(ui->compr_type));
97 err = dbg_check_dir_size(c, inode);
101 struct inode *ubifs_iget(struct super_block *sb, unsigned long inum)
105 struct ubifs_ino_node *ino;
106 struct ubifs_info *c = sb->s_fs_info;
108 struct ubifs_inode *ui;
110 dbg_gen("inode %lu", inum);
112 inode = iget_locked(sb, inum);
114 return ERR_PTR(-ENOMEM);
115 if (!(inode->i_state & I_NEW))
117 ui = ubifs_inode(inode);
119 ino = kmalloc(UBIFS_MAX_INO_NODE_SZ, GFP_NOFS);
125 ino_key_init(c, &key, inode->i_ino);
127 err = ubifs_tnc_lookup(c, &key, ino);
131 inode->i_flags |= (S_NOCMTIME | S_NOATIME);
132 inode->i_nlink = le32_to_cpu(ino->nlink);
133 inode->i_uid = le32_to_cpu(ino->uid);
134 inode->i_gid = le32_to_cpu(ino->gid);
135 inode->i_atime.tv_sec = (int64_t)le64_to_cpu(ino->atime_sec);
136 inode->i_atime.tv_nsec = le32_to_cpu(ino->atime_nsec);
137 inode->i_mtime.tv_sec = (int64_t)le64_to_cpu(ino->mtime_sec);
138 inode->i_mtime.tv_nsec = le32_to_cpu(ino->mtime_nsec);
139 inode->i_ctime.tv_sec = (int64_t)le64_to_cpu(ino->ctime_sec);
140 inode->i_ctime.tv_nsec = le32_to_cpu(ino->ctime_nsec);
141 inode->i_mode = le32_to_cpu(ino->mode);
142 inode->i_size = le64_to_cpu(ino->size);
144 ui->data_len = le32_to_cpu(ino->data_len);
145 ui->flags = le32_to_cpu(ino->flags);
146 ui->compr_type = le16_to_cpu(ino->compr_type);
147 ui->creat_sqnum = le64_to_cpu(ino->creat_sqnum);
148 ui->xattr_cnt = le32_to_cpu(ino->xattr_cnt);
149 ui->xattr_size = le32_to_cpu(ino->xattr_size);
150 ui->xattr_names = le32_to_cpu(ino->xattr_names);
151 ui->synced_i_size = ui->ui_size = inode->i_size;
153 ui->xattr = (ui->flags & UBIFS_XATTR_FL) ? 1 : 0;
155 err = validate_inode(c, inode);
159 /* Disable read-ahead */
160 inode->i_mapping->backing_dev_info = &c->bdi;
162 switch (inode->i_mode & S_IFMT) {
164 inode->i_mapping->a_ops = &ubifs_file_address_operations;
165 inode->i_op = &ubifs_file_inode_operations;
166 inode->i_fop = &ubifs_file_operations;
168 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
173 memcpy(ui->data, ino->data, ui->data_len);
174 ((char *)ui->data)[ui->data_len] = '\0';
175 } else if (ui->data_len != 0) {
181 inode->i_op = &ubifs_dir_inode_operations;
182 inode->i_fop = &ubifs_dir_operations;
183 if (ui->data_len != 0) {
189 inode->i_op = &ubifs_symlink_inode_operations;
190 if (ui->data_len <= 0 || ui->data_len > UBIFS_MAX_INO_DATA) {
194 ui->data = kmalloc(ui->data_len + 1, GFP_NOFS);
199 memcpy(ui->data, ino->data, ui->data_len);
200 ((char *)ui->data)[ui->data_len] = '\0';
206 union ubifs_dev_desc *dev;
208 ui->data = kmalloc(sizeof(union ubifs_dev_desc), GFP_NOFS);
214 dev = (union ubifs_dev_desc *)ino->data;
215 if (ui->data_len == sizeof(dev->new))
216 rdev = new_decode_dev(le32_to_cpu(dev->new));
217 else if (ui->data_len == sizeof(dev->huge))
218 rdev = huge_decode_dev(le64_to_cpu(dev->huge));
223 memcpy(ui->data, ino->data, ui->data_len);
224 inode->i_op = &ubifs_file_inode_operations;
225 init_special_inode(inode, inode->i_mode, rdev);
230 inode->i_op = &ubifs_file_inode_operations;
231 init_special_inode(inode, inode->i_mode, 0);
232 if (ui->data_len != 0) {
243 ubifs_set_inode_flags(inode);
244 unlock_new_inode(inode);
248 ubifs_err("inode %lu validation failed, error %d", inode->i_ino, err);
249 dbg_dump_node(c, ino);
250 dbg_dump_inode(c, inode);
255 ubifs_err("failed to read inode %lu, error %d", inode->i_ino, err);
260 static struct inode *ubifs_alloc_inode(struct super_block *sb)
262 struct ubifs_inode *ui;
264 ui = kmem_cache_alloc(ubifs_inode_slab, GFP_NOFS);
268 memset((void *)ui + sizeof(struct inode), 0,
269 sizeof(struct ubifs_inode) - sizeof(struct inode));
270 mutex_init(&ui->ui_mutex);
271 spin_lock_init(&ui->ui_lock);
272 return &ui->vfs_inode;
275 static void ubifs_destroy_inode(struct inode *inode)
277 struct ubifs_inode *ui = ubifs_inode(inode);
280 kmem_cache_free(ubifs_inode_slab, inode);
284 * Note, Linux write-back code calls this without 'i_mutex'.
286 static int ubifs_write_inode(struct inode *inode, int wait)
289 struct ubifs_info *c = inode->i_sb->s_fs_info;
290 struct ubifs_inode *ui = ubifs_inode(inode);
292 ubifs_assert(!ui->xattr);
293 if (is_bad_inode(inode))
296 mutex_lock(&ui->ui_mutex);
298 * Due to races between write-back forced by budgeting
299 * (see 'sync_some_inodes()') and pdflush write-back, the inode may
300 * have already been synchronized, do not do this again. This might
301 * also happen if it was synchronized in an VFS operation, e.g.
305 mutex_unlock(&ui->ui_mutex);
310 * As an optimization, do not write orphan inodes to the media just
311 * because this is not needed.
313 dbg_gen("inode %lu, mode %#x, nlink %u",
314 inode->i_ino, (int)inode->i_mode, inode->i_nlink);
315 if (inode->i_nlink) {
316 err = ubifs_jnl_write_inode(c, inode);
318 ubifs_err("can't write inode %lu, error %d",
323 mutex_unlock(&ui->ui_mutex);
324 ubifs_release_dirty_inode_budget(c, ui);
328 static void ubifs_delete_inode(struct inode *inode)
331 struct ubifs_info *c = inode->i_sb->s_fs_info;
332 struct ubifs_inode *ui = ubifs_inode(inode);
336 * Extended attribute inode deletions are fully handled in
337 * 'ubifs_removexattr()'. These inodes are special and have
338 * limited usage, so there is nothing to do here.
342 dbg_gen("inode %lu, mode %#x", inode->i_ino, (int)inode->i_mode);
343 ubifs_assert(!atomic_read(&inode->i_count));
344 ubifs_assert(inode->i_nlink == 0);
346 truncate_inode_pages(&inode->i_data, 0);
347 if (is_bad_inode(inode))
350 ui->ui_size = inode->i_size = 0;
351 err = ubifs_jnl_delete_inode(c, inode);
354 * Worst case we have a lost orphan inode wasting space, so a
355 * simple error message is OK here.
357 ubifs_err("can't delete inode %lu, error %d",
362 ubifs_release_dirty_inode_budget(c, ui);
366 static void ubifs_dirty_inode(struct inode *inode)
368 struct ubifs_inode *ui = ubifs_inode(inode);
370 ubifs_assert(mutex_is_locked(&ui->ui_mutex));
373 dbg_gen("inode %lu", inode->i_ino);
377 static int ubifs_statfs(struct dentry *dentry, struct kstatfs *buf)
379 struct ubifs_info *c = dentry->d_sb->s_fs_info;
380 unsigned long long free;
381 __le32 *uuid = (__le32 *)c->uuid;
383 free = ubifs_get_free_space(c);
384 dbg_gen("free space %lld bytes (%lld blocks)",
385 free, free >> UBIFS_BLOCK_SHIFT);
387 buf->f_type = UBIFS_SUPER_MAGIC;
388 buf->f_bsize = UBIFS_BLOCK_SIZE;
389 buf->f_blocks = c->block_cnt;
390 buf->f_bfree = free >> UBIFS_BLOCK_SHIFT;
391 if (free > c->report_rp_size)
392 buf->f_bavail = (free - c->report_rp_size) >> UBIFS_BLOCK_SHIFT;
397 buf->f_namelen = UBIFS_MAX_NLEN;
398 buf->f_fsid.val[0] = le32_to_cpu(uuid[0]) ^ le32_to_cpu(uuid[2]);
399 buf->f_fsid.val[1] = le32_to_cpu(uuid[1]) ^ le32_to_cpu(uuid[3]);
403 static int ubifs_show_options(struct seq_file *s, struct vfsmount *mnt)
405 struct ubifs_info *c = mnt->mnt_sb->s_fs_info;
407 if (c->mount_opts.unmount_mode == 2)
408 seq_printf(s, ",fast_unmount");
409 else if (c->mount_opts.unmount_mode == 1)
410 seq_printf(s, ",norm_unmount");
412 if (c->mount_opts.bulk_read == 2)
413 seq_printf(s, ",bulk_read");
414 else if (c->mount_opts.bulk_read == 1)
415 seq_printf(s, ",no_bulk_read");
417 if (c->mount_opts.chk_data_crc == 2)
418 seq_printf(s, ",chk_data_crc");
419 else if (c->mount_opts.chk_data_crc == 1)
420 seq_printf(s, ",no_chk_data_crc");
422 if (c->mount_opts.override_compr) {
423 seq_printf(s, ",compr=");
424 seq_printf(s, ubifs_compr_name(c->mount_opts.compr_type));
430 static int ubifs_sync_fs(struct super_block *sb, int wait)
433 struct ubifs_info *c = sb->s_fs_info;
434 struct writeback_control wbc = {
435 .sync_mode = WB_SYNC_ALL,
437 .range_end = LLONG_MAX,
438 .nr_to_write = LONG_MAX,
442 * Zero @wait is just an advisory thing to help the file system shove
443 * lots of data into the queues, and there will be the second
444 * '->sync_fs()' call, with non-zero @wait.
449 if (sb->s_flags & MS_RDONLY)
453 * Synchronize write buffers, because 'ubifs_run_commit()' does not
454 * do this if it waits for an already running commit.
456 for (i = 0; i < c->jhead_cnt; i++) {
457 err = ubifs_wbuf_sync(&c->jheads[i].wbuf);
463 * VFS calls '->sync_fs()' before synchronizing all dirty inodes and
464 * pages, so synchronize them first, then commit the journal. Strictly
465 * speaking, it is not necessary to commit the journal here,
466 * synchronizing write-buffers would be enough. But committing makes
467 * UBIFS free space predictions much more accurate, so we want to let
468 * the user be able to get more accurate results of 'statfs()' after
469 * they synchronize the file system.
471 generic_sync_sb_inodes(sb, &wbc);
473 err = ubifs_run_commit(c);
477 return ubi_sync(c->vi.ubi_num);
481 * init_constants_early - initialize UBIFS constants.
482 * @c: UBIFS file-system description object
484 * This function initialize UBIFS constants which do not need the superblock to
485 * be read. It also checks that the UBI volume satisfies basic UBIFS
486 * requirements. Returns zero in case of success and a negative error code in
489 static int init_constants_early(struct ubifs_info *c)
491 if (c->vi.corrupted) {
492 ubifs_warn("UBI volume is corrupted - read-only mode");
497 ubifs_msg("read-only UBI device");
501 if (c->vi.vol_type == UBI_STATIC_VOLUME) {
502 ubifs_msg("static UBI volume - read-only mode");
506 c->leb_cnt = c->vi.size;
507 c->leb_size = c->vi.usable_leb_size;
508 c->half_leb_size = c->leb_size / 2;
509 c->min_io_size = c->di.min_io_size;
510 c->min_io_shift = fls(c->min_io_size) - 1;
512 if (c->leb_size < UBIFS_MIN_LEB_SZ) {
513 ubifs_err("too small LEBs (%d bytes), min. is %d bytes",
514 c->leb_size, UBIFS_MIN_LEB_SZ);
518 if (c->leb_cnt < UBIFS_MIN_LEB_CNT) {
519 ubifs_err("too few LEBs (%d), min. is %d",
520 c->leb_cnt, UBIFS_MIN_LEB_CNT);
524 if (!is_power_of_2(c->min_io_size)) {
525 ubifs_err("bad min. I/O size %d", c->min_io_size);
530 * UBIFS aligns all node to 8-byte boundary, so to make function in
531 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
534 if (c->min_io_size < 8) {
539 c->ref_node_alsz = ALIGN(UBIFS_REF_NODE_SZ, c->min_io_size);
540 c->mst_node_alsz = ALIGN(UBIFS_MST_NODE_SZ, c->min_io_size);
543 * Initialize node length ranges which are mostly needed for node
546 c->ranges[UBIFS_PAD_NODE].len = UBIFS_PAD_NODE_SZ;
547 c->ranges[UBIFS_SB_NODE].len = UBIFS_SB_NODE_SZ;
548 c->ranges[UBIFS_MST_NODE].len = UBIFS_MST_NODE_SZ;
549 c->ranges[UBIFS_REF_NODE].len = UBIFS_REF_NODE_SZ;
550 c->ranges[UBIFS_TRUN_NODE].len = UBIFS_TRUN_NODE_SZ;
551 c->ranges[UBIFS_CS_NODE].len = UBIFS_CS_NODE_SZ;
553 c->ranges[UBIFS_INO_NODE].min_len = UBIFS_INO_NODE_SZ;
554 c->ranges[UBIFS_INO_NODE].max_len = UBIFS_MAX_INO_NODE_SZ;
555 c->ranges[UBIFS_ORPH_NODE].min_len =
556 UBIFS_ORPH_NODE_SZ + sizeof(__le64);
557 c->ranges[UBIFS_ORPH_NODE].max_len = c->leb_size;
558 c->ranges[UBIFS_DENT_NODE].min_len = UBIFS_DENT_NODE_SZ;
559 c->ranges[UBIFS_DENT_NODE].max_len = UBIFS_MAX_DENT_NODE_SZ;
560 c->ranges[UBIFS_XENT_NODE].min_len = UBIFS_XENT_NODE_SZ;
561 c->ranges[UBIFS_XENT_NODE].max_len = UBIFS_MAX_XENT_NODE_SZ;
562 c->ranges[UBIFS_DATA_NODE].min_len = UBIFS_DATA_NODE_SZ;
563 c->ranges[UBIFS_DATA_NODE].max_len = UBIFS_MAX_DATA_NODE_SZ;
565 * Minimum indexing node size is amended later when superblock is
566 * read and the key length is known.
568 c->ranges[UBIFS_IDX_NODE].min_len = UBIFS_IDX_NODE_SZ + UBIFS_BRANCH_SZ;
570 * Maximum indexing node size is amended later when superblock is
571 * read and the fanout is known.
573 c->ranges[UBIFS_IDX_NODE].max_len = INT_MAX;
576 * Initialize dead and dark LEB space watermarks.
578 * Dead space is the space which cannot be used. Its watermark is
579 * equivalent to min. I/O unit or minimum node size if it is greater
580 * then min. I/O unit.
582 * Dark space is the space which might be used, or might not, depending
583 * on which node should be written to the LEB. Its watermark is
584 * equivalent to maximum UBIFS node size.
586 c->dead_wm = ALIGN(MIN_WRITE_SZ, c->min_io_size);
587 c->dark_wm = ALIGN(UBIFS_MAX_NODE_SZ, c->min_io_size);
590 * Calculate how many bytes would be wasted at the end of LEB if it was
591 * fully filled with data nodes of maximum size. This is used in
592 * calculations when reporting free space.
594 c->leb_overhead = c->leb_size % UBIFS_MAX_DATA_NODE_SZ;
596 /* Buffer size for bulk-reads */
597 c->max_bu_buf_len = UBIFS_MAX_BULK_READ * UBIFS_MAX_DATA_NODE_SZ;
598 if (c->max_bu_buf_len > c->leb_size)
599 c->max_bu_buf_len = c->leb_size;
604 * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
605 * @c: UBIFS file-system description object
606 * @lnum: LEB the write-buffer was synchronized to
607 * @free: how many free bytes left in this LEB
608 * @pad: how many bytes were padded
610 * This is a callback function which is called by the I/O unit when the
611 * write-buffer is synchronized. We need this to correctly maintain space
612 * accounting in bud logical eraseblocks. This function returns zero in case of
613 * success and a negative error code in case of failure.
615 * This function actually belongs to the journal, but we keep it here because
616 * we want to keep it static.
618 static int bud_wbuf_callback(struct ubifs_info *c, int lnum, int free, int pad)
620 return ubifs_update_one_lp(c, lnum, free, pad, 0, 0);
624 * init_constants_sb - initialize UBIFS constants.
625 * @c: UBIFS file-system description object
627 * This is a helper function which initializes various UBIFS constants after
628 * the superblock has been read. It also checks various UBIFS parameters and
629 * makes sure they are all right. Returns zero in case of success and a
630 * negative error code in case of failure.
632 static int init_constants_sb(struct ubifs_info *c)
637 c->main_bytes = (long long)c->main_lebs * c->leb_size;
638 c->max_znode_sz = sizeof(struct ubifs_znode) +
639 c->fanout * sizeof(struct ubifs_zbranch);
641 tmp = ubifs_idx_node_sz(c, 1);
642 c->ranges[UBIFS_IDX_NODE].min_len = tmp;
643 c->min_idx_node_sz = ALIGN(tmp, 8);
645 tmp = ubifs_idx_node_sz(c, c->fanout);
646 c->ranges[UBIFS_IDX_NODE].max_len = tmp;
647 c->max_idx_node_sz = ALIGN(tmp, 8);
649 /* Make sure LEB size is large enough to fit full commit */
650 tmp = UBIFS_CS_NODE_SZ + UBIFS_REF_NODE_SZ * c->jhead_cnt;
651 tmp = ALIGN(tmp, c->min_io_size);
652 if (tmp > c->leb_size) {
653 dbg_err("too small LEB size %d, at least %d needed",
659 * Make sure that the log is large enough to fit reference nodes for
660 * all buds plus one reserved LEB.
662 tmp64 = c->max_bud_bytes + c->leb_size - 1;
663 c->max_bud_cnt = div_u64(tmp64, c->leb_size);
664 tmp = (c->ref_node_alsz * c->max_bud_cnt + c->leb_size - 1);
667 if (c->log_lebs < tmp) {
668 dbg_err("too small log %d LEBs, required min. %d LEBs",
674 * When budgeting we assume worst-case scenarios when the pages are not
675 * be compressed and direntries are of the maximum size.
677 * Note, data, which may be stored in inodes is budgeted separately, so
678 * it is not included into 'c->inode_budget'.
680 c->page_budget = UBIFS_MAX_DATA_NODE_SZ * UBIFS_BLOCKS_PER_PAGE;
681 c->inode_budget = UBIFS_INO_NODE_SZ;
682 c->dent_budget = UBIFS_MAX_DENT_NODE_SZ;
685 * When the amount of flash space used by buds becomes
686 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
687 * The writers are unblocked when the commit is finished. To avoid
688 * writers to be blocked UBIFS initiates background commit in advance,
689 * when number of bud bytes becomes above the limit defined below.
691 c->bg_bud_bytes = (c->max_bud_bytes * 13) >> 4;
694 * Ensure minimum journal size. All the bytes in the journal heads are
695 * considered to be used, when calculating the current journal usage.
696 * Consequently, if the journal is too small, UBIFS will treat it as
699 tmp64 = (long long)(c->jhead_cnt + 1) * c->leb_size + 1;
700 if (c->bg_bud_bytes < tmp64)
701 c->bg_bud_bytes = tmp64;
702 if (c->max_bud_bytes < tmp64 + c->leb_size)
703 c->max_bud_bytes = tmp64 + c->leb_size;
705 err = ubifs_calc_lpt_geom(c);
713 * init_constants_master - initialize UBIFS constants.
714 * @c: UBIFS file-system description object
716 * This is a helper function which initializes various UBIFS constants after
717 * the master node has been read. It also checks various UBIFS parameters and
718 * makes sure they are all right.
720 static void init_constants_master(struct ubifs_info *c)
724 c->min_idx_lebs = ubifs_calc_min_idx_lebs(c);
727 * Calculate total amount of FS blocks. This number is not used
728 * internally because it does not make much sense for UBIFS, but it is
729 * necessary to report something for the 'statfs()' call.
731 * Subtract the LEB reserved for GC, the LEB which is reserved for
732 * deletions, minimum LEBs for the index, and assume only one journal
735 tmp64 = c->main_lebs - 1 - 1 - MIN_INDEX_LEBS - c->jhead_cnt + 1;
736 tmp64 *= (long long)c->leb_size - c->leb_overhead;
737 tmp64 = ubifs_reported_space(c, tmp64);
738 c->block_cnt = tmp64 >> UBIFS_BLOCK_SHIFT;
742 * take_gc_lnum - reserve GC LEB.
743 * @c: UBIFS file-system description object
745 * This function ensures that the LEB reserved for garbage collection is
746 * unmapped and is marked as "taken" in lprops. We also have to set free space
747 * to LEB size and dirty space to zero, because lprops may contain out-of-date
748 * information if the file-system was un-mounted before it has been committed.
749 * This function returns zero in case of success and a negative error code in
752 static int take_gc_lnum(struct ubifs_info *c)
756 if (c->gc_lnum == -1) {
757 ubifs_err("no LEB for GC");
761 err = ubifs_leb_unmap(c, c->gc_lnum);
765 /* And we have to tell lprops that this LEB is taken */
766 err = ubifs_change_one_lp(c, c->gc_lnum, c->leb_size, 0,
772 * alloc_wbufs - allocate write-buffers.
773 * @c: UBIFS file-system description object
775 * This helper function allocates and initializes UBIFS write-buffers. Returns
776 * zero in case of success and %-ENOMEM in case of failure.
778 static int alloc_wbufs(struct ubifs_info *c)
782 c->jheads = kzalloc(c->jhead_cnt * sizeof(struct ubifs_jhead),
787 /* Initialize journal heads */
788 for (i = 0; i < c->jhead_cnt; i++) {
789 INIT_LIST_HEAD(&c->jheads[i].buds_list);
790 err = ubifs_wbuf_init(c, &c->jheads[i].wbuf);
794 c->jheads[i].wbuf.sync_callback = &bud_wbuf_callback;
795 c->jheads[i].wbuf.jhead = i;
798 c->jheads[BASEHD].wbuf.dtype = UBI_SHORTTERM;
800 * Garbage Collector head likely contains long-term data and
801 * does not need to be synchronized by timer.
803 c->jheads[GCHD].wbuf.dtype = UBI_LONGTERM;
804 c->jheads[GCHD].wbuf.timeout = 0;
810 * free_wbufs - free write-buffers.
811 * @c: UBIFS file-system description object
813 static void free_wbufs(struct ubifs_info *c)
818 for (i = 0; i < c->jhead_cnt; i++) {
819 kfree(c->jheads[i].wbuf.buf);
820 kfree(c->jheads[i].wbuf.inodes);
828 * free_orphans - free orphans.
829 * @c: UBIFS file-system description object
831 static void free_orphans(struct ubifs_info *c)
833 struct ubifs_orphan *orph;
835 while (c->orph_dnext) {
836 orph = c->orph_dnext;
837 c->orph_dnext = orph->dnext;
838 list_del(&orph->list);
842 while (!list_empty(&c->orph_list)) {
843 orph = list_entry(c->orph_list.next, struct ubifs_orphan, list);
844 list_del(&orph->list);
846 dbg_err("orphan list not empty at unmount");
854 * free_buds - free per-bud objects.
855 * @c: UBIFS file-system description object
857 static void free_buds(struct ubifs_info *c)
859 struct rb_node *this = c->buds.rb_node;
860 struct ubifs_bud *bud;
864 this = this->rb_left;
865 else if (this->rb_right)
866 this = this->rb_right;
868 bud = rb_entry(this, struct ubifs_bud, rb);
869 this = rb_parent(this);
871 if (this->rb_left == &bud->rb)
872 this->rb_left = NULL;
874 this->rb_right = NULL;
882 * check_volume_empty - check if the UBI volume is empty.
883 * @c: UBIFS file-system description object
885 * This function checks if the UBIFS volume is empty by looking if its LEBs are
886 * mapped or not. The result of checking is stored in the @c->empty variable.
887 * Returns zero in case of success and a negative error code in case of
890 static int check_volume_empty(struct ubifs_info *c)
895 for (lnum = 0; lnum < c->leb_cnt; lnum++) {
896 err = ubi_is_mapped(c->ubi, lnum);
897 if (unlikely(err < 0))
911 * UBIFS mount options.
913 * Opt_fast_unmount: do not run a journal commit before un-mounting
914 * Opt_norm_unmount: run a journal commit before un-mounting
915 * Opt_bulk_read: enable bulk-reads
916 * Opt_no_bulk_read: disable bulk-reads
917 * Opt_chk_data_crc: check CRCs when reading data nodes
918 * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
919 * Opt_override_compr: override default compressor
920 * Opt_err: just end of array marker
933 static const match_table_t tokens = {
934 {Opt_fast_unmount, "fast_unmount"},
935 {Opt_norm_unmount, "norm_unmount"},
936 {Opt_bulk_read, "bulk_read"},
937 {Opt_no_bulk_read, "no_bulk_read"},
938 {Opt_chk_data_crc, "chk_data_crc"},
939 {Opt_no_chk_data_crc, "no_chk_data_crc"},
940 {Opt_override_compr, "compr=%s"},
945 * ubifs_parse_options - parse mount parameters.
946 * @c: UBIFS file-system description object
947 * @options: parameters to parse
948 * @is_remount: non-zero if this is FS re-mount
950 * This function parses UBIFS mount options and returns zero in case success
951 * and a negative error code in case of failure.
953 static int ubifs_parse_options(struct ubifs_info *c, char *options,
957 substring_t args[MAX_OPT_ARGS];
962 while ((p = strsep(&options, ","))) {
968 token = match_token(p, tokens, args);
970 case Opt_fast_unmount:
971 c->mount_opts.unmount_mode = 2;
974 case Opt_norm_unmount:
975 c->mount_opts.unmount_mode = 1;
979 c->mount_opts.bulk_read = 2;
982 case Opt_no_bulk_read:
983 c->mount_opts.bulk_read = 1;
986 case Opt_chk_data_crc:
987 c->mount_opts.chk_data_crc = 2;
988 c->no_chk_data_crc = 0;
990 case Opt_no_chk_data_crc:
991 c->mount_opts.chk_data_crc = 1;
992 c->no_chk_data_crc = 1;
994 case Opt_override_compr:
996 char *name = match_strdup(&args[0]);
1000 if (!strcmp(name, "none"))
1001 c->mount_opts.compr_type = UBIFS_COMPR_NONE;
1002 else if (!strcmp(name, "lzo"))
1003 c->mount_opts.compr_type = UBIFS_COMPR_LZO;
1004 else if (!strcmp(name, "zlib"))
1005 c->mount_opts.compr_type = UBIFS_COMPR_ZLIB;
1007 ubifs_err("unknown compressor \"%s\"", name);
1012 c->mount_opts.override_compr = 1;
1013 c->default_compr = c->mount_opts.compr_type;
1017 ubifs_err("unrecognized mount option \"%s\" "
1018 "or missing value", p);
1027 * destroy_journal - destroy journal data structures.
1028 * @c: UBIFS file-system description object
1030 * This function destroys journal data structures including those that may have
1031 * been created by recovery functions.
1033 static void destroy_journal(struct ubifs_info *c)
1035 while (!list_empty(&c->unclean_leb_list)) {
1036 struct ubifs_unclean_leb *ucleb;
1038 ucleb = list_entry(c->unclean_leb_list.next,
1039 struct ubifs_unclean_leb, list);
1040 list_del(&ucleb->list);
1043 while (!list_empty(&c->old_buds)) {
1044 struct ubifs_bud *bud;
1046 bud = list_entry(c->old_buds.next, struct ubifs_bud, list);
1047 list_del(&bud->list);
1050 ubifs_destroy_idx_gc(c);
1051 ubifs_destroy_size_tree(c);
1057 * bu_init - initialize bulk-read information.
1058 * @c: UBIFS file-system description object
1060 static void bu_init(struct ubifs_info *c)
1062 ubifs_assert(c->bulk_read == 1);
1065 return; /* Already initialized */
1068 c->bu.buf = kmalloc(c->max_bu_buf_len, GFP_KERNEL | __GFP_NOWARN);
1070 if (c->max_bu_buf_len > UBIFS_KMALLOC_OK) {
1071 c->max_bu_buf_len = UBIFS_KMALLOC_OK;
1075 /* Just disable bulk-read */
1076 ubifs_warn("Cannot allocate %d bytes of memory for bulk-read, "
1077 "disabling it", c->max_bu_buf_len);
1078 c->mount_opts.bulk_read = 1;
1085 * check_free_space - check if there is enough free space to mount.
1086 * @c: UBIFS file-system description object
1088 * This function makes sure UBIFS has enough free space to be mounted in
1089 * read/write mode. UBIFS must always have some free space to allow deletions.
1091 static int check_free_space(struct ubifs_info *c)
1093 ubifs_assert(c->dark_wm > 0);
1094 if (c->lst.total_free + c->lst.total_dirty < c->dark_wm) {
1095 ubifs_err("insufficient free space to mount in read/write mode");
1099 * We return %-EINVAL instead of %-ENOSPC because it seems to
1100 * be the closest error code mentioned in the mount function
1109 * mount_ubifs - mount UBIFS file-system.
1110 * @c: UBIFS file-system description object
1112 * This function mounts UBIFS file system. Returns zero in case of success and
1113 * a negative error code in case of failure.
1115 * Note, the function does not de-allocate resources it it fails half way
1116 * through, and the caller has to do this instead.
1118 static int mount_ubifs(struct ubifs_info *c)
1120 struct super_block *sb = c->vfs_sb;
1121 int err, mounted_read_only = (sb->s_flags & MS_RDONLY);
1125 err = init_constants_early(c);
1129 err = ubifs_debugging_init(c);
1133 err = check_volume_empty(c);
1137 if (c->empty && (mounted_read_only || c->ro_media)) {
1139 * This UBI volume is empty, and read-only, or the file system
1140 * is mounted read-only - we cannot format it.
1142 ubifs_err("can't format empty UBI volume: read-only %s",
1143 c->ro_media ? "UBI volume" : "mount");
1148 if (c->ro_media && !mounted_read_only) {
1149 ubifs_err("cannot mount read-write - read-only media");
1155 * The requirement for the buffer is that it should fit indexing B-tree
1156 * height amount of integers. We assume the height if the TNC tree will
1160 c->bottom_up_buf = kmalloc(BOTTOM_UP_HEIGHT * sizeof(int), GFP_KERNEL);
1161 if (!c->bottom_up_buf)
1164 c->sbuf = vmalloc(c->leb_size);
1168 if (!mounted_read_only) {
1169 c->ileb_buf = vmalloc(c->leb_size);
1174 if (c->bulk_read == 1)
1178 * We have to check all CRCs, even for data nodes, when we mount the FS
1179 * (specifically, when we are replaying).
1181 c->always_chk_crc = 1;
1183 err = ubifs_read_superblock(c);
1188 * Make sure the compressor which is set as default in the superblock
1189 * or overridden by mount options is actually compiled in.
1191 if (!ubifs_compr_present(c->default_compr)) {
1192 ubifs_err("'compressor \"%s\" is not compiled in",
1193 ubifs_compr_name(c->default_compr));
1197 err = init_constants_sb(c);
1201 sz = ALIGN(c->max_idx_node_sz, c->min_io_size);
1202 sz = ALIGN(sz + c->max_idx_node_sz, c->min_io_size);
1203 c->cbuf = kmalloc(sz, GFP_NOFS);
1209 sprintf(c->bgt_name, BGT_NAME_PATTERN, c->vi.ubi_num, c->vi.vol_id);
1210 if (!mounted_read_only) {
1211 err = alloc_wbufs(c);
1215 /* Create background thread */
1216 c->bgt = kthread_create(ubifs_bg_thread, c, c->bgt_name);
1217 if (IS_ERR(c->bgt)) {
1218 err = PTR_ERR(c->bgt);
1220 ubifs_err("cannot spawn \"%s\", error %d",
1224 wake_up_process(c->bgt);
1227 err = ubifs_read_master(c);
1231 init_constants_master(c);
1233 if ((c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY)) != 0) {
1234 ubifs_msg("recovery needed");
1235 c->need_recovery = 1;
1236 if (!mounted_read_only) {
1237 err = ubifs_recover_inl_heads(c, c->sbuf);
1241 } else if (!mounted_read_only) {
1243 * Set the "dirty" flag so that if we reboot uncleanly we
1244 * will notice this immediately on the next mount.
1246 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1247 err = ubifs_write_master(c);
1252 err = ubifs_lpt_init(c, 1, !mounted_read_only);
1256 err = dbg_check_idx_size(c, c->old_idx_sz);
1260 err = ubifs_replay_journal(c);
1264 err = ubifs_mount_orphans(c, c->need_recovery, mounted_read_only);
1268 if (!mounted_read_only) {
1271 err = check_free_space(c);
1275 /* Check for enough log space */
1276 lnum = c->lhead_lnum + 1;
1277 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1278 lnum = UBIFS_LOG_LNUM;
1279 if (lnum == c->ltail_lnum) {
1280 err = ubifs_consolidate_log(c);
1285 if (c->need_recovery) {
1286 err = ubifs_recover_size(c);
1289 err = ubifs_rcvry_gc_commit(c);
1291 err = take_gc_lnum(c);
1295 err = dbg_check_lprops(c);
1298 } else if (c->need_recovery) {
1299 err = ubifs_recover_size(c);
1304 spin_lock(&ubifs_infos_lock);
1305 list_add_tail(&c->infos_list, &ubifs_infos);
1306 spin_unlock(&ubifs_infos_lock);
1308 if (c->need_recovery) {
1309 if (mounted_read_only)
1310 ubifs_msg("recovery deferred");
1312 c->need_recovery = 0;
1313 ubifs_msg("recovery completed");
1317 err = dbg_debugfs_init_fs(c);
1321 err = dbg_check_filesystem(c);
1325 c->always_chk_crc = 0;
1327 ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
1328 c->vi.ubi_num, c->vi.vol_id, c->vi.name);
1329 if (mounted_read_only)
1330 ubifs_msg("mounted read-only");
1331 x = (long long)c->main_lebs * c->leb_size;
1332 ubifs_msg("file system size: %lld bytes (%lld KiB, %lld MiB, %d "
1333 "LEBs)", x, x >> 10, x >> 20, c->main_lebs);
1334 x = (long long)c->log_lebs * c->leb_size + c->max_bud_bytes;
1335 ubifs_msg("journal size: %lld bytes (%lld KiB, %lld MiB, %d "
1336 "LEBs)", x, x >> 10, x >> 20, c->log_lebs + c->max_bud_cnt);
1337 ubifs_msg("media format: %d (latest is %d)",
1338 c->fmt_version, UBIFS_FORMAT_VERSION);
1339 ubifs_msg("default compressor: %s", ubifs_compr_name(c->default_compr));
1340 ubifs_msg("reserved for root: %llu bytes (%llu KiB)",
1341 c->report_rp_size, c->report_rp_size >> 10);
1343 dbg_msg("compiled on: " __DATE__ " at " __TIME__);
1344 dbg_msg("min. I/O unit size: %d bytes", c->min_io_size);
1345 dbg_msg("LEB size: %d bytes (%d KiB)",
1346 c->leb_size, c->leb_size >> 10);
1347 dbg_msg("data journal heads: %d",
1348 c->jhead_cnt - NONDATA_JHEADS_CNT);
1349 dbg_msg("UUID: %02X%02X%02X%02X-%02X%02X"
1350 "-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
1351 c->uuid[0], c->uuid[1], c->uuid[2], c->uuid[3],
1352 c->uuid[4], c->uuid[5], c->uuid[6], c->uuid[7],
1353 c->uuid[8], c->uuid[9], c->uuid[10], c->uuid[11],
1354 c->uuid[12], c->uuid[13], c->uuid[14], c->uuid[15]);
1355 dbg_msg("fast unmount: %d", c->fast_unmount);
1356 dbg_msg("big_lpt %d", c->big_lpt);
1357 dbg_msg("log LEBs: %d (%d - %d)",
1358 c->log_lebs, UBIFS_LOG_LNUM, c->log_last);
1359 dbg_msg("LPT area LEBs: %d (%d - %d)",
1360 c->lpt_lebs, c->lpt_first, c->lpt_last);
1361 dbg_msg("orphan area LEBs: %d (%d - %d)",
1362 c->orph_lebs, c->orph_first, c->orph_last);
1363 dbg_msg("main area LEBs: %d (%d - %d)",
1364 c->main_lebs, c->main_first, c->leb_cnt - 1);
1365 dbg_msg("index LEBs: %d", c->lst.idx_lebs);
1366 dbg_msg("total index bytes: %lld (%lld KiB, %lld MiB)",
1367 c->old_idx_sz, c->old_idx_sz >> 10, c->old_idx_sz >> 20);
1368 dbg_msg("key hash type: %d", c->key_hash_type);
1369 dbg_msg("tree fanout: %d", c->fanout);
1370 dbg_msg("reserved GC LEB: %d", c->gc_lnum);
1371 dbg_msg("first main LEB: %d", c->main_first);
1372 dbg_msg("max. znode size %d", c->max_znode_sz);
1373 dbg_msg("max. index node size %d", c->max_idx_node_sz);
1374 dbg_msg("node sizes: data %zu, inode %zu, dentry %zu",
1375 UBIFS_DATA_NODE_SZ, UBIFS_INO_NODE_SZ, UBIFS_DENT_NODE_SZ);
1376 dbg_msg("node sizes: trun %zu, sb %zu, master %zu",
1377 UBIFS_TRUN_NODE_SZ, UBIFS_SB_NODE_SZ, UBIFS_MST_NODE_SZ);
1378 dbg_msg("node sizes: ref %zu, cmt. start %zu, orph %zu",
1379 UBIFS_REF_NODE_SZ, UBIFS_CS_NODE_SZ, UBIFS_ORPH_NODE_SZ);
1380 dbg_msg("max. node sizes: data %zu, inode %zu dentry %zu",
1381 UBIFS_MAX_DATA_NODE_SZ, UBIFS_MAX_INO_NODE_SZ,
1382 UBIFS_MAX_DENT_NODE_SZ);
1383 dbg_msg("dead watermark: %d", c->dead_wm);
1384 dbg_msg("dark watermark: %d", c->dark_wm);
1385 dbg_msg("LEB overhead: %d", c->leb_overhead);
1386 x = (long long)c->main_lebs * c->dark_wm;
1387 dbg_msg("max. dark space: %lld (%lld KiB, %lld MiB)",
1388 x, x >> 10, x >> 20);
1389 dbg_msg("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
1390 c->max_bud_bytes, c->max_bud_bytes >> 10,
1391 c->max_bud_bytes >> 20);
1392 dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1393 c->bg_bud_bytes, c->bg_bud_bytes >> 10,
1394 c->bg_bud_bytes >> 20);
1395 dbg_msg("current bud bytes %lld (%lld KiB, %lld MiB)",
1396 c->bud_bytes, c->bud_bytes >> 10, c->bud_bytes >> 20);
1397 dbg_msg("max. seq. number: %llu", c->max_sqnum);
1398 dbg_msg("commit number: %llu", c->cmt_no);
1403 spin_lock(&ubifs_infos_lock);
1404 list_del(&c->infos_list);
1405 spin_unlock(&ubifs_infos_lock);
1411 ubifs_lpt_free(c, 0);
1414 kfree(c->rcvrd_mst_node);
1416 kthread_stop(c->bgt);
1425 kfree(c->bottom_up_buf);
1426 ubifs_debugging_exit(c);
1431 * ubifs_umount - un-mount UBIFS file-system.
1432 * @c: UBIFS file-system description object
1434 * Note, this function is called to free allocated resourced when un-mounting,
1435 * as well as free resources when an error occurred while we were half way
1436 * through mounting (error path cleanup function). So it has to make sure the
1437 * resource was actually allocated before freeing it.
1439 static void ubifs_umount(struct ubifs_info *c)
1441 dbg_gen("un-mounting UBI device %d, volume %d", c->vi.ubi_num,
1444 dbg_debugfs_exit_fs(c);
1445 spin_lock(&ubifs_infos_lock);
1446 list_del(&c->infos_list);
1447 spin_unlock(&ubifs_infos_lock);
1450 kthread_stop(c->bgt);
1455 ubifs_lpt_free(c, 0);
1458 kfree(c->rcvrd_mst_node);
1463 kfree(c->bottom_up_buf);
1464 ubifs_debugging_exit(c);
1468 * ubifs_remount_rw - re-mount in read-write mode.
1469 * @c: UBIFS file-system description object
1471 * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1472 * mode. This function allocates the needed resources and re-mounts UBIFS in
1475 static int ubifs_remount_rw(struct ubifs_info *c)
1482 mutex_lock(&c->umount_mutex);
1483 c->remounting_rw = 1;
1484 c->always_chk_crc = 1;
1486 err = check_free_space(c);
1490 if (c->old_leb_cnt != c->leb_cnt) {
1491 struct ubifs_sb_node *sup;
1493 sup = ubifs_read_sb_node(c);
1498 sup->leb_cnt = cpu_to_le32(c->leb_cnt);
1499 err = ubifs_write_sb_node(c, sup);
1504 if (c->need_recovery) {
1505 ubifs_msg("completing deferred recovery");
1506 err = ubifs_write_rcvrd_mst_node(c);
1509 err = ubifs_recover_size(c);
1512 err = ubifs_clean_lebs(c, c->sbuf);
1515 err = ubifs_recover_inl_heads(c, c->sbuf);
1520 if (!(c->mst_node->flags & cpu_to_le32(UBIFS_MST_DIRTY))) {
1521 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_DIRTY);
1522 err = ubifs_write_master(c);
1527 c->ileb_buf = vmalloc(c->leb_size);
1533 err = ubifs_lpt_init(c, 0, 1);
1537 err = alloc_wbufs(c);
1541 ubifs_create_buds_lists(c);
1543 /* Create background thread */
1544 c->bgt = kthread_create(ubifs_bg_thread, c, c->bgt_name);
1545 if (IS_ERR(c->bgt)) {
1546 err = PTR_ERR(c->bgt);
1548 ubifs_err("cannot spawn \"%s\", error %d",
1552 wake_up_process(c->bgt);
1554 c->orph_buf = vmalloc(c->leb_size);
1560 /* Check for enough log space */
1561 lnum = c->lhead_lnum + 1;
1562 if (lnum >= UBIFS_LOG_LNUM + c->log_lebs)
1563 lnum = UBIFS_LOG_LNUM;
1564 if (lnum == c->ltail_lnum) {
1565 err = ubifs_consolidate_log(c);
1570 if (c->need_recovery)
1571 err = ubifs_rcvry_gc_commit(c);
1573 err = take_gc_lnum(c);
1577 if (c->need_recovery) {
1578 c->need_recovery = 0;
1579 ubifs_msg("deferred recovery completed");
1582 dbg_gen("re-mounted read-write");
1583 c->vfs_sb->s_flags &= ~MS_RDONLY;
1584 c->remounting_rw = 0;
1585 c->always_chk_crc = 0;
1586 mutex_unlock(&c->umount_mutex);
1593 kthread_stop(c->bgt);
1599 ubifs_lpt_free(c, 1);
1600 c->remounting_rw = 0;
1601 c->always_chk_crc = 0;
1602 mutex_unlock(&c->umount_mutex);
1607 * commit_on_unmount - commit the journal when un-mounting.
1608 * @c: UBIFS file-system description object
1610 * This function is called during un-mounting and re-mounting, and it commits
1611 * the journal unless the "fast unmount" mode is enabled.
1613 static void commit_on_unmount(struct ubifs_info *c)
1615 struct super_block *sb = c->vfs_sb;
1616 long long bud_bytes;
1619 * This function is called before the background thread is stopped, so
1620 * we may race with ongoing commit, which means we have to take
1621 * @c->bud_lock to access @c->bud_bytes.
1623 spin_lock(&c->buds_lock);
1624 bud_bytes = c->bud_bytes;
1625 spin_unlock(&c->buds_lock);
1627 if (!c->fast_unmount && !(sb->s_flags & MS_RDONLY) && bud_bytes)
1628 ubifs_run_commit(c);
1632 * ubifs_remount_ro - re-mount in read-only mode.
1633 * @c: UBIFS file-system description object
1635 * We rely on VFS to have stopped writing. Possibly the background thread could
1636 * be running a commit, however kthread_stop will wait in that case.
1638 static void ubifs_remount_ro(struct ubifs_info *c)
1642 ubifs_assert(!c->need_recovery);
1643 commit_on_unmount(c);
1645 mutex_lock(&c->umount_mutex);
1647 kthread_stop(c->bgt);
1651 for (i = 0; i < c->jhead_cnt; i++) {
1652 ubifs_wbuf_sync(&c->jheads[i].wbuf);
1653 del_timer_sync(&c->jheads[i].wbuf.timer);
1657 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1658 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1659 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1660 err = ubifs_write_master(c);
1662 ubifs_ro_mode(c, err);
1665 ubifs_destroy_idx_gc(c);
1671 ubifs_lpt_free(c, 1);
1672 mutex_unlock(&c->umount_mutex);
1675 static void ubifs_put_super(struct super_block *sb)
1678 struct ubifs_info *c = sb->s_fs_info;
1680 ubifs_msg("un-mount UBI device %d, volume %d", c->vi.ubi_num,
1683 * The following asserts are only valid if there has not been a failure
1684 * of the media. For example, there will be dirty inodes if we failed
1685 * to write them back because of I/O errors.
1687 ubifs_assert(atomic_long_read(&c->dirty_pg_cnt) == 0);
1688 ubifs_assert(c->budg_idx_growth == 0);
1689 ubifs_assert(c->budg_dd_growth == 0);
1690 ubifs_assert(c->budg_data_growth == 0);
1693 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1694 * and file system un-mount. Namely, it prevents the shrinker from
1695 * picking this superblock for shrinking - it will be just skipped if
1696 * the mutex is locked.
1698 mutex_lock(&c->umount_mutex);
1699 if (!(c->vfs_sb->s_flags & MS_RDONLY)) {
1701 * First of all kill the background thread to make sure it does
1702 * not interfere with un-mounting and freeing resources.
1705 kthread_stop(c->bgt);
1709 /* Synchronize write-buffers */
1711 for (i = 0; i < c->jhead_cnt; i++) {
1712 ubifs_wbuf_sync(&c->jheads[i].wbuf);
1713 del_timer_sync(&c->jheads[i].wbuf.timer);
1717 * On fatal errors c->ro_media is set to 1, in which case we do
1718 * not write the master node.
1722 * We are being cleanly unmounted which means the
1723 * orphans were killed - indicate this in the master
1724 * node. Also save the reserved GC LEB number.
1728 c->mst_node->flags &= ~cpu_to_le32(UBIFS_MST_DIRTY);
1729 c->mst_node->flags |= cpu_to_le32(UBIFS_MST_NO_ORPHS);
1730 c->mst_node->gc_lnum = cpu_to_le32(c->gc_lnum);
1731 err = ubifs_write_master(c);
1734 * Recovery will attempt to fix the master area
1735 * next mount, so we just print a message and
1736 * continue to unmount normally.
1738 ubifs_err("failed to write master node, "
1744 bdi_destroy(&c->bdi);
1745 ubi_close_volume(c->ubi);
1746 mutex_unlock(&c->umount_mutex);
1750 static int ubifs_remount_fs(struct super_block *sb, int *flags, char *data)
1753 struct ubifs_info *c = sb->s_fs_info;
1755 dbg_gen("old flags %#lx, new flags %#x", sb->s_flags, *flags);
1757 err = ubifs_parse_options(c, data, 1);
1759 ubifs_err("invalid or unknown remount parameter");
1763 if ((sb->s_flags & MS_RDONLY) && !(*flags & MS_RDONLY)) {
1764 err = ubifs_remount_rw(c);
1767 } else if (!(sb->s_flags & MS_RDONLY) && (*flags & MS_RDONLY))
1768 ubifs_remount_ro(c);
1770 if (c->bulk_read == 1)
1773 dbg_gen("disable bulk-read");
1781 struct super_operations ubifs_super_operations = {
1782 .alloc_inode = ubifs_alloc_inode,
1783 .destroy_inode = ubifs_destroy_inode,
1784 .put_super = ubifs_put_super,
1785 .write_inode = ubifs_write_inode,
1786 .delete_inode = ubifs_delete_inode,
1787 .statfs = ubifs_statfs,
1788 .dirty_inode = ubifs_dirty_inode,
1789 .remount_fs = ubifs_remount_fs,
1790 .show_options = ubifs_show_options,
1791 .sync_fs = ubifs_sync_fs,
1795 * open_ubi - parse UBI device name string and open the UBI device.
1796 * @name: UBI volume name
1797 * @mode: UBI volume open mode
1799 * There are several ways to specify UBI volumes when mounting UBIFS:
1800 * o ubiX_Y - UBI device number X, volume Y;
1801 * o ubiY - UBI device number 0, volume Y;
1802 * o ubiX:NAME - mount UBI device X, volume with name NAME;
1803 * o ubi:NAME - mount UBI device 0, volume with name NAME.
1805 * Alternative '!' separator may be used instead of ':' (because some shells
1806 * like busybox may interpret ':' as an NFS host name separator). This function
1807 * returns ubi volume object in case of success and a negative error code in
1810 static struct ubi_volume_desc *open_ubi(const char *name, int mode)
1815 if (name[0] != 'u' || name[1] != 'b' || name[2] != 'i')
1816 return ERR_PTR(-EINVAL);
1818 /* ubi:NAME method */
1819 if ((name[3] == ':' || name[3] == '!') && name[4] != '\0')
1820 return ubi_open_volume_nm(0, name + 4, mode);
1822 if (!isdigit(name[3]))
1823 return ERR_PTR(-EINVAL);
1825 dev = simple_strtoul(name + 3, &endptr, 0);
1828 if (*endptr == '\0')
1829 return ubi_open_volume(0, dev, mode);
1832 if (*endptr == '_' && isdigit(endptr[1])) {
1833 vol = simple_strtoul(endptr + 1, &endptr, 0);
1834 if (*endptr != '\0')
1835 return ERR_PTR(-EINVAL);
1836 return ubi_open_volume(dev, vol, mode);
1839 /* ubiX:NAME method */
1840 if ((*endptr == ':' || *endptr == '!') && endptr[1] != '\0')
1841 return ubi_open_volume_nm(dev, ++endptr, mode);
1843 return ERR_PTR(-EINVAL);
1846 static int ubifs_fill_super(struct super_block *sb, void *data, int silent)
1848 struct ubi_volume_desc *ubi = sb->s_fs_info;
1849 struct ubifs_info *c;
1853 c = kzalloc(sizeof(struct ubifs_info), GFP_KERNEL);
1857 spin_lock_init(&c->cnt_lock);
1858 spin_lock_init(&c->cs_lock);
1859 spin_lock_init(&c->buds_lock);
1860 spin_lock_init(&c->space_lock);
1861 spin_lock_init(&c->orphan_lock);
1862 init_rwsem(&c->commit_sem);
1863 mutex_init(&c->lp_mutex);
1864 mutex_init(&c->tnc_mutex);
1865 mutex_init(&c->log_mutex);
1866 mutex_init(&c->mst_mutex);
1867 mutex_init(&c->umount_mutex);
1868 mutex_init(&c->bu_mutex);
1869 init_waitqueue_head(&c->cmt_wq);
1871 c->old_idx = RB_ROOT;
1872 c->size_tree = RB_ROOT;
1873 c->orph_tree = RB_ROOT;
1874 INIT_LIST_HEAD(&c->infos_list);
1875 INIT_LIST_HEAD(&c->idx_gc);
1876 INIT_LIST_HEAD(&c->replay_list);
1877 INIT_LIST_HEAD(&c->replay_buds);
1878 INIT_LIST_HEAD(&c->uncat_list);
1879 INIT_LIST_HEAD(&c->empty_list);
1880 INIT_LIST_HEAD(&c->freeable_list);
1881 INIT_LIST_HEAD(&c->frdi_idx_list);
1882 INIT_LIST_HEAD(&c->unclean_leb_list);
1883 INIT_LIST_HEAD(&c->old_buds);
1884 INIT_LIST_HEAD(&c->orph_list);
1885 INIT_LIST_HEAD(&c->orph_new);
1887 c->highest_inum = UBIFS_FIRST_INO;
1888 c->lhead_lnum = c->ltail_lnum = UBIFS_LOG_LNUM;
1890 ubi_get_volume_info(ubi, &c->vi);
1891 ubi_get_device_info(c->vi.ubi_num, &c->di);
1893 /* Re-open the UBI device in read-write mode */
1894 c->ubi = ubi_open_volume(c->vi.ubi_num, c->vi.vol_id, UBI_READWRITE);
1895 if (IS_ERR(c->ubi)) {
1896 err = PTR_ERR(c->ubi);
1901 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
1902 * UBIFS, I/O is not deferred, it is done immediately in readpage,
1903 * which means the user would have to wait not just for their own I/O
1904 * but the read-ahead I/O as well i.e. completely pointless.
1906 * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
1908 c->bdi.capabilities = BDI_CAP_MAP_COPY;
1909 c->bdi.unplug_io_fn = default_unplug_io_fn;
1910 err = bdi_init(&c->bdi);
1914 err = ubifs_parse_options(c, data, 0);
1921 sb->s_magic = UBIFS_SUPER_MAGIC;
1922 sb->s_blocksize = UBIFS_BLOCK_SIZE;
1923 sb->s_blocksize_bits = UBIFS_BLOCK_SHIFT;
1924 sb->s_dev = c->vi.cdev;
1925 sb->s_maxbytes = c->max_inode_sz = key_max_inode_size(c);
1926 if (c->max_inode_sz > MAX_LFS_FILESIZE)
1927 sb->s_maxbytes = c->max_inode_sz = MAX_LFS_FILESIZE;
1928 sb->s_op = &ubifs_super_operations;
1930 mutex_lock(&c->umount_mutex);
1931 err = mount_ubifs(c);
1933 ubifs_assert(err < 0);
1937 /* Read the root inode */
1938 root = ubifs_iget(sb, UBIFS_ROOT_INO);
1940 err = PTR_ERR(root);
1944 sb->s_root = d_alloc_root(root);
1948 mutex_unlock(&c->umount_mutex);
1956 mutex_unlock(&c->umount_mutex);
1958 bdi_destroy(&c->bdi);
1960 ubi_close_volume(c->ubi);
1966 static int sb_test(struct super_block *sb, void *data)
1970 return sb->s_dev == *dev;
1973 static int sb_set(struct super_block *sb, void *data)
1981 static int ubifs_get_sb(struct file_system_type *fs_type, int flags,
1982 const char *name, void *data, struct vfsmount *mnt)
1984 struct ubi_volume_desc *ubi;
1985 struct ubi_volume_info vi;
1986 struct super_block *sb;
1989 dbg_gen("name %s, flags %#x", name, flags);
1992 * Get UBI device number and volume ID. Mount it read-only so far
1993 * because this might be a new mount point, and UBI allows only one
1994 * read-write user at a time.
1996 ubi = open_ubi(name, UBI_READONLY);
1998 ubifs_err("cannot open \"%s\", error %d",
1999 name, (int)PTR_ERR(ubi));
2000 return PTR_ERR(ubi);
2002 ubi_get_volume_info(ubi, &vi);
2004 dbg_gen("opened ubi%d_%d", vi.ubi_num, vi.vol_id);
2006 sb = sget(fs_type, &sb_test, &sb_set, &vi.cdev);
2013 /* A new mount point for already mounted UBIFS */
2014 dbg_gen("this ubi volume is already mounted");
2015 if ((flags ^ sb->s_flags) & MS_RDONLY) {
2020 sb->s_flags = flags;
2022 * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
2025 sb->s_fs_info = ubi;
2026 err = ubifs_fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
2029 /* We do not support atime */
2030 sb->s_flags |= MS_ACTIVE | MS_NOATIME;
2033 /* 'fill_super()' opens ubi again so we must close it here */
2034 ubi_close_volume(ubi);
2036 return simple_set_mnt(mnt, sb);
2039 up_write(&sb->s_umount);
2040 deactivate_super(sb);
2042 ubi_close_volume(ubi);
2046 static void ubifs_kill_sb(struct super_block *sb)
2048 struct ubifs_info *c = sb->s_fs_info;
2051 * We do 'commit_on_unmount()' here instead of 'ubifs_put_super()'
2052 * in order to be outside BKL.
2055 commit_on_unmount(c);
2056 /* The un-mount routine is actually done in put_super() */
2057 generic_shutdown_super(sb);
2060 static struct file_system_type ubifs_fs_type = {
2062 .owner = THIS_MODULE,
2063 .get_sb = ubifs_get_sb,
2064 .kill_sb = ubifs_kill_sb
2068 * Inode slab cache constructor.
2070 static void inode_slab_ctor(void *obj)
2072 struct ubifs_inode *ui = obj;
2073 inode_init_once(&ui->vfs_inode);
2076 static int __init ubifs_init(void)
2080 BUILD_BUG_ON(sizeof(struct ubifs_ch) != 24);
2082 /* Make sure node sizes are 8-byte aligned */
2083 BUILD_BUG_ON(UBIFS_CH_SZ & 7);
2084 BUILD_BUG_ON(UBIFS_INO_NODE_SZ & 7);
2085 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ & 7);
2086 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ & 7);
2087 BUILD_BUG_ON(UBIFS_DATA_NODE_SZ & 7);
2088 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ & 7);
2089 BUILD_BUG_ON(UBIFS_SB_NODE_SZ & 7);
2090 BUILD_BUG_ON(UBIFS_MST_NODE_SZ & 7);
2091 BUILD_BUG_ON(UBIFS_REF_NODE_SZ & 7);
2092 BUILD_BUG_ON(UBIFS_CS_NODE_SZ & 7);
2093 BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ & 7);
2095 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ & 7);
2096 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ & 7);
2097 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ & 7);
2098 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ & 7);
2099 BUILD_BUG_ON(UBIFS_MAX_NODE_SZ & 7);
2100 BUILD_BUG_ON(MIN_WRITE_SZ & 7);
2102 /* Check min. node size */
2103 BUILD_BUG_ON(UBIFS_INO_NODE_SZ < MIN_WRITE_SZ);
2104 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ < MIN_WRITE_SZ);
2105 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ < MIN_WRITE_SZ);
2106 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ < MIN_WRITE_SZ);
2108 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2109 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ > UBIFS_MAX_NODE_SZ);
2110 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ > UBIFS_MAX_NODE_SZ);
2111 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ > UBIFS_MAX_NODE_SZ);
2113 /* Defined node sizes */
2114 BUILD_BUG_ON(UBIFS_SB_NODE_SZ != 4096);
2115 BUILD_BUG_ON(UBIFS_MST_NODE_SZ != 512);
2116 BUILD_BUG_ON(UBIFS_INO_NODE_SZ != 160);
2117 BUILD_BUG_ON(UBIFS_REF_NODE_SZ != 64);
2120 * We use 2 bit wide bit-fields to store compression type, which should
2121 * be amended if more compressors are added. The bit-fields are:
2122 * @compr_type in 'struct ubifs_inode', @default_compr in
2123 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
2125 BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT > 4);
2128 * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2129 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2131 if (PAGE_CACHE_SIZE < UBIFS_BLOCK_SIZE) {
2132 ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
2133 " at least 4096 bytes",
2134 (unsigned int)PAGE_CACHE_SIZE);
2138 err = register_filesystem(&ubifs_fs_type);
2140 ubifs_err("cannot register file system, error %d", err);
2145 ubifs_inode_slab = kmem_cache_create("ubifs_inode_slab",
2146 sizeof(struct ubifs_inode), 0,
2147 SLAB_MEM_SPREAD | SLAB_RECLAIM_ACCOUNT,
2149 if (!ubifs_inode_slab)
2152 register_shrinker(&ubifs_shrinker_info);
2154 err = ubifs_compressors_init();
2158 err = dbg_debugfs_init();
2165 ubifs_compressors_exit();
2167 unregister_shrinker(&ubifs_shrinker_info);
2168 kmem_cache_destroy(ubifs_inode_slab);
2170 unregister_filesystem(&ubifs_fs_type);
2173 /* late_initcall to let compressors initialize first */
2174 late_initcall(ubifs_init);
2176 static void __exit ubifs_exit(void)
2178 ubifs_assert(list_empty(&ubifs_infos));
2179 ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt) == 0);
2182 ubifs_compressors_exit();
2183 unregister_shrinker(&ubifs_shrinker_info);
2184 kmem_cache_destroy(ubifs_inode_slab);
2185 unregister_filesystem(&ubifs_fs_type);
2187 module_exit(ubifs_exit);
2189 MODULE_LICENSE("GPL");
2190 MODULE_VERSION(__stringify(UBIFS_VERSION));
2191 MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2192 MODULE_DESCRIPTION("UBIFS - UBI File System");