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/compiler.h>
13 #include <linux/proc_fs.h>
14 #include <linux/f2fs_fs.h>
15 #include <linux/seq_file.h>
21 static struct proc_dir_entry *f2fs_proc_root;
23 /* Sysfs support for f2fs */
25 GC_THREAD, /* struct f2fs_gc_thread */
26 SM_INFO, /* struct f2fs_sm_info */
27 DCC_INFO, /* struct discard_cmd_control */
28 NM_INFO, /* struct f2fs_nm_info */
29 F2FS_SBI, /* struct f2fs_sb_info */
30 #ifdef CONFIG_F2FS_FAULT_INJECTION
31 FAULT_INFO_RATE, /* struct f2fs_fault_info */
32 FAULT_INFO_TYPE, /* struct f2fs_fault_info */
38 struct attribute attr;
39 ssize_t (*show)(struct f2fs_attr *, struct f2fs_sb_info *, char *);
40 ssize_t (*store)(struct f2fs_attr *, struct f2fs_sb_info *,
41 const char *, size_t);
47 static unsigned char *__struct_ptr(struct f2fs_sb_info *sbi, int struct_type)
49 if (struct_type == GC_THREAD)
50 return (unsigned char *)sbi->gc_thread;
51 else if (struct_type == SM_INFO)
52 return (unsigned char *)SM_I(sbi);
53 else if (struct_type == DCC_INFO)
54 return (unsigned char *)SM_I(sbi)->dcc_info;
55 else if (struct_type == NM_INFO)
56 return (unsigned char *)NM_I(sbi);
57 else if (struct_type == F2FS_SBI || struct_type == RESERVED_BLOCKS)
58 return (unsigned char *)sbi;
59 #ifdef CONFIG_F2FS_FAULT_INJECTION
60 else if (struct_type == FAULT_INFO_RATE ||
61 struct_type == FAULT_INFO_TYPE)
62 return (unsigned char *)&sbi->fault_info;
67 static ssize_t lifetime_write_kbytes_show(struct f2fs_attr *a,
68 struct f2fs_sb_info *sbi, char *buf)
70 struct super_block *sb = sbi->sb;
72 if (!sb->s_bdev->bd_part)
73 return snprintf(buf, PAGE_SIZE, "0\n");
75 return snprintf(buf, PAGE_SIZE, "%llu\n",
76 (unsigned long long)(sbi->kbytes_written +
77 BD_PART_WRITTEN(sbi)));
80 static ssize_t features_show(struct f2fs_attr *a,
81 struct f2fs_sb_info *sbi, char *buf)
83 struct super_block *sb = sbi->sb;
86 if (!sb->s_bdev->bd_part)
87 return snprintf(buf, PAGE_SIZE, "0\n");
89 if (f2fs_sb_has_crypto(sb))
90 len += snprintf(buf, PAGE_SIZE - len, "%s",
92 if (f2fs_sb_mounted_blkzoned(sb))
93 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
94 len ? ", " : "", "blkzoned");
95 if (f2fs_sb_has_extra_attr(sb))
96 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
97 len ? ", " : "", "extra_attr");
98 if (f2fs_sb_has_project_quota(sb))
99 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
100 len ? ", " : "", "projquota");
101 if (f2fs_sb_has_inode_chksum(sb))
102 len += snprintf(buf + len, PAGE_SIZE - len, "%s%s",
103 len ? ", " : "", "inode_checksum");
104 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
108 static ssize_t f2fs_sbi_show(struct f2fs_attr *a,
109 struct f2fs_sb_info *sbi, char *buf)
111 unsigned char *ptr = NULL;
114 ptr = __struct_ptr(sbi, a->struct_type);
118 ui = (unsigned int *)(ptr + a->offset);
120 return snprintf(buf, PAGE_SIZE, "%u\n", *ui);
123 static ssize_t f2fs_sbi_store(struct f2fs_attr *a,
124 struct f2fs_sb_info *sbi,
125 const char *buf, size_t count)
132 ptr = __struct_ptr(sbi, a->struct_type);
136 ui = (unsigned int *)(ptr + a->offset);
138 ret = kstrtoul(skip_spaces(buf), 0, &t);
141 #ifdef CONFIG_F2FS_FAULT_INJECTION
142 if (a->struct_type == FAULT_INFO_TYPE && t >= (1 << FAULT_MAX))
145 if (a->struct_type == RESERVED_BLOCKS) {
146 spin_lock(&sbi->stat_lock);
147 if ((unsigned long)sbi->total_valid_block_count + t >
148 (unsigned long)sbi->user_block_count) {
149 spin_unlock(&sbi->stat_lock);
153 spin_unlock(&sbi->stat_lock);
157 if (!strcmp(a->attr.name, "discard_granularity")) {
158 struct discard_cmd_control *dcc = SM_I(sbi)->dcc_info;
161 if (t == 0 || t > MAX_PLIST_NUM)
166 mutex_lock(&dcc->cmd_lock);
167 for (i = 0; i < MAX_PLIST_NUM; i++) {
169 dcc->pend_list_tag[i] |= P_ACTIVE;
171 dcc->pend_list_tag[i] &= (~P_ACTIVE);
173 mutex_unlock(&dcc->cmd_lock);
181 if (!strcmp(a->attr.name, "iostat_enable") && *ui == 0)
182 f2fs_reset_iostat(sbi);
183 if (!strcmp(a->attr.name, "gc_urgent") && t == 1 && sbi->gc_thread) {
184 sbi->gc_thread->gc_wake = 1;
185 wake_up_interruptible_all(&sbi->gc_thread->gc_wait_queue_head);
186 wake_up_discard_thread(sbi, true);
192 static ssize_t f2fs_attr_show(struct kobject *kobj,
193 struct attribute *attr, char *buf)
195 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
197 struct f2fs_attr *a = container_of(attr, struct f2fs_attr, attr);
199 return a->show ? a->show(a, sbi, buf) : 0;
202 static ssize_t f2fs_attr_store(struct kobject *kobj, struct attribute *attr,
203 const char *buf, size_t len)
205 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
207 struct f2fs_attr *a = container_of(attr, struct f2fs_attr, attr);
209 return a->store ? a->store(a, sbi, buf, len) : 0;
212 static void f2fs_sb_release(struct kobject *kobj)
214 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
216 complete(&sbi->s_kobj_unregister);
228 static ssize_t f2fs_feature_show(struct f2fs_attr *a,
229 struct f2fs_sb_info *sbi, char *buf)
234 case FEAT_ATOMIC_WRITE:
235 case FEAT_EXTRA_ATTR:
236 case FEAT_PROJECT_QUOTA:
237 case FEAT_INODE_CHECKSUM:
238 return snprintf(buf, PAGE_SIZE, "supported\n");
243 #define F2FS_ATTR_OFFSET(_struct_type, _name, _mode, _show, _store, _offset) \
244 static struct f2fs_attr f2fs_attr_##_name = { \
245 .attr = {.name = __stringify(_name), .mode = _mode }, \
248 .struct_type = _struct_type, \
252 #define F2FS_RW_ATTR(struct_type, struct_name, name, elname) \
253 F2FS_ATTR_OFFSET(struct_type, name, 0644, \
254 f2fs_sbi_show, f2fs_sbi_store, \
255 offsetof(struct struct_name, elname))
257 #define F2FS_GENERAL_RO_ATTR(name) \
258 static struct f2fs_attr f2fs_attr_##name = __ATTR(name, 0444, name##_show, NULL)
260 #define F2FS_FEATURE_RO_ATTR(_name, _id) \
261 static struct f2fs_attr f2fs_attr_##_name = { \
262 .attr = {.name = __stringify(_name), .mode = 0444 }, \
263 .show = f2fs_feature_show, \
267 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_urgent_sleep_time,
269 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_min_sleep_time, min_sleep_time);
270 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_max_sleep_time, max_sleep_time);
271 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_no_gc_sleep_time, no_gc_sleep_time);
272 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_idle, gc_idle);
273 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_urgent, gc_urgent);
274 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, reclaim_segments, rec_prefree_segments);
275 F2FS_RW_ATTR(DCC_INFO, discard_cmd_control, max_small_discards, max_discards);
276 F2FS_RW_ATTR(DCC_INFO, discard_cmd_control, discard_granularity, discard_granularity);
277 F2FS_RW_ATTR(RESERVED_BLOCKS, f2fs_sb_info, reserved_blocks, reserved_blocks);
278 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, batched_trim_sections, trim_sections);
279 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, ipu_policy, ipu_policy);
280 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_ipu_util, min_ipu_util);
281 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_fsync_blocks, min_fsync_blocks);
282 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_hot_blocks, min_hot_blocks);
283 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, ram_thresh, ram_thresh);
284 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, ra_nid_pages, ra_nid_pages);
285 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, dirty_nats_ratio, dirty_nats_ratio);
286 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, max_victim_search, max_victim_search);
287 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, dir_level, dir_level);
288 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, cp_interval, interval_time[CP_TIME]);
289 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, idle_interval, interval_time[REQ_TIME]);
290 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, iostat_enable, iostat_enable);
291 #ifdef CONFIG_F2FS_FAULT_INJECTION
292 F2FS_RW_ATTR(FAULT_INFO_RATE, f2fs_fault_info, inject_rate, inject_rate);
293 F2FS_RW_ATTR(FAULT_INFO_TYPE, f2fs_fault_info, inject_type, inject_type);
295 F2FS_GENERAL_RO_ATTR(lifetime_write_kbytes);
296 F2FS_GENERAL_RO_ATTR(features);
298 #ifdef CONFIG_F2FS_FS_ENCRYPTION
299 F2FS_FEATURE_RO_ATTR(encryption, FEAT_CRYPTO);
301 #ifdef CONFIG_BLK_DEV_ZONED
302 F2FS_FEATURE_RO_ATTR(block_zoned, FEAT_BLKZONED);
304 F2FS_FEATURE_RO_ATTR(atomic_write, FEAT_ATOMIC_WRITE);
305 F2FS_FEATURE_RO_ATTR(extra_attr, FEAT_EXTRA_ATTR);
306 F2FS_FEATURE_RO_ATTR(project_quota, FEAT_PROJECT_QUOTA);
307 F2FS_FEATURE_RO_ATTR(inode_checksum, FEAT_INODE_CHECKSUM);
309 #define ATTR_LIST(name) (&f2fs_attr_##name.attr)
310 static struct attribute *f2fs_attrs[] = {
311 ATTR_LIST(gc_urgent_sleep_time),
312 ATTR_LIST(gc_min_sleep_time),
313 ATTR_LIST(gc_max_sleep_time),
314 ATTR_LIST(gc_no_gc_sleep_time),
316 ATTR_LIST(gc_urgent),
317 ATTR_LIST(reclaim_segments),
318 ATTR_LIST(max_small_discards),
319 ATTR_LIST(discard_granularity),
320 ATTR_LIST(batched_trim_sections),
321 ATTR_LIST(ipu_policy),
322 ATTR_LIST(min_ipu_util),
323 ATTR_LIST(min_fsync_blocks),
324 ATTR_LIST(min_hot_blocks),
325 ATTR_LIST(max_victim_search),
326 ATTR_LIST(dir_level),
327 ATTR_LIST(ram_thresh),
328 ATTR_LIST(ra_nid_pages),
329 ATTR_LIST(dirty_nats_ratio),
330 ATTR_LIST(cp_interval),
331 ATTR_LIST(idle_interval),
332 ATTR_LIST(iostat_enable),
333 #ifdef CONFIG_F2FS_FAULT_INJECTION
334 ATTR_LIST(inject_rate),
335 ATTR_LIST(inject_type),
337 ATTR_LIST(lifetime_write_kbytes),
339 ATTR_LIST(reserved_blocks),
343 static struct attribute *f2fs_feat_attrs[] = {
344 #ifdef CONFIG_F2FS_FS_ENCRYPTION
345 ATTR_LIST(encryption),
347 #ifdef CONFIG_BLK_DEV_ZONED
348 ATTR_LIST(block_zoned),
350 ATTR_LIST(atomic_write),
351 ATTR_LIST(extra_attr),
352 ATTR_LIST(project_quota),
353 ATTR_LIST(inode_checksum),
357 static const struct sysfs_ops f2fs_attr_ops = {
358 .show = f2fs_attr_show,
359 .store = f2fs_attr_store,
362 static struct kobj_type f2fs_sb_ktype = {
363 .default_attrs = f2fs_attrs,
364 .sysfs_ops = &f2fs_attr_ops,
365 .release = f2fs_sb_release,
368 static struct kobj_type f2fs_ktype = {
369 .sysfs_ops = &f2fs_attr_ops,
372 static struct kset f2fs_kset = {
373 .kobj = {.ktype = &f2fs_ktype},
376 static struct kobj_type f2fs_feat_ktype = {
377 .default_attrs = f2fs_feat_attrs,
378 .sysfs_ops = &f2fs_attr_ops,
381 static struct kobject f2fs_feat = {
385 static int __maybe_unused segment_info_seq_show(struct seq_file *seq,
388 struct super_block *sb = seq->private;
389 struct f2fs_sb_info *sbi = F2FS_SB(sb);
390 unsigned int total_segs =
391 le32_to_cpu(sbi->raw_super->segment_count_main);
394 seq_puts(seq, "format: segment_type|valid_blocks\n"
395 "segment_type(0:HD, 1:WD, 2:CD, 3:HN, 4:WN, 5:CN)\n");
397 for (i = 0; i < total_segs; i++) {
398 struct seg_entry *se = get_seg_entry(sbi, i);
401 seq_printf(seq, "%-10d", i);
402 seq_printf(seq, "%d|%-3u", se->type,
403 get_valid_blocks(sbi, i, false));
404 if ((i % 10) == 9 || i == (total_segs - 1))
413 static int __maybe_unused segment_bits_seq_show(struct seq_file *seq,
416 struct super_block *sb = seq->private;
417 struct f2fs_sb_info *sbi = F2FS_SB(sb);
418 unsigned int total_segs =
419 le32_to_cpu(sbi->raw_super->segment_count_main);
422 seq_puts(seq, "format: segment_type|valid_blocks|bitmaps\n"
423 "segment_type(0:HD, 1:WD, 2:CD, 3:HN, 4:WN, 5:CN)\n");
425 for (i = 0; i < total_segs; i++) {
426 struct seg_entry *se = get_seg_entry(sbi, i);
428 seq_printf(seq, "%-10d", i);
429 seq_printf(seq, "%d|%-3u|", se->type,
430 get_valid_blocks(sbi, i, false));
431 for (j = 0; j < SIT_VBLOCK_MAP_SIZE; j++)
432 seq_printf(seq, " %.2x", se->cur_valid_map[j]);
438 static int __maybe_unused iostat_info_seq_show(struct seq_file *seq,
441 struct super_block *sb = seq->private;
442 struct f2fs_sb_info *sbi = F2FS_SB(sb);
443 time64_t now = ktime_get_real_seconds();
445 if (!sbi->iostat_enable)
448 seq_printf(seq, "time: %-16llu\n", now);
451 seq_printf(seq, "app buffered: %-16llu\n",
452 sbi->write_iostat[APP_BUFFERED_IO]);
453 seq_printf(seq, "app direct: %-16llu\n",
454 sbi->write_iostat[APP_DIRECT_IO]);
455 seq_printf(seq, "app mapped: %-16llu\n",
456 sbi->write_iostat[APP_MAPPED_IO]);
459 seq_printf(seq, "fs data: %-16llu\n",
460 sbi->write_iostat[FS_DATA_IO]);
461 seq_printf(seq, "fs node: %-16llu\n",
462 sbi->write_iostat[FS_NODE_IO]);
463 seq_printf(seq, "fs meta: %-16llu\n",
464 sbi->write_iostat[FS_META_IO]);
465 seq_printf(seq, "fs gc data: %-16llu\n",
466 sbi->write_iostat[FS_GC_DATA_IO]);
467 seq_printf(seq, "fs gc node: %-16llu\n",
468 sbi->write_iostat[FS_GC_NODE_IO]);
469 seq_printf(seq, "fs cp data: %-16llu\n",
470 sbi->write_iostat[FS_CP_DATA_IO]);
471 seq_printf(seq, "fs cp node: %-16llu\n",
472 sbi->write_iostat[FS_CP_NODE_IO]);
473 seq_printf(seq, "fs cp meta: %-16llu\n",
474 sbi->write_iostat[FS_CP_META_IO]);
475 seq_printf(seq, "fs discard: %-16llu\n",
476 sbi->write_iostat[FS_DISCARD]);
481 #define F2FS_PROC_FILE_DEF(_name) \
482 static int _name##_open_fs(struct inode *inode, struct file *file) \
484 return single_open(file, _name##_seq_show, PDE_DATA(inode)); \
487 static const struct file_operations f2fs_seq_##_name##_fops = { \
488 .open = _name##_open_fs, \
490 .llseek = seq_lseek, \
491 .release = single_release, \
494 F2FS_PROC_FILE_DEF(segment_info);
495 F2FS_PROC_FILE_DEF(segment_bits);
496 F2FS_PROC_FILE_DEF(iostat_info);
498 int __init f2fs_init_sysfs(void)
502 kobject_set_name(&f2fs_kset.kobj, "f2fs");
503 f2fs_kset.kobj.parent = fs_kobj;
504 ret = kset_register(&f2fs_kset);
508 ret = kobject_init_and_add(&f2fs_feat, &f2fs_feat_ktype,
511 kobject_put(&f2fs_feat);
512 kset_unregister(&f2fs_kset);
514 f2fs_proc_root = proc_mkdir("fs/f2fs", NULL);
519 void f2fs_exit_sysfs(void)
521 kobject_put(&f2fs_feat);
522 kset_unregister(&f2fs_kset);
523 remove_proc_entry("fs/f2fs", NULL);
524 f2fs_proc_root = NULL;
527 int f2fs_register_sysfs(struct f2fs_sb_info *sbi)
529 struct super_block *sb = sbi->sb;
532 sbi->s_kobj.kset = &f2fs_kset;
533 init_completion(&sbi->s_kobj_unregister);
534 err = kobject_init_and_add(&sbi->s_kobj, &f2fs_sb_ktype, NULL,
537 kobject_put(&sbi->s_kobj);
538 wait_for_completion(&sbi->s_kobj_unregister);
543 sbi->s_proc = proc_mkdir(sb->s_id, f2fs_proc_root);
546 proc_create_data("segment_info", S_IRUGO, sbi->s_proc,
547 &f2fs_seq_segment_info_fops, sb);
548 proc_create_data("segment_bits", S_IRUGO, sbi->s_proc,
549 &f2fs_seq_segment_bits_fops, sb);
550 proc_create_data("iostat_info", S_IRUGO, sbi->s_proc,
551 &f2fs_seq_iostat_info_fops, sb);
556 void f2fs_unregister_sysfs(struct f2fs_sb_info *sbi)
559 remove_proc_entry("iostat_info", sbi->s_proc);
560 remove_proc_entry("segment_info", sbi->s_proc);
561 remove_proc_entry("segment_bits", sbi->s_proc);
562 remove_proc_entry(sbi->sb->s_id, f2fs_proc_root);
564 kobject_del(&sbi->s_kobj);
565 kobject_put(&sbi->s_kobj);
566 wait_for_completion(&sbi->s_kobj_unregister);