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 memset(fi, 0, sizeof(*fi));
61 inode_init_once(&fi->vfs_inode);
64 static struct inode *f2fs_alloc_inode(struct super_block *sb)
66 struct f2fs_inode_info *fi;
68 fi = kmem_cache_alloc(f2fs_inode_cachep, GFP_NOFS | __GFP_ZERO);
72 init_once((void *) fi);
74 /* Initilize f2fs-specific inode info */
75 fi->vfs_inode.i_version = 1;
76 atomic_set(&fi->dirty_dents, 0);
77 fi->i_current_depth = 1;
79 rwlock_init(&fi->ext.ext_lock);
81 set_inode_flag(fi, FI_NEW_INODE);
83 return &fi->vfs_inode;
86 static void f2fs_i_callback(struct rcu_head *head)
88 struct inode *inode = container_of(head, struct inode, i_rcu);
89 kmem_cache_free(f2fs_inode_cachep, F2FS_I(inode));
92 static void f2fs_destroy_inode(struct inode *inode)
94 call_rcu(&inode->i_rcu, f2fs_i_callback);
97 static void f2fs_put_super(struct super_block *sb)
99 struct f2fs_sb_info *sbi = F2FS_SB(sb);
101 f2fs_destroy_stats(sbi);
104 write_checkpoint(sbi, false, true);
106 iput(sbi->node_inode);
107 iput(sbi->meta_inode);
109 /* destroy f2fs internal modules */
110 destroy_node_manager(sbi);
111 destroy_segment_manager(sbi);
115 sb->s_fs_info = NULL;
116 brelse(sbi->raw_super_buf);
120 int f2fs_sync_fs(struct super_block *sb, int sync)
122 struct f2fs_sb_info *sbi = F2FS_SB(sb);
125 if (!sbi->s_dirty && !get_pages(sbi, F2FS_DIRTY_NODES))
129 write_checkpoint(sbi, false, false);
134 static int f2fs_statfs(struct dentry *dentry, struct kstatfs *buf)
136 struct super_block *sb = dentry->d_sb;
137 struct f2fs_sb_info *sbi = F2FS_SB(sb);
138 u64 id = huge_encode_dev(sb->s_bdev->bd_dev);
139 block_t total_count, user_block_count, start_count, ovp_count;
141 total_count = le64_to_cpu(sbi->raw_super->block_count);
142 user_block_count = sbi->user_block_count;
143 start_count = le32_to_cpu(sbi->raw_super->segment0_blkaddr);
144 ovp_count = SM_I(sbi)->ovp_segments << sbi->log_blocks_per_seg;
145 buf->f_type = F2FS_SUPER_MAGIC;
146 buf->f_bsize = sbi->blocksize;
148 buf->f_blocks = total_count - start_count;
149 buf->f_bfree = buf->f_blocks - valid_user_blocks(sbi) - ovp_count;
150 buf->f_bavail = user_block_count - valid_user_blocks(sbi);
152 buf->f_files = valid_inode_count(sbi);
153 buf->f_ffree = sbi->total_node_count - valid_node_count(sbi);
155 buf->f_namelen = F2FS_MAX_NAME_LEN;
156 buf->f_fsid.val[0] = (u32)id;
157 buf->f_fsid.val[1] = (u32)(id >> 32);
162 static int f2fs_show_options(struct seq_file *seq, struct dentry *root)
164 struct f2fs_sb_info *sbi = F2FS_SB(root->d_sb);
166 if (test_opt(sbi, BG_GC))
167 seq_puts(seq, ",background_gc_on");
169 seq_puts(seq, ",background_gc_off");
170 if (test_opt(sbi, DISABLE_ROLL_FORWARD))
171 seq_puts(seq, ",disable_roll_forward");
172 if (test_opt(sbi, DISCARD))
173 seq_puts(seq, ",discard");
174 if (test_opt(sbi, NOHEAP))
175 seq_puts(seq, ",no_heap_alloc");
176 #ifdef CONFIG_F2FS_FS_XATTR
177 if (test_opt(sbi, XATTR_USER))
178 seq_puts(seq, ",user_xattr");
180 seq_puts(seq, ",nouser_xattr");
182 #ifdef CONFIG_F2FS_FS_POSIX_ACL
183 if (test_opt(sbi, POSIX_ACL))
184 seq_puts(seq, ",acl");
186 seq_puts(seq, ",noacl");
188 if (test_opt(sbi, DISABLE_EXT_IDENTIFY))
189 seq_puts(seq, ",disable_ext_indentify");
191 seq_printf(seq, ",active_logs=%u", sbi->active_logs);
196 static struct super_operations f2fs_sops = {
197 .alloc_inode = f2fs_alloc_inode,
198 .destroy_inode = f2fs_destroy_inode,
199 .write_inode = f2fs_write_inode,
200 .show_options = f2fs_show_options,
201 .evict_inode = f2fs_evict_inode,
202 .put_super = f2fs_put_super,
203 .sync_fs = f2fs_sync_fs,
204 .statfs = f2fs_statfs,
207 static struct inode *f2fs_nfs_get_inode(struct super_block *sb,
208 u64 ino, u32 generation)
210 struct f2fs_sb_info *sbi = F2FS_SB(sb);
213 if (ino < F2FS_ROOT_INO(sbi))
214 return ERR_PTR(-ESTALE);
217 * f2fs_iget isn't quite right if the inode is currently unallocated!
218 * However f2fs_iget currently does appropriate checks to handle stale
219 * inodes so everything is OK.
221 inode = f2fs_iget(sb, ino);
223 return ERR_CAST(inode);
224 if (generation && inode->i_generation != generation) {
225 /* we didn't find the right inode.. */
227 return ERR_PTR(-ESTALE);
232 static struct dentry *f2fs_fh_to_dentry(struct super_block *sb, struct fid *fid,
233 int fh_len, int fh_type)
235 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
239 static struct dentry *f2fs_fh_to_parent(struct super_block *sb, struct fid *fid,
240 int fh_len, int fh_type)
242 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
246 static const struct export_operations f2fs_export_ops = {
247 .fh_to_dentry = f2fs_fh_to_dentry,
248 .fh_to_parent = f2fs_fh_to_parent,
249 .get_parent = f2fs_get_parent,
252 static int parse_options(struct f2fs_sb_info *sbi, char *options)
254 substring_t args[MAX_OPT_ARGS];
261 while ((p = strsep(&options, ",")) != NULL) {
266 * Initialize args struct so we know whether arg was
267 * found; some options take optional arguments.
269 args[0].to = args[0].from = NULL;
270 token = match_token(p, f2fs_tokens, args);
273 case Opt_gc_background_off:
274 clear_opt(sbi, BG_GC);
276 case Opt_disable_roll_forward:
277 set_opt(sbi, DISABLE_ROLL_FORWARD);
280 set_opt(sbi, DISCARD);
283 set_opt(sbi, NOHEAP);
285 #ifdef CONFIG_F2FS_FS_XATTR
286 case Opt_nouser_xattr:
287 clear_opt(sbi, XATTR_USER);
290 case Opt_nouser_xattr:
291 pr_info("nouser_xattr options not supported\n");
294 #ifdef CONFIG_F2FS_FS_POSIX_ACL
296 clear_opt(sbi, POSIX_ACL);
300 pr_info("noacl options not supported\n");
303 case Opt_active_logs:
304 if (args->from && match_int(args, &arg))
306 if (arg != 2 && arg != 4 && arg != 6)
308 sbi->active_logs = arg;
310 case Opt_disable_ext_identify:
311 set_opt(sbi, DISABLE_EXT_IDENTIFY);
314 pr_err("Unrecognized mount option \"%s\" or missing value\n",
322 static loff_t max_file_size(unsigned bits)
324 loff_t result = ADDRS_PER_INODE;
325 loff_t leaf_count = ADDRS_PER_BLOCK;
327 /* two direct node blocks */
328 result += (leaf_count * 2);
330 /* two indirect node blocks */
331 leaf_count *= NIDS_PER_BLOCK;
332 result += (leaf_count * 2);
334 /* one double indirect node block */
335 leaf_count *= NIDS_PER_BLOCK;
336 result += leaf_count;
342 static int sanity_check_raw_super(struct f2fs_super_block *raw_super)
344 unsigned int blocksize;
346 if (F2FS_SUPER_MAGIC != le32_to_cpu(raw_super->magic))
349 /* Currently, support only 4KB block size */
350 blocksize = 1 << le32_to_cpu(raw_super->log_blocksize);
351 if (blocksize != PAGE_CACHE_SIZE)
353 if (le32_to_cpu(raw_super->log_sectorsize) !=
354 F2FS_LOG_SECTOR_SIZE)
356 if (le32_to_cpu(raw_super->log_sectors_per_block) !=
357 F2FS_LOG_SECTORS_PER_BLOCK)
362 static int sanity_check_ckpt(struct f2fs_super_block *raw_super,
363 struct f2fs_checkpoint *ckpt)
365 unsigned int total, fsmeta;
367 total = le32_to_cpu(raw_super->segment_count);
368 fsmeta = le32_to_cpu(raw_super->segment_count_ckpt);
369 fsmeta += le32_to_cpu(raw_super->segment_count_sit);
370 fsmeta += le32_to_cpu(raw_super->segment_count_nat);
371 fsmeta += le32_to_cpu(ckpt->rsvd_segment_count);
372 fsmeta += le32_to_cpu(raw_super->segment_count_ssa);
379 static void init_sb_info(struct f2fs_sb_info *sbi)
381 struct f2fs_super_block *raw_super = sbi->raw_super;
384 sbi->log_sectors_per_block =
385 le32_to_cpu(raw_super->log_sectors_per_block);
386 sbi->log_blocksize = le32_to_cpu(raw_super->log_blocksize);
387 sbi->blocksize = 1 << sbi->log_blocksize;
388 sbi->log_blocks_per_seg = le32_to_cpu(raw_super->log_blocks_per_seg);
389 sbi->blocks_per_seg = 1 << sbi->log_blocks_per_seg;
390 sbi->segs_per_sec = le32_to_cpu(raw_super->segs_per_sec);
391 sbi->secs_per_zone = le32_to_cpu(raw_super->secs_per_zone);
392 sbi->total_sections = le32_to_cpu(raw_super->section_count);
393 sbi->total_node_count =
394 (le32_to_cpu(raw_super->segment_count_nat) / 2)
395 * sbi->blocks_per_seg * NAT_ENTRY_PER_BLOCK;
396 sbi->root_ino_num = le32_to_cpu(raw_super->root_ino);
397 sbi->node_ino_num = le32_to_cpu(raw_super->node_ino);
398 sbi->meta_ino_num = le32_to_cpu(raw_super->meta_ino);
400 for (i = 0; i < NR_COUNT_TYPE; i++)
401 atomic_set(&sbi->nr_pages[i], 0);
404 static int f2fs_fill_super(struct super_block *sb, void *data, int silent)
406 struct f2fs_sb_info *sbi;
407 struct f2fs_super_block *raw_super;
408 struct buffer_head *raw_super_buf;
413 /* allocate memory for f2fs-specific super block info */
414 sbi = kzalloc(sizeof(struct f2fs_sb_info), GFP_KERNEL);
418 /* set a temporary block size */
419 if (!sb_set_blocksize(sb, F2FS_BLKSIZE))
422 /* read f2fs raw super block */
423 raw_super_buf = sb_bread(sb, 0);
424 if (!raw_super_buf) {
428 raw_super = (struct f2fs_super_block *)
429 ((char *)raw_super_buf->b_data + F2FS_SUPER_OFFSET);
431 /* init some FS parameters */
432 sbi->active_logs = NR_CURSEG_TYPE;
436 #ifdef CONFIG_F2FS_FS_XATTR
437 set_opt(sbi, XATTR_USER);
439 #ifdef CONFIG_F2FS_FS_POSIX_ACL
440 set_opt(sbi, POSIX_ACL);
442 /* parse mount options */
443 if (parse_options(sbi, (char *)data))
446 /* sanity checking of raw super */
447 if (sanity_check_raw_super(raw_super))
450 sb->s_maxbytes = max_file_size(le32_to_cpu(raw_super->log_blocksize));
451 sb->s_max_links = F2FS_LINK_MAX;
452 get_random_bytes(&sbi->s_next_generation, sizeof(u32));
454 sb->s_op = &f2fs_sops;
455 sb->s_xattr = f2fs_xattr_handlers;
456 sb->s_export_op = &f2fs_export_ops;
457 sb->s_magic = F2FS_SUPER_MAGIC;
460 sb->s_flags = (sb->s_flags & ~MS_POSIXACL) |
461 (test_opt(sbi, POSIX_ACL) ? MS_POSIXACL : 0);
462 memcpy(sb->s_uuid, raw_super->uuid, sizeof(raw_super->uuid));
464 /* init f2fs-specific super block info */
466 sbi->raw_super = raw_super;
467 sbi->raw_super_buf = raw_super_buf;
468 mutex_init(&sbi->gc_mutex);
469 mutex_init(&sbi->write_inode);
470 mutex_init(&sbi->writepages);
471 mutex_init(&sbi->cp_mutex);
472 for (i = 0; i < NR_LOCK_TYPE; i++)
473 mutex_init(&sbi->fs_lock[i]);
475 spin_lock_init(&sbi->stat_lock);
476 init_rwsem(&sbi->bio_sem);
479 /* get an inode for meta space */
480 sbi->meta_inode = f2fs_iget(sb, F2FS_META_INO(sbi));
481 if (IS_ERR(sbi->meta_inode)) {
482 err = PTR_ERR(sbi->meta_inode);
486 err = get_valid_checkpoint(sbi);
488 goto free_meta_inode;
490 /* sanity checking of checkpoint */
492 if (sanity_check_ckpt(raw_super, sbi->ckpt))
495 sbi->total_valid_node_count =
496 le32_to_cpu(sbi->ckpt->valid_node_count);
497 sbi->total_valid_inode_count =
498 le32_to_cpu(sbi->ckpt->valid_inode_count);
499 sbi->user_block_count = le64_to_cpu(sbi->ckpt->user_block_count);
500 sbi->total_valid_block_count =
501 le64_to_cpu(sbi->ckpt->valid_block_count);
502 sbi->last_valid_block_count = sbi->total_valid_block_count;
503 sbi->alloc_valid_block_count = 0;
504 INIT_LIST_HEAD(&sbi->dir_inode_list);
505 spin_lock_init(&sbi->dir_inode_lock);
507 /* init super block */
508 if (!sb_set_blocksize(sb, sbi->blocksize))
511 init_orphan_info(sbi);
513 /* setup f2fs internal modules */
514 err = build_segment_manager(sbi);
517 err = build_node_manager(sbi);
521 build_gc_manager(sbi);
523 /* get an inode for node space */
524 sbi->node_inode = f2fs_iget(sb, F2FS_NODE_INO(sbi));
525 if (IS_ERR(sbi->node_inode)) {
526 err = PTR_ERR(sbi->node_inode);
530 /* if there are nt orphan nodes free them */
532 if (!is_set_ckpt_flags(F2FS_CKPT(sbi), CP_UMOUNT_FLAG) &&
533 recover_orphan_inodes(sbi))
534 goto free_node_inode;
536 /* read root inode and dentry */
537 root = f2fs_iget(sb, F2FS_ROOT_INO(sbi));
540 goto free_node_inode;
542 if (!S_ISDIR(root->i_mode) || !root->i_blocks || !root->i_size)
543 goto free_root_inode;
545 sb->s_root = d_make_root(root); /* allocate root dentry */
548 goto free_root_inode;
551 /* recover fsynced data */
552 if (!is_set_ckpt_flags(F2FS_CKPT(sbi), CP_UMOUNT_FLAG) &&
553 !test_opt(sbi, DISABLE_ROLL_FORWARD))
554 recover_fsync_data(sbi);
556 /* After POR, we can run background GC thread */
557 err = start_gc_thread(sbi);
561 err = f2fs_build_stats(sbi);
572 iput(sbi->node_inode);
574 destroy_node_manager(sbi);
576 destroy_segment_manager(sbi);
580 make_bad_inode(sbi->meta_inode);
581 iput(sbi->meta_inode);
583 brelse(raw_super_buf);
589 static struct dentry *f2fs_mount(struct file_system_type *fs_type, int flags,
590 const char *dev_name, void *data)
592 return mount_bdev(fs_type, flags, dev_name, data, f2fs_fill_super);
595 static struct file_system_type f2fs_fs_type = {
596 .owner = THIS_MODULE,
599 .kill_sb = kill_block_super,
600 .fs_flags = FS_REQUIRES_DEV,
603 static int init_inodecache(void)
605 f2fs_inode_cachep = f2fs_kmem_cache_create("f2fs_inode_cache",
606 sizeof(struct f2fs_inode_info), NULL);
607 if (f2fs_inode_cachep == NULL)
612 static void destroy_inodecache(void)
615 * Make sure all delayed rcu free inodes are flushed before we
619 kmem_cache_destroy(f2fs_inode_cachep);
622 static int __init init_f2fs_fs(void)
626 err = init_inodecache();
629 err = create_node_manager_caches();
632 err = create_gc_caches();
635 err = create_checkpoint_caches();
638 return register_filesystem(&f2fs_fs_type);
643 static void __exit exit_f2fs_fs(void)
645 destroy_root_stats();
646 unregister_filesystem(&f2fs_fs_type);
647 destroy_checkpoint_caches();
649 destroy_node_manager_caches();
650 destroy_inodecache();
653 module_init(init_f2fs_fs)
654 module_exit(exit_f2fs_fs)
656 MODULE_AUTHOR("Samsung Electronics's Praesto Team");
657 MODULE_DESCRIPTION("Flash Friendly File System");
658 MODULE_LICENSE("GPL");