1 // SPDX-License-Identifier: GPL-2.0+
3 * NILFS module and super block management.
5 * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
7 * Written by Ryusuke Konishi.
10 * linux/fs/ext2/super.c
12 * Copyright (C) 1992, 1993, 1994, 1995
14 * Laboratoire MASI - Institut Blaise Pascal
15 * Universite Pierre et Marie Curie (Paris VI)
19 * linux/fs/minix/inode.c
21 * Copyright (C) 1991, 1992 Linus Torvalds
23 * Big-endian to little-endian byte-swapping/bitmaps by
27 #include <linux/module.h>
28 #include <linux/string.h>
29 #include <linux/slab.h>
30 #include <linux/init.h>
31 #include <linux/blkdev.h>
32 #include <linux/crc32.h>
33 #include <linux/vfs.h>
34 #include <linux/writeback.h>
35 #include <linux/seq_file.h>
36 #include <linux/mount.h>
37 #include <linux/fs_context.h>
38 #include <linux/fs_parser.h>
47 #include "sufile.h" /* nilfs_sufile_resize(), nilfs_sufile_set_alloc_range() */
53 MODULE_AUTHOR("NTT Corp.");
54 MODULE_DESCRIPTION("A New Implementation of the Log-structured Filesystem "
56 MODULE_LICENSE("GPL");
58 static struct kmem_cache *nilfs_inode_cachep;
59 struct kmem_cache *nilfs_transaction_cachep;
60 struct kmem_cache *nilfs_segbuf_cachep;
61 struct kmem_cache *nilfs_btree_path_cache;
63 static int nilfs_setup_super(struct super_block *sb, int is_mount);
65 void __nilfs_msg(struct super_block *sb, const char *fmt, ...)
73 level = printk_get_level(fmt);
74 vaf.fmt = printk_skip_level(fmt);
78 printk("%c%cNILFS (%s): %pV\n",
79 KERN_SOH_ASCII, level, sb->s_id, &vaf);
81 printk("%c%cNILFS: %pV\n",
82 KERN_SOH_ASCII, level, &vaf);
87 static void nilfs_set_error(struct super_block *sb)
89 struct the_nilfs *nilfs = sb->s_fs_info;
90 struct nilfs_super_block **sbp;
92 down_write(&nilfs->ns_sem);
93 if (!(nilfs->ns_mount_state & NILFS_ERROR_FS)) {
94 nilfs->ns_mount_state |= NILFS_ERROR_FS;
95 sbp = nilfs_prepare_super(sb, 0);
97 sbp[0]->s_state |= cpu_to_le16(NILFS_ERROR_FS);
99 sbp[1]->s_state |= cpu_to_le16(NILFS_ERROR_FS);
100 nilfs_commit_super(sb, NILFS_SB_COMMIT_ALL);
103 up_write(&nilfs->ns_sem);
107 * __nilfs_error() - report failure condition on a filesystem
108 * @sb: super block instance
109 * @function: name of calling function
110 * @fmt: format string for message to be output
111 * @...: optional arguments to @fmt
113 * __nilfs_error() sets an ERROR_FS flag on the superblock as well as
114 * reporting an error message. This function should be called when
115 * NILFS detects incoherences or defects of meta data on disk.
117 * This implements the body of nilfs_error() macro. Normally,
118 * nilfs_error() should be used. As for sustainable errors such as a
119 * single-shot I/O error, nilfs_err() should be used instead.
121 * Callers should not add a trailing newline since this will do it.
123 void __nilfs_error(struct super_block *sb, const char *function,
124 const char *fmt, ...)
126 struct the_nilfs *nilfs = sb->s_fs_info;
127 struct va_format vaf;
135 printk(KERN_CRIT "NILFS error (device %s): %s: %pV\n",
136 sb->s_id, function, &vaf);
140 if (!sb_rdonly(sb)) {
143 if (nilfs_test_opt(nilfs, ERRORS_RO)) {
144 printk(KERN_CRIT "Remounting filesystem read-only\n");
145 sb->s_flags |= SB_RDONLY;
149 if (nilfs_test_opt(nilfs, ERRORS_PANIC))
150 panic("NILFS (device %s): panic forced after error\n",
154 struct inode *nilfs_alloc_inode(struct super_block *sb)
156 struct nilfs_inode_info *ii;
158 ii = alloc_inode_sb(sb, nilfs_inode_cachep, GFP_NOFS);
165 ii->i_assoc_inode = NULL;
166 ii->i_bmap = &ii->i_bmap_data;
167 return &ii->vfs_inode;
170 static void nilfs_free_inode(struct inode *inode)
172 if (nilfs_is_metadata_file_inode(inode))
173 nilfs_mdt_destroy(inode);
175 kmem_cache_free(nilfs_inode_cachep, NILFS_I(inode));
178 static int nilfs_sync_super(struct super_block *sb, int flag)
180 struct the_nilfs *nilfs = sb->s_fs_info;
184 set_buffer_dirty(nilfs->ns_sbh[0]);
185 if (nilfs_test_opt(nilfs, BARRIER)) {
186 err = __sync_dirty_buffer(nilfs->ns_sbh[0],
187 REQ_SYNC | REQ_PREFLUSH | REQ_FUA);
189 err = sync_dirty_buffer(nilfs->ns_sbh[0]);
193 nilfs_err(sb, "unable to write superblock: err=%d", err);
194 if (err == -EIO && nilfs->ns_sbh[1]) {
196 * sbp[0] points to newer log than sbp[1],
197 * so copy sbp[0] to sbp[1] to take over sbp[0].
199 memcpy(nilfs->ns_sbp[1], nilfs->ns_sbp[0],
201 nilfs_fall_back_super_block(nilfs);
205 struct nilfs_super_block *sbp = nilfs->ns_sbp[0];
207 nilfs->ns_sbwcount++;
210 * The latest segment becomes trailable from the position
211 * written in superblock.
213 clear_nilfs_discontinued(nilfs);
215 /* update GC protection for recent segments */
216 if (nilfs->ns_sbh[1]) {
217 if (flag == NILFS_SB_COMMIT_ALL) {
218 set_buffer_dirty(nilfs->ns_sbh[1]);
219 if (sync_dirty_buffer(nilfs->ns_sbh[1]) < 0)
222 if (le64_to_cpu(nilfs->ns_sbp[1]->s_last_cno) <
223 le64_to_cpu(nilfs->ns_sbp[0]->s_last_cno))
224 sbp = nilfs->ns_sbp[1];
227 spin_lock(&nilfs->ns_last_segment_lock);
228 nilfs->ns_prot_seq = le64_to_cpu(sbp->s_last_seq);
229 spin_unlock(&nilfs->ns_last_segment_lock);
235 void nilfs_set_log_cursor(struct nilfs_super_block *sbp,
236 struct the_nilfs *nilfs)
238 sector_t nfreeblocks;
240 /* nilfs->ns_sem must be locked by the caller. */
241 nilfs_count_free_blocks(nilfs, &nfreeblocks);
242 sbp->s_free_blocks_count = cpu_to_le64(nfreeblocks);
244 spin_lock(&nilfs->ns_last_segment_lock);
245 sbp->s_last_seq = cpu_to_le64(nilfs->ns_last_seq);
246 sbp->s_last_pseg = cpu_to_le64(nilfs->ns_last_pseg);
247 sbp->s_last_cno = cpu_to_le64(nilfs->ns_last_cno);
248 spin_unlock(&nilfs->ns_last_segment_lock);
251 struct nilfs_super_block **nilfs_prepare_super(struct super_block *sb,
254 struct the_nilfs *nilfs = sb->s_fs_info;
255 struct nilfs_super_block **sbp = nilfs->ns_sbp;
257 /* nilfs->ns_sem must be locked by the caller. */
258 if (sbp[0]->s_magic != cpu_to_le16(NILFS_SUPER_MAGIC)) {
260 sbp[1]->s_magic == cpu_to_le16(NILFS_SUPER_MAGIC)) {
261 memcpy(sbp[0], sbp[1], nilfs->ns_sbsize);
263 nilfs_crit(sb, "superblock broke");
267 sbp[1]->s_magic != cpu_to_le16(NILFS_SUPER_MAGIC)) {
268 memcpy(sbp[1], sbp[0], nilfs->ns_sbsize);
272 nilfs_swap_super_block(nilfs);
277 int nilfs_commit_super(struct super_block *sb, int flag)
279 struct the_nilfs *nilfs = sb->s_fs_info;
280 struct nilfs_super_block **sbp = nilfs->ns_sbp;
283 /* nilfs->ns_sem must be locked by the caller. */
284 t = ktime_get_real_seconds();
285 nilfs->ns_sbwtime = t;
286 sbp[0]->s_wtime = cpu_to_le64(t);
288 sbp[0]->s_sum = cpu_to_le32(crc32_le(nilfs->ns_crc_seed,
289 (unsigned char *)sbp[0],
291 if (flag == NILFS_SB_COMMIT_ALL && sbp[1]) {
292 sbp[1]->s_wtime = sbp[0]->s_wtime;
294 sbp[1]->s_sum = cpu_to_le32(crc32_le(nilfs->ns_crc_seed,
295 (unsigned char *)sbp[1],
298 clear_nilfs_sb_dirty(nilfs);
299 nilfs->ns_flushed_device = 1;
300 /* make sure store to ns_flushed_device cannot be reordered */
302 return nilfs_sync_super(sb, flag);
306 * nilfs_cleanup_super() - write filesystem state for cleanup
307 * @sb: super block instance to be unmounted or degraded to read-only
309 * This function restores state flags in the on-disk super block.
310 * This will set "clean" flag (i.e. NILFS_VALID_FS) unless the
311 * filesystem was not clean previously.
313 int nilfs_cleanup_super(struct super_block *sb)
315 struct the_nilfs *nilfs = sb->s_fs_info;
316 struct nilfs_super_block **sbp;
317 int flag = NILFS_SB_COMMIT;
320 sbp = nilfs_prepare_super(sb, 0);
322 sbp[0]->s_state = cpu_to_le16(nilfs->ns_mount_state);
323 nilfs_set_log_cursor(sbp[0], nilfs);
324 if (sbp[1] && sbp[0]->s_last_cno == sbp[1]->s_last_cno) {
326 * make the "clean" flag also to the opposite
327 * super block if both super blocks point to
328 * the same checkpoint.
330 sbp[1]->s_state = sbp[0]->s_state;
331 flag = NILFS_SB_COMMIT_ALL;
333 ret = nilfs_commit_super(sb, flag);
339 * nilfs_move_2nd_super - relocate secondary super block
340 * @sb: super block instance
341 * @sb2off: new offset of the secondary super block (in bytes)
343 static int nilfs_move_2nd_super(struct super_block *sb, loff_t sb2off)
345 struct the_nilfs *nilfs = sb->s_fs_info;
346 struct buffer_head *nsbh;
347 struct nilfs_super_block *nsbp;
348 sector_t blocknr, newblocknr;
349 unsigned long offset;
350 int sb2i; /* array index of the secondary superblock */
353 /* nilfs->ns_sem must be locked by the caller. */
354 if (nilfs->ns_sbh[1] &&
355 nilfs->ns_sbh[1]->b_blocknr > nilfs->ns_first_data_block) {
357 blocknr = nilfs->ns_sbh[1]->b_blocknr;
358 } else if (nilfs->ns_sbh[0]->b_blocknr > nilfs->ns_first_data_block) {
360 blocknr = nilfs->ns_sbh[0]->b_blocknr;
365 if (sb2i >= 0 && (u64)blocknr << nilfs->ns_blocksize_bits == sb2off)
366 goto out; /* super block location is unchanged */
368 /* Get new super block buffer */
369 newblocknr = sb2off >> nilfs->ns_blocksize_bits;
370 offset = sb2off & (nilfs->ns_blocksize - 1);
371 nsbh = sb_getblk(sb, newblocknr);
374 "unable to move secondary superblock to block %llu",
375 (unsigned long long)newblocknr);
379 nsbp = (void *)nsbh->b_data + offset;
384 * The position of the second superblock only changes by 4KiB,
385 * which is larger than the maximum superblock data size
386 * (= 1KiB), so there is no need to use memmove() to allow
387 * overlap between source and destination.
389 memcpy(nsbp, nilfs->ns_sbp[sb2i], nilfs->ns_sbsize);
392 * Zero fill after copy to avoid overwriting in case of move
393 * within the same block.
395 memset(nsbh->b_data, 0, offset);
396 memset((void *)nsbp + nilfs->ns_sbsize, 0,
397 nsbh->b_size - offset - nilfs->ns_sbsize);
399 memset(nsbh->b_data, 0, nsbh->b_size);
401 set_buffer_uptodate(nsbh);
405 brelse(nilfs->ns_sbh[sb2i]);
406 nilfs->ns_sbh[sb2i] = nsbh;
407 nilfs->ns_sbp[sb2i] = nsbp;
408 } else if (nilfs->ns_sbh[0]->b_blocknr < nilfs->ns_first_data_block) {
409 /* secondary super block will be restored to index 1 */
410 nilfs->ns_sbh[1] = nsbh;
411 nilfs->ns_sbp[1] = nsbp;
420 * nilfs_resize_fs - resize the filesystem
421 * @sb: super block instance
422 * @newsize: new size of the filesystem (in bytes)
424 int nilfs_resize_fs(struct super_block *sb, __u64 newsize)
426 struct the_nilfs *nilfs = sb->s_fs_info;
427 struct nilfs_super_block **sbp;
428 __u64 devsize, newnsegs;
433 devsize = bdev_nr_bytes(sb->s_bdev);
434 if (newsize > devsize)
438 * Prevent underflow in second superblock position calculation.
439 * The exact minimum size check is done in nilfs_sufile_resize().
441 if (newsize < 4096) {
447 * Write lock is required to protect some functions depending
448 * on the number of segments, the number of reserved segments,
451 down_write(&nilfs->ns_segctor_sem);
453 sb2off = NILFS_SB2_OFFSET_BYTES(newsize);
454 newnsegs = sb2off >> nilfs->ns_blocksize_bits;
455 newnsegs = div64_ul(newnsegs, nilfs->ns_blocks_per_segment);
457 ret = nilfs_sufile_resize(nilfs->ns_sufile, newnsegs);
458 up_write(&nilfs->ns_segctor_sem);
462 ret = nilfs_construct_segment(sb);
466 down_write(&nilfs->ns_sem);
467 nilfs_move_2nd_super(sb, sb2off);
469 sbp = nilfs_prepare_super(sb, 0);
471 nilfs_set_log_cursor(sbp[0], nilfs);
473 * Drop NILFS_RESIZE_FS flag for compatibility with
474 * mount-time resize which may be implemented in a
477 sbp[0]->s_state = cpu_to_le16(le16_to_cpu(sbp[0]->s_state) &
479 sbp[0]->s_dev_size = cpu_to_le64(newsize);
480 sbp[0]->s_nsegments = cpu_to_le64(nilfs->ns_nsegments);
482 memcpy(sbp[1], sbp[0], nilfs->ns_sbsize);
483 ret = nilfs_commit_super(sb, NILFS_SB_COMMIT_ALL);
485 up_write(&nilfs->ns_sem);
488 * Reset the range of allocatable segments last. This order
489 * is important in the case of expansion because the secondary
490 * superblock must be protected from log write until migration
494 nilfs_sufile_set_alloc_range(nilfs->ns_sufile, 0, newnsegs - 1);
499 static void nilfs_put_super(struct super_block *sb)
501 struct the_nilfs *nilfs = sb->s_fs_info;
503 nilfs_detach_log_writer(sb);
505 if (!sb_rdonly(sb)) {
506 down_write(&nilfs->ns_sem);
507 nilfs_cleanup_super(sb);
508 up_write(&nilfs->ns_sem);
511 nilfs_sysfs_delete_device_group(nilfs);
512 iput(nilfs->ns_sufile);
513 iput(nilfs->ns_cpfile);
516 destroy_nilfs(nilfs);
517 sb->s_fs_info = NULL;
520 static int nilfs_sync_fs(struct super_block *sb, int wait)
522 struct the_nilfs *nilfs = sb->s_fs_info;
523 struct nilfs_super_block **sbp;
526 /* This function is called when super block should be written back */
528 err = nilfs_construct_segment(sb);
530 down_write(&nilfs->ns_sem);
531 if (nilfs_sb_dirty(nilfs)) {
532 sbp = nilfs_prepare_super(sb, nilfs_sb_will_flip(nilfs));
534 nilfs_set_log_cursor(sbp[0], nilfs);
535 nilfs_commit_super(sb, NILFS_SB_COMMIT);
538 up_write(&nilfs->ns_sem);
541 err = nilfs_flush_device(nilfs);
546 int nilfs_attach_checkpoint(struct super_block *sb, __u64 cno, int curr_mnt,
547 struct nilfs_root **rootp)
549 struct the_nilfs *nilfs = sb->s_fs_info;
550 struct nilfs_root *root;
553 root = nilfs_find_or_create_root(
554 nilfs, curr_mnt ? NILFS_CPTREE_CURRENT_CNO : cno);
559 goto reuse; /* already attached checkpoint */
561 down_read(&nilfs->ns_segctor_sem);
562 err = nilfs_ifile_read(sb, root, cno, nilfs->ns_inode_size);
563 up_read(&nilfs->ns_segctor_sem);
573 nilfs_err(sb, "Invalid checkpoint (checkpoint number=%llu)",
574 (unsigned long long)cno);
575 nilfs_put_root(root);
580 static int nilfs_freeze(struct super_block *sb)
582 struct the_nilfs *nilfs = sb->s_fs_info;
588 /* Mark super block clean */
589 down_write(&nilfs->ns_sem);
590 err = nilfs_cleanup_super(sb);
591 up_write(&nilfs->ns_sem);
595 static int nilfs_unfreeze(struct super_block *sb)
597 struct the_nilfs *nilfs = sb->s_fs_info;
602 down_write(&nilfs->ns_sem);
603 nilfs_setup_super(sb, false);
604 up_write(&nilfs->ns_sem);
608 static int nilfs_statfs(struct dentry *dentry, struct kstatfs *buf)
610 struct super_block *sb = dentry->d_sb;
611 struct nilfs_root *root = NILFS_I(d_inode(dentry))->i_root;
612 struct the_nilfs *nilfs = root->nilfs;
613 u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
614 unsigned long long blocks;
615 unsigned long overhead;
616 unsigned long nrsvblocks;
617 sector_t nfreeblocks;
618 u64 nmaxinodes, nfreeinodes;
622 * Compute all of the segment blocks
624 * The blocks before first segment and after last segment
627 blocks = nilfs->ns_blocks_per_segment * nilfs->ns_nsegments
628 - nilfs->ns_first_data_block;
629 nrsvblocks = nilfs->ns_nrsvsegs * nilfs->ns_blocks_per_segment;
632 * Compute the overhead
634 * When distributing meta data blocks outside segment structure,
635 * We must count them as the overhead.
639 err = nilfs_count_free_blocks(nilfs, &nfreeblocks);
643 err = nilfs_ifile_count_free_inodes(root->ifile,
644 &nmaxinodes, &nfreeinodes);
646 nilfs_warn(sb, "failed to count free inodes: err=%d", err);
647 if (err == -ERANGE) {
649 * If nilfs_palloc_count_max_entries() returns
650 * -ERANGE error code then we simply treat
651 * curent inodes count as maximum possible and
652 * zero as free inodes value.
654 nmaxinodes = atomic64_read(&root->inodes_count);
661 buf->f_type = NILFS_SUPER_MAGIC;
662 buf->f_bsize = sb->s_blocksize;
663 buf->f_blocks = blocks - overhead;
664 buf->f_bfree = nfreeblocks;
665 buf->f_bavail = (buf->f_bfree >= nrsvblocks) ?
666 (buf->f_bfree - nrsvblocks) : 0;
667 buf->f_files = nmaxinodes;
668 buf->f_ffree = nfreeinodes;
669 buf->f_namelen = NILFS_NAME_LEN;
670 buf->f_fsid = u64_to_fsid(id);
675 static int nilfs_show_options(struct seq_file *seq, struct dentry *dentry)
677 struct super_block *sb = dentry->d_sb;
678 struct the_nilfs *nilfs = sb->s_fs_info;
679 struct nilfs_root *root = NILFS_I(d_inode(dentry))->i_root;
681 if (!nilfs_test_opt(nilfs, BARRIER))
682 seq_puts(seq, ",nobarrier");
683 if (root->cno != NILFS_CPTREE_CURRENT_CNO)
684 seq_printf(seq, ",cp=%llu", (unsigned long long)root->cno);
685 if (nilfs_test_opt(nilfs, ERRORS_PANIC))
686 seq_puts(seq, ",errors=panic");
687 if (nilfs_test_opt(nilfs, ERRORS_CONT))
688 seq_puts(seq, ",errors=continue");
689 if (nilfs_test_opt(nilfs, STRICT_ORDER))
690 seq_puts(seq, ",order=strict");
691 if (nilfs_test_opt(nilfs, NORECOVERY))
692 seq_puts(seq, ",norecovery");
693 if (nilfs_test_opt(nilfs, DISCARD))
694 seq_puts(seq, ",discard");
699 static const struct super_operations nilfs_sops = {
700 .alloc_inode = nilfs_alloc_inode,
701 .free_inode = nilfs_free_inode,
702 .dirty_inode = nilfs_dirty_inode,
703 .evict_inode = nilfs_evict_inode,
704 .put_super = nilfs_put_super,
705 .sync_fs = nilfs_sync_fs,
706 .freeze_fs = nilfs_freeze,
707 .unfreeze_fs = nilfs_unfreeze,
708 .statfs = nilfs_statfs,
709 .show_options = nilfs_show_options
713 Opt_err, Opt_barrier, Opt_snapshot, Opt_order, Opt_norecovery,
717 static const struct constant_table nilfs_param_err[] = {
718 {"continue", NILFS_MOUNT_ERRORS_CONT},
719 {"panic", NILFS_MOUNT_ERRORS_PANIC},
720 {"remount-ro", NILFS_MOUNT_ERRORS_RO},
724 static const struct fs_parameter_spec nilfs_param_spec[] = {
725 fsparam_enum ("errors", Opt_err, nilfs_param_err),
726 fsparam_flag_no ("barrier", Opt_barrier),
727 fsparam_u64 ("cp", Opt_snapshot),
728 fsparam_string ("order", Opt_order),
729 fsparam_flag ("norecovery", Opt_norecovery),
730 fsparam_flag_no ("discard", Opt_discard),
734 struct nilfs_fs_context {
735 unsigned long ns_mount_opt;
739 static int nilfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
741 struct nilfs_fs_context *nilfs = fc->fs_private;
742 int is_remount = fc->purpose == FS_CONTEXT_FOR_RECONFIGURE;
743 struct fs_parse_result result;
746 opt = fs_parse(fc, nilfs_param_spec, param, &result);
753 nilfs_clear_opt(nilfs, BARRIER);
755 nilfs_set_opt(nilfs, BARRIER);
758 if (strcmp(param->string, "relaxed") == 0)
759 /* Ordered data semantics */
760 nilfs_clear_opt(nilfs, STRICT_ORDER);
761 else if (strcmp(param->string, "strict") == 0)
762 /* Strict in-order semantics */
763 nilfs_set_opt(nilfs, STRICT_ORDER);
768 nilfs->ns_mount_opt &= ~NILFS_MOUNT_ERROR_MODE;
769 nilfs->ns_mount_opt |= result.uint_32;
773 struct super_block *sb = fc->root->d_sb;
776 "\"%s\" option is invalid for remount",
780 if (result.uint_64 == 0) {
782 "invalid option \"cp=0\": invalid checkpoint number 0");
785 nilfs->cno = result.uint_64;
788 nilfs_set_opt(nilfs, NORECOVERY);
792 nilfs_clear_opt(nilfs, DISCARD);
794 nilfs_set_opt(nilfs, DISCARD);
803 static int nilfs_setup_super(struct super_block *sb, int is_mount)
805 struct the_nilfs *nilfs = sb->s_fs_info;
806 struct nilfs_super_block **sbp;
810 /* nilfs->ns_sem must be locked by the caller. */
811 sbp = nilfs_prepare_super(sb, 0);
816 goto skip_mount_setup;
818 max_mnt_count = le16_to_cpu(sbp[0]->s_max_mnt_count);
819 mnt_count = le16_to_cpu(sbp[0]->s_mnt_count);
821 if (nilfs->ns_mount_state & NILFS_ERROR_FS) {
822 nilfs_warn(sb, "mounting fs with errors");
824 } else if (max_mnt_count >= 0 && mnt_count >= max_mnt_count) {
825 nilfs_warn(sb, "maximal mount count reached");
829 sbp[0]->s_max_mnt_count = cpu_to_le16(NILFS_DFL_MAX_MNT_COUNT);
831 sbp[0]->s_mnt_count = cpu_to_le16(mnt_count + 1);
832 sbp[0]->s_mtime = cpu_to_le64(ktime_get_real_seconds());
836 cpu_to_le16(le16_to_cpu(sbp[0]->s_state) & ~NILFS_VALID_FS);
837 /* synchronize sbp[1] with sbp[0] */
839 memcpy(sbp[1], sbp[0], nilfs->ns_sbsize);
840 return nilfs_commit_super(sb, NILFS_SB_COMMIT_ALL);
843 struct nilfs_super_block *nilfs_read_super_block(struct super_block *sb,
844 u64 pos, int blocksize,
845 struct buffer_head **pbh)
847 unsigned long long sb_index = pos;
848 unsigned long offset;
850 offset = do_div(sb_index, blocksize);
851 *pbh = sb_bread(sb, sb_index);
854 return (struct nilfs_super_block *)((char *)(*pbh)->b_data + offset);
857 int nilfs_store_magic(struct super_block *sb,
858 struct nilfs_super_block *sbp)
860 struct the_nilfs *nilfs = sb->s_fs_info;
862 sb->s_magic = le16_to_cpu(sbp->s_magic);
864 /* FS independent flags */
865 #ifdef NILFS_ATIME_DISABLE
866 sb->s_flags |= SB_NOATIME;
869 nilfs->ns_resuid = le16_to_cpu(sbp->s_def_resuid);
870 nilfs->ns_resgid = le16_to_cpu(sbp->s_def_resgid);
871 nilfs->ns_interval = le32_to_cpu(sbp->s_c_interval);
872 nilfs->ns_watermark = le32_to_cpu(sbp->s_c_block_max);
877 int nilfs_check_feature_compatibility(struct super_block *sb,
878 struct nilfs_super_block *sbp)
882 features = le64_to_cpu(sbp->s_feature_incompat) &
883 ~NILFS_FEATURE_INCOMPAT_SUPP;
886 "couldn't mount because of unsupported optional features (%llx)",
887 (unsigned long long)features);
890 features = le64_to_cpu(sbp->s_feature_compat_ro) &
891 ~NILFS_FEATURE_COMPAT_RO_SUPP;
892 if (!sb_rdonly(sb) && features) {
894 "couldn't mount RDWR because of unsupported optional features (%llx)",
895 (unsigned long long)features);
901 static int nilfs_get_root_dentry(struct super_block *sb,
902 struct nilfs_root *root,
903 struct dentry **root_dentry)
906 struct dentry *dentry;
909 inode = nilfs_iget(sb, root, NILFS_ROOT_INO);
911 ret = PTR_ERR(inode);
912 nilfs_err(sb, "error %d getting root inode", ret);
915 if (!S_ISDIR(inode->i_mode) || !inode->i_blocks || !inode->i_size) {
917 nilfs_err(sb, "corrupt root inode");
922 if (root->cno == NILFS_CPTREE_CURRENT_CNO) {
923 dentry = d_find_alias(inode);
925 dentry = d_make_root(inode);
934 dentry = d_obtain_root(inode);
935 if (IS_ERR(dentry)) {
936 ret = PTR_ERR(dentry);
940 *root_dentry = dentry;
945 nilfs_err(sb, "error %d getting root dentry", ret);
949 static int nilfs_attach_snapshot(struct super_block *s, __u64 cno,
950 struct dentry **root_dentry)
952 struct the_nilfs *nilfs = s->s_fs_info;
953 struct nilfs_root *root;
956 mutex_lock(&nilfs->ns_snapshot_mount_mutex);
958 down_read(&nilfs->ns_segctor_sem);
959 ret = nilfs_cpfile_is_snapshot(nilfs->ns_cpfile, cno);
960 up_read(&nilfs->ns_segctor_sem);
962 ret = (ret == -ENOENT) ? -EINVAL : ret;
966 "The specified checkpoint is not a snapshot (checkpoint number=%llu)",
967 (unsigned long long)cno);
972 ret = nilfs_attach_checkpoint(s, cno, false, &root);
975 "error %d while loading snapshot (checkpoint number=%llu)",
976 ret, (unsigned long long)cno);
979 ret = nilfs_get_root_dentry(s, root, root_dentry);
980 nilfs_put_root(root);
982 mutex_unlock(&nilfs->ns_snapshot_mount_mutex);
987 * nilfs_tree_is_busy() - try to shrink dentries of a checkpoint
988 * @root_dentry: root dentry of the tree to be shrunk
990 * This function returns true if the tree was in-use.
992 static bool nilfs_tree_is_busy(struct dentry *root_dentry)
994 shrink_dcache_parent(root_dentry);
995 return d_count(root_dentry) > 1;
998 int nilfs_checkpoint_is_mounted(struct super_block *sb, __u64 cno)
1000 struct the_nilfs *nilfs = sb->s_fs_info;
1001 struct nilfs_root *root;
1002 struct inode *inode;
1003 struct dentry *dentry;
1006 if (cno > nilfs->ns_cno)
1009 if (cno >= nilfs_last_cno(nilfs))
1010 return true; /* protect recent checkpoints */
1013 root = nilfs_lookup_root(nilfs, cno);
1015 inode = nilfs_ilookup(sb, root, NILFS_ROOT_INO);
1017 dentry = d_find_alias(inode);
1019 ret = nilfs_tree_is_busy(dentry);
1024 nilfs_put_root(root);
1030 * nilfs_fill_super() - initialize a super block instance
1032 * @fc: filesystem context
1034 * This function is called exclusively by nilfs->ns_mount_mutex.
1035 * So, the recovery process is protected from other simultaneous mounts.
1038 nilfs_fill_super(struct super_block *sb, struct fs_context *fc)
1040 struct the_nilfs *nilfs;
1041 struct nilfs_root *fsroot;
1042 struct nilfs_fs_context *ctx = fc->fs_private;
1046 nilfs = alloc_nilfs(sb);
1050 sb->s_fs_info = nilfs;
1052 err = init_nilfs(nilfs, sb);
1056 /* Copy in parsed mount options */
1057 nilfs->ns_mount_opt = ctx->ns_mount_opt;
1059 sb->s_op = &nilfs_sops;
1060 sb->s_export_op = &nilfs_export_ops;
1062 sb->s_time_gran = 1;
1063 sb->s_max_links = NILFS_LINK_MAX;
1065 sb->s_bdi = bdi_get(sb->s_bdev->bd_disk->bdi);
1067 err = load_nilfs(nilfs, sb);
1071 super_set_uuid(sb, nilfs->ns_sbp[0]->s_uuid,
1072 sizeof(nilfs->ns_sbp[0]->s_uuid));
1073 super_set_sysfs_name_bdev(sb);
1075 cno = nilfs_last_cno(nilfs);
1076 err = nilfs_attach_checkpoint(sb, cno, true, &fsroot);
1079 "error %d while loading last checkpoint (checkpoint number=%llu)",
1080 err, (unsigned long long)cno);
1084 if (!sb_rdonly(sb)) {
1085 err = nilfs_attach_log_writer(sb, fsroot);
1087 goto failed_checkpoint;
1090 err = nilfs_get_root_dentry(sb, fsroot, &sb->s_root);
1092 goto failed_segctor;
1094 nilfs_put_root(fsroot);
1096 if (!sb_rdonly(sb)) {
1097 down_write(&nilfs->ns_sem);
1098 nilfs_setup_super(sb, true);
1099 up_write(&nilfs->ns_sem);
1105 nilfs_detach_log_writer(sb);
1108 nilfs_put_root(fsroot);
1111 nilfs_sysfs_delete_device_group(nilfs);
1112 iput(nilfs->ns_sufile);
1113 iput(nilfs->ns_cpfile);
1114 iput(nilfs->ns_dat);
1117 destroy_nilfs(nilfs);
1121 static int nilfs_reconfigure(struct fs_context *fc)
1123 struct nilfs_fs_context *ctx = fc->fs_private;
1124 struct super_block *sb = fc->root->d_sb;
1125 struct the_nilfs *nilfs = sb->s_fs_info;
1128 sync_filesystem(sb);
1132 if (!nilfs_valid_fs(nilfs)) {
1134 "couldn't remount because the filesystem is in an incomplete recovery state");
1137 if ((bool)(fc->sb_flags & SB_RDONLY) == sb_rdonly(sb))
1139 if (fc->sb_flags & SB_RDONLY) {
1140 sb->s_flags |= SB_RDONLY;
1143 * Remounting a valid RW partition RDONLY, so set
1144 * the RDONLY flag and then mark the partition as valid again.
1146 down_write(&nilfs->ns_sem);
1147 nilfs_cleanup_super(sb);
1148 up_write(&nilfs->ns_sem);
1151 struct nilfs_root *root;
1154 * Mounting a RDONLY partition read-write, so reread and
1155 * store the current valid flag. (It may have been changed
1156 * by fsck since we originally mounted the partition.)
1158 down_read(&nilfs->ns_sem);
1159 features = le64_to_cpu(nilfs->ns_sbp[0]->s_feature_compat_ro) &
1160 ~NILFS_FEATURE_COMPAT_RO_SUPP;
1161 up_read(&nilfs->ns_sem);
1164 "couldn't remount RDWR because of unsupported optional features (%llx)",
1165 (unsigned long long)features);
1170 sb->s_flags &= ~SB_RDONLY;
1172 root = NILFS_I(d_inode(sb->s_root))->i_root;
1173 err = nilfs_attach_log_writer(sb, root);
1175 sb->s_flags |= SB_RDONLY;
1179 down_write(&nilfs->ns_sem);
1180 nilfs_setup_super(sb, true);
1181 up_write(&nilfs->ns_sem);
1184 sb->s_flags = (sb->s_flags & ~SB_POSIXACL);
1185 /* Copy over parsed remount options */
1186 nilfs->ns_mount_opt = ctx->ns_mount_opt;
1195 nilfs_get_tree(struct fs_context *fc)
1197 struct nilfs_fs_context *ctx = fc->fs_private;
1198 struct super_block *s;
1202 if (ctx->cno && !(fc->sb_flags & SB_RDONLY)) {
1204 "invalid option \"cp=%llu\": read-only option is not specified",
1209 err = lookup_bdev(fc->source, &dev);
1213 s = sget_dev(fc, dev);
1218 err = setup_bdev_super(s, fc->sb_flags, fc);
1220 err = nilfs_fill_super(s, fc);
1224 s->s_flags |= SB_ACTIVE;
1225 } else if (!ctx->cno) {
1226 if (nilfs_tree_is_busy(s->s_root)) {
1227 if ((fc->sb_flags ^ s->s_flags) & SB_RDONLY) {
1229 "the device already has a %s mount.",
1230 sb_rdonly(s) ? "read-only" : "read/write");
1236 * Try reconfigure to setup mount states if the current
1237 * tree is not mounted and only snapshots use this sb.
1239 * Since nilfs_reconfigure() requires fc->root to be
1240 * set, set it first and release it on failure.
1242 fc->root = dget(s->s_root);
1243 err = nilfs_reconfigure(fc);
1246 fc->root = NULL; /* prevent double release */
1254 struct dentry *root_dentry;
1256 err = nilfs_attach_snapshot(s, ctx->cno, &root_dentry);
1259 fc->root = root_dentry;
1263 fc->root = dget(s->s_root);
1267 deactivate_locked_super(s);
1271 static void nilfs_free_fc(struct fs_context *fc)
1273 kfree(fc->fs_private);
1276 static const struct fs_context_operations nilfs_context_ops = {
1277 .parse_param = nilfs_parse_param,
1278 .get_tree = nilfs_get_tree,
1279 .reconfigure = nilfs_reconfigure,
1280 .free = nilfs_free_fc,
1283 static int nilfs_init_fs_context(struct fs_context *fc)
1285 struct nilfs_fs_context *ctx;
1287 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
1291 ctx->ns_mount_opt = NILFS_MOUNT_ERRORS_RO | NILFS_MOUNT_BARRIER;
1292 fc->fs_private = ctx;
1293 fc->ops = &nilfs_context_ops;
1298 struct file_system_type nilfs_fs_type = {
1299 .owner = THIS_MODULE,
1301 .kill_sb = kill_block_super,
1302 .fs_flags = FS_REQUIRES_DEV,
1303 .init_fs_context = nilfs_init_fs_context,
1304 .parameters = nilfs_param_spec,
1306 MODULE_ALIAS_FS("nilfs2");
1308 static void nilfs_inode_init_once(void *obj)
1310 struct nilfs_inode_info *ii = obj;
1312 INIT_LIST_HEAD(&ii->i_dirty);
1313 #ifdef CONFIG_NILFS_XATTR
1314 init_rwsem(&ii->xattr_sem);
1316 inode_init_once(&ii->vfs_inode);
1319 static void nilfs_segbuf_init_once(void *obj)
1321 memset(obj, 0, sizeof(struct nilfs_segment_buffer));
1324 static void nilfs_destroy_cachep(void)
1327 * Make sure all delayed rcu free inodes are flushed before we
1332 kmem_cache_destroy(nilfs_inode_cachep);
1333 kmem_cache_destroy(nilfs_transaction_cachep);
1334 kmem_cache_destroy(nilfs_segbuf_cachep);
1335 kmem_cache_destroy(nilfs_btree_path_cache);
1338 static int __init nilfs_init_cachep(void)
1340 nilfs_inode_cachep = kmem_cache_create("nilfs2_inode_cache",
1341 sizeof(struct nilfs_inode_info), 0,
1342 SLAB_RECLAIM_ACCOUNT|SLAB_ACCOUNT,
1343 nilfs_inode_init_once);
1344 if (!nilfs_inode_cachep)
1347 nilfs_transaction_cachep = kmem_cache_create("nilfs2_transaction_cache",
1348 sizeof(struct nilfs_transaction_info), 0,
1349 SLAB_RECLAIM_ACCOUNT, NULL);
1350 if (!nilfs_transaction_cachep)
1353 nilfs_segbuf_cachep = kmem_cache_create("nilfs2_segbuf_cache",
1354 sizeof(struct nilfs_segment_buffer), 0,
1355 SLAB_RECLAIM_ACCOUNT, nilfs_segbuf_init_once);
1356 if (!nilfs_segbuf_cachep)
1359 nilfs_btree_path_cache = kmem_cache_create("nilfs2_btree_path_cache",
1360 sizeof(struct nilfs_btree_path) * NILFS_BTREE_LEVEL_MAX,
1362 if (!nilfs_btree_path_cache)
1368 nilfs_destroy_cachep();
1372 static int __init init_nilfs_fs(void)
1376 err = nilfs_init_cachep();
1380 err = nilfs_sysfs_init();
1384 err = register_filesystem(&nilfs_fs_type);
1386 goto deinit_sysfs_entry;
1388 printk(KERN_INFO "NILFS version 2 loaded\n");
1394 nilfs_destroy_cachep();
1399 static void __exit exit_nilfs_fs(void)
1401 nilfs_destroy_cachep();
1403 unregister_filesystem(&nilfs_fs_type);
1406 module_init(init_nilfs_fs)
1407 module_exit(exit_nilfs_fs)