4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 #include <linux/module.h>
12 #include <linux/init.h>
14 #include <linux/statfs.h>
15 #include <linux/proc_fs.h>
16 #include <linux/buffer_head.h>
17 #include <linux/backing-dev.h>
18 #include <linux/kthread.h>
19 #include <linux/parser.h>
20 #include <linux/mount.h>
21 #include <linux/seq_file.h>
22 #include <linux/random.h>
23 #include <linux/exportfs.h>
24 #include <linux/f2fs_fs.h>
30 static struct kmem_cache *f2fs_inode_cachep;
33 Opt_gc_background_off,
34 Opt_disable_roll_forward,
40 Opt_disable_ext_identify,
44 static match_table_t f2fs_tokens = {
45 {Opt_gc_background_off, "background_gc_off"},
46 {Opt_disable_roll_forward, "disable_roll_forward"},
47 {Opt_discard, "discard"},
48 {Opt_noheap, "no_heap"},
49 {Opt_nouser_xattr, "nouser_xattr"},
51 {Opt_active_logs, "active_logs=%u"},
52 {Opt_disable_ext_identify, "disable_ext_identify"},
56 void f2fs_msg(struct super_block *sb, const char *level, const char *fmt, ...)
64 printk("%sF2FS-fs (%s): %pV\n", level, sb->s_id, &vaf);
68 static void init_once(void *foo)
70 struct f2fs_inode_info *fi = (struct f2fs_inode_info *) foo;
72 inode_init_once(&fi->vfs_inode);
75 static struct inode *f2fs_alloc_inode(struct super_block *sb)
77 struct f2fs_inode_info *fi;
79 fi = kmem_cache_alloc(f2fs_inode_cachep, GFP_NOFS | __GFP_ZERO);
83 init_once((void *) fi);
85 /* Initilize f2fs-specific inode info */
86 fi->vfs_inode.i_version = 1;
87 atomic_set(&fi->dirty_dents, 0);
88 fi->i_current_depth = 1;
90 rwlock_init(&fi->ext.ext_lock);
92 set_inode_flag(fi, FI_NEW_INODE);
94 return &fi->vfs_inode;
97 static void f2fs_i_callback(struct rcu_head *head)
99 struct inode *inode = container_of(head, struct inode, i_rcu);
100 kmem_cache_free(f2fs_inode_cachep, F2FS_I(inode));
103 static void f2fs_destroy_inode(struct inode *inode)
105 call_rcu(&inode->i_rcu, f2fs_i_callback);
108 static void f2fs_put_super(struct super_block *sb)
110 struct f2fs_sb_info *sbi = F2FS_SB(sb);
112 f2fs_destroy_stats(sbi);
115 write_checkpoint(sbi, false, true);
117 iput(sbi->node_inode);
118 iput(sbi->meta_inode);
120 /* destroy f2fs internal modules */
121 destroy_node_manager(sbi);
122 destroy_segment_manager(sbi);
126 sb->s_fs_info = NULL;
127 brelse(sbi->raw_super_buf);
131 int f2fs_sync_fs(struct super_block *sb, int sync)
133 struct f2fs_sb_info *sbi = F2FS_SB(sb);
135 if (!sbi->s_dirty && !get_pages(sbi, F2FS_DIRTY_NODES))
139 write_checkpoint(sbi, false, false);
141 f2fs_balance_fs(sbi);
146 static int f2fs_statfs(struct dentry *dentry, struct kstatfs *buf)
148 struct super_block *sb = dentry->d_sb;
149 struct f2fs_sb_info *sbi = F2FS_SB(sb);
150 u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
151 block_t total_count, user_block_count, start_count, ovp_count;
153 total_count = le64_to_cpu(sbi->raw_super->block_count);
154 user_block_count = sbi->user_block_count;
155 start_count = le32_to_cpu(sbi->raw_super->segment0_blkaddr);
156 ovp_count = SM_I(sbi)->ovp_segments << sbi->log_blocks_per_seg;
157 buf->f_type = F2FS_SUPER_MAGIC;
158 buf->f_bsize = sbi->blocksize;
160 buf->f_blocks = total_count - start_count;
161 buf->f_bfree = buf->f_blocks - valid_user_blocks(sbi) - ovp_count;
162 buf->f_bavail = user_block_count - valid_user_blocks(sbi);
164 buf->f_files = sbi->total_node_count;
165 buf->f_ffree = sbi->total_node_count - valid_inode_count(sbi);
167 buf->f_namelen = F2FS_MAX_NAME_LEN;
168 buf->f_fsid.val[0] = (u32)id;
169 buf->f_fsid.val[1] = (u32)(id >> 32);
174 static int f2fs_show_options(struct seq_file *seq, struct dentry *root)
176 struct f2fs_sb_info *sbi = F2FS_SB(root->d_sb);
178 if (test_opt(sbi, BG_GC))
179 seq_puts(seq, ",background_gc_on");
181 seq_puts(seq, ",background_gc_off");
182 if (test_opt(sbi, DISABLE_ROLL_FORWARD))
183 seq_puts(seq, ",disable_roll_forward");
184 if (test_opt(sbi, DISCARD))
185 seq_puts(seq, ",discard");
186 if (test_opt(sbi, NOHEAP))
187 seq_puts(seq, ",no_heap_alloc");
188 #ifdef CONFIG_F2FS_FS_XATTR
189 if (test_opt(sbi, XATTR_USER))
190 seq_puts(seq, ",user_xattr");
192 seq_puts(seq, ",nouser_xattr");
194 #ifdef CONFIG_F2FS_FS_POSIX_ACL
195 if (test_opt(sbi, POSIX_ACL))
196 seq_puts(seq, ",acl");
198 seq_puts(seq, ",noacl");
200 if (test_opt(sbi, DISABLE_EXT_IDENTIFY))
201 seq_puts(seq, ",disable_ext_identify");
203 seq_printf(seq, ",active_logs=%u", sbi->active_logs);
208 static struct super_operations f2fs_sops = {
209 .alloc_inode = f2fs_alloc_inode,
210 .destroy_inode = f2fs_destroy_inode,
211 .write_inode = f2fs_write_inode,
212 .show_options = f2fs_show_options,
213 .evict_inode = f2fs_evict_inode,
214 .put_super = f2fs_put_super,
215 .sync_fs = f2fs_sync_fs,
216 .statfs = f2fs_statfs,
219 static struct inode *f2fs_nfs_get_inode(struct super_block *sb,
220 u64 ino, u32 generation)
222 struct f2fs_sb_info *sbi = F2FS_SB(sb);
225 if (ino < F2FS_ROOT_INO(sbi))
226 return ERR_PTR(-ESTALE);
229 * f2fs_iget isn't quite right if the inode is currently unallocated!
230 * However f2fs_iget currently does appropriate checks to handle stale
231 * inodes so everything is OK.
233 inode = f2fs_iget(sb, ino);
235 return ERR_CAST(inode);
236 if (generation && inode->i_generation != generation) {
237 /* we didn't find the right inode.. */
239 return ERR_PTR(-ESTALE);
244 static struct dentry *f2fs_fh_to_dentry(struct super_block *sb, struct fid *fid,
245 int fh_len, int fh_type)
247 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
251 static struct dentry *f2fs_fh_to_parent(struct super_block *sb, struct fid *fid,
252 int fh_len, int fh_type)
254 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
258 static const struct export_operations f2fs_export_ops = {
259 .fh_to_dentry = f2fs_fh_to_dentry,
260 .fh_to_parent = f2fs_fh_to_parent,
261 .get_parent = f2fs_get_parent,
264 static int parse_options(struct super_block *sb, struct f2fs_sb_info *sbi,
267 substring_t args[MAX_OPT_ARGS];
274 while ((p = strsep(&options, ",")) != NULL) {
279 * Initialize args struct so we know whether arg was
280 * found; some options take optional arguments.
282 args[0].to = args[0].from = NULL;
283 token = match_token(p, f2fs_tokens, args);
286 case Opt_gc_background_off:
287 clear_opt(sbi, BG_GC);
289 case Opt_disable_roll_forward:
290 set_opt(sbi, DISABLE_ROLL_FORWARD);
293 set_opt(sbi, DISCARD);
296 set_opt(sbi, NOHEAP);
298 #ifdef CONFIG_F2FS_FS_XATTR
299 case Opt_nouser_xattr:
300 clear_opt(sbi, XATTR_USER);
303 case Opt_nouser_xattr:
304 f2fs_msg(sb, KERN_INFO,
305 "nouser_xattr options not supported");
308 #ifdef CONFIG_F2FS_FS_POSIX_ACL
310 clear_opt(sbi, POSIX_ACL);
314 f2fs_msg(sb, KERN_INFO, "noacl options not supported");
317 case Opt_active_logs:
318 if (args->from && match_int(args, &arg))
320 if (arg != 2 && arg != 4 && arg != NR_CURSEG_TYPE)
322 sbi->active_logs = arg;
324 case Opt_disable_ext_identify:
325 set_opt(sbi, DISABLE_EXT_IDENTIFY);
328 f2fs_msg(sb, KERN_ERR,
329 "Unrecognized mount option \"%s\" or missing value",
337 static loff_t max_file_size(unsigned bits)
339 loff_t result = ADDRS_PER_INODE;
340 loff_t leaf_count = ADDRS_PER_BLOCK;
342 /* two direct node blocks */
343 result += (leaf_count * 2);
345 /* two indirect node blocks */
346 leaf_count *= NIDS_PER_BLOCK;
347 result += (leaf_count * 2);
349 /* one double indirect node block */
350 leaf_count *= NIDS_PER_BLOCK;
351 result += leaf_count;
357 static int sanity_check_raw_super(struct super_block *sb,
358 struct f2fs_super_block *raw_super)
360 unsigned int blocksize;
362 if (F2FS_SUPER_MAGIC != le32_to_cpu(raw_super->magic)) {
363 f2fs_msg(sb, KERN_INFO,
364 "Magic Mismatch, valid(0x%x) - read(0x%x)",
365 F2FS_SUPER_MAGIC, le32_to_cpu(raw_super->magic));
369 /* Currently, support only 4KB block size */
370 blocksize = 1 << le32_to_cpu(raw_super->log_blocksize);
371 if (blocksize != PAGE_CACHE_SIZE) {
372 f2fs_msg(sb, KERN_INFO,
373 "Invalid blocksize (%u), supports only 4KB\n",
377 if (le32_to_cpu(raw_super->log_sectorsize) !=
378 F2FS_LOG_SECTOR_SIZE) {
379 f2fs_msg(sb, KERN_INFO, "Invalid log sectorsize");
382 if (le32_to_cpu(raw_super->log_sectors_per_block) !=
383 F2FS_LOG_SECTORS_PER_BLOCK) {
384 f2fs_msg(sb, KERN_INFO, "Invalid log sectors per block");
390 static int sanity_check_ckpt(struct f2fs_sb_info *sbi)
392 unsigned int total, fsmeta;
393 struct f2fs_super_block *raw_super = F2FS_RAW_SUPER(sbi);
394 struct f2fs_checkpoint *ckpt = F2FS_CKPT(sbi);
396 total = le32_to_cpu(raw_super->segment_count);
397 fsmeta = le32_to_cpu(raw_super->segment_count_ckpt);
398 fsmeta += le32_to_cpu(raw_super->segment_count_sit);
399 fsmeta += le32_to_cpu(raw_super->segment_count_nat);
400 fsmeta += le32_to_cpu(ckpt->rsvd_segment_count);
401 fsmeta += le32_to_cpu(raw_super->segment_count_ssa);
406 if (is_set_ckpt_flags(ckpt, CP_ERROR_FLAG)) {
407 f2fs_msg(sbi->sb, KERN_ERR, "A bug case: need to run fsck");
413 static void init_sb_info(struct f2fs_sb_info *sbi)
415 struct f2fs_super_block *raw_super = sbi->raw_super;
418 sbi->log_sectors_per_block =
419 le32_to_cpu(raw_super->log_sectors_per_block);
420 sbi->log_blocksize = le32_to_cpu(raw_super->log_blocksize);
421 sbi->blocksize = 1 << sbi->log_blocksize;
422 sbi->log_blocks_per_seg = le32_to_cpu(raw_super->log_blocks_per_seg);
423 sbi->blocks_per_seg = 1 << sbi->log_blocks_per_seg;
424 sbi->segs_per_sec = le32_to_cpu(raw_super->segs_per_sec);
425 sbi->secs_per_zone = le32_to_cpu(raw_super->secs_per_zone);
426 sbi->total_sections = le32_to_cpu(raw_super->section_count);
427 sbi->total_node_count =
428 (le32_to_cpu(raw_super->segment_count_nat) / 2)
429 * sbi->blocks_per_seg * NAT_ENTRY_PER_BLOCK;
430 sbi->root_ino_num = le32_to_cpu(raw_super->root_ino);
431 sbi->node_ino_num = le32_to_cpu(raw_super->node_ino);
432 sbi->meta_ino_num = le32_to_cpu(raw_super->meta_ino);
434 for (i = 0; i < NR_COUNT_TYPE; i++)
435 atomic_set(&sbi->nr_pages[i], 0);
438 static int f2fs_fill_super(struct super_block *sb, void *data, int silent)
440 struct f2fs_sb_info *sbi;
441 struct f2fs_super_block *raw_super;
442 struct buffer_head *raw_super_buf;
447 /* allocate memory for f2fs-specific super block info */
448 sbi = kzalloc(sizeof(struct f2fs_sb_info), GFP_KERNEL);
452 /* set a block size */
453 if (!sb_set_blocksize(sb, F2FS_BLKSIZE)) {
454 f2fs_msg(sb, KERN_ERR, "unable to set blocksize");
458 /* read f2fs raw super block */
459 raw_super_buf = sb_bread(sb, 0);
460 if (!raw_super_buf) {
462 f2fs_msg(sb, KERN_ERR, "unable to read superblock");
465 raw_super = (struct f2fs_super_block *)
466 ((char *)raw_super_buf->b_data + F2FS_SUPER_OFFSET);
468 /* init some FS parameters */
469 sbi->active_logs = NR_CURSEG_TYPE;
473 #ifdef CONFIG_F2FS_FS_XATTR
474 set_opt(sbi, XATTR_USER);
476 #ifdef CONFIG_F2FS_FS_POSIX_ACL
477 set_opt(sbi, POSIX_ACL);
479 /* parse mount options */
480 if (parse_options(sb, sbi, (char *)data))
483 /* sanity checking of raw super */
484 if (sanity_check_raw_super(sb, raw_super)) {
485 f2fs_msg(sb, KERN_ERR, "Can't find a valid F2FS filesystem");
489 sb->s_maxbytes = max_file_size(le32_to_cpu(raw_super->log_blocksize));
490 sb->s_max_links = F2FS_LINK_MAX;
491 get_random_bytes(&sbi->s_next_generation, sizeof(u32));
493 sb->s_op = &f2fs_sops;
494 sb->s_xattr = f2fs_xattr_handlers;
495 sb->s_export_op = &f2fs_export_ops;
496 sb->s_magic = F2FS_SUPER_MAGIC;
499 sb->s_flags = (sb->s_flags & ~MS_POSIXACL) |
500 (test_opt(sbi, POSIX_ACL) ? MS_POSIXACL : 0);
501 memcpy(sb->s_uuid, raw_super->uuid, sizeof(raw_super->uuid));
503 /* init f2fs-specific super block info */
505 sbi->raw_super = raw_super;
506 sbi->raw_super_buf = raw_super_buf;
507 mutex_init(&sbi->gc_mutex);
508 mutex_init(&sbi->write_inode);
509 mutex_init(&sbi->writepages);
510 mutex_init(&sbi->cp_mutex);
511 for (i = 0; i < NR_LOCK_TYPE; i++)
512 mutex_init(&sbi->fs_lock[i]);
514 spin_lock_init(&sbi->stat_lock);
515 init_rwsem(&sbi->bio_sem);
518 /* get an inode for meta space */
519 sbi->meta_inode = f2fs_iget(sb, F2FS_META_INO(sbi));
520 if (IS_ERR(sbi->meta_inode)) {
521 f2fs_msg(sb, KERN_ERR, "Failed to read F2FS meta data inode");
522 err = PTR_ERR(sbi->meta_inode);
526 err = get_valid_checkpoint(sbi);
528 f2fs_msg(sb, KERN_ERR, "Failed to get valid F2FS checkpoint");
529 goto free_meta_inode;
532 /* sanity checking of checkpoint */
534 if (sanity_check_ckpt(sbi)) {
535 f2fs_msg(sb, KERN_ERR, "Invalid F2FS checkpoint");
539 sbi->total_valid_node_count =
540 le32_to_cpu(sbi->ckpt->valid_node_count);
541 sbi->total_valid_inode_count =
542 le32_to_cpu(sbi->ckpt->valid_inode_count);
543 sbi->user_block_count = le64_to_cpu(sbi->ckpt->user_block_count);
544 sbi->total_valid_block_count =
545 le64_to_cpu(sbi->ckpt->valid_block_count);
546 sbi->last_valid_block_count = sbi->total_valid_block_count;
547 sbi->alloc_valid_block_count = 0;
548 INIT_LIST_HEAD(&sbi->dir_inode_list);
549 spin_lock_init(&sbi->dir_inode_lock);
551 init_orphan_info(sbi);
553 /* setup f2fs internal modules */
554 err = build_segment_manager(sbi);
556 f2fs_msg(sb, KERN_ERR,
557 "Failed to initialize F2FS segment manager");
560 err = build_node_manager(sbi);
562 f2fs_msg(sb, KERN_ERR,
563 "Failed to initialize F2FS node manager");
567 build_gc_manager(sbi);
569 /* get an inode for node space */
570 sbi->node_inode = f2fs_iget(sb, F2FS_NODE_INO(sbi));
571 if (IS_ERR(sbi->node_inode)) {
572 f2fs_msg(sb, KERN_ERR, "Failed to read node inode");
573 err = PTR_ERR(sbi->node_inode);
577 /* if there are nt orphan nodes free them */
579 if (recover_orphan_inodes(sbi))
580 goto free_node_inode;
582 /* read root inode and dentry */
583 root = f2fs_iget(sb, F2FS_ROOT_INO(sbi));
585 f2fs_msg(sb, KERN_ERR, "Failed to read root inode");
587 goto free_node_inode;
589 if (!S_ISDIR(root->i_mode) || !root->i_blocks || !root->i_size)
590 goto free_root_inode;
592 sb->s_root = d_make_root(root); /* allocate root dentry */
595 goto free_root_inode;
598 /* recover fsynced data */
599 if (!test_opt(sbi, DISABLE_ROLL_FORWARD))
600 recover_fsync_data(sbi);
602 /* After POR, we can run background GC thread */
603 err = start_gc_thread(sbi);
607 err = f2fs_build_stats(sbi);
618 iput(sbi->node_inode);
620 destroy_node_manager(sbi);
622 destroy_segment_manager(sbi);
626 make_bad_inode(sbi->meta_inode);
627 iput(sbi->meta_inode);
629 brelse(raw_super_buf);
635 static struct dentry *f2fs_mount(struct file_system_type *fs_type, int flags,
636 const char *dev_name, void *data)
638 return mount_bdev(fs_type, flags, dev_name, data, f2fs_fill_super);
641 static struct file_system_type f2fs_fs_type = {
642 .owner = THIS_MODULE,
645 .kill_sb = kill_block_super,
646 .fs_flags = FS_REQUIRES_DEV,
649 static int __init init_inodecache(void)
651 f2fs_inode_cachep = f2fs_kmem_cache_create("f2fs_inode_cache",
652 sizeof(struct f2fs_inode_info), NULL);
653 if (f2fs_inode_cachep == NULL)
658 static void destroy_inodecache(void)
661 * Make sure all delayed rcu free inodes are flushed before we
665 kmem_cache_destroy(f2fs_inode_cachep);
668 static int __init init_f2fs_fs(void)
672 err = init_inodecache();
675 err = create_node_manager_caches();
678 err = create_gc_caches();
681 err = create_checkpoint_caches();
684 err = register_filesystem(&f2fs_fs_type);
687 f2fs_create_root_stats();
692 static void __exit exit_f2fs_fs(void)
694 f2fs_destroy_root_stats();
695 unregister_filesystem(&f2fs_fs_type);
696 destroy_checkpoint_caches();
698 destroy_node_manager_caches();
699 destroy_inodecache();
702 module_init(init_f2fs_fs)
703 module_exit(exit_f2fs_fs)
705 MODULE_AUTHOR("Samsung Electronics's Praesto Team");
706 MODULE_DESCRIPTION("Flash Friendly File System");
707 MODULE_LICENSE("GPL");