]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - fs/f2fs/sysfs.c
48ebe6153cc51bedc400023751b560285978c6ed
[mirror_ubuntu-bionic-kernel.git] / fs / f2fs / sysfs.c
1 /*
2 * f2fs sysfs interface
3 *
4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
6 * Copyright (c) 2017 Chao Yu <chao@kernel.org>
7 *
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.
11 */
12 #include <linux/proc_fs.h>
13 #include <linux/f2fs_fs.h>
14 #include <linux/seq_file.h>
15
16 #include "f2fs.h"
17 #include "segment.h"
18 #include "gc.h"
19
20 static struct proc_dir_entry *f2fs_proc_root;
21
22 /* Sysfs support for f2fs */
23 enum {
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 */
32 #endif
33 RESERVED_BLOCKS,
34 };
35
36 struct f2fs_attr {
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);
41 int struct_type;
42 int offset;
43 int id;
44 };
45
46 static unsigned char *__struct_ptr(struct f2fs_sb_info *sbi, int struct_type)
47 {
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;
62 #endif
63 return NULL;
64 }
65
66 static ssize_t dirty_segments_show(struct f2fs_attr *a,
67 struct f2fs_sb_info *sbi, char *buf)
68 {
69 return snprintf(buf, PAGE_SIZE, "%llu\n",
70 (unsigned long long)(dirty_segments(sbi)));
71 }
72
73 static ssize_t lifetime_write_kbytes_show(struct f2fs_attr *a,
74 struct f2fs_sb_info *sbi, char *buf)
75 {
76 struct super_block *sb = sbi->sb;
77
78 if (!sb->s_bdev->bd_part)
79 return snprintf(buf, PAGE_SIZE, "0\n");
80
81 return snprintf(buf, PAGE_SIZE, "%llu\n",
82 (unsigned long long)(sbi->kbytes_written +
83 BD_PART_WRITTEN(sbi)));
84 }
85
86 static ssize_t features_show(struct f2fs_attr *a,
87 struct f2fs_sb_info *sbi, char *buf)
88 {
89 struct super_block *sb = sbi->sb;
90 int len = 0;
91
92 if (!sb->s_bdev->bd_part)
93 return snprintf(buf, PAGE_SIZE, "0\n");
94
95 if (f2fs_sb_has_crypto(sb))
96 len += snprintf(buf, PAGE_SIZE - len, "%s",
97 "encryption");
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 len += snprintf(buf + len, PAGE_SIZE - len, "\n");
111 return len;
112 }
113
114 static ssize_t f2fs_sbi_show(struct f2fs_attr *a,
115 struct f2fs_sb_info *sbi, char *buf)
116 {
117 unsigned char *ptr = NULL;
118 unsigned int *ui;
119
120 ptr = __struct_ptr(sbi, a->struct_type);
121 if (!ptr)
122 return -EINVAL;
123
124 ui = (unsigned int *)(ptr + a->offset);
125
126 return snprintf(buf, PAGE_SIZE, "%u\n", *ui);
127 }
128
129 static ssize_t f2fs_sbi_store(struct f2fs_attr *a,
130 struct f2fs_sb_info *sbi,
131 const char *buf, size_t count)
132 {
133 unsigned char *ptr;
134 unsigned long t;
135 unsigned int *ui;
136 ssize_t ret;
137
138 ptr = __struct_ptr(sbi, a->struct_type);
139 if (!ptr)
140 return -EINVAL;
141
142 ui = (unsigned int *)(ptr + a->offset);
143
144 ret = kstrtoul(skip_spaces(buf), 0, &t);
145 if (ret < 0)
146 return ret;
147 #ifdef CONFIG_F2FS_FAULT_INJECTION
148 if (a->struct_type == FAULT_INFO_TYPE && t >= (1 << FAULT_MAX))
149 return -EINVAL;
150 #endif
151 if (a->struct_type == RESERVED_BLOCKS) {
152 spin_lock(&sbi->stat_lock);
153 if ((unsigned long)sbi->total_valid_block_count + t >
154 (unsigned long)sbi->user_block_count) {
155 spin_unlock(&sbi->stat_lock);
156 return -EINVAL;
157 }
158 *ui = t;
159 spin_unlock(&sbi->stat_lock);
160 return count;
161 }
162
163 if (!strcmp(a->attr.name, "discard_granularity")) {
164 if (t == 0 || t > MAX_PLIST_NUM)
165 return -EINVAL;
166 if (t == *ui)
167 return count;
168 *ui = t;
169 return count;
170 }
171
172 *ui = t;
173
174 if (!strcmp(a->attr.name, "iostat_enable") && *ui == 0)
175 f2fs_reset_iostat(sbi);
176 if (!strcmp(a->attr.name, "gc_urgent") && t == 1 && sbi->gc_thread) {
177 sbi->gc_thread->gc_wake = 1;
178 wake_up_interruptible_all(&sbi->gc_thread->gc_wait_queue_head);
179 wake_up_discard_thread(sbi, true);
180 }
181
182 return count;
183 }
184
185 static ssize_t f2fs_attr_show(struct kobject *kobj,
186 struct attribute *attr, char *buf)
187 {
188 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
189 s_kobj);
190 struct f2fs_attr *a = container_of(attr, struct f2fs_attr, attr);
191
192 return a->show ? a->show(a, sbi, buf) : 0;
193 }
194
195 static ssize_t f2fs_attr_store(struct kobject *kobj, struct attribute *attr,
196 const char *buf, size_t len)
197 {
198 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
199 s_kobj);
200 struct f2fs_attr *a = container_of(attr, struct f2fs_attr, attr);
201
202 return a->store ? a->store(a, sbi, buf, len) : 0;
203 }
204
205 static void f2fs_sb_release(struct kobject *kobj)
206 {
207 struct f2fs_sb_info *sbi = container_of(kobj, struct f2fs_sb_info,
208 s_kobj);
209 complete(&sbi->s_kobj_unregister);
210 }
211
212 enum feat_id {
213 FEAT_CRYPTO = 0,
214 FEAT_BLKZONED,
215 FEAT_ATOMIC_WRITE,
216 FEAT_EXTRA_ATTR,
217 FEAT_PROJECT_QUOTA,
218 FEAT_INODE_CHECKSUM,
219 };
220
221 static ssize_t f2fs_feature_show(struct f2fs_attr *a,
222 struct f2fs_sb_info *sbi, char *buf)
223 {
224 switch (a->id) {
225 case FEAT_CRYPTO:
226 case FEAT_BLKZONED:
227 case FEAT_ATOMIC_WRITE:
228 case FEAT_EXTRA_ATTR:
229 case FEAT_PROJECT_QUOTA:
230 case FEAT_INODE_CHECKSUM:
231 return snprintf(buf, PAGE_SIZE, "supported\n");
232 }
233 return 0;
234 }
235
236 #define F2FS_ATTR_OFFSET(_struct_type, _name, _mode, _show, _store, _offset) \
237 static struct f2fs_attr f2fs_attr_##_name = { \
238 .attr = {.name = __stringify(_name), .mode = _mode }, \
239 .show = _show, \
240 .store = _store, \
241 .struct_type = _struct_type, \
242 .offset = _offset \
243 }
244
245 #define F2FS_RW_ATTR(struct_type, struct_name, name, elname) \
246 F2FS_ATTR_OFFSET(struct_type, name, 0644, \
247 f2fs_sbi_show, f2fs_sbi_store, \
248 offsetof(struct struct_name, elname))
249
250 #define F2FS_GENERAL_RO_ATTR(name) \
251 static struct f2fs_attr f2fs_attr_##name = __ATTR(name, 0444, name##_show, NULL)
252
253 #define F2FS_FEATURE_RO_ATTR(_name, _id) \
254 static struct f2fs_attr f2fs_attr_##_name = { \
255 .attr = {.name = __stringify(_name), .mode = 0444 }, \
256 .show = f2fs_feature_show, \
257 .id = _id, \
258 }
259
260 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_urgent_sleep_time,
261 urgent_sleep_time);
262 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_min_sleep_time, min_sleep_time);
263 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_max_sleep_time, max_sleep_time);
264 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_no_gc_sleep_time, no_gc_sleep_time);
265 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_idle, gc_idle);
266 F2FS_RW_ATTR(GC_THREAD, f2fs_gc_kthread, gc_urgent, gc_urgent);
267 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, reclaim_segments, rec_prefree_segments);
268 F2FS_RW_ATTR(DCC_INFO, discard_cmd_control, max_small_discards, max_discards);
269 F2FS_RW_ATTR(DCC_INFO, discard_cmd_control, discard_granularity, discard_granularity);
270 F2FS_RW_ATTR(RESERVED_BLOCKS, f2fs_sb_info, reserved_blocks, reserved_blocks);
271 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, batched_trim_sections, trim_sections);
272 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, ipu_policy, ipu_policy);
273 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_ipu_util, min_ipu_util);
274 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_fsync_blocks, min_fsync_blocks);
275 F2FS_RW_ATTR(SM_INFO, f2fs_sm_info, min_hot_blocks, min_hot_blocks);
276 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, ram_thresh, ram_thresh);
277 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, ra_nid_pages, ra_nid_pages);
278 F2FS_RW_ATTR(NM_INFO, f2fs_nm_info, dirty_nats_ratio, dirty_nats_ratio);
279 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, max_victim_search, max_victim_search);
280 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, dir_level, dir_level);
281 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, cp_interval, interval_time[CP_TIME]);
282 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, idle_interval, interval_time[REQ_TIME]);
283 F2FS_RW_ATTR(F2FS_SBI, f2fs_sb_info, iostat_enable, iostat_enable);
284 #ifdef CONFIG_F2FS_FAULT_INJECTION
285 F2FS_RW_ATTR(FAULT_INFO_RATE, f2fs_fault_info, inject_rate, inject_rate);
286 F2FS_RW_ATTR(FAULT_INFO_TYPE, f2fs_fault_info, inject_type, inject_type);
287 #endif
288 F2FS_GENERAL_RO_ATTR(dirty_segments);
289 F2FS_GENERAL_RO_ATTR(lifetime_write_kbytes);
290 F2FS_GENERAL_RO_ATTR(features);
291
292 #ifdef CONFIG_F2FS_FS_ENCRYPTION
293 F2FS_FEATURE_RO_ATTR(encryption, FEAT_CRYPTO);
294 #endif
295 #ifdef CONFIG_BLK_DEV_ZONED
296 F2FS_FEATURE_RO_ATTR(block_zoned, FEAT_BLKZONED);
297 #endif
298 F2FS_FEATURE_RO_ATTR(atomic_write, FEAT_ATOMIC_WRITE);
299 F2FS_FEATURE_RO_ATTR(extra_attr, FEAT_EXTRA_ATTR);
300 F2FS_FEATURE_RO_ATTR(project_quota, FEAT_PROJECT_QUOTA);
301 F2FS_FEATURE_RO_ATTR(inode_checksum, FEAT_INODE_CHECKSUM);
302
303 #define ATTR_LIST(name) (&f2fs_attr_##name.attr)
304 static struct attribute *f2fs_attrs[] = {
305 ATTR_LIST(gc_urgent_sleep_time),
306 ATTR_LIST(gc_min_sleep_time),
307 ATTR_LIST(gc_max_sleep_time),
308 ATTR_LIST(gc_no_gc_sleep_time),
309 ATTR_LIST(gc_idle),
310 ATTR_LIST(gc_urgent),
311 ATTR_LIST(reclaim_segments),
312 ATTR_LIST(max_small_discards),
313 ATTR_LIST(discard_granularity),
314 ATTR_LIST(batched_trim_sections),
315 ATTR_LIST(ipu_policy),
316 ATTR_LIST(min_ipu_util),
317 ATTR_LIST(min_fsync_blocks),
318 ATTR_LIST(min_hot_blocks),
319 ATTR_LIST(max_victim_search),
320 ATTR_LIST(dir_level),
321 ATTR_LIST(ram_thresh),
322 ATTR_LIST(ra_nid_pages),
323 ATTR_LIST(dirty_nats_ratio),
324 ATTR_LIST(cp_interval),
325 ATTR_LIST(idle_interval),
326 ATTR_LIST(iostat_enable),
327 #ifdef CONFIG_F2FS_FAULT_INJECTION
328 ATTR_LIST(inject_rate),
329 ATTR_LIST(inject_type),
330 #endif
331 ATTR_LIST(dirty_segments),
332 ATTR_LIST(lifetime_write_kbytes),
333 ATTR_LIST(features),
334 ATTR_LIST(reserved_blocks),
335 NULL,
336 };
337
338 static struct attribute *f2fs_feat_attrs[] = {
339 #ifdef CONFIG_F2FS_FS_ENCRYPTION
340 ATTR_LIST(encryption),
341 #endif
342 #ifdef CONFIG_BLK_DEV_ZONED
343 ATTR_LIST(block_zoned),
344 #endif
345 ATTR_LIST(atomic_write),
346 ATTR_LIST(extra_attr),
347 ATTR_LIST(project_quota),
348 ATTR_LIST(inode_checksum),
349 NULL,
350 };
351
352 static const struct sysfs_ops f2fs_attr_ops = {
353 .show = f2fs_attr_show,
354 .store = f2fs_attr_store,
355 };
356
357 static struct kobj_type f2fs_sb_ktype = {
358 .default_attrs = f2fs_attrs,
359 .sysfs_ops = &f2fs_attr_ops,
360 .release = f2fs_sb_release,
361 };
362
363 static struct kobj_type f2fs_ktype = {
364 .sysfs_ops = &f2fs_attr_ops,
365 };
366
367 static struct kset f2fs_kset = {
368 .kobj = {.ktype = &f2fs_ktype},
369 };
370
371 static struct kobj_type f2fs_feat_ktype = {
372 .default_attrs = f2fs_feat_attrs,
373 .sysfs_ops = &f2fs_attr_ops,
374 };
375
376 static struct kobject f2fs_feat = {
377 .kset = &f2fs_kset,
378 };
379
380 static int segment_info_seq_show(struct seq_file *seq, void *offset)
381 {
382 struct super_block *sb = seq->private;
383 struct f2fs_sb_info *sbi = F2FS_SB(sb);
384 unsigned int total_segs =
385 le32_to_cpu(sbi->raw_super->segment_count_main);
386 int i;
387
388 seq_puts(seq, "format: segment_type|valid_blocks\n"
389 "segment_type(0:HD, 1:WD, 2:CD, 3:HN, 4:WN, 5:CN)\n");
390
391 for (i = 0; i < total_segs; i++) {
392 struct seg_entry *se = get_seg_entry(sbi, i);
393
394 if ((i % 10) == 0)
395 seq_printf(seq, "%-10d", i);
396 seq_printf(seq, "%d|%-3u", se->type,
397 get_valid_blocks(sbi, i, false));
398 if ((i % 10) == 9 || i == (total_segs - 1))
399 seq_putc(seq, '\n');
400 else
401 seq_putc(seq, ' ');
402 }
403
404 return 0;
405 }
406
407 static int segment_bits_seq_show(struct seq_file *seq, void *offset)
408 {
409 struct super_block *sb = seq->private;
410 struct f2fs_sb_info *sbi = F2FS_SB(sb);
411 unsigned int total_segs =
412 le32_to_cpu(sbi->raw_super->segment_count_main);
413 int i, j;
414
415 seq_puts(seq, "format: segment_type|valid_blocks|bitmaps\n"
416 "segment_type(0:HD, 1:WD, 2:CD, 3:HN, 4:WN, 5:CN)\n");
417
418 for (i = 0; i < total_segs; i++) {
419 struct seg_entry *se = get_seg_entry(sbi, i);
420
421 seq_printf(seq, "%-10d", i);
422 seq_printf(seq, "%d|%-3u|", se->type,
423 get_valid_blocks(sbi, i, false));
424 for (j = 0; j < SIT_VBLOCK_MAP_SIZE; j++)
425 seq_printf(seq, " %.2x", se->cur_valid_map[j]);
426 seq_putc(seq, '\n');
427 }
428 return 0;
429 }
430
431 static int iostat_info_seq_show(struct seq_file *seq, void *offset)
432 {
433 struct super_block *sb = seq->private;
434 struct f2fs_sb_info *sbi = F2FS_SB(sb);
435 time64_t now = ktime_get_real_seconds();
436
437 if (!sbi->iostat_enable)
438 return 0;
439
440 seq_printf(seq, "time: %-16llu\n", now);
441
442 /* print app IOs */
443 seq_printf(seq, "app buffered: %-16llu\n",
444 sbi->write_iostat[APP_BUFFERED_IO]);
445 seq_printf(seq, "app direct: %-16llu\n",
446 sbi->write_iostat[APP_DIRECT_IO]);
447 seq_printf(seq, "app mapped: %-16llu\n",
448 sbi->write_iostat[APP_MAPPED_IO]);
449
450 /* print fs IOs */
451 seq_printf(seq, "fs data: %-16llu\n",
452 sbi->write_iostat[FS_DATA_IO]);
453 seq_printf(seq, "fs node: %-16llu\n",
454 sbi->write_iostat[FS_NODE_IO]);
455 seq_printf(seq, "fs meta: %-16llu\n",
456 sbi->write_iostat[FS_META_IO]);
457 seq_printf(seq, "fs gc data: %-16llu\n",
458 sbi->write_iostat[FS_GC_DATA_IO]);
459 seq_printf(seq, "fs gc node: %-16llu\n",
460 sbi->write_iostat[FS_GC_NODE_IO]);
461 seq_printf(seq, "fs cp data: %-16llu\n",
462 sbi->write_iostat[FS_CP_DATA_IO]);
463 seq_printf(seq, "fs cp node: %-16llu\n",
464 sbi->write_iostat[FS_CP_NODE_IO]);
465 seq_printf(seq, "fs cp meta: %-16llu\n",
466 sbi->write_iostat[FS_CP_META_IO]);
467 seq_printf(seq, "fs discard: %-16llu\n",
468 sbi->write_iostat[FS_DISCARD]);
469
470 return 0;
471 }
472
473 #define F2FS_PROC_FILE_DEF(_name) \
474 static int _name##_open_fs(struct inode *inode, struct file *file) \
475 { \
476 return single_open(file, _name##_seq_show, PDE_DATA(inode)); \
477 } \
478 \
479 static const struct file_operations f2fs_seq_##_name##_fops = { \
480 .open = _name##_open_fs, \
481 .read = seq_read, \
482 .llseek = seq_lseek, \
483 .release = single_release, \
484 };
485
486 F2FS_PROC_FILE_DEF(segment_info);
487 F2FS_PROC_FILE_DEF(segment_bits);
488 F2FS_PROC_FILE_DEF(iostat_info);
489
490 int __init f2fs_init_sysfs(void)
491 {
492 int ret;
493
494 kobject_set_name(&f2fs_kset.kobj, "f2fs");
495 f2fs_kset.kobj.parent = fs_kobj;
496 ret = kset_register(&f2fs_kset);
497 if (ret)
498 return ret;
499
500 ret = kobject_init_and_add(&f2fs_feat, &f2fs_feat_ktype,
501 NULL, "features");
502 if (ret)
503 kset_unregister(&f2fs_kset);
504 else
505 f2fs_proc_root = proc_mkdir("fs/f2fs", NULL);
506 return ret;
507 }
508
509 void f2fs_exit_sysfs(void)
510 {
511 kobject_put(&f2fs_feat);
512 kset_unregister(&f2fs_kset);
513 remove_proc_entry("fs/f2fs", NULL);
514 f2fs_proc_root = NULL;
515 }
516
517 int f2fs_register_sysfs(struct f2fs_sb_info *sbi)
518 {
519 struct super_block *sb = sbi->sb;
520 int err;
521
522 sbi->s_kobj.kset = &f2fs_kset;
523 init_completion(&sbi->s_kobj_unregister);
524 err = kobject_init_and_add(&sbi->s_kobj, &f2fs_sb_ktype, NULL,
525 "%s", sb->s_id);
526 if (err)
527 return err;
528
529 if (f2fs_proc_root)
530 sbi->s_proc = proc_mkdir(sb->s_id, f2fs_proc_root);
531
532 if (sbi->s_proc) {
533 proc_create_data("segment_info", S_IRUGO, sbi->s_proc,
534 &f2fs_seq_segment_info_fops, sb);
535 proc_create_data("segment_bits", S_IRUGO, sbi->s_proc,
536 &f2fs_seq_segment_bits_fops, sb);
537 proc_create_data("iostat_info", S_IRUGO, sbi->s_proc,
538 &f2fs_seq_iostat_info_fops, sb);
539 }
540 return 0;
541 }
542
543 void f2fs_unregister_sysfs(struct f2fs_sb_info *sbi)
544 {
545 if (sbi->s_proc) {
546 remove_proc_entry("iostat_info", sbi->s_proc);
547 remove_proc_entry("segment_info", sbi->s_proc);
548 remove_proc_entry("segment_bits", sbi->s_proc);
549 remove_proc_entry(sbi->sb->s_id, f2fs_proc_root);
550 }
551 kobject_del(&sbi->s_kobj);
552 }