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 static void init_once(void *foo)
58 struct f2fs_inode_info *fi = (struct f2fs_inode_info *) foo;
60 inode_init_once(&fi->vfs_inode);
63 static struct inode *f2fs_alloc_inode(struct super_block *sb)
65 struct f2fs_inode_info *fi;
67 fi = kmem_cache_alloc(f2fs_inode_cachep, GFP_NOFS | __GFP_ZERO);
71 init_once((void *) fi);
73 /* Initilize f2fs-specific inode info */
74 fi->vfs_inode.i_version = 1;
75 atomic_set(&fi->dirty_dents, 0);
76 fi->i_current_depth = 1;
78 rwlock_init(&fi->ext.ext_lock);
80 set_inode_flag(fi, FI_NEW_INODE);
82 return &fi->vfs_inode;
85 static void f2fs_i_callback(struct rcu_head *head)
87 struct inode *inode = container_of(head, struct inode, i_rcu);
88 kmem_cache_free(f2fs_inode_cachep, F2FS_I(inode));
91 static void f2fs_destroy_inode(struct inode *inode)
93 call_rcu(&inode->i_rcu, f2fs_i_callback);
96 static void f2fs_put_super(struct super_block *sb)
98 struct f2fs_sb_info *sbi = F2FS_SB(sb);
100 f2fs_destroy_stats(sbi);
103 write_checkpoint(sbi, false, true);
105 iput(sbi->node_inode);
106 iput(sbi->meta_inode);
108 /* destroy f2fs internal modules */
109 destroy_node_manager(sbi);
110 destroy_segment_manager(sbi);
114 sb->s_fs_info = NULL;
115 brelse(sbi->raw_super_buf);
119 int f2fs_sync_fs(struct super_block *sb, int sync)
121 struct f2fs_sb_info *sbi = F2FS_SB(sb);
124 if (!sbi->s_dirty && !get_pages(sbi, F2FS_DIRTY_NODES))
128 write_checkpoint(sbi, false, false);
133 static int f2fs_statfs(struct dentry *dentry, struct kstatfs *buf)
135 struct super_block *sb = dentry->d_sb;
136 struct f2fs_sb_info *sbi = F2FS_SB(sb);
137 u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
138 block_t total_count, user_block_count, start_count, ovp_count;
140 total_count = le64_to_cpu(sbi->raw_super->block_count);
141 user_block_count = sbi->user_block_count;
142 start_count = le32_to_cpu(sbi->raw_super->segment0_blkaddr);
143 ovp_count = SM_I(sbi)->ovp_segments << sbi->log_blocks_per_seg;
144 buf->f_type = F2FS_SUPER_MAGIC;
145 buf->f_bsize = sbi->blocksize;
147 buf->f_blocks = total_count - start_count;
148 buf->f_bfree = buf->f_blocks - valid_user_blocks(sbi) - ovp_count;
149 buf->f_bavail = user_block_count - valid_user_blocks(sbi);
151 buf->f_files = sbi->total_node_count;
152 buf->f_ffree = sbi->total_node_count - valid_inode_count(sbi);
154 buf->f_namelen = F2FS_MAX_NAME_LEN;
155 buf->f_fsid.val[0] = (u32)id;
156 buf->f_fsid.val[1] = (u32)(id >> 32);
161 static int f2fs_show_options(struct seq_file *seq, struct dentry *root)
163 struct f2fs_sb_info *sbi = F2FS_SB(root->d_sb);
165 if (test_opt(sbi, BG_GC))
166 seq_puts(seq, ",background_gc_on");
168 seq_puts(seq, ",background_gc_off");
169 if (test_opt(sbi, DISABLE_ROLL_FORWARD))
170 seq_puts(seq, ",disable_roll_forward");
171 if (test_opt(sbi, DISCARD))
172 seq_puts(seq, ",discard");
173 if (test_opt(sbi, NOHEAP))
174 seq_puts(seq, ",no_heap_alloc");
175 #ifdef CONFIG_F2FS_FS_XATTR
176 if (test_opt(sbi, XATTR_USER))
177 seq_puts(seq, ",user_xattr");
179 seq_puts(seq, ",nouser_xattr");
181 #ifdef CONFIG_F2FS_FS_POSIX_ACL
182 if (test_opt(sbi, POSIX_ACL))
183 seq_puts(seq, ",acl");
185 seq_puts(seq, ",noacl");
187 if (test_opt(sbi, DISABLE_EXT_IDENTIFY))
188 seq_puts(seq, ",disable_ext_indentify");
190 seq_printf(seq, ",active_logs=%u", sbi->active_logs);
195 static struct super_operations f2fs_sops = {
196 .alloc_inode = f2fs_alloc_inode,
197 .destroy_inode = f2fs_destroy_inode,
198 .write_inode = f2fs_write_inode,
199 .show_options = f2fs_show_options,
200 .evict_inode = f2fs_evict_inode,
201 .put_super = f2fs_put_super,
202 .sync_fs = f2fs_sync_fs,
203 .statfs = f2fs_statfs,
206 static struct inode *f2fs_nfs_get_inode(struct super_block *sb,
207 u64 ino, u32 generation)
209 struct f2fs_sb_info *sbi = F2FS_SB(sb);
212 if (ino < F2FS_ROOT_INO(sbi))
213 return ERR_PTR(-ESTALE);
216 * f2fs_iget isn't quite right if the inode is currently unallocated!
217 * However f2fs_iget currently does appropriate checks to handle stale
218 * inodes so everything is OK.
220 inode = f2fs_iget(sb, ino);
222 return ERR_CAST(inode);
223 if (generation && inode->i_generation != generation) {
224 /* we didn't find the right inode.. */
226 return ERR_PTR(-ESTALE);
231 static struct dentry *f2fs_fh_to_dentry(struct super_block *sb, struct fid *fid,
232 int fh_len, int fh_type)
234 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
238 static struct dentry *f2fs_fh_to_parent(struct super_block *sb, struct fid *fid,
239 int fh_len, int fh_type)
241 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
245 static const struct export_operations f2fs_export_ops = {
246 .fh_to_dentry = f2fs_fh_to_dentry,
247 .fh_to_parent = f2fs_fh_to_parent,
248 .get_parent = f2fs_get_parent,
251 static int parse_options(struct f2fs_sb_info *sbi, char *options)
253 substring_t args[MAX_OPT_ARGS];
260 while ((p = strsep(&options, ",")) != NULL) {
265 * Initialize args struct so we know whether arg was
266 * found; some options take optional arguments.
268 args[0].to = args[0].from = NULL;
269 token = match_token(p, f2fs_tokens, args);
272 case Opt_gc_background_off:
273 clear_opt(sbi, BG_GC);
275 case Opt_disable_roll_forward:
276 set_opt(sbi, DISABLE_ROLL_FORWARD);
279 set_opt(sbi, DISCARD);
282 set_opt(sbi, NOHEAP);
284 #ifdef CONFIG_F2FS_FS_XATTR
285 case Opt_nouser_xattr:
286 clear_opt(sbi, XATTR_USER);
289 case Opt_nouser_xattr:
290 pr_info("nouser_xattr options not supported\n");
293 #ifdef CONFIG_F2FS_FS_POSIX_ACL
295 clear_opt(sbi, POSIX_ACL);
299 pr_info("noacl options not supported\n");
302 case Opt_active_logs:
303 if (args->from && match_int(args, &arg))
305 if (arg != 2 && arg != 4 && arg != NR_CURSEG_TYPE)
307 sbi->active_logs = arg;
309 case Opt_disable_ext_identify:
310 set_opt(sbi, DISABLE_EXT_IDENTIFY);
313 pr_err("Unrecognized mount option \"%s\" or missing value\n",
321 static loff_t max_file_size(unsigned bits)
323 loff_t result = ADDRS_PER_INODE;
324 loff_t leaf_count = ADDRS_PER_BLOCK;
326 /* two direct node blocks */
327 result += (leaf_count * 2);
329 /* two indirect node blocks */
330 leaf_count *= NIDS_PER_BLOCK;
331 result += (leaf_count * 2);
333 /* one double indirect node block */
334 leaf_count *= NIDS_PER_BLOCK;
335 result += leaf_count;
341 static int sanity_check_raw_super(struct f2fs_super_block *raw_super)
343 unsigned int blocksize;
345 if (F2FS_SUPER_MAGIC != le32_to_cpu(raw_super->magic))
348 /* Currently, support only 4KB block size */
349 blocksize = 1 << le32_to_cpu(raw_super->log_blocksize);
350 if (blocksize != PAGE_CACHE_SIZE)
352 if (le32_to_cpu(raw_super->log_sectorsize) !=
353 F2FS_LOG_SECTOR_SIZE)
355 if (le32_to_cpu(raw_super->log_sectors_per_block) !=
356 F2FS_LOG_SECTORS_PER_BLOCK)
361 static int sanity_check_ckpt(struct f2fs_super_block *raw_super,
362 struct f2fs_checkpoint *ckpt)
364 unsigned int total, fsmeta;
366 total = le32_to_cpu(raw_super->segment_count);
367 fsmeta = le32_to_cpu(raw_super->segment_count_ckpt);
368 fsmeta += le32_to_cpu(raw_super->segment_count_sit);
369 fsmeta += le32_to_cpu(raw_super->segment_count_nat);
370 fsmeta += le32_to_cpu(ckpt->rsvd_segment_count);
371 fsmeta += le32_to_cpu(raw_super->segment_count_ssa);
378 static void init_sb_info(struct f2fs_sb_info *sbi)
380 struct f2fs_super_block *raw_super = sbi->raw_super;
383 sbi->log_sectors_per_block =
384 le32_to_cpu(raw_super->log_sectors_per_block);
385 sbi->log_blocksize = le32_to_cpu(raw_super->log_blocksize);
386 sbi->blocksize = 1 << sbi->log_blocksize;
387 sbi->log_blocks_per_seg = le32_to_cpu(raw_super->log_blocks_per_seg);
388 sbi->blocks_per_seg = 1 << sbi->log_blocks_per_seg;
389 sbi->segs_per_sec = le32_to_cpu(raw_super->segs_per_sec);
390 sbi->secs_per_zone = le32_to_cpu(raw_super->secs_per_zone);
391 sbi->total_sections = le32_to_cpu(raw_super->section_count);
392 sbi->total_node_count =
393 (le32_to_cpu(raw_super->segment_count_nat) / 2)
394 * sbi->blocks_per_seg * NAT_ENTRY_PER_BLOCK;
395 sbi->root_ino_num = le32_to_cpu(raw_super->root_ino);
396 sbi->node_ino_num = le32_to_cpu(raw_super->node_ino);
397 sbi->meta_ino_num = le32_to_cpu(raw_super->meta_ino);
399 for (i = 0; i < NR_COUNT_TYPE; i++)
400 atomic_set(&sbi->nr_pages[i], 0);
403 static int f2fs_fill_super(struct super_block *sb, void *data, int silent)
405 struct f2fs_sb_info *sbi;
406 struct f2fs_super_block *raw_super;
407 struct buffer_head *raw_super_buf;
412 /* allocate memory for f2fs-specific super block info */
413 sbi = kzalloc(sizeof(struct f2fs_sb_info), GFP_KERNEL);
417 /* set a temporary block size */
418 if (!sb_set_blocksize(sb, F2FS_BLKSIZE))
421 /* read f2fs raw super block */
422 raw_super_buf = sb_bread(sb, 0);
423 if (!raw_super_buf) {
427 raw_super = (struct f2fs_super_block *)
428 ((char *)raw_super_buf->b_data + F2FS_SUPER_OFFSET);
430 /* init some FS parameters */
431 sbi->active_logs = NR_CURSEG_TYPE;
435 #ifdef CONFIG_F2FS_FS_XATTR
436 set_opt(sbi, XATTR_USER);
438 #ifdef CONFIG_F2FS_FS_POSIX_ACL
439 set_opt(sbi, POSIX_ACL);
441 /* parse mount options */
442 if (parse_options(sbi, (char *)data))
445 /* sanity checking of raw super */
446 if (sanity_check_raw_super(raw_super))
449 sb->s_maxbytes = max_file_size(le32_to_cpu(raw_super->log_blocksize));
450 sb->s_max_links = F2FS_LINK_MAX;
451 get_random_bytes(&sbi->s_next_generation, sizeof(u32));
453 sb->s_op = &f2fs_sops;
454 sb->s_xattr = f2fs_xattr_handlers;
455 sb->s_export_op = &f2fs_export_ops;
456 sb->s_magic = F2FS_SUPER_MAGIC;
459 sb->s_flags = (sb->s_flags & ~MS_POSIXACL) |
460 (test_opt(sbi, POSIX_ACL) ? MS_POSIXACL : 0);
461 memcpy(sb->s_uuid, raw_super->uuid, sizeof(raw_super->uuid));
463 /* init f2fs-specific super block info */
465 sbi->raw_super = raw_super;
466 sbi->raw_super_buf = raw_super_buf;
467 mutex_init(&sbi->gc_mutex);
468 mutex_init(&sbi->write_inode);
469 mutex_init(&sbi->writepages);
470 mutex_init(&sbi->cp_mutex);
471 for (i = 0; i < NR_LOCK_TYPE; i++)
472 mutex_init(&sbi->fs_lock[i]);
474 spin_lock_init(&sbi->stat_lock);
475 init_rwsem(&sbi->bio_sem);
478 /* get an inode for meta space */
479 sbi->meta_inode = f2fs_iget(sb, F2FS_META_INO(sbi));
480 if (IS_ERR(sbi->meta_inode)) {
481 err = PTR_ERR(sbi->meta_inode);
485 err = get_valid_checkpoint(sbi);
487 goto free_meta_inode;
489 /* sanity checking of checkpoint */
491 if (sanity_check_ckpt(raw_super, sbi->ckpt))
494 sbi->total_valid_node_count =
495 le32_to_cpu(sbi->ckpt->valid_node_count);
496 sbi->total_valid_inode_count =
497 le32_to_cpu(sbi->ckpt->valid_inode_count);
498 sbi->user_block_count = le64_to_cpu(sbi->ckpt->user_block_count);
499 sbi->total_valid_block_count =
500 le64_to_cpu(sbi->ckpt->valid_block_count);
501 sbi->last_valid_block_count = sbi->total_valid_block_count;
502 sbi->alloc_valid_block_count = 0;
503 INIT_LIST_HEAD(&sbi->dir_inode_list);
504 spin_lock_init(&sbi->dir_inode_lock);
506 /* init super block */
507 if (!sb_set_blocksize(sb, sbi->blocksize))
510 init_orphan_info(sbi);
512 /* setup f2fs internal modules */
513 err = build_segment_manager(sbi);
516 err = build_node_manager(sbi);
520 build_gc_manager(sbi);
522 /* get an inode for node space */
523 sbi->node_inode = f2fs_iget(sb, F2FS_NODE_INO(sbi));
524 if (IS_ERR(sbi->node_inode)) {
525 err = PTR_ERR(sbi->node_inode);
529 /* if there are nt orphan nodes free them */
531 if (recover_orphan_inodes(sbi))
532 goto free_node_inode;
534 /* read root inode and dentry */
535 root = f2fs_iget(sb, F2FS_ROOT_INO(sbi));
538 goto free_node_inode;
540 if (!S_ISDIR(root->i_mode) || !root->i_blocks || !root->i_size)
541 goto free_root_inode;
543 sb->s_root = d_make_root(root); /* allocate root dentry */
546 goto free_root_inode;
549 /* recover fsynced data */
550 if (!test_opt(sbi, DISABLE_ROLL_FORWARD))
551 recover_fsync_data(sbi);
553 /* After POR, we can run background GC thread */
554 err = start_gc_thread(sbi);
558 err = f2fs_build_stats(sbi);
569 iput(sbi->node_inode);
571 destroy_node_manager(sbi);
573 destroy_segment_manager(sbi);
577 make_bad_inode(sbi->meta_inode);
578 iput(sbi->meta_inode);
580 brelse(raw_super_buf);
586 static struct dentry *f2fs_mount(struct file_system_type *fs_type, int flags,
587 const char *dev_name, void *data)
589 return mount_bdev(fs_type, flags, dev_name, data, f2fs_fill_super);
592 static struct file_system_type f2fs_fs_type = {
593 .owner = THIS_MODULE,
596 .kill_sb = kill_block_super,
597 .fs_flags = FS_REQUIRES_DEV,
600 static int init_inodecache(void)
602 f2fs_inode_cachep = f2fs_kmem_cache_create("f2fs_inode_cache",
603 sizeof(struct f2fs_inode_info), NULL);
604 if (f2fs_inode_cachep == NULL)
609 static void destroy_inodecache(void)
612 * Make sure all delayed rcu free inodes are flushed before we
616 kmem_cache_destroy(f2fs_inode_cachep);
619 static int __init init_f2fs_fs(void)
623 err = init_inodecache();
626 err = create_node_manager_caches();
629 err = create_gc_caches();
632 err = create_checkpoint_caches();
635 return register_filesystem(&f2fs_fs_type);
640 static void __exit exit_f2fs_fs(void)
642 destroy_root_stats();
643 unregister_filesystem(&f2fs_fs_type);
644 destroy_checkpoint_caches();
646 destroy_node_manager_caches();
647 destroy_inodecache();
650 module_init(init_f2fs_fs)
651 module_exit(exit_f2fs_fs)
653 MODULE_AUTHOR("Samsung Electronics's Praesto Team");
654 MODULE_DESCRIPTION("Flash Friendly File System");
655 MODULE_LICENSE("GPL");