]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - fs/ext4/sysfs.c
License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[mirror_ubuntu-bionic-kernel.git] / fs / ext4 / sysfs.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
b5799018
TT
2/*
3 * linux/fs/ext4/sysfs.c
4 *
5 * Copyright (C) 1992, 1993, 1994, 1995
6 * Remy Card (card@masi.ibp.fr)
7 * Theodore Ts'o (tytso@mit.edu)
8 *
9 */
10
11#include <linux/time.h>
12#include <linux/fs.h>
13#include <linux/seq_file.h>
14#include <linux/proc_fs.h>
15
16#include "ext4.h"
17#include "ext4_jbd2.h"
18
76d33bca
TT
19typedef enum {
20 attr_noop,
21 attr_delayed_allocation_blocks,
22 attr_session_write_kbytes,
23 attr_lifetime_write_kbytes,
24 attr_reserved_clusters,
25 attr_inode_readahead,
26 attr_trigger_test_error,
27 attr_feature,
28 attr_pointer_ui,
29 attr_pointer_atomic,
30} attr_id_t;
31
32typedef enum {
33 ptr_explicit,
34 ptr_ext4_sb_info_offset,
35 ptr_ext4_super_block_offset,
36} attr_ptr_t;
37
d6006186 38static const char proc_dirname[] = "fs/ext4";
ebd173be
TT
39static struct proc_dir_entry *ext4_proc_root;
40
b5799018
TT
41struct ext4_attr {
42 struct attribute attr;
76d33bca
TT
43 short attr_id;
44 short attr_ptr;
b5799018
TT
45 union {
46 int offset;
76d33bca 47 void *explicit_ptr;
b5799018
TT
48 } u;
49};
50
b5799018
TT
51static ssize_t session_write_kbytes_show(struct ext4_attr *a,
52 struct ext4_sb_info *sbi, char *buf)
53{
54 struct super_block *sb = sbi->s_buddy_cache->i_sb;
55
56 if (!sb->s_bdev->bd_part)
57 return snprintf(buf, PAGE_SIZE, "0\n");
58 return snprintf(buf, PAGE_SIZE, "%lu\n",
59 (part_stat_read(sb->s_bdev->bd_part, sectors[1]) -
60 sbi->s_sectors_written_start) >> 1);
61}
62
63static ssize_t lifetime_write_kbytes_show(struct ext4_attr *a,
64 struct ext4_sb_info *sbi, char *buf)
65{
66 struct super_block *sb = sbi->s_buddy_cache->i_sb;
67
68 if (!sb->s_bdev->bd_part)
69 return snprintf(buf, PAGE_SIZE, "0\n");
70 return snprintf(buf, PAGE_SIZE, "%llu\n",
71 (unsigned long long)(sbi->s_kbytes_written +
72 ((part_stat_read(sb->s_bdev->bd_part, sectors[1]) -
73 EXT4_SB(sb)->s_sectors_written_start) >> 1)));
74}
75
76static ssize_t inode_readahead_blks_store(struct ext4_attr *a,
77 struct ext4_sb_info *sbi,
78 const char *buf, size_t count)
79{
80 unsigned long t;
81 int ret;
82
83 ret = kstrtoul(skip_spaces(buf), 0, &t);
84 if (ret)
85 return ret;
86
87 if (t && (!is_power_of_2(t) || t > 0x40000000))
88 return -EINVAL;
89
90 sbi->s_inode_readahead_blks = t;
91 return count;
92}
93
b5799018
TT
94static ssize_t reserved_clusters_store(struct ext4_attr *a,
95 struct ext4_sb_info *sbi,
96 const char *buf, size_t count)
97{
98 unsigned long long val;
99 ext4_fsblk_t clusters = (ext4_blocks_count(sbi->s_es) >>
100 sbi->s_cluster_bits);
76d33bca 101 int ret;
b5799018 102
76d33bca 103 ret = kstrtoull(skip_spaces(buf), 0, &val);
1ea1516f 104 if (ret || val >= clusters)
b5799018
TT
105 return -EINVAL;
106
107 atomic64_set(&sbi->s_resv_clusters, val);
108 return count;
109}
110
111static ssize_t trigger_test_error(struct ext4_attr *a,
112 struct ext4_sb_info *sbi,
113 const char *buf, size_t count)
114{
115 int len = count;
116
117 if (!capable(CAP_SYS_ADMIN))
118 return -EPERM;
119
120 if (len && buf[len-1] == '\n')
121 len--;
122
123 if (len)
124 ext4_error(sbi->s_sb, "%.*s", len, buf);
125 return count;
126}
127
76d33bca
TT
128#define EXT4_ATTR(_name,_mode,_id) \
129static struct ext4_attr ext4_attr_##_name = { \
130 .attr = {.name = __stringify(_name), .mode = _mode }, \
131 .attr_id = attr_##_id, \
b5799018
TT
132}
133
76d33bca
TT
134#define EXT4_ATTR_FUNC(_name,_mode) EXT4_ATTR(_name,_mode,_name)
135
136#define EXT4_ATTR_FEATURE(_name) EXT4_ATTR(_name, 0444, feature)
137
138#define EXT4_ATTR_OFFSET(_name,_mode,_id,_struct,_elname) \
b5799018
TT
139static struct ext4_attr ext4_attr_##_name = { \
140 .attr = {.name = __stringify(_name), .mode = _mode }, \
76d33bca
TT
141 .attr_id = attr_##_id, \
142 .attr_ptr = ptr_##_struct##_offset, \
b5799018 143 .u = { \
76d33bca 144 .offset = offsetof(struct _struct, _elname),\
b5799018
TT
145 }, \
146}
147
76d33bca
TT
148#define EXT4_RO_ATTR_ES_UI(_name,_elname) \
149 EXT4_ATTR_OFFSET(_name, 0444, pointer_ui, ext4_super_block, _elname)
b5799018 150
76d33bca
TT
151#define EXT4_RW_ATTR_SBI_UI(_name,_elname) \
152 EXT4_ATTR_OFFSET(_name, 0644, pointer_ui, ext4_sb_info, _elname)
b5799018 153
76d33bca 154#define EXT4_ATTR_PTR(_name,_mode,_id,_ptr) \
b5799018 155static struct ext4_attr ext4_attr_##_name = { \
76d33bca
TT
156 .attr = {.name = __stringify(_name), .mode = _mode }, \
157 .attr_id = attr_##_id, \
158 .attr_ptr = ptr_explicit, \
b5799018 159 .u = { \
76d33bca 160 .explicit_ptr = _ptr, \
b5799018
TT
161 }, \
162}
163
76d33bca
TT
164#define ATTR_LIST(name) &ext4_attr_##name.attr
165
166EXT4_ATTR_FUNC(delayed_allocation_blocks, 0444);
167EXT4_ATTR_FUNC(session_write_kbytes, 0444);
168EXT4_ATTR_FUNC(lifetime_write_kbytes, 0444);
169EXT4_ATTR_FUNC(reserved_clusters, 0644);
170
171EXT4_ATTR_OFFSET(inode_readahead_blks, 0644, inode_readahead,
172 ext4_sb_info, s_inode_readahead_blks);
b5799018
TT
173EXT4_RW_ATTR_SBI_UI(inode_goal, s_inode_goal);
174EXT4_RW_ATTR_SBI_UI(mb_stats, s_mb_stats);
175EXT4_RW_ATTR_SBI_UI(mb_max_to_scan, s_mb_max_to_scan);
176EXT4_RW_ATTR_SBI_UI(mb_min_to_scan, s_mb_min_to_scan);
177EXT4_RW_ATTR_SBI_UI(mb_order2_req, s_mb_order2_reqs);
178EXT4_RW_ATTR_SBI_UI(mb_stream_req, s_mb_stream_request);
179EXT4_RW_ATTR_SBI_UI(mb_group_prealloc, s_mb_group_prealloc);
b5799018 180EXT4_RW_ATTR_SBI_UI(extent_max_zeroout_kb, s_extent_max_zeroout_kb);
76d33bca 181EXT4_ATTR(trigger_fs_error, 0200, trigger_test_error);
b5799018
TT
182EXT4_RW_ATTR_SBI_UI(err_ratelimit_interval_ms, s_err_ratelimit_state.interval);
183EXT4_RW_ATTR_SBI_UI(err_ratelimit_burst, s_err_ratelimit_state.burst);
184EXT4_RW_ATTR_SBI_UI(warning_ratelimit_interval_ms, s_warning_ratelimit_state.interval);
185EXT4_RW_ATTR_SBI_UI(warning_ratelimit_burst, s_warning_ratelimit_state.burst);
186EXT4_RW_ATTR_SBI_UI(msg_ratelimit_interval_ms, s_msg_ratelimit_state.interval);
187EXT4_RW_ATTR_SBI_UI(msg_ratelimit_burst, s_msg_ratelimit_state.burst);
188EXT4_RO_ATTR_ES_UI(errors_count, s_error_count);
189EXT4_RO_ATTR_ES_UI(first_error_time, s_first_error_time);
190EXT4_RO_ATTR_ES_UI(last_error_time, s_last_error_time);
191
76d33bca
TT
192static unsigned int old_bump_val = 128;
193EXT4_ATTR_PTR(max_writeback_mb_bump, 0444, pointer_ui, &old_bump_val);
194
b5799018
TT
195static struct attribute *ext4_attrs[] = {
196 ATTR_LIST(delayed_allocation_blocks),
197 ATTR_LIST(session_write_kbytes),
198 ATTR_LIST(lifetime_write_kbytes),
199 ATTR_LIST(reserved_clusters),
200 ATTR_LIST(inode_readahead_blks),
201 ATTR_LIST(inode_goal),
202 ATTR_LIST(mb_stats),
203 ATTR_LIST(mb_max_to_scan),
204 ATTR_LIST(mb_min_to_scan),
205 ATTR_LIST(mb_order2_req),
206 ATTR_LIST(mb_stream_req),
207 ATTR_LIST(mb_group_prealloc),
208 ATTR_LIST(max_writeback_mb_bump),
209 ATTR_LIST(extent_max_zeroout_kb),
210 ATTR_LIST(trigger_fs_error),
211 ATTR_LIST(err_ratelimit_interval_ms),
212 ATTR_LIST(err_ratelimit_burst),
213 ATTR_LIST(warning_ratelimit_interval_ms),
214 ATTR_LIST(warning_ratelimit_burst),
215 ATTR_LIST(msg_ratelimit_interval_ms),
216 ATTR_LIST(msg_ratelimit_burst),
217 ATTR_LIST(errors_count),
218 ATTR_LIST(first_error_time),
219 ATTR_LIST(last_error_time),
220 NULL,
221};
222
223/* Features this copy of ext4 supports */
76d33bca
TT
224EXT4_ATTR_FEATURE(lazy_itable_init);
225EXT4_ATTR_FEATURE(batched_discard);
226EXT4_ATTR_FEATURE(meta_bg_resize);
c4704a4f 227#ifdef CONFIG_EXT4_FS_ENCRYPTION
76d33bca 228EXT4_ATTR_FEATURE(encryption);
c4704a4f 229#endif
8c81bd8f 230EXT4_ATTR_FEATURE(metadata_csum_seed);
b5799018
TT
231
232static struct attribute *ext4_feat_attrs[] = {
233 ATTR_LIST(lazy_itable_init),
234 ATTR_LIST(batched_discard),
235 ATTR_LIST(meta_bg_resize),
c4704a4f 236#ifdef CONFIG_EXT4_FS_ENCRYPTION
b5799018 237 ATTR_LIST(encryption),
c4704a4f 238#endif
8c81bd8f 239 ATTR_LIST(metadata_csum_seed),
b5799018
TT
240 NULL,
241};
242
76d33bca
TT
243static void *calc_ptr(struct ext4_attr *a, struct ext4_sb_info *sbi)
244{
245 switch (a->attr_ptr) {
246 case ptr_explicit:
247 return a->u.explicit_ptr;
248 case ptr_ext4_sb_info_offset:
249 return (void *) (((char *) sbi) + a->u.offset);
250 case ptr_ext4_super_block_offset:
251 return (void *) (((char *) sbi->s_es) + a->u.offset);
252 }
253 return NULL;
254}
255
b5799018
TT
256static ssize_t ext4_attr_show(struct kobject *kobj,
257 struct attribute *attr, char *buf)
258{
259 struct ext4_sb_info *sbi = container_of(kobj, struct ext4_sb_info,
260 s_kobj);
261 struct ext4_attr *a = container_of(attr, struct ext4_attr, attr);
76d33bca
TT
262 void *ptr = calc_ptr(a, sbi);
263
264 switch (a->attr_id) {
265 case attr_delayed_allocation_blocks:
266 return snprintf(buf, PAGE_SIZE, "%llu\n",
267 (s64) EXT4_C2B(sbi,
268 percpu_counter_sum(&sbi->s_dirtyclusters_counter)));
269 case attr_session_write_kbytes:
270 return session_write_kbytes_show(a, sbi, buf);
271 case attr_lifetime_write_kbytes:
272 return lifetime_write_kbytes_show(a, sbi, buf);
273 case attr_reserved_clusters:
274 return snprintf(buf, PAGE_SIZE, "%llu\n",
275 (unsigned long long)
276 atomic64_read(&sbi->s_resv_clusters));
277 case attr_inode_readahead:
278 case attr_pointer_ui:
279 if (!ptr)
280 return 0;
281 return snprintf(buf, PAGE_SIZE, "%u\n",
282 *((unsigned int *) ptr));
283 case attr_pointer_atomic:
284 if (!ptr)
285 return 0;
286 return snprintf(buf, PAGE_SIZE, "%d\n",
287 atomic_read((atomic_t *) ptr));
288 case attr_feature:
289 return snprintf(buf, PAGE_SIZE, "supported\n");
290 }
291
292 return 0;
b5799018
TT
293}
294
295static ssize_t ext4_attr_store(struct kobject *kobj,
296 struct attribute *attr,
297 const char *buf, size_t len)
298{
299 struct ext4_sb_info *sbi = container_of(kobj, struct ext4_sb_info,
300 s_kobj);
301 struct ext4_attr *a = container_of(attr, struct ext4_attr, attr);
76d33bca
TT
302 void *ptr = calc_ptr(a, sbi);
303 unsigned long t;
304 int ret;
b5799018 305
76d33bca
TT
306 switch (a->attr_id) {
307 case attr_reserved_clusters:
308 return reserved_clusters_store(a, sbi, buf, len);
309 case attr_pointer_ui:
310 if (!ptr)
311 return 0;
312 ret = kstrtoul(skip_spaces(buf), 0, &t);
313 if (ret)
314 return ret;
315 *((unsigned int *) ptr) = t;
316 return len;
317 case attr_inode_readahead:
318 return inode_readahead_blks_store(a, sbi, buf, len);
319 case attr_trigger_test_error:
320 return trigger_test_error(a, sbi, buf, len);
321 }
322 return 0;
b5799018
TT
323}
324
325static void ext4_sb_release(struct kobject *kobj)
326{
327 struct ext4_sb_info *sbi = container_of(kobj, struct ext4_sb_info,
328 s_kobj);
329 complete(&sbi->s_kobj_unregister);
330}
331
332static const struct sysfs_ops ext4_attr_ops = {
333 .show = ext4_attr_show,
334 .store = ext4_attr_store,
335};
336
337static struct kobj_type ext4_sb_ktype = {
338 .default_attrs = ext4_attrs,
339 .sysfs_ops = &ext4_attr_ops,
340 .release = ext4_sb_release,
341};
342
343static struct kobj_type ext4_ktype = {
344 .sysfs_ops = &ext4_attr_ops,
345};
346
347static struct kset ext4_kset = {
348 .kobj = {.ktype = &ext4_ktype},
349};
350
b5799018
TT
351static struct kobj_type ext4_feat_ktype = {
352 .default_attrs = ext4_feat_attrs,
76d33bca 353 .sysfs_ops = &ext4_attr_ops,
b5799018
TT
354};
355
356static struct kobject ext4_feat = {
357 .kset = &ext4_kset,
358};
359
ebd173be
TT
360#define PROC_FILE_SHOW_DEFN(name) \
361static int name##_open(struct inode *inode, struct file *file) \
362{ \
363 return single_open(file, ext4_seq_##name##_show, PDE_DATA(inode)); \
364} \
365\
681c46b1 366static const struct file_operations ext4_seq_##name##_fops = { \
ebd173be
TT
367 .open = name##_open, \
368 .read = seq_read, \
369 .llseek = seq_lseek, \
370 .release = single_release, \
371}
372
373#define PROC_FILE_LIST(name) \
374 { __stringify(name), &ext4_seq_##name##_fops }
375
376PROC_FILE_SHOW_DEFN(es_shrinker_info);
377PROC_FILE_SHOW_DEFN(options);
378
d6006186 379static const struct ext4_proc_files {
ebd173be
TT
380 const char *name;
381 const struct file_operations *fops;
382} proc_files[] = {
383 PROC_FILE_LIST(options),
384 PROC_FILE_LIST(es_shrinker_info),
385 PROC_FILE_LIST(mb_groups),
386 { NULL, NULL },
387};
388
b5799018
TT
389int ext4_register_sysfs(struct super_block *sb)
390{
391 struct ext4_sb_info *sbi = EXT4_SB(sb);
d6006186 392 const struct ext4_proc_files *p;
ebd173be 393 int err;
b5799018
TT
394
395 sbi->s_kobj.kset = &ext4_kset;
396 init_completion(&sbi->s_kobj_unregister);
ebd173be
TT
397 err = kobject_init_and_add(&sbi->s_kobj, &ext4_sb_ktype, NULL,
398 "%s", sb->s_id);
399 if (err)
400 return err;
401
402 if (ext4_proc_root)
403 sbi->s_proc = proc_mkdir(sb->s_id, ext4_proc_root);
404
405 if (sbi->s_proc) {
406 for (p = proc_files; p->name; p++)
407 proc_create_data(p->name, S_IRUGO, sbi->s_proc,
408 p->fops, sb);
409 }
410 return 0;
411}
412
413void ext4_unregister_sysfs(struct super_block *sb)
414{
415 struct ext4_sb_info *sbi = EXT4_SB(sb);
d6006186 416 const struct ext4_proc_files *p;
ebd173be
TT
417
418 if (sbi->s_proc) {
419 for (p = proc_files; p->name; p++)
420 remove_proc_entry(p->name, sbi->s_proc);
421 remove_proc_entry(sb->s_id, ext4_proc_root);
422 }
423 kobject_del(&sbi->s_kobj);
b5799018
TT
424}
425
426int __init ext4_init_sysfs(void)
427{
428 int ret;
429
430 kobject_set_name(&ext4_kset.kobj, "ext4");
431 ext4_kset.kobj.parent = fs_kobj;
432 ret = kset_register(&ext4_kset);
433 if (ret)
434 return ret;
435
436 ret = kobject_init_and_add(&ext4_feat, &ext4_feat_ktype,
437 NULL, "features");
438 if (ret)
439 kset_unregister(&ext4_kset);
ebd173be
TT
440 else
441 ext4_proc_root = proc_mkdir(proc_dirname, NULL);
b5799018
TT
442 return ret;
443}
444
445void ext4_exit_sysfs(void)
446{
447 kobject_put(&ext4_feat);
448 kset_unregister(&ext4_kset);
ebd173be
TT
449 remove_proc_entry(proc_dirname, NULL);
450 ext4_proc_root = NULL;
b5799018
TT
451}
452