4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
6 * Copyright (c) 2017 Chao Yu <chao@kernel.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 #include <linux/proc_fs.h>
13 #include <linux/f2fs_fs.h>
14 #include <linux/seq_file.h>
20 static struct proc_dir_entry *f2fs_proc_root;
22 /* Sysfs support for f2fs */
24 GC_THREAD, /* struct f2fs_gc_thread */
25 SM_INFO, /* struct f2fs_sm_info */
26 DCC_INFO, /* struct discard_cmd_control */
27 NM_INFO, /* struct f2fs_nm_info */
28 F2FS_SBI, /* struct f2fs_sb_info */
29 #ifdef CONFIG_F2FS_FAULT_INJECTION
30 FAULT_INFO_RATE, /* struct f2fs_fault_info */
31 FAULT_INFO_TYPE, /* struct f2fs_fault_info */
33 RESERVED_BLOCKS, /* struct f2fs_sb_info */
37 struct attribute attr;
38 ssize_t (*show)(struct f2fs_attr *, struct f2fs_sb_info *, char *);
39 ssize_t (*store)(struct f2fs_attr *, struct f2fs_sb_info *,
40 const char *, size_t);
46 static unsigned char *__struct_ptr(struct f2fs_sb_info *sbi, int struct_type)
48 if (struct_type == GC_THREAD)
49 return (unsigned char *)sbi->gc_thread;
50 else if (struct_type == SM_INFO)
51 return (unsigned char *)SM_I(sbi);
52 else if (struct_type == DCC_INFO)
53 return (unsigned char *)SM_I(sbi)->dcc_info;
54 else if (struct_type == NM_INFO)
55 return (unsigned char *)NM_I(sbi);
56 else if (struct_type == F2FS_SBI || struct_type == RESERVED_BLOCKS)
57 return (unsigned char *)sbi;
58 #ifdef CONFIG_F2FS_FAULT_INJECTION
59 else if (struct_type == FAULT_INFO_RATE ||
60 struct_type == FAULT_INFO_TYPE)
61 return (unsigned char *)&sbi->fault_info;
66 static ssize_t dirty_segments_show(struct f2fs_attr *a,
67 struct f2fs_sb_info *sbi, char *buf)
69 return snprintf(buf, PAGE_SIZE, "%llu\n",
70 (unsigned long long)(dirty_segments(sbi)));
73 static ssize_t lifetime_write_kbytes_show(struct f2fs_attr *a,
74 struct f2fs_sb_info *sbi, char *buf)
76 struct super_block *sb = sbi->sb;
78 if (!sb->s_bdev->bd_part)
79 return snprintf(buf, PAGE_SIZE, "0\n");
81 return snprintf(buf, PAGE_SIZE, "%llu\n",
82 (unsigned long long)(sbi->kbytes_written +
83 BD_PART_WRITTEN(sbi)));
86 static ssize_t features_show(struct f2fs_attr *a,
87 struct f2fs_sb_info *sbi, char *buf)
89 struct super_block *sb = sbi->sb;
92 if (!sb->s_bdev->bd_part)
93 return snprintf(buf, PAGE_SIZE, "0\n");
95 if (f2fs_sb_has_crypto(sb))
96 len += snprintf(buf, PAGE_SIZE - len, "%s",
98 if (f2fs_sb_mounted_blkzoned(sb))
99 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
100 len ? ", " : "", "blkzoned");
101 if (f2fs_sb_has_extra_attr(sb))
102 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
103 len ? ", " : "", "extra_attr");
104 if (f2fs_sb_has_project_quota(sb))
105 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
106 len ? ", " : "", "projquota");
107 if (f2fs_sb_has_inode_chksum(sb))
108 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
109 len ? ", " : "", "inode_checksum");
110 if (f2fs_sb_has_flexible_inline_xattr(sb))
111 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
112 len ? ", " : "", "flexible_inline_xattr");
113 if (f2fs_sb_has_quota_ino(sb))
114 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
115 len ? ", " : "", "quota_ino");
116 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
120 static ssize_t current_reserved_blocks_show(struct f2fs_attr *a,
121 struct f2fs_sb_info *sbi, char *buf)
123 return snprintf(buf, PAGE_SIZE, "%u\n", sbi->current_reserved_blocks);
126 static ssize_t f2fs_sbi_show(struct f2fs_attr *a,
127 struct f2fs_sb_info *sbi, char *buf)
129 unsigned char *ptr = NULL;
132 ptr = __struct_ptr(sbi, a->struct_type);
136 ui = (unsigned int *)(ptr + a->offset);
138 return snprintf(buf, PAGE_SIZE, "%u\n", *ui);
141 static ssize_t f2fs_sbi_store(struct f2fs_attr *a,
142 struct f2fs_sb_info *sbi,
143 const char *buf, size_t count)
150 ptr = __struct_ptr(sbi, a->struct_type);
154 ui = (unsigned int *)(ptr + a->offset);
156 ret = kstrtoul(skip_spaces(buf), 0, &t);
159 #ifdef CONFIG_F2FS_FAULT_INJECTION
160 if (a->struct_type == FAULT_INFO_TYPE && t >= (1 << FAULT_MAX))
163 if (a->struct_type == RESERVED_BLOCKS) {
164 spin_lock(&sbi->stat_lock);
165 if (t > (unsigned long)(sbi->user_block_count -
166 sbi->root_reserved_blocks)) {
167 spin_unlock(&sbi->stat_lock);
171 sbi->current_reserved_blocks = min(sbi->reserved_blocks,
172 sbi->user_block_count - valid_user_blocks(sbi));
173 spin_unlock(&sbi->stat_lock);
177 if (!strcmp(a->attr.name, "discard_granularity")) {
178 if (t == 0 || t > MAX_PLIST_NUM)
188 if (!strcmp(a->attr.name, "iostat_enable") && *ui == 0)
189 f2fs_reset_iostat(sbi);
190 if (!strcmp(a->attr.name, "gc_urgent") && t == 1 && sbi->gc_thread) {
191 sbi->gc_thread->gc_wake = 1;
192 wake_up_interruptible_all(&sbi->gc_thread->gc_wait_queue_head);
193 wake_up_discard_thread(sbi, true);
199 static ssize_t f2fs_attr_show(struct kobject *kobj,
200 struct attribute *attr, char *buf)
202 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
204 struct f2fs_attr *a = container_of(attr, struct f2fs_attr, attr);
206 return a->show ? a->show(a, sbi, buf) : 0;
209 static ssize_t f2fs_attr_store(struct kobject *kobj, struct attribute *attr,
210 const char *buf, size_t len)
212 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
214 struct f2fs_attr *a = container_of(attr, struct f2fs_attr, attr);
216 return a->store ? a->store(a, sbi, buf, len) : 0;
219 static void f2fs_sb_release(struct kobject *kobj)
221 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
223 complete(&sbi->s_kobj_unregister);
233 FEAT_FLEXIBLE_INLINE_XATTR,
237 static ssize_t f2fs_feature_show(struct f2fs_attr *a,
238 struct f2fs_sb_info *sbi, char *buf)
243 case FEAT_ATOMIC_WRITE:
244 case FEAT_EXTRA_ATTR:
245 case FEAT_PROJECT_QUOTA:
246 case FEAT_INODE_CHECKSUM:
247 case FEAT_FLEXIBLE_INLINE_XATTR:
249 return snprintf(buf, PAGE_SIZE, "supported\n");
254 #define F2FS_ATTR_OFFSET(_struct_type, _name, _mode, _show, _store, _offset) \
255 static struct f2fs_attr f2fs_attr_##_name = { \
256 .attr = {.name = __stringify(_name), .mode = _mode }, \
259 .struct_type = _struct_type, \
263 #define F2FS_RW_ATTR(struct_type, struct_name, name, elname) \
264 F2FS_ATTR_OFFSET(struct_type, name, 0644, \
265 f2fs_sbi_show, f2fs_sbi_store, \
266 offsetof(struct struct_name, elname))
268 #define F2FS_GENERAL_RO_ATTR(name) \
269 static struct f2fs_attr f2fs_attr_##name = __ATTR(name, 0444, name##_show, NULL)
271 #define F2FS_FEATURE_RO_ATTR(_name, _id) \
272 static struct f2fs_attr f2fs_attr_##_name = { \
273 .attr = {.name = __stringify(_name), .mode = 0444 }, \
274 .show = f2fs_feature_show, \
278 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_urgent_sleep_time,
280 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_min_sleep_time, min_sleep_time);
281 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_max_sleep_time, max_sleep_time);
282 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_no_gc_sleep_time, no_gc_sleep_time);
283 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_idle, gc_idle);
284 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_urgent, gc_urgent);
285 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, reclaim_segments, rec_prefree_segments);
286 F2FS_RW_ATTR(DCC_INFO, discard_cmd_control, max_small_discards, max_discards);
287 F2FS_RW_ATTR(DCC_INFO, discard_cmd_control, discard_granularity, discard_granularity);
288 F2FS_RW_ATTR(RESERVED_BLOCKS, f2fs_sb_info, reserved_blocks, reserved_blocks);
289 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, batched_trim_sections, trim_sections);
290 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, ipu_policy, ipu_policy);
291 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_ipu_util, min_ipu_util);
292 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_fsync_blocks, min_fsync_blocks);
293 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_hot_blocks, min_hot_blocks);
294 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_ssr_sections, min_ssr_sections);
295 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, ram_thresh, ram_thresh);
296 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, ra_nid_pages, ra_nid_pages);
297 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, dirty_nats_ratio, dirty_nats_ratio);
298 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, max_victim_search, max_victim_search);
299 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, dir_level, dir_level);
300 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, cp_interval, interval_time[CP_TIME]);
301 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, idle_interval, interval_time[REQ_TIME]);
302 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, iostat_enable, iostat_enable);
303 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, readdir_ra, readdir_ra);
304 #ifdef CONFIG_F2FS_FAULT_INJECTION
305 F2FS_RW_ATTR(FAULT_INFO_RATE, f2fs_fault_info, inject_rate, inject_rate);
306 F2FS_RW_ATTR(FAULT_INFO_TYPE, f2fs_fault_info, inject_type, inject_type);
308 F2FS_GENERAL_RO_ATTR(dirty_segments);
309 F2FS_GENERAL_RO_ATTR(lifetime_write_kbytes);
310 F2FS_GENERAL_RO_ATTR(features);
311 F2FS_GENERAL_RO_ATTR(current_reserved_blocks);
313 #ifdef CONFIG_F2FS_FS_ENCRYPTION
314 F2FS_FEATURE_RO_ATTR(encryption, FEAT_CRYPTO);
316 #ifdef CONFIG_BLK_DEV_ZONED
317 F2FS_FEATURE_RO_ATTR(block_zoned, FEAT_BLKZONED);
319 F2FS_FEATURE_RO_ATTR(atomic_write, FEAT_ATOMIC_WRITE);
320 F2FS_FEATURE_RO_ATTR(extra_attr, FEAT_EXTRA_ATTR);
321 F2FS_FEATURE_RO_ATTR(project_quota, FEAT_PROJECT_QUOTA);
322 F2FS_FEATURE_RO_ATTR(inode_checksum, FEAT_INODE_CHECKSUM);
323 F2FS_FEATURE_RO_ATTR(flexible_inline_xattr, FEAT_FLEXIBLE_INLINE_XATTR);
324 F2FS_FEATURE_RO_ATTR(quota_ino, FEAT_QUOTA_INO);
326 #define ATTR_LIST(name) (&f2fs_attr_##name.attr)
327 static struct attribute *f2fs_attrs[] = {
328 ATTR_LIST(gc_urgent_sleep_time),
329 ATTR_LIST(gc_min_sleep_time),
330 ATTR_LIST(gc_max_sleep_time),
331 ATTR_LIST(gc_no_gc_sleep_time),
333 ATTR_LIST(gc_urgent),
334 ATTR_LIST(reclaim_segments),
335 ATTR_LIST(max_small_discards),
336 ATTR_LIST(discard_granularity),
337 ATTR_LIST(batched_trim_sections),
338 ATTR_LIST(ipu_policy),
339 ATTR_LIST(min_ipu_util),
340 ATTR_LIST(min_fsync_blocks),
341 ATTR_LIST(min_hot_blocks),
342 ATTR_LIST(min_ssr_sections),
343 ATTR_LIST(max_victim_search),
344 ATTR_LIST(dir_level),
345 ATTR_LIST(ram_thresh),
346 ATTR_LIST(ra_nid_pages),
347 ATTR_LIST(dirty_nats_ratio),
348 ATTR_LIST(cp_interval),
349 ATTR_LIST(idle_interval),
350 ATTR_LIST(iostat_enable),
351 ATTR_LIST(readdir_ra),
352 #ifdef CONFIG_F2FS_FAULT_INJECTION
353 ATTR_LIST(inject_rate),
354 ATTR_LIST(inject_type),
356 ATTR_LIST(dirty_segments),
357 ATTR_LIST(lifetime_write_kbytes),
359 ATTR_LIST(reserved_blocks),
360 ATTR_LIST(current_reserved_blocks),
364 static struct attribute *f2fs_feat_attrs[] = {
365 #ifdef CONFIG_F2FS_FS_ENCRYPTION
366 ATTR_LIST(encryption),
368 #ifdef CONFIG_BLK_DEV_ZONED
369 ATTR_LIST(block_zoned),
371 ATTR_LIST(atomic_write),
372 ATTR_LIST(extra_attr),
373 ATTR_LIST(project_quota),
374 ATTR_LIST(inode_checksum),
375 ATTR_LIST(flexible_inline_xattr),
376 ATTR_LIST(quota_ino),
380 static const struct sysfs_ops f2fs_attr_ops = {
381 .show = f2fs_attr_show,
382 .store = f2fs_attr_store,
385 static struct kobj_type f2fs_sb_ktype = {
386 .default_attrs = f2fs_attrs,
387 .sysfs_ops = &f2fs_attr_ops,
388 .release = f2fs_sb_release,
391 static struct kobj_type f2fs_ktype = {
392 .sysfs_ops = &f2fs_attr_ops,
395 static struct kset f2fs_kset = {
396 .kobj = {.ktype = &f2fs_ktype},
399 static struct kobj_type f2fs_feat_ktype = {
400 .default_attrs = f2fs_feat_attrs,
401 .sysfs_ops = &f2fs_attr_ops,
404 static struct kobject f2fs_feat = {
408 static int segment_info_seq_show(struct seq_file *seq, void *offset)
410 struct super_block *sb = seq->private;
411 struct f2fs_sb_info *sbi = F2FS_SB(sb);
412 unsigned int total_segs =
413 le32_to_cpu(sbi->raw_super->segment_count_main);
416 seq_puts(seq, "format: segment_type|valid_blocks\n"
417 "segment_type(0:HD, 1:WD, 2:CD, 3:HN, 4:WN, 5:CN)\n");
419 for (i = 0; i < total_segs; i++) {
420 struct seg_entry *se = get_seg_entry(sbi, i);
423 seq_printf(seq, "%-10d", i);
424 seq_printf(seq, "%d|%-3u", se->type,
425 get_valid_blocks(sbi, i, false));
426 if ((i % 10) == 9 || i == (total_segs - 1))
435 static int segment_bits_seq_show(struct seq_file *seq, void *offset)
437 struct super_block *sb = seq->private;
438 struct f2fs_sb_info *sbi = F2FS_SB(sb);
439 unsigned int total_segs =
440 le32_to_cpu(sbi->raw_super->segment_count_main);
443 seq_puts(seq, "format: segment_type|valid_blocks|bitmaps\n"
444 "segment_type(0:HD, 1:WD, 2:CD, 3:HN, 4:WN, 5:CN)\n");
446 for (i = 0; i < total_segs; i++) {
447 struct seg_entry *se = get_seg_entry(sbi, i);
449 seq_printf(seq, "%-10d", i);
450 seq_printf(seq, "%d|%-3u|", se->type,
451 get_valid_blocks(sbi, i, false));
452 for (j = 0; j < SIT_VBLOCK_MAP_SIZE; j++)
453 seq_printf(seq, " %.2x", se->cur_valid_map[j]);
459 static int iostat_info_seq_show(struct seq_file *seq, void *offset)
461 struct super_block *sb = seq->private;
462 struct f2fs_sb_info *sbi = F2FS_SB(sb);
463 time64_t now = ktime_get_real_seconds();
465 if (!sbi->iostat_enable)
468 seq_printf(seq, "time: %-16llu\n", now);
471 seq_printf(seq, "app buffered: %-16llu\n",
472 sbi->write_iostat[APP_BUFFERED_IO]);
473 seq_printf(seq, "app direct: %-16llu\n",
474 sbi->write_iostat[APP_DIRECT_IO]);
475 seq_printf(seq, "app mapped: %-16llu\n",
476 sbi->write_iostat[APP_MAPPED_IO]);
479 seq_printf(seq, "fs data: %-16llu\n",
480 sbi->write_iostat[FS_DATA_IO]);
481 seq_printf(seq, "fs node: %-16llu\n",
482 sbi->write_iostat[FS_NODE_IO]);
483 seq_printf(seq, "fs meta: %-16llu\n",
484 sbi->write_iostat[FS_META_IO]);
485 seq_printf(seq, "fs gc data: %-16llu\n",
486 sbi->write_iostat[FS_GC_DATA_IO]);
487 seq_printf(seq, "fs gc node: %-16llu\n",
488 sbi->write_iostat[FS_GC_NODE_IO]);
489 seq_printf(seq, "fs cp data: %-16llu\n",
490 sbi->write_iostat[FS_CP_DATA_IO]);
491 seq_printf(seq, "fs cp node: %-16llu\n",
492 sbi->write_iostat[FS_CP_NODE_IO]);
493 seq_printf(seq, "fs cp meta: %-16llu\n",
494 sbi->write_iostat[FS_CP_META_IO]);
495 seq_printf(seq, "fs discard: %-16llu\n",
496 sbi->write_iostat[FS_DISCARD]);
501 #define F2FS_PROC_FILE_DEF(_name) \
502 static int _name##_open_fs(struct inode *inode, struct file *file) \
504 return single_open(file, _name##_seq_show, PDE_DATA(inode)); \
507 static const struct file_operations f2fs_seq_##_name##_fops = { \
508 .open = _name##_open_fs, \
510 .llseek = seq_lseek, \
511 .release = single_release, \
514 F2FS_PROC_FILE_DEF(segment_info);
515 F2FS_PROC_FILE_DEF(segment_bits);
516 F2FS_PROC_FILE_DEF(iostat_info);
518 int __init f2fs_init_sysfs(void)
522 kobject_set_name(&f2fs_kset.kobj, "f2fs");
523 f2fs_kset.kobj.parent = fs_kobj;
524 ret = kset_register(&f2fs_kset);
528 ret = kobject_init_and_add(&f2fs_feat, &f2fs_feat_ktype,
531 kset_unregister(&f2fs_kset);
533 f2fs_proc_root = proc_mkdir("fs/f2fs", NULL);
537 void f2fs_exit_sysfs(void)
539 kobject_put(&f2fs_feat);
540 kset_unregister(&f2fs_kset);
541 remove_proc_entry("fs/f2fs", NULL);
542 f2fs_proc_root = NULL;
545 int f2fs_register_sysfs(struct f2fs_sb_info *sbi)
547 struct super_block *sb = sbi->sb;
550 sbi->s_kobj.kset = &f2fs_kset;
551 init_completion(&sbi->s_kobj_unregister);
552 err = kobject_init_and_add(&sbi->s_kobj, &f2fs_sb_ktype, NULL,
558 sbi->s_proc = proc_mkdir(sb->s_id, f2fs_proc_root);
561 proc_create_data("segment_info", S_IRUGO, sbi->s_proc,
562 &f2fs_seq_segment_info_fops, sb);
563 proc_create_data("segment_bits", S_IRUGO, sbi->s_proc,
564 &f2fs_seq_segment_bits_fops, sb);
565 proc_create_data("iostat_info", S_IRUGO, sbi->s_proc,
566 &f2fs_seq_iostat_info_fops, sb);
571 void f2fs_unregister_sysfs(struct f2fs_sb_info *sbi)
574 remove_proc_entry("iostat_info", sbi->s_proc);
575 remove_proc_entry("segment_info", sbi->s_proc);
576 remove_proc_entry("segment_bits", sbi->s_proc);
577 remove_proc_entry(sbi->sb->s_id, f2fs_proc_root);
579 kobject_del(&sbi->s_kobj);