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>
40 * Maximum amount of memory we may 'kmalloc()' without worrying that we are
41 * allocating too much.
43 #define UBIFS_KMALLOC_OK (128*1024)
45 /* Slab cache for UBIFS inodes */
46 struct kmem_cache
*ubifs_inode_slab
;
48 /* UBIFS TNC shrinker description */
49 static struct shrinker ubifs_shrinker_info
= {
50 .shrink
= ubifs_shrinker
,
51 .seeks
= DEFAULT_SEEKS
,
55 * validate_inode - validate inode.
56 * @c: UBIFS file-system description object
57 * @inode: the inode to validate
59 * This is a helper function for 'ubifs_iget()' which validates various fields
60 * of a newly built inode to make sure they contain sane values and prevent
61 * possible vulnerabilities. Returns zero if the inode is all right and
62 * a non-zero error code if not.
64 static int validate_inode(struct ubifs_info
*c
, const struct inode
*inode
)
67 const struct ubifs_inode
*ui
= ubifs_inode(inode
);
69 if (inode
->i_size
> c
->max_inode_sz
) {
70 ubifs_err("inode is too large (%lld)",
71 (long long)inode
->i_size
);
75 if (ui
->compr_type
< 0 || ui
->compr_type
>= UBIFS_COMPR_TYPES_CNT
) {
76 ubifs_err("unknown compression type %d", ui
->compr_type
);
80 if (ui
->xattr_names
+ ui
->xattr_cnt
> XATTR_LIST_MAX
)
83 if (ui
->data_len
< 0 || ui
->data_len
> UBIFS_MAX_INO_DATA
)
86 if (ui
->xattr
&& (inode
->i_mode
& S_IFMT
) != S_IFREG
)
89 if (!ubifs_compr_present(ui
->compr_type
)) {
90 ubifs_warn("inode %lu uses '%s' compression, but it was not "
91 "compiled in", inode
->i_ino
,
92 ubifs_compr_name(ui
->compr_type
));
95 err
= dbg_check_dir_size(c
, inode
);
99 struct inode
*ubifs_iget(struct super_block
*sb
, unsigned long inum
)
103 struct ubifs_ino_node
*ino
;
104 struct ubifs_info
*c
= sb
->s_fs_info
;
106 struct ubifs_inode
*ui
;
108 dbg_gen("inode %lu", inum
);
110 inode
= iget_locked(sb
, inum
);
112 return ERR_PTR(-ENOMEM
);
113 if (!(inode
->i_state
& I_NEW
))
115 ui
= ubifs_inode(inode
);
117 ino
= kmalloc(UBIFS_MAX_INO_NODE_SZ
, GFP_NOFS
);
123 ino_key_init(c
, &key
, inode
->i_ino
);
125 err
= ubifs_tnc_lookup(c
, &key
, ino
);
129 inode
->i_flags
|= (S_NOCMTIME
| S_NOATIME
);
130 inode
->i_nlink
= le32_to_cpu(ino
->nlink
);
131 inode
->i_uid
= le32_to_cpu(ino
->uid
);
132 inode
->i_gid
= le32_to_cpu(ino
->gid
);
133 inode
->i_atime
.tv_sec
= (int64_t)le64_to_cpu(ino
->atime_sec
);
134 inode
->i_atime
.tv_nsec
= le32_to_cpu(ino
->atime_nsec
);
135 inode
->i_mtime
.tv_sec
= (int64_t)le64_to_cpu(ino
->mtime_sec
);
136 inode
->i_mtime
.tv_nsec
= le32_to_cpu(ino
->mtime_nsec
);
137 inode
->i_ctime
.tv_sec
= (int64_t)le64_to_cpu(ino
->ctime_sec
);
138 inode
->i_ctime
.tv_nsec
= le32_to_cpu(ino
->ctime_nsec
);
139 inode
->i_mode
= le32_to_cpu(ino
->mode
);
140 inode
->i_size
= le64_to_cpu(ino
->size
);
142 ui
->data_len
= le32_to_cpu(ino
->data_len
);
143 ui
->flags
= le32_to_cpu(ino
->flags
);
144 ui
->compr_type
= le16_to_cpu(ino
->compr_type
);
145 ui
->creat_sqnum
= le64_to_cpu(ino
->creat_sqnum
);
146 ui
->xattr_cnt
= le32_to_cpu(ino
->xattr_cnt
);
147 ui
->xattr_size
= le32_to_cpu(ino
->xattr_size
);
148 ui
->xattr_names
= le32_to_cpu(ino
->xattr_names
);
149 ui
->synced_i_size
= ui
->ui_size
= inode
->i_size
;
151 ui
->xattr
= (ui
->flags
& UBIFS_XATTR_FL
) ? 1 : 0;
153 err
= validate_inode(c
, inode
);
157 /* Disable read-ahead */
158 inode
->i_mapping
->backing_dev_info
= &c
->bdi
;
160 switch (inode
->i_mode
& S_IFMT
) {
162 inode
->i_mapping
->a_ops
= &ubifs_file_address_operations
;
163 inode
->i_op
= &ubifs_file_inode_operations
;
164 inode
->i_fop
= &ubifs_file_operations
;
166 ui
->data
= kmalloc(ui
->data_len
+ 1, GFP_NOFS
);
171 memcpy(ui
->data
, ino
->data
, ui
->data_len
);
172 ((char *)ui
->data
)[ui
->data_len
] = '\0';
173 } else if (ui
->data_len
!= 0) {
179 inode
->i_op
= &ubifs_dir_inode_operations
;
180 inode
->i_fop
= &ubifs_dir_operations
;
181 if (ui
->data_len
!= 0) {
187 inode
->i_op
= &ubifs_symlink_inode_operations
;
188 if (ui
->data_len
<= 0 || ui
->data_len
> UBIFS_MAX_INO_DATA
) {
192 ui
->data
= kmalloc(ui
->data_len
+ 1, GFP_NOFS
);
197 memcpy(ui
->data
, ino
->data
, ui
->data_len
);
198 ((char *)ui
->data
)[ui
->data_len
] = '\0';
204 union ubifs_dev_desc
*dev
;
206 ui
->data
= kmalloc(sizeof(union ubifs_dev_desc
), GFP_NOFS
);
212 dev
= (union ubifs_dev_desc
*)ino
->data
;
213 if (ui
->data_len
== sizeof(dev
->new))
214 rdev
= new_decode_dev(le32_to_cpu(dev
->new));
215 else if (ui
->data_len
== sizeof(dev
->huge
))
216 rdev
= huge_decode_dev(le64_to_cpu(dev
->huge
));
221 memcpy(ui
->data
, ino
->data
, ui
->data_len
);
222 inode
->i_op
= &ubifs_file_inode_operations
;
223 init_special_inode(inode
, inode
->i_mode
, rdev
);
228 inode
->i_op
= &ubifs_file_inode_operations
;
229 init_special_inode(inode
, inode
->i_mode
, 0);
230 if (ui
->data_len
!= 0) {
241 ubifs_set_inode_flags(inode
);
242 unlock_new_inode(inode
);
246 ubifs_err("inode %lu validation failed, error %d", inode
->i_ino
, err
);
247 dbg_dump_node(c
, ino
);
248 dbg_dump_inode(c
, inode
);
253 ubifs_err("failed to read inode %lu, error %d", inode
->i_ino
, err
);
258 static struct inode
*ubifs_alloc_inode(struct super_block
*sb
)
260 struct ubifs_inode
*ui
;
262 ui
= kmem_cache_alloc(ubifs_inode_slab
, GFP_NOFS
);
266 memset((void *)ui
+ sizeof(struct inode
), 0,
267 sizeof(struct ubifs_inode
) - sizeof(struct inode
));
268 mutex_init(&ui
->ui_mutex
);
269 spin_lock_init(&ui
->ui_lock
);
270 return &ui
->vfs_inode
;
273 static void ubifs_destroy_inode(struct inode
*inode
)
275 struct ubifs_inode
*ui
= ubifs_inode(inode
);
278 kmem_cache_free(ubifs_inode_slab
, inode
);
282 * Note, Linux write-back code calls this without 'i_mutex'.
284 static int ubifs_write_inode(struct inode
*inode
, int wait
)
287 struct ubifs_info
*c
= inode
->i_sb
->s_fs_info
;
288 struct ubifs_inode
*ui
= ubifs_inode(inode
);
290 ubifs_assert(!ui
->xattr
);
291 if (is_bad_inode(inode
))
294 mutex_lock(&ui
->ui_mutex
);
296 * Due to races between write-back forced by budgeting
297 * (see 'sync_some_inodes()') and pdflush write-back, the inode may
298 * have already been synchronized, do not do this again. This might
299 * also happen if it was synchronized in an VFS operation, e.g.
303 mutex_unlock(&ui
->ui_mutex
);
308 * As an optimization, do not write orphan inodes to the media just
309 * because this is not needed.
311 dbg_gen("inode %lu, mode %#x, nlink %u",
312 inode
->i_ino
, (int)inode
->i_mode
, inode
->i_nlink
);
313 if (inode
->i_nlink
) {
314 err
= ubifs_jnl_write_inode(c
, inode
);
316 ubifs_err("can't write inode %lu, error %d",
321 mutex_unlock(&ui
->ui_mutex
);
322 ubifs_release_dirty_inode_budget(c
, ui
);
326 static void ubifs_delete_inode(struct inode
*inode
)
329 struct ubifs_info
*c
= inode
->i_sb
->s_fs_info
;
330 struct ubifs_inode
*ui
= ubifs_inode(inode
);
334 * Extended attribute inode deletions are fully handled in
335 * 'ubifs_removexattr()'. These inodes are special and have
336 * limited usage, so there is nothing to do here.
340 dbg_gen("inode %lu, mode %#x", inode
->i_ino
, (int)inode
->i_mode
);
341 ubifs_assert(!atomic_read(&inode
->i_count
));
342 ubifs_assert(inode
->i_nlink
== 0);
344 truncate_inode_pages(&inode
->i_data
, 0);
345 if (is_bad_inode(inode
))
348 ui
->ui_size
= inode
->i_size
= 0;
349 err
= ubifs_jnl_delete_inode(c
, inode
);
352 * Worst case we have a lost orphan inode wasting space, so a
353 * simple error message is OK here.
355 ubifs_err("can't delete inode %lu, error %d",
360 ubifs_release_dirty_inode_budget(c
, ui
);
364 static void ubifs_dirty_inode(struct inode
*inode
)
366 struct ubifs_inode
*ui
= ubifs_inode(inode
);
368 ubifs_assert(mutex_is_locked(&ui
->ui_mutex
));
371 dbg_gen("inode %lu", inode
->i_ino
);
375 static int ubifs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
377 struct ubifs_info
*c
= dentry
->d_sb
->s_fs_info
;
378 unsigned long long free
;
379 __le32
*uuid
= (__le32
*)c
->uuid
;
381 free
= ubifs_get_free_space(c
);
382 dbg_gen("free space %lld bytes (%lld blocks)",
383 free
, free
>> UBIFS_BLOCK_SHIFT
);
385 buf
->f_type
= UBIFS_SUPER_MAGIC
;
386 buf
->f_bsize
= UBIFS_BLOCK_SIZE
;
387 buf
->f_blocks
= c
->block_cnt
;
388 buf
->f_bfree
= free
>> UBIFS_BLOCK_SHIFT
;
389 if (free
> c
->report_rp_size
)
390 buf
->f_bavail
= (free
- c
->report_rp_size
) >> UBIFS_BLOCK_SHIFT
;
395 buf
->f_namelen
= UBIFS_MAX_NLEN
;
396 buf
->f_fsid
.val
[0] = le32_to_cpu(uuid
[0]) ^ le32_to_cpu(uuid
[2]);
397 buf
->f_fsid
.val
[1] = le32_to_cpu(uuid
[1]) ^ le32_to_cpu(uuid
[3]);
401 static int ubifs_show_options(struct seq_file
*s
, struct vfsmount
*mnt
)
403 struct ubifs_info
*c
= mnt
->mnt_sb
->s_fs_info
;
405 if (c
->mount_opts
.unmount_mode
== 2)
406 seq_printf(s
, ",fast_unmount");
407 else if (c
->mount_opts
.unmount_mode
== 1)
408 seq_printf(s
, ",norm_unmount");
410 if (c
->mount_opts
.bulk_read
== 2)
411 seq_printf(s
, ",bulk_read");
412 else if (c
->mount_opts
.bulk_read
== 1)
413 seq_printf(s
, ",no_bulk_read");
415 if (c
->mount_opts
.chk_data_crc
== 2)
416 seq_printf(s
, ",chk_data_crc");
417 else if (c
->mount_opts
.chk_data_crc
== 1)
418 seq_printf(s
, ",no_chk_data_crc");
420 if (c
->mount_opts
.override_compr
) {
421 seq_printf(s
, ",compr=");
422 seq_printf(s
, ubifs_compr_name(c
->mount_opts
.compr_type
));
428 static int ubifs_sync_fs(struct super_block
*sb
, int wait
)
430 struct ubifs_info
*c
= sb
->s_fs_info
;
435 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
436 err
= ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
441 /* Commit the journal unless it has too little data */
442 spin_lock(&c
->buds_lock
);
443 bud_bytes
= c
->bud_bytes
;
444 spin_unlock(&c
->buds_lock
);
445 if (bud_bytes
> c
->leb_size
) {
446 err
= ubifs_run_commit(c
);
453 * We ought to call sync for c->ubi but it does not have one. If it had
454 * it would in turn call mtd->sync, however mtd operations are
455 * synchronous anyway, so we don't lose any sleep here.
461 * init_constants_early - initialize UBIFS constants.
462 * @c: UBIFS file-system description object
464 * This function initialize UBIFS constants which do not need the superblock to
465 * be read. It also checks that the UBI volume satisfies basic UBIFS
466 * requirements. Returns zero in case of success and a negative error code in
469 static int init_constants_early(struct ubifs_info
*c
)
471 if (c
->vi
.corrupted
) {
472 ubifs_warn("UBI volume is corrupted - read-only mode");
477 ubifs_msg("read-only UBI device");
481 if (c
->vi
.vol_type
== UBI_STATIC_VOLUME
) {
482 ubifs_msg("static UBI volume - read-only mode");
486 c
->leb_cnt
= c
->vi
.size
;
487 c
->leb_size
= c
->vi
.usable_leb_size
;
488 c
->half_leb_size
= c
->leb_size
/ 2;
489 c
->min_io_size
= c
->di
.min_io_size
;
490 c
->min_io_shift
= fls(c
->min_io_size
) - 1;
492 if (c
->leb_size
< UBIFS_MIN_LEB_SZ
) {
493 ubifs_err("too small LEBs (%d bytes), min. is %d bytes",
494 c
->leb_size
, UBIFS_MIN_LEB_SZ
);
498 if (c
->leb_cnt
< UBIFS_MIN_LEB_CNT
) {
499 ubifs_err("too few LEBs (%d), min. is %d",
500 c
->leb_cnt
, UBIFS_MIN_LEB_CNT
);
504 if (!is_power_of_2(c
->min_io_size
)) {
505 ubifs_err("bad min. I/O size %d", c
->min_io_size
);
510 * UBIFS aligns all node to 8-byte boundary, so to make function in
511 * io.c simpler, assume minimum I/O unit size to be 8 bytes if it is
514 if (c
->min_io_size
< 8) {
519 c
->ref_node_alsz
= ALIGN(UBIFS_REF_NODE_SZ
, c
->min_io_size
);
520 c
->mst_node_alsz
= ALIGN(UBIFS_MST_NODE_SZ
, c
->min_io_size
);
523 * Initialize node length ranges which are mostly needed for node
526 c
->ranges
[UBIFS_PAD_NODE
].len
= UBIFS_PAD_NODE_SZ
;
527 c
->ranges
[UBIFS_SB_NODE
].len
= UBIFS_SB_NODE_SZ
;
528 c
->ranges
[UBIFS_MST_NODE
].len
= UBIFS_MST_NODE_SZ
;
529 c
->ranges
[UBIFS_REF_NODE
].len
= UBIFS_REF_NODE_SZ
;
530 c
->ranges
[UBIFS_TRUN_NODE
].len
= UBIFS_TRUN_NODE_SZ
;
531 c
->ranges
[UBIFS_CS_NODE
].len
= UBIFS_CS_NODE_SZ
;
533 c
->ranges
[UBIFS_INO_NODE
].min_len
= UBIFS_INO_NODE_SZ
;
534 c
->ranges
[UBIFS_INO_NODE
].max_len
= UBIFS_MAX_INO_NODE_SZ
;
535 c
->ranges
[UBIFS_ORPH_NODE
].min_len
=
536 UBIFS_ORPH_NODE_SZ
+ sizeof(__le64
);
537 c
->ranges
[UBIFS_ORPH_NODE
].max_len
= c
->leb_size
;
538 c
->ranges
[UBIFS_DENT_NODE
].min_len
= UBIFS_DENT_NODE_SZ
;
539 c
->ranges
[UBIFS_DENT_NODE
].max_len
= UBIFS_MAX_DENT_NODE_SZ
;
540 c
->ranges
[UBIFS_XENT_NODE
].min_len
= UBIFS_XENT_NODE_SZ
;
541 c
->ranges
[UBIFS_XENT_NODE
].max_len
= UBIFS_MAX_XENT_NODE_SZ
;
542 c
->ranges
[UBIFS_DATA_NODE
].min_len
= UBIFS_DATA_NODE_SZ
;
543 c
->ranges
[UBIFS_DATA_NODE
].max_len
= UBIFS_MAX_DATA_NODE_SZ
;
545 * Minimum indexing node size is amended later when superblock is
546 * read and the key length is known.
548 c
->ranges
[UBIFS_IDX_NODE
].min_len
= UBIFS_IDX_NODE_SZ
+ UBIFS_BRANCH_SZ
;
550 * Maximum indexing node size is amended later when superblock is
551 * read and the fanout is known.
553 c
->ranges
[UBIFS_IDX_NODE
].max_len
= INT_MAX
;
556 * Initialize dead and dark LEB space watermarks.
558 * Dead space is the space which cannot be used. Its watermark is
559 * equivalent to min. I/O unit or minimum node size if it is greater
560 * then min. I/O unit.
562 * Dark space is the space which might be used, or might not, depending
563 * on which node should be written to the LEB. Its watermark is
564 * equivalent to maximum UBIFS node size.
566 c
->dead_wm
= ALIGN(MIN_WRITE_SZ
, c
->min_io_size
);
567 c
->dark_wm
= ALIGN(UBIFS_MAX_NODE_SZ
, c
->min_io_size
);
570 * Calculate how many bytes would be wasted at the end of LEB if it was
571 * fully filled with data nodes of maximum size. This is used in
572 * calculations when reporting free space.
574 c
->leb_overhead
= c
->leb_size
% UBIFS_MAX_DATA_NODE_SZ
;
576 /* Buffer size for bulk-reads */
577 c
->max_bu_buf_len
= UBIFS_MAX_BULK_READ
* UBIFS_MAX_DATA_NODE_SZ
;
578 if (c
->max_bu_buf_len
> c
->leb_size
)
579 c
->max_bu_buf_len
= c
->leb_size
;
584 * bud_wbuf_callback - bud LEB write-buffer synchronization call-back.
585 * @c: UBIFS file-system description object
586 * @lnum: LEB the write-buffer was synchronized to
587 * @free: how many free bytes left in this LEB
588 * @pad: how many bytes were padded
590 * This is a callback function which is called by the I/O unit when the
591 * write-buffer is synchronized. We need this to correctly maintain space
592 * accounting in bud logical eraseblocks. This function returns zero in case of
593 * success and a negative error code in case of failure.
595 * This function actually belongs to the journal, but we keep it here because
596 * we want to keep it static.
598 static int bud_wbuf_callback(struct ubifs_info
*c
, int lnum
, int free
, int pad
)
600 return ubifs_update_one_lp(c
, lnum
, free
, pad
, 0, 0);
604 * init_constants_late - initialize UBIFS constants.
605 * @c: UBIFS file-system description object
607 * This is a helper function which initializes various UBIFS constants after
608 * the superblock has been read. It also checks various UBIFS parameters and
609 * makes sure they are all right. Returns zero in case of success and a
610 * negative error code in case of failure.
612 static int init_constants_late(struct ubifs_info
*c
)
617 c
->main_bytes
= (long long)c
->main_lebs
* c
->leb_size
;
618 c
->max_znode_sz
= sizeof(struct ubifs_znode
) +
619 c
->fanout
* sizeof(struct ubifs_zbranch
);
621 tmp
= ubifs_idx_node_sz(c
, 1);
622 c
->ranges
[UBIFS_IDX_NODE
].min_len
= tmp
;
623 c
->min_idx_node_sz
= ALIGN(tmp
, 8);
625 tmp
= ubifs_idx_node_sz(c
, c
->fanout
);
626 c
->ranges
[UBIFS_IDX_NODE
].max_len
= tmp
;
627 c
->max_idx_node_sz
= ALIGN(tmp
, 8);
629 /* Make sure LEB size is large enough to fit full commit */
630 tmp
= UBIFS_CS_NODE_SZ
+ UBIFS_REF_NODE_SZ
* c
->jhead_cnt
;
631 tmp
= ALIGN(tmp
, c
->min_io_size
);
632 if (tmp
> c
->leb_size
) {
633 dbg_err("too small LEB size %d, at least %d needed",
639 * Make sure that the log is large enough to fit reference nodes for
640 * all buds plus one reserved LEB.
642 tmp64
= c
->max_bud_bytes
;
643 tmp
= do_div(tmp64
, c
->leb_size
);
644 c
->max_bud_cnt
= tmp64
+ !!tmp
;
645 tmp
= (c
->ref_node_alsz
* c
->max_bud_cnt
+ c
->leb_size
- 1);
648 if (c
->log_lebs
< tmp
) {
649 dbg_err("too small log %d LEBs, required min. %d LEBs",
655 * When budgeting we assume worst-case scenarios when the pages are not
656 * be compressed and direntries are of the maximum size.
658 * Note, data, which may be stored in inodes is budgeted separately, so
659 * it is not included into 'c->inode_budget'.
661 c
->page_budget
= UBIFS_MAX_DATA_NODE_SZ
* UBIFS_BLOCKS_PER_PAGE
;
662 c
->inode_budget
= UBIFS_INO_NODE_SZ
;
663 c
->dent_budget
= UBIFS_MAX_DENT_NODE_SZ
;
666 * When the amount of flash space used by buds becomes
667 * 'c->max_bud_bytes', UBIFS just blocks all writers and starts commit.
668 * The writers are unblocked when the commit is finished. To avoid
669 * writers to be blocked UBIFS initiates background commit in advance,
670 * when number of bud bytes becomes above the limit defined below.
672 c
->bg_bud_bytes
= (c
->max_bud_bytes
* 13) >> 4;
675 * Ensure minimum journal size. All the bytes in the journal heads are
676 * considered to be used, when calculating the current journal usage.
677 * Consequently, if the journal is too small, UBIFS will treat it as
680 tmp64
= (uint64_t)(c
->jhead_cnt
+ 1) * c
->leb_size
+ 1;
681 if (c
->bg_bud_bytes
< tmp64
)
682 c
->bg_bud_bytes
= tmp64
;
683 if (c
->max_bud_bytes
< tmp64
+ c
->leb_size
)
684 c
->max_bud_bytes
= tmp64
+ c
->leb_size
;
686 err
= ubifs_calc_lpt_geom(c
);
690 c
->min_idx_lebs
= ubifs_calc_min_idx_lebs(c
);
693 * Calculate total amount of FS blocks. This number is not used
694 * internally because it does not make much sense for UBIFS, but it is
695 * necessary to report something for the 'statfs()' call.
697 * Subtract the LEB reserved for GC, the LEB which is reserved for
698 * deletions, and assume only one journal head is available.
700 tmp64
= c
->main_lebs
- 2 - c
->jhead_cnt
+ 1;
701 tmp64
*= (uint64_t)c
->leb_size
- c
->leb_overhead
;
702 tmp64
= ubifs_reported_space(c
, tmp64
);
703 c
->block_cnt
= tmp64
>> UBIFS_BLOCK_SHIFT
;
709 * take_gc_lnum - reserve GC LEB.
710 * @c: UBIFS file-system description object
712 * This function ensures that the LEB reserved for garbage collection is
713 * unmapped and is marked as "taken" in lprops. We also have to set free space
714 * to LEB size and dirty space to zero, because lprops may contain out-of-date
715 * information if the file-system was un-mounted before it has been committed.
716 * This function returns zero in case of success and a negative error code in
719 static int take_gc_lnum(struct ubifs_info
*c
)
723 if (c
->gc_lnum
== -1) {
724 ubifs_err("no LEB for GC");
728 err
= ubifs_leb_unmap(c
, c
->gc_lnum
);
732 /* And we have to tell lprops that this LEB is taken */
733 err
= ubifs_change_one_lp(c
, c
->gc_lnum
, c
->leb_size
, 0,
739 * alloc_wbufs - allocate write-buffers.
740 * @c: UBIFS file-system description object
742 * This helper function allocates and initializes UBIFS write-buffers. Returns
743 * zero in case of success and %-ENOMEM in case of failure.
745 static int alloc_wbufs(struct ubifs_info
*c
)
749 c
->jheads
= kzalloc(c
->jhead_cnt
* sizeof(struct ubifs_jhead
),
754 /* Initialize journal heads */
755 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
756 INIT_LIST_HEAD(&c
->jheads
[i
].buds_list
);
757 err
= ubifs_wbuf_init(c
, &c
->jheads
[i
].wbuf
);
761 c
->jheads
[i
].wbuf
.sync_callback
= &bud_wbuf_callback
;
762 c
->jheads
[i
].wbuf
.jhead
= i
;
765 c
->jheads
[BASEHD
].wbuf
.dtype
= UBI_SHORTTERM
;
767 * Garbage Collector head likely contains long-term data and
768 * does not need to be synchronized by timer.
770 c
->jheads
[GCHD
].wbuf
.dtype
= UBI_LONGTERM
;
771 c
->jheads
[GCHD
].wbuf
.timeout
= 0;
777 * free_wbufs - free write-buffers.
778 * @c: UBIFS file-system description object
780 static void free_wbufs(struct ubifs_info
*c
)
785 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
786 kfree(c
->jheads
[i
].wbuf
.buf
);
787 kfree(c
->jheads
[i
].wbuf
.inodes
);
795 * free_orphans - free orphans.
796 * @c: UBIFS file-system description object
798 static void free_orphans(struct ubifs_info
*c
)
800 struct ubifs_orphan
*orph
;
802 while (c
->orph_dnext
) {
803 orph
= c
->orph_dnext
;
804 c
->orph_dnext
= orph
->dnext
;
805 list_del(&orph
->list
);
809 while (!list_empty(&c
->orph_list
)) {
810 orph
= list_entry(c
->orph_list
.next
, struct ubifs_orphan
, list
);
811 list_del(&orph
->list
);
813 dbg_err("orphan list not empty at unmount");
821 * free_buds - free per-bud objects.
822 * @c: UBIFS file-system description object
824 static void free_buds(struct ubifs_info
*c
)
826 struct rb_node
*this = c
->buds
.rb_node
;
827 struct ubifs_bud
*bud
;
831 this = this->rb_left
;
832 else if (this->rb_right
)
833 this = this->rb_right
;
835 bud
= rb_entry(this, struct ubifs_bud
, rb
);
836 this = rb_parent(this);
838 if (this->rb_left
== &bud
->rb
)
839 this->rb_left
= NULL
;
841 this->rb_right
= NULL
;
849 * check_volume_empty - check if the UBI volume is empty.
850 * @c: UBIFS file-system description object
852 * This function checks if the UBIFS volume is empty by looking if its LEBs are
853 * mapped or not. The result of checking is stored in the @c->empty variable.
854 * Returns zero in case of success and a negative error code in case of
857 static int check_volume_empty(struct ubifs_info
*c
)
862 for (lnum
= 0; lnum
< c
->leb_cnt
; lnum
++) {
863 err
= ubi_is_mapped(c
->ubi
, lnum
);
864 if (unlikely(err
< 0))
878 * UBIFS mount options.
880 * Opt_fast_unmount: do not run a journal commit before un-mounting
881 * Opt_norm_unmount: run a journal commit before un-mounting
882 * Opt_bulk_read: enable bulk-reads
883 * Opt_no_bulk_read: disable bulk-reads
884 * Opt_chk_data_crc: check CRCs when reading data nodes
885 * Opt_no_chk_data_crc: do not check CRCs when reading data nodes
886 * Opt_override_compr: override default compressor
887 * Opt_err: just end of array marker
900 static const match_table_t tokens
= {
901 {Opt_fast_unmount
, "fast_unmount"},
902 {Opt_norm_unmount
, "norm_unmount"},
903 {Opt_bulk_read
, "bulk_read"},
904 {Opt_no_bulk_read
, "no_bulk_read"},
905 {Opt_chk_data_crc
, "chk_data_crc"},
906 {Opt_no_chk_data_crc
, "no_chk_data_crc"},
907 {Opt_override_compr
, "compr=%s"},
912 * ubifs_parse_options - parse mount parameters.
913 * @c: UBIFS file-system description object
914 * @options: parameters to parse
915 * @is_remount: non-zero if this is FS re-mount
917 * This function parses UBIFS mount options and returns zero in case success
918 * and a negative error code in case of failure.
920 static int ubifs_parse_options(struct ubifs_info
*c
, char *options
,
924 substring_t args
[MAX_OPT_ARGS
];
929 while ((p
= strsep(&options
, ","))) {
935 token
= match_token(p
, tokens
, args
);
937 case Opt_fast_unmount
:
938 c
->mount_opts
.unmount_mode
= 2;
941 case Opt_norm_unmount
:
942 c
->mount_opts
.unmount_mode
= 1;
946 c
->mount_opts
.bulk_read
= 2;
949 case Opt_no_bulk_read
:
950 c
->mount_opts
.bulk_read
= 1;
953 case Opt_chk_data_crc
:
954 c
->mount_opts
.chk_data_crc
= 2;
955 c
->no_chk_data_crc
= 0;
957 case Opt_no_chk_data_crc
:
958 c
->mount_opts
.chk_data_crc
= 1;
959 c
->no_chk_data_crc
= 1;
961 case Opt_override_compr
:
963 char *name
= match_strdup(&args
[0]);
967 if (!strcmp(name
, "none"))
968 c
->mount_opts
.compr_type
= UBIFS_COMPR_NONE
;
969 else if (!strcmp(name
, "lzo"))
970 c
->mount_opts
.compr_type
= UBIFS_COMPR_LZO
;
971 else if (!strcmp(name
, "zlib"))
972 c
->mount_opts
.compr_type
= UBIFS_COMPR_ZLIB
;
974 ubifs_err("unknown compressor \"%s\"", name
);
979 c
->mount_opts
.override_compr
= 1;
980 c
->default_compr
= c
->mount_opts
.compr_type
;
984 ubifs_err("unrecognized mount option \"%s\" "
985 "or missing value", p
);
994 * destroy_journal - destroy journal data structures.
995 * @c: UBIFS file-system description object
997 * This function destroys journal data structures including those that may have
998 * been created by recovery functions.
1000 static void destroy_journal(struct ubifs_info
*c
)
1002 while (!list_empty(&c
->unclean_leb_list
)) {
1003 struct ubifs_unclean_leb
*ucleb
;
1005 ucleb
= list_entry(c
->unclean_leb_list
.next
,
1006 struct ubifs_unclean_leb
, list
);
1007 list_del(&ucleb
->list
);
1010 while (!list_empty(&c
->old_buds
)) {
1011 struct ubifs_bud
*bud
;
1013 bud
= list_entry(c
->old_buds
.next
, struct ubifs_bud
, list
);
1014 list_del(&bud
->list
);
1017 ubifs_destroy_idx_gc(c
);
1018 ubifs_destroy_size_tree(c
);
1024 * bu_init - initialize bulk-read information.
1025 * @c: UBIFS file-system description object
1027 static void bu_init(struct ubifs_info
*c
)
1029 ubifs_assert(c
->bulk_read
== 1);
1032 return; /* Already initialized */
1035 c
->bu
.buf
= kmalloc(c
->max_bu_buf_len
, GFP_KERNEL
| __GFP_NOWARN
);
1037 if (c
->max_bu_buf_len
> UBIFS_KMALLOC_OK
) {
1038 c
->max_bu_buf_len
= UBIFS_KMALLOC_OK
;
1042 /* Just disable bulk-read */
1043 ubifs_warn("Cannot allocate %d bytes of memory for bulk-read, "
1044 "disabling it", c
->max_bu_buf_len
);
1045 c
->mount_opts
.bulk_read
= 1;
1052 * mount_ubifs - mount UBIFS file-system.
1053 * @c: UBIFS file-system description object
1055 * This function mounts UBIFS file system. Returns zero in case of success and
1056 * a negative error code in case of failure.
1058 * Note, the function does not de-allocate resources it it fails half way
1059 * through, and the caller has to do this instead.
1061 static int mount_ubifs(struct ubifs_info
*c
)
1063 struct super_block
*sb
= c
->vfs_sb
;
1064 int err
, mounted_read_only
= (sb
->s_flags
& MS_RDONLY
);
1068 err
= init_constants_early(c
);
1072 err
= ubifs_debugging_init(c
);
1076 err
= check_volume_empty(c
);
1080 if (c
->empty
&& (mounted_read_only
|| c
->ro_media
)) {
1082 * This UBI volume is empty, and read-only, or the file system
1083 * is mounted read-only - we cannot format it.
1085 ubifs_err("can't format empty UBI volume: read-only %s",
1086 c
->ro_media
? "UBI volume" : "mount");
1091 if (c
->ro_media
&& !mounted_read_only
) {
1092 ubifs_err("cannot mount read-write - read-only media");
1098 * The requirement for the buffer is that it should fit indexing B-tree
1099 * height amount of integers. We assume the height if the TNC tree will
1103 c
->bottom_up_buf
= kmalloc(BOTTOM_UP_HEIGHT
* sizeof(int), GFP_KERNEL
);
1104 if (!c
->bottom_up_buf
)
1107 c
->sbuf
= vmalloc(c
->leb_size
);
1111 if (!mounted_read_only
) {
1112 c
->ileb_buf
= vmalloc(c
->leb_size
);
1117 if (c
->bulk_read
== 1)
1121 * We have to check all CRCs, even for data nodes, when we mount the FS
1122 * (specifically, when we are replaying).
1124 c
->always_chk_crc
= 1;
1126 err
= ubifs_read_superblock(c
);
1131 * Make sure the compressor which is set as default in the superblock
1132 * or overriden by mount options is actually compiled in.
1134 if (!ubifs_compr_present(c
->default_compr
)) {
1135 ubifs_err("'compressor \"%s\" is not compiled in",
1136 ubifs_compr_name(c
->default_compr
));
1140 err
= init_constants_late(c
);
1144 sz
= ALIGN(c
->max_idx_node_sz
, c
->min_io_size
);
1145 sz
= ALIGN(sz
+ c
->max_idx_node_sz
, c
->min_io_size
);
1146 c
->cbuf
= kmalloc(sz
, GFP_NOFS
);
1152 sprintf(c
->bgt_name
, BGT_NAME_PATTERN
, c
->vi
.ubi_num
, c
->vi
.vol_id
);
1153 if (!mounted_read_only
) {
1154 err
= alloc_wbufs(c
);
1158 /* Create background thread */
1159 c
->bgt
= kthread_create(ubifs_bg_thread
, c
, c
->bgt_name
);
1160 if (IS_ERR(c
->bgt
)) {
1161 err
= PTR_ERR(c
->bgt
);
1163 ubifs_err("cannot spawn \"%s\", error %d",
1167 wake_up_process(c
->bgt
);
1170 err
= ubifs_read_master(c
);
1174 if ((c
->mst_node
->flags
& cpu_to_le32(UBIFS_MST_DIRTY
)) != 0) {
1175 ubifs_msg("recovery needed");
1176 c
->need_recovery
= 1;
1177 if (!mounted_read_only
) {
1178 err
= ubifs_recover_inl_heads(c
, c
->sbuf
);
1182 } else if (!mounted_read_only
) {
1184 * Set the "dirty" flag so that if we reboot uncleanly we
1185 * will notice this immediately on the next mount.
1187 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_DIRTY
);
1188 err
= ubifs_write_master(c
);
1193 err
= ubifs_lpt_init(c
, 1, !mounted_read_only
);
1197 err
= dbg_check_idx_size(c
, c
->old_idx_sz
);
1201 err
= ubifs_replay_journal(c
);
1205 err
= ubifs_mount_orphans(c
, c
->need_recovery
, mounted_read_only
);
1209 if (!mounted_read_only
) {
1212 /* Check for enough free space */
1213 if (ubifs_calc_available(c
, c
->min_idx_lebs
) <= 0) {
1214 ubifs_err("insufficient available space");
1219 /* Check for enough log space */
1220 lnum
= c
->lhead_lnum
+ 1;
1221 if (lnum
>= UBIFS_LOG_LNUM
+ c
->log_lebs
)
1222 lnum
= UBIFS_LOG_LNUM
;
1223 if (lnum
== c
->ltail_lnum
) {
1224 err
= ubifs_consolidate_log(c
);
1229 if (c
->need_recovery
) {
1230 err
= ubifs_recover_size(c
);
1233 err
= ubifs_rcvry_gc_commit(c
);
1235 err
= take_gc_lnum(c
);
1239 err
= dbg_check_lprops(c
);
1242 } else if (c
->need_recovery
) {
1243 err
= ubifs_recover_size(c
);
1248 spin_lock(&ubifs_infos_lock
);
1249 list_add_tail(&c
->infos_list
, &ubifs_infos
);
1250 spin_unlock(&ubifs_infos_lock
);
1252 if (c
->need_recovery
) {
1253 if (mounted_read_only
)
1254 ubifs_msg("recovery deferred");
1256 c
->need_recovery
= 0;
1257 ubifs_msg("recovery completed");
1261 err
= dbg_check_filesystem(c
);
1265 c
->always_chk_crc
= 0;
1267 ubifs_msg("mounted UBI device %d, volume %d, name \"%s\"",
1268 c
->vi
.ubi_num
, c
->vi
.vol_id
, c
->vi
.name
);
1269 if (mounted_read_only
)
1270 ubifs_msg("mounted read-only");
1271 x
= (long long)c
->main_lebs
* c
->leb_size
;
1272 ubifs_msg("file system size: %lld bytes (%lld KiB, %lld MiB, %d "
1273 "LEBs)", x
, x
>> 10, x
>> 20, c
->main_lebs
);
1274 x
= (long long)c
->log_lebs
* c
->leb_size
+ c
->max_bud_bytes
;
1275 ubifs_msg("journal size: %lld bytes (%lld KiB, %lld MiB, %d "
1276 "LEBs)", x
, x
>> 10, x
>> 20, c
->log_lebs
+ c
->max_bud_cnt
);
1277 ubifs_msg("media format: %d (latest is %d)",
1278 c
->fmt_version
, UBIFS_FORMAT_VERSION
);
1279 ubifs_msg("default compressor: %s", ubifs_compr_name(c
->default_compr
));
1280 ubifs_msg("reserved for root: %llu bytes (%llu KiB)",
1281 c
->report_rp_size
, c
->report_rp_size
>> 10);
1283 dbg_msg("compiled on: " __DATE__
" at " __TIME__
);
1284 dbg_msg("min. I/O unit size: %d bytes", c
->min_io_size
);
1285 dbg_msg("LEB size: %d bytes (%d KiB)",
1286 c
->leb_size
, c
->leb_size
>> 10);
1287 dbg_msg("data journal heads: %d",
1288 c
->jhead_cnt
- NONDATA_JHEADS_CNT
);
1289 dbg_msg("UUID: %02X%02X%02X%02X-%02X%02X"
1290 "-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
1291 c
->uuid
[0], c
->uuid
[1], c
->uuid
[2], c
->uuid
[3],
1292 c
->uuid
[4], c
->uuid
[5], c
->uuid
[6], c
->uuid
[7],
1293 c
->uuid
[8], c
->uuid
[9], c
->uuid
[10], c
->uuid
[11],
1294 c
->uuid
[12], c
->uuid
[13], c
->uuid
[14], c
->uuid
[15]);
1295 dbg_msg("fast unmount: %d", c
->fast_unmount
);
1296 dbg_msg("big_lpt %d", c
->big_lpt
);
1297 dbg_msg("log LEBs: %d (%d - %d)",
1298 c
->log_lebs
, UBIFS_LOG_LNUM
, c
->log_last
);
1299 dbg_msg("LPT area LEBs: %d (%d - %d)",
1300 c
->lpt_lebs
, c
->lpt_first
, c
->lpt_last
);
1301 dbg_msg("orphan area LEBs: %d (%d - %d)",
1302 c
->orph_lebs
, c
->orph_first
, c
->orph_last
);
1303 dbg_msg("main area LEBs: %d (%d - %d)",
1304 c
->main_lebs
, c
->main_first
, c
->leb_cnt
- 1);
1305 dbg_msg("index LEBs: %d", c
->lst
.idx_lebs
);
1306 dbg_msg("total index bytes: %lld (%lld KiB, %lld MiB)",
1307 c
->old_idx_sz
, c
->old_idx_sz
>> 10, c
->old_idx_sz
>> 20);
1308 dbg_msg("key hash type: %d", c
->key_hash_type
);
1309 dbg_msg("tree fanout: %d", c
->fanout
);
1310 dbg_msg("reserved GC LEB: %d", c
->gc_lnum
);
1311 dbg_msg("first main LEB: %d", c
->main_first
);
1312 dbg_msg("dead watermark: %d", c
->dead_wm
);
1313 dbg_msg("dark watermark: %d", c
->dark_wm
);
1314 x
= (long long)c
->main_lebs
* c
->dark_wm
;
1315 dbg_msg("max. dark space: %lld (%lld KiB, %lld MiB)",
1316 x
, x
>> 10, x
>> 20);
1317 dbg_msg("maximum bud bytes: %lld (%lld KiB, %lld MiB)",
1318 c
->max_bud_bytes
, c
->max_bud_bytes
>> 10,
1319 c
->max_bud_bytes
>> 20);
1320 dbg_msg("BG commit bud bytes: %lld (%lld KiB, %lld MiB)",
1321 c
->bg_bud_bytes
, c
->bg_bud_bytes
>> 10,
1322 c
->bg_bud_bytes
>> 20);
1323 dbg_msg("current bud bytes %lld (%lld KiB, %lld MiB)",
1324 c
->bud_bytes
, c
->bud_bytes
>> 10, c
->bud_bytes
>> 20);
1325 dbg_msg("max. seq. number: %llu", c
->max_sqnum
);
1326 dbg_msg("commit number: %llu", c
->cmt_no
);
1331 spin_lock(&ubifs_infos_lock
);
1332 list_del(&c
->infos_list
);
1333 spin_unlock(&ubifs_infos_lock
);
1339 ubifs_lpt_free(c
, 0);
1342 kfree(c
->rcvrd_mst_node
);
1344 kthread_stop(c
->bgt
);
1353 kfree(c
->bottom_up_buf
);
1354 ubifs_debugging_exit(c
);
1359 * ubifs_umount - un-mount UBIFS file-system.
1360 * @c: UBIFS file-system description object
1362 * Note, this function is called to free allocated resourced when un-mounting,
1363 * as well as free resources when an error occurred while we were half way
1364 * through mounting (error path cleanup function). So it has to make sure the
1365 * resource was actually allocated before freeing it.
1367 static void ubifs_umount(struct ubifs_info
*c
)
1369 dbg_gen("un-mounting UBI device %d, volume %d", c
->vi
.ubi_num
,
1372 spin_lock(&ubifs_infos_lock
);
1373 list_del(&c
->infos_list
);
1374 spin_unlock(&ubifs_infos_lock
);
1377 kthread_stop(c
->bgt
);
1382 ubifs_lpt_free(c
, 0);
1385 kfree(c
->rcvrd_mst_node
);
1390 kfree(c
->bottom_up_buf
);
1391 ubifs_debugging_exit(c
);
1395 * ubifs_remount_rw - re-mount in read-write mode.
1396 * @c: UBIFS file-system description object
1398 * UBIFS avoids allocating many unnecessary resources when mounted in read-only
1399 * mode. This function allocates the needed resources and re-mounts UBIFS in
1402 static int ubifs_remount_rw(struct ubifs_info
*c
)
1409 mutex_lock(&c
->umount_mutex
);
1410 c
->remounting_rw
= 1;
1411 c
->always_chk_crc
= 1;
1413 /* Check for enough free space */
1414 if (ubifs_calc_available(c
, c
->min_idx_lebs
) <= 0) {
1415 ubifs_err("insufficient available space");
1420 if (c
->old_leb_cnt
!= c
->leb_cnt
) {
1421 struct ubifs_sb_node
*sup
;
1423 sup
= ubifs_read_sb_node(c
);
1428 sup
->leb_cnt
= cpu_to_le32(c
->leb_cnt
);
1429 err
= ubifs_write_sb_node(c
, sup
);
1434 if (c
->need_recovery
) {
1435 ubifs_msg("completing deferred recovery");
1436 err
= ubifs_write_rcvrd_mst_node(c
);
1439 err
= ubifs_recover_size(c
);
1442 err
= ubifs_clean_lebs(c
, c
->sbuf
);
1445 err
= ubifs_recover_inl_heads(c
, c
->sbuf
);
1450 if (!(c
->mst_node
->flags
& cpu_to_le32(UBIFS_MST_DIRTY
))) {
1451 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_DIRTY
);
1452 err
= ubifs_write_master(c
);
1457 c
->ileb_buf
= vmalloc(c
->leb_size
);
1463 err
= ubifs_lpt_init(c
, 0, 1);
1467 err
= alloc_wbufs(c
);
1471 ubifs_create_buds_lists(c
);
1473 /* Create background thread */
1474 c
->bgt
= kthread_create(ubifs_bg_thread
, c
, c
->bgt_name
);
1475 if (IS_ERR(c
->bgt
)) {
1476 err
= PTR_ERR(c
->bgt
);
1478 ubifs_err("cannot spawn \"%s\", error %d",
1482 wake_up_process(c
->bgt
);
1484 c
->orph_buf
= vmalloc(c
->leb_size
);
1490 /* Check for enough log space */
1491 lnum
= c
->lhead_lnum
+ 1;
1492 if (lnum
>= UBIFS_LOG_LNUM
+ c
->log_lebs
)
1493 lnum
= UBIFS_LOG_LNUM
;
1494 if (lnum
== c
->ltail_lnum
) {
1495 err
= ubifs_consolidate_log(c
);
1500 if (c
->need_recovery
)
1501 err
= ubifs_rcvry_gc_commit(c
);
1503 err
= take_gc_lnum(c
);
1507 if (c
->need_recovery
) {
1508 c
->need_recovery
= 0;
1509 ubifs_msg("deferred recovery completed");
1512 dbg_gen("re-mounted read-write");
1513 c
->vfs_sb
->s_flags
&= ~MS_RDONLY
;
1514 c
->remounting_rw
= 0;
1515 c
->always_chk_crc
= 0;
1516 mutex_unlock(&c
->umount_mutex
);
1523 kthread_stop(c
->bgt
);
1529 ubifs_lpt_free(c
, 1);
1530 c
->remounting_rw
= 0;
1531 c
->always_chk_crc
= 0;
1532 mutex_unlock(&c
->umount_mutex
);
1537 * commit_on_unmount - commit the journal when un-mounting.
1538 * @c: UBIFS file-system description object
1540 * This function is called during un-mounting and re-mounting, and it commits
1541 * the journal unless the "fast unmount" mode is enabled. It also avoids
1542 * committing the journal if it contains too few data.
1544 static void commit_on_unmount(struct ubifs_info
*c
)
1546 if (!c
->fast_unmount
) {
1547 long long bud_bytes
;
1549 spin_lock(&c
->buds_lock
);
1550 bud_bytes
= c
->bud_bytes
;
1551 spin_unlock(&c
->buds_lock
);
1552 if (bud_bytes
> c
->leb_size
)
1553 ubifs_run_commit(c
);
1558 * ubifs_remount_ro - re-mount in read-only mode.
1559 * @c: UBIFS file-system description object
1561 * We rely on VFS to have stopped writing. Possibly the background thread could
1562 * be running a commit, however kthread_stop will wait in that case.
1564 static void ubifs_remount_ro(struct ubifs_info
*c
)
1568 ubifs_assert(!c
->need_recovery
);
1569 commit_on_unmount(c
);
1571 mutex_lock(&c
->umount_mutex
);
1573 kthread_stop(c
->bgt
);
1577 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
1578 ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
1579 del_timer_sync(&c
->jheads
[i
].wbuf
.timer
);
1583 c
->mst_node
->flags
&= ~cpu_to_le32(UBIFS_MST_DIRTY
);
1584 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_NO_ORPHS
);
1585 c
->mst_node
->gc_lnum
= cpu_to_le32(c
->gc_lnum
);
1586 err
= ubifs_write_master(c
);
1588 ubifs_ro_mode(c
, err
);
1591 ubifs_destroy_idx_gc(c
);
1597 ubifs_lpt_free(c
, 1);
1598 mutex_unlock(&c
->umount_mutex
);
1601 static void ubifs_put_super(struct super_block
*sb
)
1604 struct ubifs_info
*c
= sb
->s_fs_info
;
1606 ubifs_msg("un-mount UBI device %d, volume %d", c
->vi
.ubi_num
,
1609 * The following asserts are only valid if there has not been a failure
1610 * of the media. For example, there will be dirty inodes if we failed
1611 * to write them back because of I/O errors.
1613 ubifs_assert(atomic_long_read(&c
->dirty_pg_cnt
) == 0);
1614 ubifs_assert(c
->budg_idx_growth
== 0);
1615 ubifs_assert(c
->budg_dd_growth
== 0);
1616 ubifs_assert(c
->budg_data_growth
== 0);
1619 * The 'c->umount_lock' prevents races between UBIFS memory shrinker
1620 * and file system un-mount. Namely, it prevents the shrinker from
1621 * picking this superblock for shrinking - it will be just skipped if
1622 * the mutex is locked.
1624 mutex_lock(&c
->umount_mutex
);
1625 if (!(c
->vfs_sb
->s_flags
& MS_RDONLY
)) {
1627 * First of all kill the background thread to make sure it does
1628 * not interfere with un-mounting and freeing resources.
1631 kthread_stop(c
->bgt
);
1635 /* Synchronize write-buffers */
1637 for (i
= 0; i
< c
->jhead_cnt
; i
++) {
1638 ubifs_wbuf_sync(&c
->jheads
[i
].wbuf
);
1639 del_timer_sync(&c
->jheads
[i
].wbuf
.timer
);
1643 * On fatal errors c->ro_media is set to 1, in which case we do
1644 * not write the master node.
1648 * We are being cleanly unmounted which means the
1649 * orphans were killed - indicate this in the master
1650 * node. Also save the reserved GC LEB number.
1654 c
->mst_node
->flags
&= ~cpu_to_le32(UBIFS_MST_DIRTY
);
1655 c
->mst_node
->flags
|= cpu_to_le32(UBIFS_MST_NO_ORPHS
);
1656 c
->mst_node
->gc_lnum
= cpu_to_le32(c
->gc_lnum
);
1657 err
= ubifs_write_master(c
);
1660 * Recovery will attempt to fix the master area
1661 * next mount, so we just print a message and
1662 * continue to unmount normally.
1664 ubifs_err("failed to write master node, "
1670 bdi_destroy(&c
->bdi
);
1671 ubi_close_volume(c
->ubi
);
1672 mutex_unlock(&c
->umount_mutex
);
1676 static int ubifs_remount_fs(struct super_block
*sb
, int *flags
, char *data
)
1679 struct ubifs_info
*c
= sb
->s_fs_info
;
1681 dbg_gen("old flags %#lx, new flags %#x", sb
->s_flags
, *flags
);
1683 err
= ubifs_parse_options(c
, data
, 1);
1685 ubifs_err("invalid or unknown remount parameter");
1689 if ((sb
->s_flags
& MS_RDONLY
) && !(*flags
& MS_RDONLY
)) {
1690 err
= ubifs_remount_rw(c
);
1693 } else if (!(sb
->s_flags
& MS_RDONLY
) && (*flags
& MS_RDONLY
))
1694 ubifs_remount_ro(c
);
1696 if (c
->bulk_read
== 1)
1699 dbg_gen("disable bulk-read");
1707 struct super_operations ubifs_super_operations
= {
1708 .alloc_inode
= ubifs_alloc_inode
,
1709 .destroy_inode
= ubifs_destroy_inode
,
1710 .put_super
= ubifs_put_super
,
1711 .write_inode
= ubifs_write_inode
,
1712 .delete_inode
= ubifs_delete_inode
,
1713 .statfs
= ubifs_statfs
,
1714 .dirty_inode
= ubifs_dirty_inode
,
1715 .remount_fs
= ubifs_remount_fs
,
1716 .show_options
= ubifs_show_options
,
1717 .sync_fs
= ubifs_sync_fs
,
1721 * open_ubi - parse UBI device name string and open the UBI device.
1722 * @name: UBI volume name
1723 * @mode: UBI volume open mode
1725 * There are several ways to specify UBI volumes when mounting UBIFS:
1726 * o ubiX_Y - UBI device number X, volume Y;
1727 * o ubiY - UBI device number 0, volume Y;
1728 * o ubiX:NAME - mount UBI device X, volume with name NAME;
1729 * o ubi:NAME - mount UBI device 0, volume with name NAME.
1731 * Alternative '!' separator may be used instead of ':' (because some shells
1732 * like busybox may interpret ':' as an NFS host name separator). This function
1733 * returns ubi volume object in case of success and a negative error code in
1736 static struct ubi_volume_desc
*open_ubi(const char *name
, int mode
)
1741 if (name
[0] != 'u' || name
[1] != 'b' || name
[2] != 'i')
1742 return ERR_PTR(-EINVAL
);
1744 /* ubi:NAME method */
1745 if ((name
[3] == ':' || name
[3] == '!') && name
[4] != '\0')
1746 return ubi_open_volume_nm(0, name
+ 4, mode
);
1748 if (!isdigit(name
[3]))
1749 return ERR_PTR(-EINVAL
);
1751 dev
= simple_strtoul(name
+ 3, &endptr
, 0);
1754 if (*endptr
== '\0')
1755 return ubi_open_volume(0, dev
, mode
);
1758 if (*endptr
== '_' && isdigit(endptr
[1])) {
1759 vol
= simple_strtoul(endptr
+ 1, &endptr
, 0);
1760 if (*endptr
!= '\0')
1761 return ERR_PTR(-EINVAL
);
1762 return ubi_open_volume(dev
, vol
, mode
);
1765 /* ubiX:NAME method */
1766 if ((*endptr
== ':' || *endptr
== '!') && endptr
[1] != '\0')
1767 return ubi_open_volume_nm(dev
, ++endptr
, mode
);
1769 return ERR_PTR(-EINVAL
);
1772 static int ubifs_fill_super(struct super_block
*sb
, void *data
, int silent
)
1774 struct ubi_volume_desc
*ubi
= sb
->s_fs_info
;
1775 struct ubifs_info
*c
;
1779 c
= kzalloc(sizeof(struct ubifs_info
), GFP_KERNEL
);
1783 spin_lock_init(&c
->cnt_lock
);
1784 spin_lock_init(&c
->cs_lock
);
1785 spin_lock_init(&c
->buds_lock
);
1786 spin_lock_init(&c
->space_lock
);
1787 spin_lock_init(&c
->orphan_lock
);
1788 init_rwsem(&c
->commit_sem
);
1789 mutex_init(&c
->lp_mutex
);
1790 mutex_init(&c
->tnc_mutex
);
1791 mutex_init(&c
->log_mutex
);
1792 mutex_init(&c
->mst_mutex
);
1793 mutex_init(&c
->umount_mutex
);
1794 mutex_init(&c
->bu_mutex
);
1795 init_waitqueue_head(&c
->cmt_wq
);
1797 c
->old_idx
= RB_ROOT
;
1798 c
->size_tree
= RB_ROOT
;
1799 c
->orph_tree
= RB_ROOT
;
1800 INIT_LIST_HEAD(&c
->infos_list
);
1801 INIT_LIST_HEAD(&c
->idx_gc
);
1802 INIT_LIST_HEAD(&c
->replay_list
);
1803 INIT_LIST_HEAD(&c
->replay_buds
);
1804 INIT_LIST_HEAD(&c
->uncat_list
);
1805 INIT_LIST_HEAD(&c
->empty_list
);
1806 INIT_LIST_HEAD(&c
->freeable_list
);
1807 INIT_LIST_HEAD(&c
->frdi_idx_list
);
1808 INIT_LIST_HEAD(&c
->unclean_leb_list
);
1809 INIT_LIST_HEAD(&c
->old_buds
);
1810 INIT_LIST_HEAD(&c
->orph_list
);
1811 INIT_LIST_HEAD(&c
->orph_new
);
1813 c
->highest_inum
= UBIFS_FIRST_INO
;
1814 c
->lhead_lnum
= c
->ltail_lnum
= UBIFS_LOG_LNUM
;
1816 ubi_get_volume_info(ubi
, &c
->vi
);
1817 ubi_get_device_info(c
->vi
.ubi_num
, &c
->di
);
1819 /* Re-open the UBI device in read-write mode */
1820 c
->ubi
= ubi_open_volume(c
->vi
.ubi_num
, c
->vi
.vol_id
, UBI_READWRITE
);
1821 if (IS_ERR(c
->ubi
)) {
1822 err
= PTR_ERR(c
->ubi
);
1827 * UBIFS provides 'backing_dev_info' in order to disable read-ahead. For
1828 * UBIFS, I/O is not deferred, it is done immediately in readpage,
1829 * which means the user would have to wait not just for their own I/O
1830 * but the read-ahead I/O as well i.e. completely pointless.
1832 * Read-ahead will be disabled because @c->bdi.ra_pages is 0.
1834 c
->bdi
.capabilities
= BDI_CAP_MAP_COPY
;
1835 c
->bdi
.unplug_io_fn
= default_unplug_io_fn
;
1836 err
= bdi_init(&c
->bdi
);
1840 err
= ubifs_parse_options(c
, data
, 0);
1847 sb
->s_magic
= UBIFS_SUPER_MAGIC
;
1848 sb
->s_blocksize
= UBIFS_BLOCK_SIZE
;
1849 sb
->s_blocksize_bits
= UBIFS_BLOCK_SHIFT
;
1850 sb
->s_dev
= c
->vi
.cdev
;
1851 sb
->s_maxbytes
= c
->max_inode_sz
= key_max_inode_size(c
);
1852 if (c
->max_inode_sz
> MAX_LFS_FILESIZE
)
1853 sb
->s_maxbytes
= c
->max_inode_sz
= MAX_LFS_FILESIZE
;
1854 sb
->s_op
= &ubifs_super_operations
;
1856 mutex_lock(&c
->umount_mutex
);
1857 err
= mount_ubifs(c
);
1859 ubifs_assert(err
< 0);
1863 /* Read the root inode */
1864 root
= ubifs_iget(sb
, UBIFS_ROOT_INO
);
1866 err
= PTR_ERR(root
);
1870 sb
->s_root
= d_alloc_root(root
);
1874 mutex_unlock(&c
->umount_mutex
);
1882 mutex_unlock(&c
->umount_mutex
);
1884 bdi_destroy(&c
->bdi
);
1886 ubi_close_volume(c
->ubi
);
1892 static int sb_test(struct super_block
*sb
, void *data
)
1896 return sb
->s_dev
== *dev
;
1899 static int sb_set(struct super_block
*sb
, void *data
)
1907 static int ubifs_get_sb(struct file_system_type
*fs_type
, int flags
,
1908 const char *name
, void *data
, struct vfsmount
*mnt
)
1910 struct ubi_volume_desc
*ubi
;
1911 struct ubi_volume_info vi
;
1912 struct super_block
*sb
;
1915 dbg_gen("name %s, flags %#x", name
, flags
);
1918 * Get UBI device number and volume ID. Mount it read-only so far
1919 * because this might be a new mount point, and UBI allows only one
1920 * read-write user at a time.
1922 ubi
= open_ubi(name
, UBI_READONLY
);
1924 ubifs_err("cannot open \"%s\", error %d",
1925 name
, (int)PTR_ERR(ubi
));
1926 return PTR_ERR(ubi
);
1928 ubi_get_volume_info(ubi
, &vi
);
1930 dbg_gen("opened ubi%d_%d", vi
.ubi_num
, vi
.vol_id
);
1932 sb
= sget(fs_type
, &sb_test
, &sb_set
, &vi
.cdev
);
1939 /* A new mount point for already mounted UBIFS */
1940 dbg_gen("this ubi volume is already mounted");
1941 if ((flags
^ sb
->s_flags
) & MS_RDONLY
) {
1946 sb
->s_flags
= flags
;
1948 * Pass 'ubi' to 'fill_super()' in sb->s_fs_info where it is
1951 sb
->s_fs_info
= ubi
;
1952 err
= ubifs_fill_super(sb
, data
, flags
& MS_SILENT
? 1 : 0);
1955 /* We do not support atime */
1956 sb
->s_flags
|= MS_ACTIVE
| MS_NOATIME
;
1959 /* 'fill_super()' opens ubi again so we must close it here */
1960 ubi_close_volume(ubi
);
1962 return simple_set_mnt(mnt
, sb
);
1965 up_write(&sb
->s_umount
);
1966 deactivate_super(sb
);
1968 ubi_close_volume(ubi
);
1972 static void ubifs_kill_sb(struct super_block
*sb
)
1974 struct ubifs_info
*c
= sb
->s_fs_info
;
1977 * We do 'commit_on_unmount()' here instead of 'ubifs_put_super()'
1978 * in order to be outside BKL.
1980 if (sb
->s_root
&& !(sb
->s_flags
& MS_RDONLY
))
1981 commit_on_unmount(c
);
1982 /* The un-mount routine is actually done in put_super() */
1983 generic_shutdown_super(sb
);
1986 static struct file_system_type ubifs_fs_type
= {
1988 .owner
= THIS_MODULE
,
1989 .get_sb
= ubifs_get_sb
,
1990 .kill_sb
= ubifs_kill_sb
1994 * Inode slab cache constructor.
1996 static void inode_slab_ctor(void *obj
)
1998 struct ubifs_inode
*ui
= obj
;
1999 inode_init_once(&ui
->vfs_inode
);
2002 static int __init
ubifs_init(void)
2006 BUILD_BUG_ON(sizeof(struct ubifs_ch
) != 24);
2008 /* Make sure node sizes are 8-byte aligned */
2009 BUILD_BUG_ON(UBIFS_CH_SZ
& 7);
2010 BUILD_BUG_ON(UBIFS_INO_NODE_SZ
& 7);
2011 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ
& 7);
2012 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ
& 7);
2013 BUILD_BUG_ON(UBIFS_DATA_NODE_SZ
& 7);
2014 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ
& 7);
2015 BUILD_BUG_ON(UBIFS_SB_NODE_SZ
& 7);
2016 BUILD_BUG_ON(UBIFS_MST_NODE_SZ
& 7);
2017 BUILD_BUG_ON(UBIFS_REF_NODE_SZ
& 7);
2018 BUILD_BUG_ON(UBIFS_CS_NODE_SZ
& 7);
2019 BUILD_BUG_ON(UBIFS_ORPH_NODE_SZ
& 7);
2021 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ
& 7);
2022 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ
& 7);
2023 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ
& 7);
2024 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ
& 7);
2025 BUILD_BUG_ON(UBIFS_MAX_NODE_SZ
& 7);
2026 BUILD_BUG_ON(MIN_WRITE_SZ
& 7);
2028 /* Check min. node size */
2029 BUILD_BUG_ON(UBIFS_INO_NODE_SZ
< MIN_WRITE_SZ
);
2030 BUILD_BUG_ON(UBIFS_DENT_NODE_SZ
< MIN_WRITE_SZ
);
2031 BUILD_BUG_ON(UBIFS_XENT_NODE_SZ
< MIN_WRITE_SZ
);
2032 BUILD_BUG_ON(UBIFS_TRUN_NODE_SZ
< MIN_WRITE_SZ
);
2034 BUILD_BUG_ON(UBIFS_MAX_DENT_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2035 BUILD_BUG_ON(UBIFS_MAX_XENT_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2036 BUILD_BUG_ON(UBIFS_MAX_DATA_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2037 BUILD_BUG_ON(UBIFS_MAX_INO_NODE_SZ
> UBIFS_MAX_NODE_SZ
);
2039 /* Defined node sizes */
2040 BUILD_BUG_ON(UBIFS_SB_NODE_SZ
!= 4096);
2041 BUILD_BUG_ON(UBIFS_MST_NODE_SZ
!= 512);
2042 BUILD_BUG_ON(UBIFS_INO_NODE_SZ
!= 160);
2043 BUILD_BUG_ON(UBIFS_REF_NODE_SZ
!= 64);
2046 * We use 2 bit wide bit-fields to store compression type, which should
2047 * be amended if more compressors are added. The bit-fields are:
2048 * @compr_type in 'struct ubifs_inode', @default_compr in
2049 * 'struct ubifs_info' and @compr_type in 'struct ubifs_mount_opts'.
2051 BUILD_BUG_ON(UBIFS_COMPR_TYPES_CNT
> 4);
2054 * We require that PAGE_CACHE_SIZE is greater-than-or-equal-to
2055 * UBIFS_BLOCK_SIZE. It is assumed that both are powers of 2.
2057 if (PAGE_CACHE_SIZE
< UBIFS_BLOCK_SIZE
) {
2058 ubifs_err("VFS page cache size is %u bytes, but UBIFS requires"
2059 " at least 4096 bytes",
2060 (unsigned int)PAGE_CACHE_SIZE
);
2064 err
= register_filesystem(&ubifs_fs_type
);
2066 ubifs_err("cannot register file system, error %d", err
);
2071 ubifs_inode_slab
= kmem_cache_create("ubifs_inode_slab",
2072 sizeof(struct ubifs_inode
), 0,
2073 SLAB_MEM_SPREAD
| SLAB_RECLAIM_ACCOUNT
,
2075 if (!ubifs_inode_slab
)
2078 register_shrinker(&ubifs_shrinker_info
);
2080 err
= ubifs_compressors_init();
2087 unregister_shrinker(&ubifs_shrinker_info
);
2088 kmem_cache_destroy(ubifs_inode_slab
);
2090 unregister_filesystem(&ubifs_fs_type
);
2093 /* late_initcall to let compressors initialize first */
2094 late_initcall(ubifs_init
);
2096 static void __exit
ubifs_exit(void)
2098 ubifs_assert(list_empty(&ubifs_infos
));
2099 ubifs_assert(atomic_long_read(&ubifs_clean_zn_cnt
) == 0);
2101 ubifs_compressors_exit();
2102 unregister_shrinker(&ubifs_shrinker_info
);
2103 kmem_cache_destroy(ubifs_inode_slab
);
2104 unregister_filesystem(&ubifs_fs_type
);
2106 module_exit(ubifs_exit
);
2108 MODULE_LICENSE("GPL");
2109 MODULE_VERSION(__stringify(UBIFS_VERSION
));
2110 MODULE_AUTHOR("Artem Bityutskiy, Adrian Hunter");
2111 MODULE_DESCRIPTION("UBIFS - UBI File System");