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
);
364 /* We've deleted something - clean the "no space" flags */
365 c
->nospace
= c
->nospace_rp
= 0;
371 static void ubifs_dirty_inode(struct inode
*inode
)
373 struct ubifs_inode
*ui
= ubifs_inode(inode
);
375 ubifs_assert(mutex_is_locked(&ui
->ui_mutex
));
378 dbg_gen("inode %lu", inode
->i_ino
);
382 static int ubifs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
384 struct ubifs_info
*c
= dentry
->d_sb
->s_fs_info
;
385 unsigned long long free
;
386 __le32
*uuid
= (__le32
*)c
->uuid
;
388 free
= ubifs_get_free_space(c
);
389 dbg_gen("free space %lld bytes (%lld blocks)",
390 free
, free
>> UBIFS_BLOCK_SHIFT
);
392 buf
->f_type
= UBIFS_SUPER_MAGIC
;
393 buf
->f_bsize
= UBIFS_BLOCK_SIZE
;
394 buf
->f_blocks
= c
->block_cnt
;
395 buf
->f_bfree
= free
>> UBIFS_BLOCK_SHIFT
;
396 if (free
> c
->report_rp_size
)
397 buf
->f_bavail
= (free
- c
->report_rp_size
) >> UBIFS_BLOCK_SHIFT
;
402 buf
->f_namelen
= UBIFS_MAX_NLEN
;
403 buf
->f_fsid
.val
[0] = le32_to_cpu(uuid
[0]) ^ le32_to_cpu(uuid
[2]);
404 buf
->f_fsid
.val
[1] = le32_to_cpu(uuid
[1]) ^ le32_to_cpu(uuid
[3]);
405 ubifs_assert(buf
->f_bfree
<= c
->block_cnt
);
409 static int ubifs_show_options(struct seq_file
*s
, struct vfsmount
*mnt
)
411 struct ubifs_info
*c
= mnt
->mnt_sb
->s_fs_info
;
413 if (c
->mount_opts
.unmount_mode
== 2)
414 seq_printf(s
, ",fast_unmount");
415 else if (c
->mount_opts
.unmount_mode
== 1)
416 seq_printf(s
, ",norm_unmount");
418 if (c
->mount_opts
.bulk_read
== 2)
419 seq_printf(s
, ",bulk_read");
420 else if (c
->mount_opts
.bulk_read
== 1)
421 seq_printf(s
, ",no_bulk_read");
423 if (c
->mount_opts
.chk_data_crc
== 2)
424 seq_printf(s
, ",chk_data_crc");
425 else if (c
->mount_opts
.chk_data_crc
== 1)
426 seq_printf(s
, ",no_chk_data_crc");
428 if (c
->mount_opts
.override_compr
) {
429 seq_printf(s
, ",compr=%s",
430 ubifs_compr_name(c
->mount_opts
.compr_type
));
436 static int ubifs_sync_fs(struct super_block
*sb
, int wait
)
439 struct ubifs_info
*c
= sb
->s_fs_info
;
440 struct writeback_control wbc
= {
441 .sync_mode
= WB_SYNC_ALL
,
443 .range_end
= LLONG_MAX
,
444 .nr_to_write
= LONG_MAX
,
448 * Zero @wait is just an advisory thing to help the file system shove
449 * lots of data into the queues, and there will be the second
450 * '->sync_fs()' call, with non-zero @wait.
455 if (sb
->s_flags
& MS_RDONLY
)
459 * VFS calls '->sync_fs()' before synchronizing all dirty inodes and
460 * pages, so synchronize them first, then commit the journal. Strictly
461 * speaking, it is not necessary to commit the journal here,
462 * synchronizing write-buffers would be enough. But committing makes
463 * UBIFS free space predictions much more accurate, so we want to let
464 * the user be able to get more accurate results of 'statfs()' after
465 * they synchronize the file system.
467 generic_sync_sb_inodes(sb
, &wbc
);
470 * Synchronize write buffers, because 'ubifs_run_commit()' does not
471 * do this if it waits for an already running commit.
473 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
474 err
= ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
479 err
= ubifs_run_commit(c
);
483 return ubi_sync(c
->vi
.ubi_num
);
487 * init_constants_early - initialize UBIFS constants.
488 * @c: UBIFS file-system description object
490 * This function initialize UBIFS constants which do not need the superblock to
491 * be read. It also checks that the UBI volume satisfies basic UBIFS
492 * requirements. Returns zero in case of success and a negative error code in
495 static int init_constants_early(struct ubifs_info
*c
)
497 if (c
->vi
.corrupted
) {
498 ubifs_warn("UBI volume is corrupted - read-only mode");
503 ubifs_msg("read-only UBI device");
507 if (c
->vi
.vol_type
== UBI_STATIC_VOLUME
) {
508 ubifs_msg("static UBI volume - read-only mode");
512 c
->leb_cnt
= c
->vi
.size
;
513 c
->leb_size
= c
->vi
.usable_leb_size
;
514 c
->half_leb_size
= c
->leb_size
/ 2;
515 c
->min_io_size
= c
->di
.min_io_size
;
516 c
->min_io_shift
= fls(c
->min_io_size
) - 1;
518 if (c
->leb_size
< UBIFS_MIN_LEB_SZ
) {
519 ubifs_err("too small LEBs (%d bytes), min. is %d bytes",
520 c
->leb_size
, UBIFS_MIN_LEB_SZ
);
524 if (c
->leb_cnt
< UBIFS_MIN_LEB_CNT
) {
525 ubifs_err("too few LEBs (%d), min. is %d",
526 c
->leb_cnt
, UBIFS_MIN_LEB_CNT
);
530 if (!is_power_of_2(c
->min_io_size
)) {
531 ubifs_err("bad min. I/O size %d", c
->min_io_size
);
536 * UBIFS aligns all node to 8-byte boundary, so to make function in
537 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
540 if (c
->min_io_size
< 8) {
545 c
->ref_node_alsz
= ALIGN(UBIFS_REF_NODE_SZ
, c
->min_io_size
);
546 c
->mst_node_alsz
= ALIGN(UBIFS_MST_NODE_SZ
, c
->min_io_size
);
549 * Initialize node length ranges which are mostly needed for node
552 c
->ranges
[UBIFS_PAD_NODE
].len
= UBIFS_PAD_NODE_SZ
;
553 c
->ranges
[UBIFS_SB_NODE
].len
= UBIFS_SB_NODE_SZ
;
554 c
->ranges
[UBIFS_MST_NODE
].len
= UBIFS_MST_NODE_SZ
;
555 c
->ranges
[UBIFS_REF_NODE
].len
= UBIFS_REF_NODE_SZ
;
556 c
->ranges
[UBIFS_TRUN_NODE
].len
= UBIFS_TRUN_NODE_SZ
;
557 c
->ranges
[UBIFS_CS_NODE
].len
= UBIFS_CS_NODE_SZ
;
559 c
->ranges
[UBIFS_INO_NODE
].min_len
= UBIFS_INO_NODE_SZ
;
560 c
->ranges
[UBIFS_INO_NODE
].max_len
= UBIFS_MAX_INO_NODE_SZ
;
561 c
->ranges
[UBIFS_ORPH_NODE
].min_len
=
562 UBIFS_ORPH_NODE_SZ
+ sizeof(__le64
);
563 c
->ranges
[UBIFS_ORPH_NODE
].max_len
= c
->leb_size
;
564 c
->ranges
[UBIFS_DENT_NODE
].min_len
= UBIFS_DENT_NODE_SZ
;
565 c
->ranges
[UBIFS_DENT_NODE
].max_len
= UBIFS_MAX_DENT_NODE_SZ
;
566 c
->ranges
[UBIFS_XENT_NODE
].min_len
= UBIFS_XENT_NODE_SZ
;
567 c
->ranges
[UBIFS_XENT_NODE
].max_len
= UBIFS_MAX_XENT_NODE_SZ
;
568 c
->ranges
[UBIFS_DATA_NODE
].min_len
= UBIFS_DATA_NODE_SZ
;
569 c
->ranges
[UBIFS_DATA_NODE
].max_len
= UBIFS_MAX_DATA_NODE_SZ
;
571 * Minimum indexing node size is amended later when superblock is
572 * read and the key length is known.
574 c
->ranges
[UBIFS_IDX_NODE
].min_len
= UBIFS_IDX_NODE_SZ
+ UBIFS_BRANCH_SZ
;
576 * Maximum indexing node size is amended later when superblock is
577 * read and the fanout is known.
579 c
->ranges
[UBIFS_IDX_NODE
].max_len
= INT_MAX
;
582 * Initialize dead and dark LEB space watermarks. See gc.c for comments
583 * about these values.
585 c
->dead_wm
= ALIGN(MIN_WRITE_SZ
, c
->min_io_size
);
586 c
->dark_wm
= ALIGN(UBIFS_MAX_NODE_SZ
, c
->min_io_size
);
589 * Calculate how many bytes would be wasted at the end of LEB if it was
590 * fully filled with data nodes of maximum size. This is used in
591 * calculations when reporting free space.
593 c
->leb_overhead
= c
->leb_size
% UBIFS_MAX_DATA_NODE_SZ
;
595 /* Buffer size for bulk-reads */
596 c
->max_bu_buf_len
= UBIFS_MAX_BULK_READ
* UBIFS_MAX_DATA_NODE_SZ
;
597 if (c
->max_bu_buf_len
> c
->leb_size
)
598 c
->max_bu_buf_len
= c
->leb_size
;
603 * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
604 * @c: UBIFS file-system description object
605 * @lnum: LEB the write-buffer was synchronized to
606 * @free: how many free bytes left in this LEB
607 * @pad: how many bytes were padded
609 * This is a callback function which is called by the I/O unit when the
610 * write-buffer is synchronized. We need this to correctly maintain space
611 * accounting in bud logical eraseblocks. This function returns zero in case of
612 * success and a negative error code in case of failure.
614 * This function actually belongs to the journal, but we keep it here because
615 * we want to keep it static.
617 static int bud_wbuf_callback(struct ubifs_info
*c
, int lnum
, int free
, int pad
)
619 return ubifs_update_one_lp(c
, lnum
, free
, pad
, 0, 0);
623 * init_constants_sb - initialize UBIFS constants.
624 * @c: UBIFS file-system description object
626 * This is a helper function which initializes various UBIFS constants after
627 * the superblock has been read. It also checks various UBIFS parameters and
628 * makes sure they are all right. Returns zero in case of success and a
629 * negative error code in case of failure.
631 static int init_constants_sb(struct ubifs_info
*c
)
636 c
->main_bytes
= (long long)c
->main_lebs
* c
->leb_size
;
637 c
->max_znode_sz
= sizeof(struct ubifs_znode
) +
638 c
->fanout
* sizeof(struct ubifs_zbranch
);
640 tmp
= ubifs_idx_node_sz(c
, 1);
641 c
->ranges
[UBIFS_IDX_NODE
].min_len
= tmp
;
642 c
->min_idx_node_sz
= ALIGN(tmp
, 8);
644 tmp
= ubifs_idx_node_sz(c
, c
->fanout
);
645 c
->ranges
[UBIFS_IDX_NODE
].max_len
= tmp
;
646 c
->max_idx_node_sz
= ALIGN(tmp
, 8);
648 /* Make sure LEB size is large enough to fit full commit */
649 tmp
= UBIFS_CS_NODE_SZ
+ UBIFS_REF_NODE_SZ
* c
->jhead_cnt
;
650 tmp
= ALIGN(tmp
, c
->min_io_size
);
651 if (tmp
> c
->leb_size
) {
652 dbg_err("too small LEB size %d, at least %d needed",
658 * Make sure that the log is large enough to fit reference nodes for
659 * all buds plus one reserved LEB.
661 tmp64
= c
->max_bud_bytes
+ c
->leb_size
- 1;
662 c
->max_bud_cnt
= div_u64(tmp64
, c
->leb_size
);
663 tmp
= (c
->ref_node_alsz
* c
->max_bud_cnt
+ c
->leb_size
- 1);
666 if (c
->log_lebs
< tmp
) {
667 dbg_err("too small log %d LEBs, required min. %d LEBs",
673 * When budgeting we assume worst-case scenarios when the pages are not
674 * be compressed and direntries are of the maximum size.
676 * Note, data, which may be stored in inodes is budgeted separately, so
677 * it is not included into 'c->inode_budget'.
679 c
->page_budget
= UBIFS_MAX_DATA_NODE_SZ
* UBIFS_BLOCKS_PER_PAGE
;
680 c
->inode_budget
= UBIFS_INO_NODE_SZ
;
681 c
->dent_budget
= UBIFS_MAX_DENT_NODE_SZ
;
684 * When the amount of flash space used by buds becomes
685 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
686 * The writers are unblocked when the commit is finished. To avoid
687 * writers to be blocked UBIFS initiates background commit in advance,
688 * when number of bud bytes becomes above the limit defined below.
690 c
->bg_bud_bytes
= (c
->max_bud_bytes
* 13) >> 4;
693 * Ensure minimum journal size. All the bytes in the journal heads are
694 * considered to be used, when calculating the current journal usage.
695 * Consequently, if the journal is too small, UBIFS will treat it as
698 tmp64
= (long long)(c
->jhead_cnt
+ 1) * c
->leb_size
+ 1;
699 if (c
->bg_bud_bytes
< tmp64
)
700 c
->bg_bud_bytes
= tmp64
;
701 if (c
->max_bud_bytes
< tmp64
+ c
->leb_size
)
702 c
->max_bud_bytes
= tmp64
+ c
->leb_size
;
704 err
= ubifs_calc_lpt_geom(c
);
708 /* Initialize effective LEB size used in budgeting calculations */
709 c
->idx_leb_size
= c
->leb_size
- c
->max_idx_node_sz
;
714 * init_constants_master - initialize UBIFS constants.
715 * @c: UBIFS file-system description object
717 * This is a helper function which initializes various UBIFS constants after
718 * the master node has been read. It also checks various UBIFS parameters and
719 * makes sure they are all right.
721 static void init_constants_master(struct ubifs_info
*c
)
725 c
->min_idx_lebs
= ubifs_calc_min_idx_lebs(c
);
726 c
->report_rp_size
= ubifs_reported_space(c
, c
->rp_size
);
729 * Calculate total amount of FS blocks. This number is not used
730 * internally because it does not make much sense for UBIFS, but it is
731 * necessary to report something for the 'statfs()' call.
733 * Subtract the LEB reserved for GC, the LEB which is reserved for
734 * deletions, minimum LEBs for the index, and assume only one journal
737 tmp64
= c
->main_lebs
- 1 - 1 - MIN_INDEX_LEBS
- c
->jhead_cnt
+ 1;
738 tmp64
*= (long long)c
->leb_size
- c
->leb_overhead
;
739 tmp64
= ubifs_reported_space(c
, tmp64
);
740 c
->block_cnt
= tmp64
>> UBIFS_BLOCK_SHIFT
;
744 * take_gc_lnum - reserve GC LEB.
745 * @c: UBIFS file-system description object
747 * This function ensures that the LEB reserved for garbage collection is marked
748 * as "taken" in lprops. We also have to set free space to LEB size and dirty
749 * space to zero, because lprops may contain out-of-date information if the
750 * file-system was un-mounted before it has been committed. This function
751 * returns zero in case of success and a negative error code in case of
754 static int take_gc_lnum(struct ubifs_info
*c
)
758 if (c
->gc_lnum
== -1) {
759 ubifs_err("no LEB for GC");
763 /* And we have to tell lprops that this LEB is taken */
764 err
= ubifs_change_one_lp(c
, c
->gc_lnum
, c
->leb_size
, 0,
770 * alloc_wbufs - allocate write-buffers.
771 * @c: UBIFS file-system description object
773 * This helper function allocates and initializes UBIFS write-buffers. Returns
774 * zero in case of success and %-ENOMEM in case of failure.
776 static int alloc_wbufs(struct ubifs_info
*c
)
780 c
->jheads
= kzalloc(c
->jhead_cnt
* sizeof(struct ubifs_jhead
),
785 /* Initialize journal heads */
786 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
787 INIT_LIST_HEAD(&c
->jheads
[i
].buds_list
);
788 err
= ubifs_wbuf_init(c
, &c
->jheads
[i
].wbuf
);
792 c
->jheads
[i
].wbuf
.sync_callback
= &bud_wbuf_callback
;
793 c
->jheads
[i
].wbuf
.jhead
= i
;
796 c
->jheads
[BASEHD
].wbuf
.dtype
= UBI_SHORTTERM
;
798 * Garbage Collector head likely contains long-term data and
799 * does not need to be synchronized by timer.
801 c
->jheads
[GCHD
].wbuf
.dtype
= UBI_LONGTERM
;
802 c
->jheads
[GCHD
].wbuf
.timeout
= 0;
808 * free_wbufs - free write-buffers.
809 * @c: UBIFS file-system description object
811 static void free_wbufs(struct ubifs_info
*c
)
816 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
817 kfree(c
->jheads
[i
].wbuf
.buf
);
818 kfree(c
->jheads
[i
].wbuf
.inodes
);
826 * free_orphans - free orphans.
827 * @c: UBIFS file-system description object
829 static void free_orphans(struct ubifs_info
*c
)
831 struct ubifs_orphan
*orph
;
833 while (c
->orph_dnext
) {
834 orph
= c
->orph_dnext
;
835 c
->orph_dnext
= orph
->dnext
;
836 list_del(&orph
->list
);
840 while (!list_empty(&c
->orph_list
)) {
841 orph
= list_entry(c
->orph_list
.next
, struct ubifs_orphan
, list
);
842 list_del(&orph
->list
);
844 dbg_err("orphan list not empty at unmount");
852 * free_buds - free per-bud objects.
853 * @c: UBIFS file-system description object
855 static void free_buds(struct ubifs_info
*c
)
857 struct rb_node
*this = c
->buds
.rb_node
;
858 struct ubifs_bud
*bud
;
862 this = this->rb_left
;
863 else if (this->rb_right
)
864 this = this->rb_right
;
866 bud
= rb_entry(this, struct ubifs_bud
, rb
);
867 this = rb_parent(this);
869 if (this->rb_left
== &bud
->rb
)
870 this->rb_left
= NULL
;
872 this->rb_right
= NULL
;
880 * check_volume_empty - check if the UBI volume is empty.
881 * @c: UBIFS file-system description object
883 * This function checks if the UBIFS volume is empty by looking if its LEBs are
884 * mapped or not. The result of checking is stored in the @c->empty variable.
885 * Returns zero in case of success and a negative error code in case of
888 static int check_volume_empty(struct ubifs_info
*c
)
893 for (lnum
= 0; lnum
< c
->leb_cnt
; lnum
++) {
894 err
= ubi_is_mapped(c
->ubi
, lnum
);
895 if (unlikely(err
< 0))
909 * UBIFS mount options.
911 * Opt_fast_unmount: do not run a journal commit before un-mounting
912 * Opt_norm_unmount: run a journal commit before un-mounting
913 * Opt_bulk_read: enable bulk-reads
914 * Opt_no_bulk_read: disable bulk-reads
915 * Opt_chk_data_crc: check CRCs when reading data nodes
916 * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
917 * Opt_override_compr: override default compressor
918 * Opt_err: just end of array marker
931 static const match_table_t tokens
= {
932 {Opt_fast_unmount
, "fast_unmount"},
933 {Opt_norm_unmount
, "norm_unmount"},
934 {Opt_bulk_read
, "bulk_read"},
935 {Opt_no_bulk_read
, "no_bulk_read"},
936 {Opt_chk_data_crc
, "chk_data_crc"},
937 {Opt_no_chk_data_crc
, "no_chk_data_crc"},
938 {Opt_override_compr
, "compr=%s"},
943 * ubifs_parse_options - parse mount parameters.
944 * @c: UBIFS file-system description object
945 * @options: parameters to parse
946 * @is_remount: non-zero if this is FS re-mount
948 * This function parses UBIFS mount options and returns zero in case success
949 * and a negative error code in case of failure.
951 static int ubifs_parse_options(struct ubifs_info
*c
, char *options
,
955 substring_t args
[MAX_OPT_ARGS
];
960 while ((p
= strsep(&options
, ","))) {
966 token
= match_token(p
, tokens
, args
);
969 * %Opt_fast_unmount and %Opt_norm_unmount options are ignored.
970 * We accepte them in order to be backware-compatible. But this
971 * should be removed at some point.
973 case Opt_fast_unmount
:
974 c
->mount_opts
.unmount_mode
= 2;
976 case Opt_norm_unmount
:
977 c
->mount_opts
.unmount_mode
= 1;
980 c
->mount_opts
.bulk_read
= 2;
983 case Opt_no_bulk_read
:
984 c
->mount_opts
.bulk_read
= 1;
987 case Opt_chk_data_crc
:
988 c
->mount_opts
.chk_data_crc
= 2;
989 c
->no_chk_data_crc
= 0;
991 case Opt_no_chk_data_crc
:
992 c
->mount_opts
.chk_data_crc
= 1;
993 c
->no_chk_data_crc
= 1;
995 case Opt_override_compr
:
997 char *name
= match_strdup(&args
[0]);
1001 if (!strcmp(name
, "none"))
1002 c
->mount_opts
.compr_type
= UBIFS_COMPR_NONE
;
1003 else if (!strcmp(name
, "lzo"))
1004 c
->mount_opts
.compr_type
= UBIFS_COMPR_LZO
;
1005 else if (!strcmp(name
, "zlib"))
1006 c
->mount_opts
.compr_type
= UBIFS_COMPR_ZLIB
;
1008 ubifs_err("unknown compressor \"%s\"", name
);
1013 c
->mount_opts
.override_compr
= 1;
1014 c
->default_compr
= c
->mount_opts
.compr_type
;
1018 ubifs_err("unrecognized mount option \"%s\" "
1019 "or missing value", p
);
1028 * destroy_journal - destroy journal data structures.
1029 * @c: UBIFS file-system description object
1031 * This function destroys journal data structures including those that may have
1032 * been created by recovery functions.
1034 static void destroy_journal(struct ubifs_info
*c
)
1036 while (!list_empty(&c
->unclean_leb_list
)) {
1037 struct ubifs_unclean_leb
*ucleb
;
1039 ucleb
= list_entry(c
->unclean_leb_list
.next
,
1040 struct ubifs_unclean_leb
, list
);
1041 list_del(&ucleb
->list
);
1044 while (!list_empty(&c
->old_buds
)) {
1045 struct ubifs_bud
*bud
;
1047 bud
= list_entry(c
->old_buds
.next
, struct ubifs_bud
, list
);
1048 list_del(&bud
->list
);
1051 ubifs_destroy_idx_gc(c
);
1052 ubifs_destroy_size_tree(c
);
1058 * bu_init - initialize bulk-read information.
1059 * @c: UBIFS file-system description object
1061 static void bu_init(struct ubifs_info
*c
)
1063 ubifs_assert(c
->bulk_read
== 1);
1066 return; /* Already initialized */
1069 c
->bu
.buf
= kmalloc(c
->max_bu_buf_len
, GFP_KERNEL
| __GFP_NOWARN
);
1071 if (c
->max_bu_buf_len
> UBIFS_KMALLOC_OK
) {
1072 c
->max_bu_buf_len
= UBIFS_KMALLOC_OK
;
1076 /* Just disable bulk-read */
1077 ubifs_warn("Cannot allocate %d bytes of memory for bulk-read, "
1078 "disabling it", c
->max_bu_buf_len
);
1079 c
->mount_opts
.bulk_read
= 1;
1086 * check_free_space - check if there is enough free space to mount.
1087 * @c: UBIFS file-system description object
1089 * This function makes sure UBIFS has enough free space to be mounted in
1090 * read/write mode. UBIFS must always have some free space to allow deletions.
1092 static int check_free_space(struct ubifs_info
*c
)
1094 ubifs_assert(c
->dark_wm
> 0);
1095 if (c
->lst
.total_free
+ c
->lst
.total_dirty
< c
->dark_wm
) {
1096 ubifs_err("insufficient free space to mount in read/write mode");
1105 * mount_ubifs - mount UBIFS file-system.
1106 * @c: UBIFS file-system description object
1108 * This function mounts UBIFS file system. Returns zero in case of success and
1109 * a negative error code in case of failure.
1111 * Note, the function does not de-allocate resources it it fails half way
1112 * through, and the caller has to do this instead.
1114 static int mount_ubifs(struct ubifs_info
*c
)
1116 struct super_block
*sb
= c
->vfs_sb
;
1117 int err
, mounted_read_only
= (sb
->s_flags
& MS_RDONLY
);
1121 err
= init_constants_early(c
);
1125 err
= ubifs_debugging_init(c
);
1129 err
= check_volume_empty(c
);
1133 if (c
->empty
&& (mounted_read_only
|| c
->ro_media
)) {
1135 * This UBI volume is empty, and read-only, or the file system
1136 * is mounted read-only - we cannot format it.
1138 ubifs_err("can't format empty UBI volume: read-only %s",
1139 c
->ro_media
? "UBI volume" : "mount");
1144 if (c
->ro_media
&& !mounted_read_only
) {
1145 ubifs_err("cannot mount read-write - read-only media");
1151 * The requirement for the buffer is that it should fit indexing B-tree
1152 * height amount of integers. We assume the height if the TNC tree will
1156 c
->bottom_up_buf
= kmalloc(BOTTOM_UP_HEIGHT
* sizeof(int), GFP_KERNEL
);
1157 if (!c
->bottom_up_buf
)
1160 c
->sbuf
= vmalloc(c
->leb_size
);
1164 if (!mounted_read_only
) {
1165 c
->ileb_buf
= vmalloc(c
->leb_size
);
1170 if (c
->bulk_read
== 1)
1174 * We have to check all CRCs, even for data nodes, when we mount the FS
1175 * (specifically, when we are replaying).
1177 c
->always_chk_crc
= 1;
1179 err
= ubifs_read_superblock(c
);
1184 * Make sure the compressor which is set as default in the superblock
1185 * or overridden by mount options is actually compiled in.
1187 if (!ubifs_compr_present(c
->default_compr
)) {
1188 ubifs_err("'compressor \"%s\" is not compiled in",
1189 ubifs_compr_name(c
->default_compr
));
1194 err
= init_constants_sb(c
);
1198 sz
= ALIGN(c
->max_idx_node_sz
, c
->min_io_size
);
1199 sz
= ALIGN(sz
+ c
->max_idx_node_sz
, c
->min_io_size
);
1200 c
->cbuf
= kmalloc(sz
, GFP_NOFS
);
1206 sprintf(c
->bgt_name
, BGT_NAME_PATTERN
, c
->vi
.ubi_num
, c
->vi
.vol_id
);
1207 if (!mounted_read_only
) {
1208 err
= alloc_wbufs(c
);
1212 /* Create background thread */
1213 c
->bgt
= kthread_create(ubifs_bg_thread
, c
, "%s", c
->bgt_name
);
1214 if (IS_ERR(c
->bgt
)) {
1215 err
= PTR_ERR(c
->bgt
);
1217 ubifs_err("cannot spawn \"%s\", error %d",
1221 wake_up_process(c
->bgt
);
1224 err
= ubifs_read_master(c
);
1228 init_constants_master(c
);
1230 if ((c
->mst_node
->flags
& cpu_to_le32(UBIFS_MST_DIRTY
)) != 0) {
1231 ubifs_msg("recovery needed");
1232 c
->need_recovery
= 1;
1233 if (!mounted_read_only
) {
1234 err
= ubifs_recover_inl_heads(c
, c
->sbuf
);
1238 } else if (!mounted_read_only
) {
1240 * Set the "dirty" flag so that if we reboot uncleanly we
1241 * will notice this immediately on the next mount.
1243 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_DIRTY
);
1244 err
= ubifs_write_master(c
);
1249 err
= ubifs_lpt_init(c
, 1, !mounted_read_only
);
1253 err
= dbg_check_idx_size(c
, c
->old_idx_sz
);
1257 err
= ubifs_replay_journal(c
);
1261 err
= ubifs_mount_orphans(c
, c
->need_recovery
, mounted_read_only
);
1265 if (!mounted_read_only
) {
1268 err
= check_free_space(c
);
1272 /* Check for enough log space */
1273 lnum
= c
->lhead_lnum
+ 1;
1274 if (lnum
>= UBIFS_LOG_LNUM
+ c
->log_lebs
)
1275 lnum
= UBIFS_LOG_LNUM
;
1276 if (lnum
== c
->ltail_lnum
) {
1277 err
= ubifs_consolidate_log(c
);
1282 if (c
->need_recovery
) {
1283 err
= ubifs_recover_size(c
);
1286 err
= ubifs_rcvry_gc_commit(c
);
1288 err
= take_gc_lnum(c
);
1293 * GC LEB may contain garbage if there was an unclean
1294 * reboot, and it should be un-mapped.
1296 err
= ubifs_leb_unmap(c
, c
->gc_lnum
);
1301 err
= dbg_check_lprops(c
);
1304 } else if (c
->need_recovery
) {
1305 err
= ubifs_recover_size(c
);
1310 * Even if we mount read-only, we have to set space in GC LEB
1311 * to proper value because this affects UBIFS free space
1312 * reporting. We do not want to have a situation when
1313 * re-mounting from R/O to R/W changes amount of free space.
1315 err
= take_gc_lnum(c
);
1320 spin_lock(&ubifs_infos_lock
);
1321 list_add_tail(&c
->infos_list
, &ubifs_infos
);
1322 spin_unlock(&ubifs_infos_lock
);
1324 if (c
->need_recovery
) {
1325 if (mounted_read_only
)
1326 ubifs_msg("recovery deferred");
1328 c
->need_recovery
= 0;
1329 ubifs_msg("recovery completed");
1331 * GC LEB has to be empty and taken at this point. But
1332 * the journal head LEBs may also be accounted as
1333 * "empty taken" if they are empty.
1335 ubifs_assert(c
->lst
.taken_empty_lebs
> 0);
1338 ubifs_assert(c
->lst
.taken_empty_lebs
> 0);
1340 err
= dbg_check_filesystem(c
);
1344 err
= dbg_debugfs_init_fs(c
);
1348 c
->always_chk_crc
= 0;
1350 ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
1351 c
->vi
.ubi_num
, c
->vi
.vol_id
, c
->vi
.name
);
1352 if (mounted_read_only
)
1353 ubifs_msg("mounted read-only");
1354 x
= (long long)c
->main_lebs
* c
->leb_size
;
1355 ubifs_msg("file system size: %lld bytes (%lld KiB, %lld MiB, %d "
1356 "LEBs)", x
, x
>> 10, x
>> 20, c
->main_lebs
);
1357 x
= (long long)c
->log_lebs
* c
->leb_size
+ c
->max_bud_bytes
;
1358 ubifs_msg("journal size: %lld bytes (%lld KiB, %lld MiB, %d "
1359 "LEBs)", x
, x
>> 10, x
>> 20, c
->log_lebs
+ c
->max_bud_cnt
);
1360 ubifs_msg("media format: w%d/r%d (latest is w%d/r%d)",
1361 c
->fmt_version
, c
->ro_compat_version
,
1362 UBIFS_FORMAT_VERSION
, UBIFS_RO_COMPAT_VERSION
);
1363 ubifs_msg("default compressor: %s", ubifs_compr_name(c
->default_compr
));
1364 ubifs_msg("reserved for root: %llu bytes (%llu KiB)",
1365 c
->report_rp_size
, c
->report_rp_size
>> 10);
1367 dbg_msg("compiled on: " __DATE__
" at " __TIME__
);
1368 dbg_msg("min. I/O unit size: %d bytes", c
->min_io_size
);
1369 dbg_msg("LEB size: %d bytes (%d KiB)",
1370 c
->leb_size
, c
->leb_size
>> 10);
1371 dbg_msg("data journal heads: %d",
1372 c
->jhead_cnt
- NONDATA_JHEADS_CNT
);
1373 dbg_msg("UUID: %02X%02X%02X%02X-%02X%02X"
1374 "-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
1375 c
->uuid
[0], c
->uuid
[1], c
->uuid
[2], c
->uuid
[3],
1376 c
->uuid
[4], c
->uuid
[5], c
->uuid
[6], c
->uuid
[7],
1377 c
->uuid
[8], c
->uuid
[9], c
->uuid
[10], c
->uuid
[11],
1378 c
->uuid
[12], c
->uuid
[13], c
->uuid
[14], c
->uuid
[15]);
1379 dbg_msg("big_lpt %d", c
->big_lpt
);
1380 dbg_msg("log LEBs: %d (%d - %d)",
1381 c
->log_lebs
, UBIFS_LOG_LNUM
, c
->log_last
);
1382 dbg_msg("LPT area LEBs: %d (%d - %d)",
1383 c
->lpt_lebs
, c
->lpt_first
, c
->lpt_last
);
1384 dbg_msg("orphan area LEBs: %d (%d - %d)",
1385 c
->orph_lebs
, c
->orph_first
, c
->orph_last
);
1386 dbg_msg("main area LEBs: %d (%d - %d)",
1387 c
->main_lebs
, c
->main_first
, c
->leb_cnt
- 1);
1388 dbg_msg("index LEBs: %d", c
->lst
.idx_lebs
);
1389 dbg_msg("total index bytes: %lld (%lld KiB, %lld MiB)",
1390 c
->old_idx_sz
, c
->old_idx_sz
>> 10, c
->old_idx_sz
>> 20);
1391 dbg_msg("key hash type: %d", c
->key_hash_type
);
1392 dbg_msg("tree fanout: %d", c
->fanout
);
1393 dbg_msg("reserved GC LEB: %d", c
->gc_lnum
);
1394 dbg_msg("first main LEB: %d", c
->main_first
);
1395 dbg_msg("max. znode size %d", c
->max_znode_sz
);
1396 dbg_msg("max. index node size %d", c
->max_idx_node_sz
);
1397 dbg_msg("node sizes: data %zu, inode %zu, dentry %zu",
1398 UBIFS_DATA_NODE_SZ
, UBIFS_INO_NODE_SZ
, UBIFS_DENT_NODE_SZ
);
1399 dbg_msg("node sizes: trun %zu, sb %zu, master %zu",
1400 UBIFS_TRUN_NODE_SZ
, UBIFS_SB_NODE_SZ
, UBIFS_MST_NODE_SZ
);
1401 dbg_msg("node sizes: ref %zu, cmt. start %zu, orph %zu",
1402 UBIFS_REF_NODE_SZ
, UBIFS_CS_NODE_SZ
, UBIFS_ORPH_NODE_SZ
);
1403 dbg_msg("max. node sizes: data %zu, inode %zu dentry %zu",
1404 UBIFS_MAX_DATA_NODE_SZ
, UBIFS_MAX_INO_NODE_SZ
,
1405 UBIFS_MAX_DENT_NODE_SZ
);
1406 dbg_msg("dead watermark: %d", c
->dead_wm
);
1407 dbg_msg("dark watermark: %d", c
->dark_wm
);
1408 dbg_msg("LEB overhead: %d", c
->leb_overhead
);
1409 x
= (long long)c
->main_lebs
* c
->dark_wm
;
1410 dbg_msg("max. dark space: %lld (%lld KiB, %lld MiB)",
1411 x
, x
>> 10, x
>> 20);
1412 dbg_msg("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
1413 c
->max_bud_bytes
, c
->max_bud_bytes
>> 10,
1414 c
->max_bud_bytes
>> 20);
1415 dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1416 c
->bg_bud_bytes
, c
->bg_bud_bytes
>> 10,
1417 c
->bg_bud_bytes
>> 20);
1418 dbg_msg("current bud bytes %lld (%lld KiB, %lld MiB)",
1419 c
->bud_bytes
, c
->bud_bytes
>> 10, c
->bud_bytes
>> 20);
1420 dbg_msg("max. seq. number: %llu", c
->max_sqnum
);
1421 dbg_msg("commit number: %llu", c
->cmt_no
);
1426 spin_lock(&ubifs_infos_lock
);
1427 list_del(&c
->infos_list
);
1428 spin_unlock(&ubifs_infos_lock
);
1434 ubifs_lpt_free(c
, 0);
1437 kfree(c
->rcvrd_mst_node
);
1439 kthread_stop(c
->bgt
);
1448 kfree(c
->bottom_up_buf
);
1449 ubifs_debugging_exit(c
);
1454 * ubifs_umount - un-mount UBIFS file-system.
1455 * @c: UBIFS file-system description object
1457 * Note, this function is called to free allocated resourced when un-mounting,
1458 * as well as free resources when an error occurred while we were half way
1459 * through mounting (error path cleanup function). So it has to make sure the
1460 * resource was actually allocated before freeing it.
1462 static void ubifs_umount(struct ubifs_info
*c
)
1464 dbg_gen("un-mounting UBI device %d, volume %d", c
->vi
.ubi_num
,
1467 dbg_debugfs_exit_fs(c
);
1468 spin_lock(&ubifs_infos_lock
);
1469 list_del(&c
->infos_list
);
1470 spin_unlock(&ubifs_infos_lock
);
1473 kthread_stop(c
->bgt
);
1478 ubifs_lpt_free(c
, 0);
1481 kfree(c
->rcvrd_mst_node
);
1486 kfree(c
->bottom_up_buf
);
1487 ubifs_debugging_exit(c
);
1491 * ubifs_remount_rw - re-mount in read-write mode.
1492 * @c: UBIFS file-system description object
1494 * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1495 * mode. This function allocates the needed resources and re-mounts UBIFS in
1498 static int ubifs_remount_rw(struct ubifs_info
*c
)
1502 if (c
->rw_incompat
) {
1503 ubifs_err("the file-system is not R/W-compatible");
1504 ubifs_msg("on-flash format version is w%d/r%d, but software "
1505 "only supports up to version w%d/r%d", c
->fmt_version
,
1506 c
->ro_compat_version
, UBIFS_FORMAT_VERSION
,
1507 UBIFS_RO_COMPAT_VERSION
);
1511 mutex_lock(&c
->umount_mutex
);
1512 dbg_save_space_info(c
);
1513 c
->remounting_rw
= 1;
1514 c
->always_chk_crc
= 1;
1516 err
= check_free_space(c
);
1520 if (c
->old_leb_cnt
!= c
->leb_cnt
) {
1521 struct ubifs_sb_node
*sup
;
1523 sup
= ubifs_read_sb_node(c
);
1528 sup
->leb_cnt
= cpu_to_le32(c
->leb_cnt
);
1529 err
= ubifs_write_sb_node(c
, sup
);
1534 if (c
->need_recovery
) {
1535 ubifs_msg("completing deferred recovery");
1536 err
= ubifs_write_rcvrd_mst_node(c
);
1539 err
= ubifs_recover_size(c
);
1542 err
= ubifs_clean_lebs(c
, c
->sbuf
);
1545 err
= ubifs_recover_inl_heads(c
, c
->sbuf
);
1549 /* A readonly mount is not allowed to have orphans */
1550 ubifs_assert(c
->tot_orphans
== 0);
1551 err
= ubifs_clear_orphans(c
);
1556 if (!(c
->mst_node
->flags
& cpu_to_le32(UBIFS_MST_DIRTY
))) {
1557 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_DIRTY
);
1558 err
= ubifs_write_master(c
);
1563 c
->ileb_buf
= vmalloc(c
->leb_size
);
1569 err
= ubifs_lpt_init(c
, 0, 1);
1573 err
= alloc_wbufs(c
);
1577 ubifs_create_buds_lists(c
);
1579 /* Create background thread */
1580 c
->bgt
= kthread_create(ubifs_bg_thread
, c
, "%s", c
->bgt_name
);
1581 if (IS_ERR(c
->bgt
)) {
1582 err
= PTR_ERR(c
->bgt
);
1584 ubifs_err("cannot spawn \"%s\", error %d",
1588 wake_up_process(c
->bgt
);
1590 c
->orph_buf
= vmalloc(c
->leb_size
);
1596 /* Check for enough log space */
1597 lnum
= c
->lhead_lnum
+ 1;
1598 if (lnum
>= UBIFS_LOG_LNUM
+ c
->log_lebs
)
1599 lnum
= UBIFS_LOG_LNUM
;
1600 if (lnum
== c
->ltail_lnum
) {
1601 err
= ubifs_consolidate_log(c
);
1606 if (c
->need_recovery
)
1607 err
= ubifs_rcvry_gc_commit(c
);
1609 err
= ubifs_leb_unmap(c
, c
->gc_lnum
);
1613 if (c
->need_recovery
) {
1614 c
->need_recovery
= 0;
1615 ubifs_msg("deferred recovery completed");
1618 dbg_gen("re-mounted read-write");
1619 c
->vfs_sb
->s_flags
&= ~MS_RDONLY
;
1620 c
->remounting_rw
= 0;
1621 c
->always_chk_crc
= 0;
1622 err
= dbg_check_space_info(c
);
1623 mutex_unlock(&c
->umount_mutex
);
1630 kthread_stop(c
->bgt
);
1636 ubifs_lpt_free(c
, 1);
1637 c
->remounting_rw
= 0;
1638 c
->always_chk_crc
= 0;
1639 mutex_unlock(&c
->umount_mutex
);
1644 * ubifs_remount_ro - re-mount in read-only mode.
1645 * @c: UBIFS file-system description object
1647 * We assume VFS has stopped writing. Possibly the background thread could be
1648 * running a commit, however kthread_stop will wait in that case.
1650 static void ubifs_remount_ro(struct ubifs_info
*c
)
1654 ubifs_assert(!c
->need_recovery
);
1655 ubifs_assert(!(c
->vfs_sb
->s_flags
& MS_RDONLY
));
1657 mutex_lock(&c
->umount_mutex
);
1659 kthread_stop(c
->bgt
);
1663 dbg_save_space_info(c
);
1665 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
1666 ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
1667 del_timer_sync(&c
->jheads
[i
].wbuf
.timer
);
1670 c
->mst_node
->flags
&= ~cpu_to_le32(UBIFS_MST_DIRTY
);
1671 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_NO_ORPHS
);
1672 c
->mst_node
->gc_lnum
= cpu_to_le32(c
->gc_lnum
);
1673 err
= ubifs_write_master(c
);
1675 ubifs_ro_mode(c
, err
);
1682 ubifs_lpt_free(c
, 1);
1683 err
= dbg_check_space_info(c
);
1685 ubifs_ro_mode(c
, err
);
1686 mutex_unlock(&c
->umount_mutex
);
1689 static void ubifs_put_super(struct super_block
*sb
)
1692 struct ubifs_info
*c
= sb
->s_fs_info
;
1694 ubifs_msg("un-mount UBI device %d, volume %d", c
->vi
.ubi_num
,
1697 * The following asserts are only valid if there has not been a failure
1698 * of the media. For example, there will be dirty inodes if we failed
1699 * to write them back because of I/O errors.
1701 ubifs_assert(atomic_long_read(&c
->dirty_pg_cnt
) == 0);
1702 ubifs_assert(c
->budg_idx_growth
== 0);
1703 ubifs_assert(c
->budg_dd_growth
== 0);
1704 ubifs_assert(c
->budg_data_growth
== 0);
1707 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1708 * and file system un-mount. Namely, it prevents the shrinker from
1709 * picking this superblock for shrinking - it will be just skipped if
1710 * the mutex is locked.
1712 mutex_lock(&c
->umount_mutex
);
1713 if (!(c
->vfs_sb
->s_flags
& MS_RDONLY
)) {
1715 * First of all kill the background thread to make sure it does
1716 * not interfere with un-mounting and freeing resources.
1719 kthread_stop(c
->bgt
);
1723 /* Synchronize write-buffers */
1725 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
1726 ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
1727 del_timer_sync(&c
->jheads
[i
].wbuf
.timer
);
1731 * On fatal errors c->ro_media is set to 1, in which case we do
1732 * not write the master node.
1736 * We are being cleanly unmounted which means the
1737 * orphans were killed - indicate this in the master
1738 * node. Also save the reserved GC LEB number.
1742 c
->mst_node
->flags
&= ~cpu_to_le32(UBIFS_MST_DIRTY
);
1743 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_NO_ORPHS
);
1744 c
->mst_node
->gc_lnum
= cpu_to_le32(c
->gc_lnum
);
1745 err
= ubifs_write_master(c
);
1748 * Recovery will attempt to fix the master area
1749 * next mount, so we just print a message and
1750 * continue to unmount normally.
1752 ubifs_err("failed to write master node, "
1758 bdi_destroy(&c
->bdi
);
1759 ubi_close_volume(c
->ubi
);
1760 mutex_unlock(&c
->umount_mutex
);
1764 static int ubifs_remount_fs(struct super_block
*sb
, int *flags
, char *data
)
1767 struct ubifs_info
*c
= sb
->s_fs_info
;
1769 dbg_gen("old flags %#lx, new flags %#x", sb
->s_flags
, *flags
);
1771 err
= ubifs_parse_options(c
, data
, 1);
1773 ubifs_err("invalid or unknown remount parameter");
1777 if ((sb
->s_flags
& MS_RDONLY
) && !(*flags
& MS_RDONLY
)) {
1779 ubifs_msg("cannot re-mount due to prior errors");
1782 err
= ubifs_remount_rw(c
);
1785 } else if (!(sb
->s_flags
& MS_RDONLY
) && (*flags
& MS_RDONLY
)) {
1787 ubifs_msg("cannot re-mount due to prior errors");
1790 ubifs_remount_ro(c
);
1793 if (c
->bulk_read
== 1)
1796 dbg_gen("disable bulk-read");
1801 ubifs_assert(c
->lst
.taken_empty_lebs
> 0);
1805 const struct super_operations ubifs_super_operations
= {
1806 .alloc_inode
= ubifs_alloc_inode
,
1807 .destroy_inode
= ubifs_destroy_inode
,
1808 .put_super
= ubifs_put_super
,
1809 .write_inode
= ubifs_write_inode
,
1810 .delete_inode
= ubifs_delete_inode
,
1811 .statfs
= ubifs_statfs
,
1812 .dirty_inode
= ubifs_dirty_inode
,
1813 .remount_fs
= ubifs_remount_fs
,
1814 .show_options
= ubifs_show_options
,
1815 .sync_fs
= ubifs_sync_fs
,
1819 * open_ubi - parse UBI device name string and open the UBI device.
1820 * @name: UBI volume name
1821 * @mode: UBI volume open mode
1823 * There are several ways to specify UBI volumes when mounting UBIFS:
1824 * o ubiX_Y - UBI device number X, volume Y;
1825 * o ubiY - UBI device number 0, volume Y;
1826 * o ubiX:NAME - mount UBI device X, volume with name NAME;
1827 * o ubi:NAME - mount UBI device 0, volume with name NAME.
1829 * Alternative '!' separator may be used instead of ':' (because some shells
1830 * like busybox may interpret ':' as an NFS host name separator). This function
1831 * returns ubi volume object in case of success and a negative error code in
1834 static struct ubi_volume_desc
*open_ubi(const char *name
, int mode
)
1839 if (name
[0] != 'u' || name
[1] != 'b' || name
[2] != 'i')
1840 return ERR_PTR(-EINVAL
);
1842 /* ubi:NAME method */
1843 if ((name
[3] == ':' || name
[3] == '!') && name
[4] != '\0')
1844 return ubi_open_volume_nm(0, name
+ 4, mode
);
1846 if (!isdigit(name
[3]))
1847 return ERR_PTR(-EINVAL
);
1849 dev
= simple_strtoul(name
+ 3, &endptr
, 0);
1852 if (*endptr
== '\0')
1853 return ubi_open_volume(0, dev
, mode
);
1856 if (*endptr
== '_' && isdigit(endptr
[1])) {
1857 vol
= simple_strtoul(endptr
+ 1, &endptr
, 0);
1858 if (*endptr
!= '\0')
1859 return ERR_PTR(-EINVAL
);
1860 return ubi_open_volume(dev
, vol
, mode
);
1863 /* ubiX:NAME method */
1864 if ((*endptr
== ':' || *endptr
== '!') && endptr
[1] != '\0')
1865 return ubi_open_volume_nm(dev
, ++endptr
, mode
);
1867 return ERR_PTR(-EINVAL
);
1870 static int ubifs_fill_super(struct super_block
*sb
, void *data
, int silent
)
1872 struct ubi_volume_desc
*ubi
= sb
->s_fs_info
;
1873 struct ubifs_info
*c
;
1877 c
= kzalloc(sizeof(struct ubifs_info
), GFP_KERNEL
);
1881 spin_lock_init(&c
->cnt_lock
);
1882 spin_lock_init(&c
->cs_lock
);
1883 spin_lock_init(&c
->buds_lock
);
1884 spin_lock_init(&c
->space_lock
);
1885 spin_lock_init(&c
->orphan_lock
);
1886 init_rwsem(&c
->commit_sem
);
1887 mutex_init(&c
->lp_mutex
);
1888 mutex_init(&c
->tnc_mutex
);
1889 mutex_init(&c
->log_mutex
);
1890 mutex_init(&c
->mst_mutex
);
1891 mutex_init(&c
->umount_mutex
);
1892 mutex_init(&c
->bu_mutex
);
1893 init_waitqueue_head(&c
->cmt_wq
);
1895 c
->old_idx
= RB_ROOT
;
1896 c
->size_tree
= RB_ROOT
;
1897 c
->orph_tree
= RB_ROOT
;
1898 INIT_LIST_HEAD(&c
->infos_list
);
1899 INIT_LIST_HEAD(&c
->idx_gc
);
1900 INIT_LIST_HEAD(&c
->replay_list
);
1901 INIT_LIST_HEAD(&c
->replay_buds
);
1902 INIT_LIST_HEAD(&c
->uncat_list
);
1903 INIT_LIST_HEAD(&c
->empty_list
);
1904 INIT_LIST_HEAD(&c
->freeable_list
);
1905 INIT_LIST_HEAD(&c
->frdi_idx_list
);
1906 INIT_LIST_HEAD(&c
->unclean_leb_list
);
1907 INIT_LIST_HEAD(&c
->old_buds
);
1908 INIT_LIST_HEAD(&c
->orph_list
);
1909 INIT_LIST_HEAD(&c
->orph_new
);
1911 c
->highest_inum
= UBIFS_FIRST_INO
;
1912 c
->lhead_lnum
= c
->ltail_lnum
= UBIFS_LOG_LNUM
;
1914 ubi_get_volume_info(ubi
, &c
->vi
);
1915 ubi_get_device_info(c
->vi
.ubi_num
, &c
->di
);
1917 /* Re-open the UBI device in read-write mode */
1918 c
->ubi
= ubi_open_volume(c
->vi
.ubi_num
, c
->vi
.vol_id
, UBI_READWRITE
);
1919 if (IS_ERR(c
->ubi
)) {
1920 err
= PTR_ERR(c
->ubi
);
1925 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
1926 * UBIFS, I/O is not deferred, it is done immediately in readpage,
1927 * which means the user would have to wait not just for their own I/O
1928 * but the read-ahead I/O as well i.e. completely pointless.
1930 * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
1932 c
->bdi
.capabilities
= BDI_CAP_MAP_COPY
;
1933 c
->bdi
.unplug_io_fn
= default_unplug_io_fn
;
1934 err
= bdi_init(&c
->bdi
);
1938 err
= ubifs_parse_options(c
, data
, 0);
1945 sb
->s_magic
= UBIFS_SUPER_MAGIC
;
1946 sb
->s_blocksize
= UBIFS_BLOCK_SIZE
;
1947 sb
->s_blocksize_bits
= UBIFS_BLOCK_SHIFT
;
1948 sb
->s_dev
= c
->vi
.cdev
;
1949 sb
->s_maxbytes
= c
->max_inode_sz
= key_max_inode_size(c
);
1950 if (c
->max_inode_sz
> MAX_LFS_FILESIZE
)
1951 sb
->s_maxbytes
= c
->max_inode_sz
= MAX_LFS_FILESIZE
;
1952 sb
->s_op
= &ubifs_super_operations
;
1954 mutex_lock(&c
->umount_mutex
);
1955 err
= mount_ubifs(c
);
1957 ubifs_assert(err
< 0);
1961 /* Read the root inode */
1962 root
= ubifs_iget(sb
, UBIFS_ROOT_INO
);
1964 err
= PTR_ERR(root
);
1968 sb
->s_root
= d_alloc_root(root
);
1972 mutex_unlock(&c
->umount_mutex
);
1980 mutex_unlock(&c
->umount_mutex
);
1982 bdi_destroy(&c
->bdi
);
1984 ubi_close_volume(c
->ubi
);
1990 static int sb_test(struct super_block
*sb
, void *data
)
1994 return sb
->s_dev
== *dev
;
1997 static int sb_set(struct super_block
*sb
, void *data
)
2005 static int ubifs_get_sb(struct file_system_type
*fs_type
, int flags
,
2006 const char *name
, void *data
, struct vfsmount
*mnt
)
2008 struct ubi_volume_desc
*ubi
;
2009 struct ubi_volume_info vi
;
2010 struct super_block
*sb
;
2013 dbg_gen("name %s, flags %#x", name
, flags
);
2016 * Get UBI device number and volume ID. Mount it read-only so far
2017 * because this might be a new mount point, and UBI allows only one
2018 * read-write user at a time.
2020 ubi
= open_ubi(name
, UBI_READONLY
);
2022 ubifs_err("cannot open \"%s\", error %d",
2023 name
, (int)PTR_ERR(ubi
));
2024 return PTR_ERR(ubi
);
2026 ubi_get_volume_info(ubi
, &vi
);
2028 dbg_gen("opened ubi%d_%d", vi
.ubi_num
, vi
.vol_id
);
2030 sb
= sget(fs_type
, &sb_test
, &sb_set
, &vi
.cdev
);
2037 /* A new mount point for already mounted UBIFS */
2038 dbg_gen("this ubi volume is already mounted");
2039 if ((flags
^ sb
->s_flags
) & MS_RDONLY
) {
2044 sb
->s_flags
= flags
;
2046 * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
2049 sb
->s_fs_info
= ubi
;
2050 err
= ubifs_fill_super(sb
, data
, flags
& MS_SILENT
? 1 : 0);
2053 /* We do not support atime */
2054 sb
->s_flags
|= MS_ACTIVE
| MS_NOATIME
;
2057 /* 'fill_super()' opens ubi again so we must close it here */
2058 ubi_close_volume(ubi
);
2060 simple_set_mnt(mnt
, sb
);
2064 up_write(&sb
->s_umount
);
2065 deactivate_super(sb
);
2067 ubi_close_volume(ubi
);
2071 static void ubifs_kill_sb(struct super_block
*sb
)
2073 generic_shutdown_super(sb
);
2076 static struct file_system_type ubifs_fs_type
= {
2078 .owner
= THIS_MODULE
,
2079 .get_sb
= ubifs_get_sb
,
2080 .kill_sb
= ubifs_kill_sb
2084 * Inode slab cache constructor.
2086 static void inode_slab_ctor(void *obj
)
2088 struct ubifs_inode
*ui
= obj
;
2089 inode_init_once(&ui
->vfs_inode
);
2092 static int __init
ubifs_init(void)
2096 BUILD_BUG_ON(sizeof(struct ubifs_ch
) != 24);
2098 /* Make sure node sizes are 8-byte aligned */
2099 BUILD_BUG_ON(UBIFS_CH_SZ
& 7);
2100 BUILD_BUG_ON(UBIFS_INO_NODE_SZ
& 7);
2101 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ
& 7);
2102 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ
& 7);
2103 BUILD_BUG_ON(UBIFS_DATA_NODE_SZ
& 7);
2104 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ
& 7);
2105 BUILD_BUG_ON(UBIFS_SB_NODE_SZ
& 7);
2106 BUILD_BUG_ON(UBIFS_MST_NODE_SZ
& 7);
2107 BUILD_BUG_ON(UBIFS_REF_NODE_SZ
& 7);
2108 BUILD_BUG_ON(UBIFS_CS_NODE_SZ
& 7);
2109 BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ
& 7);
2111 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ
& 7);
2112 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ
& 7);
2113 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ
& 7);
2114 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ
& 7);
2115 BUILD_BUG_ON(UBIFS_MAX_NODE_SZ
& 7);
2116 BUILD_BUG_ON(MIN_WRITE_SZ
& 7);
2118 /* Check min. node size */
2119 BUILD_BUG_ON(UBIFS_INO_NODE_SZ
< MIN_WRITE_SZ
);
2120 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ
< MIN_WRITE_SZ
);
2121 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ
< MIN_WRITE_SZ
);
2122 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ
< MIN_WRITE_SZ
);
2124 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2125 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2126 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2127 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2129 /* Defined node sizes */
2130 BUILD_BUG_ON(UBIFS_SB_NODE_SZ
!= 4096);
2131 BUILD_BUG_ON(UBIFS_MST_NODE_SZ
!= 512);
2132 BUILD_BUG_ON(UBIFS_INO_NODE_SZ
!= 160);
2133 BUILD_BUG_ON(UBIFS_REF_NODE_SZ
!= 64);
2136 * We use 2 bit wide bit-fields to store compression type, which should
2137 * be amended if more compressors are added. The bit-fields are:
2138 * @compr_type in 'struct ubifs_inode', @default_compr in
2139 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
2141 BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT
> 4);
2144 * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2145 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2147 if (PAGE_CACHE_SIZE
< UBIFS_BLOCK_SIZE
) {
2148 ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
2149 " at least 4096 bytes",
2150 (unsigned int)PAGE_CACHE_SIZE
);
2154 err
= register_filesystem(&ubifs_fs_type
);
2156 ubifs_err("cannot register file system, error %d", err
);
2161 ubifs_inode_slab
= kmem_cache_create("ubifs_inode_slab",
2162 sizeof(struct ubifs_inode
), 0,
2163 SLAB_MEM_SPREAD
| SLAB_RECLAIM_ACCOUNT
,
2165 if (!ubifs_inode_slab
)
2168 register_shrinker(&ubifs_shrinker_info
);
2170 err
= ubifs_compressors_init();
2174 err
= dbg_debugfs_init();
2181 ubifs_compressors_exit();
2183 unregister_shrinker(&ubifs_shrinker_info
);
2184 kmem_cache_destroy(ubifs_inode_slab
);
2186 unregister_filesystem(&ubifs_fs_type
);
2189 /* late_initcall to let compressors initialize first */
2190 late_initcall(ubifs_init
);
2192 static void __exit
ubifs_exit(void)
2194 ubifs_assert(list_empty(&ubifs_infos
));
2195 ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt
) == 0);
2198 ubifs_compressors_exit();
2199 unregister_shrinker(&ubifs_shrinker_info
);
2200 kmem_cache_destroy(ubifs_inode_slab
);
2201 unregister_filesystem(&ubifs_fs_type
);
2203 module_exit(ubifs_exit
);
2205 MODULE_LICENSE("GPL");
2206 MODULE_VERSION(__stringify(UBIFS_VERSION
));
2207 MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2208 MODULE_DESCRIPTION("UBIFS - UBI File System");