1 // SPDX-License-Identifier: GPL-2.0
3 * linux/fs/ext4/sysfs.c
5 * Copyright (C) 1992, 1993, 1994, 1995
6 * Remy Card (card@masi.ibp.fr)
7 * Theodore Ts'o (tytso@mit.edu)
11 #include <linux/time.h>
13 #include <linux/seq_file.h>
14 #include <linux/slab.h>
15 #include <linux/proc_fs.h>
16 #include <linux/part_stat.h>
19 #include "ext4_jbd2.h"
23 attr_delayed_allocation_blocks
,
24 attr_session_write_kbytes
,
25 attr_lifetime_write_kbytes
,
26 attr_reserved_clusters
,
28 attr_trigger_test_error
,
29 attr_first_error_time
,
43 ptr_ext4_sb_info_offset
,
44 ptr_ext4_super_block_offset
,
47 static const char proc_dirname
[] = "fs/ext4";
48 static struct proc_dir_entry
*ext4_proc_root
;
51 struct attribute attr
;
54 unsigned short attr_size
;
61 static ssize_t
session_write_kbytes_show(struct ext4_sb_info
*sbi
, char *buf
)
63 struct super_block
*sb
= sbi
->s_buddy_cache
->i_sb
;
65 if (!sb
->s_bdev
->bd_part
)
66 return snprintf(buf
, PAGE_SIZE
, "0\n");
67 return snprintf(buf
, PAGE_SIZE
, "%lu\n",
68 (part_stat_read(sb
->s_bdev
->bd_part
,
69 sectors
[STAT_WRITE
]) -
70 sbi
->s_sectors_written_start
) >> 1);
73 static ssize_t
lifetime_write_kbytes_show(struct ext4_sb_info
*sbi
, char *buf
)
75 struct super_block
*sb
= sbi
->s_buddy_cache
->i_sb
;
77 if (!sb
->s_bdev
->bd_part
)
78 return snprintf(buf
, PAGE_SIZE
, "0\n");
79 return snprintf(buf
, PAGE_SIZE
, "%llu\n",
80 (unsigned long long)(sbi
->s_kbytes_written
+
81 ((part_stat_read(sb
->s_bdev
->bd_part
,
82 sectors
[STAT_WRITE
]) -
83 EXT4_SB(sb
)->s_sectors_written_start
) >> 1)));
86 static ssize_t
inode_readahead_blks_store(struct ext4_sb_info
*sbi
,
87 const char *buf
, size_t count
)
92 ret
= kstrtoul(skip_spaces(buf
), 0, &t
);
96 if (t
&& (!is_power_of_2(t
) || t
> 0x40000000))
99 sbi
->s_inode_readahead_blks
= t
;
103 static ssize_t
reserved_clusters_store(struct ext4_sb_info
*sbi
,
104 const char *buf
, size_t count
)
106 unsigned long long val
;
107 ext4_fsblk_t clusters
= (ext4_blocks_count(sbi
->s_es
) >>
108 sbi
->s_cluster_bits
);
111 ret
= kstrtoull(skip_spaces(buf
), 0, &val
);
112 if (ret
|| val
>= clusters
)
115 atomic64_set(&sbi
->s_resv_clusters
, val
);
119 static ssize_t
trigger_test_error(struct ext4_sb_info
*sbi
,
120 const char *buf
, size_t count
)
124 if (!capable(CAP_SYS_ADMIN
))
127 if (len
&& buf
[len
-1] == '\n')
131 ext4_error(sbi
->s_sb
, "%.*s", len
, buf
);
135 static ssize_t
journal_task_show(struct ext4_sb_info
*sbi
, char *buf
)
138 return snprintf(buf
, PAGE_SIZE
, "<none>\n");
139 return snprintf(buf
, PAGE_SIZE
, "%d\n",
140 task_pid_vnr(sbi
->s_journal
->j_task
));
143 #define EXT4_ATTR(_name,_mode,_id) \
144 static struct ext4_attr ext4_attr_##_name = { \
145 .attr = {.name = __stringify(_name), .mode = _mode }, \
146 .attr_id = attr_##_id, \
149 #define EXT4_ATTR_FUNC(_name,_mode) EXT4_ATTR(_name,_mode,_name)
151 #define EXT4_ATTR_FEATURE(_name) EXT4_ATTR(_name, 0444, feature)
153 #define EXT4_ATTR_OFFSET(_name,_mode,_id,_struct,_elname) \
154 static struct ext4_attr ext4_attr_##_name = { \
155 .attr = {.name = __stringify(_name), .mode = _mode }, \
156 .attr_id = attr_##_id, \
157 .attr_ptr = ptr_##_struct##_offset, \
159 .offset = offsetof(struct _struct, _elname),\
163 #define EXT4_ATTR_STRING(_name,_mode,_size,_struct,_elname) \
164 static struct ext4_attr ext4_attr_##_name = { \
165 .attr = {.name = __stringify(_name), .mode = _mode }, \
166 .attr_id = attr_pointer_string, \
167 .attr_size = _size, \
168 .attr_ptr = ptr_##_struct##_offset, \
170 .offset = offsetof(struct _struct, _elname),\
174 #define EXT4_RO_ATTR_ES_UI(_name,_elname) \
175 EXT4_ATTR_OFFSET(_name, 0444, pointer_ui, ext4_super_block, _elname)
177 #define EXT4_RO_ATTR_ES_U8(_name,_elname) \
178 EXT4_ATTR_OFFSET(_name, 0444, pointer_u8, ext4_super_block, _elname)
180 #define EXT4_RO_ATTR_ES_U64(_name,_elname) \
181 EXT4_ATTR_OFFSET(_name, 0444, pointer_u64, ext4_super_block, _elname)
183 #define EXT4_RO_ATTR_ES_STRING(_name,_elname,_size) \
184 EXT4_ATTR_STRING(_name, 0444, _size, ext4_super_block, _elname)
186 #define EXT4_RW_ATTR_SBI_UI(_name,_elname) \
187 EXT4_ATTR_OFFSET(_name, 0644, pointer_ui, ext4_sb_info, _elname)
189 #define EXT4_RW_ATTR_SBI_UL(_name,_elname) \
190 EXT4_ATTR_OFFSET(_name, 0644, pointer_ul, ext4_sb_info, _elname)
192 #define EXT4_ATTR_PTR(_name,_mode,_id,_ptr) \
193 static struct ext4_attr ext4_attr_##_name = { \
194 .attr = {.name = __stringify(_name), .mode = _mode }, \
195 .attr_id = attr_##_id, \
196 .attr_ptr = ptr_explicit, \
198 .explicit_ptr = _ptr, \
202 #define ATTR_LIST(name) &ext4_attr_##name.attr
204 EXT4_ATTR_FUNC(delayed_allocation_blocks
, 0444);
205 EXT4_ATTR_FUNC(session_write_kbytes
, 0444);
206 EXT4_ATTR_FUNC(lifetime_write_kbytes
, 0444);
207 EXT4_ATTR_FUNC(reserved_clusters
, 0644);
209 EXT4_ATTR_OFFSET(inode_readahead_blks
, 0644, inode_readahead
,
210 ext4_sb_info
, s_inode_readahead_blks
);
211 EXT4_RW_ATTR_SBI_UI(inode_goal
, s_inode_goal
);
212 EXT4_RW_ATTR_SBI_UI(mb_stats
, s_mb_stats
);
213 EXT4_RW_ATTR_SBI_UI(mb_max_to_scan
, s_mb_max_to_scan
);
214 EXT4_RW_ATTR_SBI_UI(mb_min_to_scan
, s_mb_min_to_scan
);
215 EXT4_RW_ATTR_SBI_UI(mb_order2_req
, s_mb_order2_reqs
);
216 EXT4_RW_ATTR_SBI_UI(mb_stream_req
, s_mb_stream_request
);
217 EXT4_RW_ATTR_SBI_UI(mb_group_prealloc
, s_mb_group_prealloc
);
218 EXT4_RW_ATTR_SBI_UI(extent_max_zeroout_kb
, s_extent_max_zeroout_kb
);
219 EXT4_ATTR(trigger_fs_error
, 0200, trigger_test_error
);
220 EXT4_RW_ATTR_SBI_UI(err_ratelimit_interval_ms
, s_err_ratelimit_state
.interval
);
221 EXT4_RW_ATTR_SBI_UI(err_ratelimit_burst
, s_err_ratelimit_state
.burst
);
222 EXT4_RW_ATTR_SBI_UI(warning_ratelimit_interval_ms
, s_warning_ratelimit_state
.interval
);
223 EXT4_RW_ATTR_SBI_UI(warning_ratelimit_burst
, s_warning_ratelimit_state
.burst
);
224 EXT4_RW_ATTR_SBI_UI(msg_ratelimit_interval_ms
, s_msg_ratelimit_state
.interval
);
225 EXT4_RW_ATTR_SBI_UI(msg_ratelimit_burst
, s_msg_ratelimit_state
.burst
);
226 #ifdef CONFIG_EXT4_DEBUG
227 EXT4_RW_ATTR_SBI_UL(simulate_fail
, s_simulate_fail
);
229 EXT4_RO_ATTR_ES_UI(errors_count
, s_error_count
);
230 EXT4_RO_ATTR_ES_U8(first_error_errcode
, s_first_error_errcode
);
231 EXT4_RO_ATTR_ES_U8(last_error_errcode
, s_last_error_errcode
);
232 EXT4_RO_ATTR_ES_UI(first_error_ino
, s_first_error_ino
);
233 EXT4_RO_ATTR_ES_UI(last_error_ino
, s_last_error_ino
);
234 EXT4_RO_ATTR_ES_U64(first_error_block
, s_first_error_block
);
235 EXT4_RO_ATTR_ES_U64(last_error_block
, s_last_error_block
);
236 EXT4_RO_ATTR_ES_UI(first_error_line
, s_first_error_line
);
237 EXT4_RO_ATTR_ES_UI(last_error_line
, s_last_error_line
);
238 EXT4_RO_ATTR_ES_STRING(first_error_func
, s_first_error_func
, 32);
239 EXT4_RO_ATTR_ES_STRING(last_error_func
, s_last_error_func
, 32);
240 EXT4_ATTR(first_error_time
, 0444, first_error_time
);
241 EXT4_ATTR(last_error_time
, 0444, last_error_time
);
242 EXT4_ATTR(journal_task
, 0444, journal_task
);
244 static unsigned int old_bump_val
= 128;
245 EXT4_ATTR_PTR(max_writeback_mb_bump
, 0444, pointer_ui
, &old_bump_val
);
247 static struct attribute
*ext4_attrs
[] = {
248 ATTR_LIST(delayed_allocation_blocks
),
249 ATTR_LIST(session_write_kbytes
),
250 ATTR_LIST(lifetime_write_kbytes
),
251 ATTR_LIST(reserved_clusters
),
252 ATTR_LIST(inode_readahead_blks
),
253 ATTR_LIST(inode_goal
),
255 ATTR_LIST(mb_max_to_scan
),
256 ATTR_LIST(mb_min_to_scan
),
257 ATTR_LIST(mb_order2_req
),
258 ATTR_LIST(mb_stream_req
),
259 ATTR_LIST(mb_group_prealloc
),
260 ATTR_LIST(max_writeback_mb_bump
),
261 ATTR_LIST(extent_max_zeroout_kb
),
262 ATTR_LIST(trigger_fs_error
),
263 ATTR_LIST(err_ratelimit_interval_ms
),
264 ATTR_LIST(err_ratelimit_burst
),
265 ATTR_LIST(warning_ratelimit_interval_ms
),
266 ATTR_LIST(warning_ratelimit_burst
),
267 ATTR_LIST(msg_ratelimit_interval_ms
),
268 ATTR_LIST(msg_ratelimit_burst
),
269 ATTR_LIST(errors_count
),
270 ATTR_LIST(first_error_ino
),
271 ATTR_LIST(last_error_ino
),
272 ATTR_LIST(first_error_block
),
273 ATTR_LIST(last_error_block
),
274 ATTR_LIST(first_error_line
),
275 ATTR_LIST(last_error_line
),
276 ATTR_LIST(first_error_func
),
277 ATTR_LIST(last_error_func
),
278 ATTR_LIST(first_error_errcode
),
279 ATTR_LIST(last_error_errcode
),
280 ATTR_LIST(first_error_time
),
281 ATTR_LIST(last_error_time
),
282 ATTR_LIST(journal_task
),
283 #ifdef CONFIG_EXT4_DEBUG
284 ATTR_LIST(simulate_fail
),
288 ATTRIBUTE_GROUPS(ext4
);
290 /* Features this copy of ext4 supports */
291 EXT4_ATTR_FEATURE(lazy_itable_init
);
292 EXT4_ATTR_FEATURE(batched_discard
);
293 EXT4_ATTR_FEATURE(meta_bg_resize
);
294 #ifdef CONFIG_FS_ENCRYPTION
295 EXT4_ATTR_FEATURE(encryption
);
296 EXT4_ATTR_FEATURE(test_dummy_encryption_v2
);
298 #ifdef CONFIG_UNICODE
299 EXT4_ATTR_FEATURE(casefold
);
301 #ifdef CONFIG_FS_VERITY
302 EXT4_ATTR_FEATURE(verity
);
304 EXT4_ATTR_FEATURE(metadata_csum_seed
);
306 static struct attribute
*ext4_feat_attrs
[] = {
307 ATTR_LIST(lazy_itable_init
),
308 ATTR_LIST(batched_discard
),
309 ATTR_LIST(meta_bg_resize
),
310 #ifdef CONFIG_FS_ENCRYPTION
311 ATTR_LIST(encryption
),
312 ATTR_LIST(test_dummy_encryption_v2
),
314 #ifdef CONFIG_UNICODE
317 #ifdef CONFIG_FS_VERITY
320 ATTR_LIST(metadata_csum_seed
),
323 ATTRIBUTE_GROUPS(ext4_feat
);
325 static void *calc_ptr(struct ext4_attr
*a
, struct ext4_sb_info
*sbi
)
327 switch (a
->attr_ptr
) {
329 return a
->u
.explicit_ptr
;
330 case ptr_ext4_sb_info_offset
:
331 return (void *) (((char *) sbi
) + a
->u
.offset
);
332 case ptr_ext4_super_block_offset
:
333 return (void *) (((char *) sbi
->s_es
) + a
->u
.offset
);
338 static ssize_t
__print_tstamp(char *buf
, __le32 lo
, __u8 hi
)
340 return snprintf(buf
, PAGE_SIZE
, "%lld\n",
341 ((time64_t
)hi
<< 32) + le32_to_cpu(lo
));
344 #define print_tstamp(buf, es, tstamp) \
345 __print_tstamp(buf, (es)->tstamp, (es)->tstamp ## _hi)
347 static ssize_t
ext4_attr_show(struct kobject
*kobj
,
348 struct attribute
*attr
, char *buf
)
350 struct ext4_sb_info
*sbi
= container_of(kobj
, struct ext4_sb_info
,
352 struct ext4_attr
*a
= container_of(attr
, struct ext4_attr
, attr
);
353 void *ptr
= calc_ptr(a
, sbi
);
355 switch (a
->attr_id
) {
356 case attr_delayed_allocation_blocks
:
357 return snprintf(buf
, PAGE_SIZE
, "%llu\n",
359 percpu_counter_sum(&sbi
->s_dirtyclusters_counter
)));
360 case attr_session_write_kbytes
:
361 return session_write_kbytes_show(sbi
, buf
);
362 case attr_lifetime_write_kbytes
:
363 return lifetime_write_kbytes_show(sbi
, buf
);
364 case attr_reserved_clusters
:
365 return snprintf(buf
, PAGE_SIZE
, "%llu\n",
367 atomic64_read(&sbi
->s_resv_clusters
));
368 case attr_inode_readahead
:
369 case attr_pointer_ui
:
372 if (a
->attr_ptr
== ptr_ext4_super_block_offset
)
373 return snprintf(buf
, PAGE_SIZE
, "%u\n",
376 return snprintf(buf
, PAGE_SIZE
, "%u\n",
377 *((unsigned int *) ptr
));
378 case attr_pointer_ul
:
381 return snprintf(buf
, PAGE_SIZE
, "%lu\n",
382 *((unsigned long *) ptr
));
383 case attr_pointer_u8
:
386 return snprintf(buf
, PAGE_SIZE
, "%u\n",
387 *((unsigned char *) ptr
));
388 case attr_pointer_u64
:
391 if (a
->attr_ptr
== ptr_ext4_super_block_offset
)
392 return snprintf(buf
, PAGE_SIZE
, "%llu\n",
395 return snprintf(buf
, PAGE_SIZE
, "%llu\n",
396 *((unsigned long long *) ptr
));
397 case attr_pointer_string
:
400 return snprintf(buf
, PAGE_SIZE
, "%.*s\n", a
->attr_size
,
402 case attr_pointer_atomic
:
405 return snprintf(buf
, PAGE_SIZE
, "%d\n",
406 atomic_read((atomic_t
*) ptr
));
408 return snprintf(buf
, PAGE_SIZE
, "supported\n");
409 case attr_first_error_time
:
410 return print_tstamp(buf
, sbi
->s_es
, s_first_error_time
);
411 case attr_last_error_time
:
412 return print_tstamp(buf
, sbi
->s_es
, s_last_error_time
);
413 case attr_journal_task
:
414 return journal_task_show(sbi
, buf
);
420 static ssize_t
ext4_attr_store(struct kobject
*kobj
,
421 struct attribute
*attr
,
422 const char *buf
, size_t len
)
424 struct ext4_sb_info
*sbi
= container_of(kobj
, struct ext4_sb_info
,
426 struct ext4_attr
*a
= container_of(attr
, struct ext4_attr
, attr
);
427 void *ptr
= calc_ptr(a
, sbi
);
431 switch (a
->attr_id
) {
432 case attr_reserved_clusters
:
433 return reserved_clusters_store(sbi
, buf
, len
);
434 case attr_pointer_ui
:
437 ret
= kstrtoul(skip_spaces(buf
), 0, &t
);
440 if (a
->attr_ptr
== ptr_ext4_super_block_offset
)
441 *((__le32
*) ptr
) = cpu_to_le32(t
);
443 *((unsigned int *) ptr
) = t
;
445 case attr_pointer_ul
:
448 ret
= kstrtoul(skip_spaces(buf
), 0, &t
);
451 *((unsigned long *) ptr
) = t
;
453 case attr_inode_readahead
:
454 return inode_readahead_blks_store(sbi
, buf
, len
);
455 case attr_trigger_test_error
:
456 return trigger_test_error(sbi
, buf
, len
);
461 static void ext4_sb_release(struct kobject
*kobj
)
463 struct ext4_sb_info
*sbi
= container_of(kobj
, struct ext4_sb_info
,
465 complete(&sbi
->s_kobj_unregister
);
468 static const struct sysfs_ops ext4_attr_ops
= {
469 .show
= ext4_attr_show
,
470 .store
= ext4_attr_store
,
473 static struct kobj_type ext4_sb_ktype
= {
474 .default_groups
= ext4_groups
,
475 .sysfs_ops
= &ext4_attr_ops
,
476 .release
= ext4_sb_release
,
479 static struct kobj_type ext4_feat_ktype
= {
480 .default_groups
= ext4_feat_groups
,
481 .sysfs_ops
= &ext4_attr_ops
,
482 .release
= (void (*)(struct kobject
*))kfree
,
485 static struct kobject
*ext4_root
;
487 static struct kobject
*ext4_feat
;
489 int ext4_register_sysfs(struct super_block
*sb
)
491 struct ext4_sb_info
*sbi
= EXT4_SB(sb
);
494 init_completion(&sbi
->s_kobj_unregister
);
495 err
= kobject_init_and_add(&sbi
->s_kobj
, &ext4_sb_ktype
, ext4_root
,
498 kobject_put(&sbi
->s_kobj
);
499 wait_for_completion(&sbi
->s_kobj_unregister
);
504 sbi
->s_proc
= proc_mkdir(sb
->s_id
, ext4_proc_root
);
506 proc_create_single_data("options", S_IRUGO
, sbi
->s_proc
,
507 ext4_seq_options_show
, sb
);
508 proc_create_single_data("es_shrinker_info", S_IRUGO
,
509 sbi
->s_proc
, ext4_seq_es_shrinker_info_show
,
511 proc_create_seq_data("mb_groups", S_IRUGO
, sbi
->s_proc
,
512 &ext4_mb_seq_groups_ops
, sb
);
517 void ext4_unregister_sysfs(struct super_block
*sb
)
519 struct ext4_sb_info
*sbi
= EXT4_SB(sb
);
522 remove_proc_subtree(sb
->s_id
, ext4_proc_root
);
523 kobject_del(&sbi
->s_kobj
);
526 int __init
ext4_init_sysfs(void)
530 ext4_root
= kobject_create_and_add("ext4", fs_kobj
);
534 ext4_feat
= kzalloc(sizeof(*ext4_feat
), GFP_KERNEL
);
540 ret
= kobject_init_and_add(ext4_feat
, &ext4_feat_ktype
,
541 ext4_root
, "features");
545 ext4_proc_root
= proc_mkdir(proc_dirname
, NULL
);
549 kobject_put(ext4_feat
);
552 kobject_put(ext4_root
);
557 void ext4_exit_sysfs(void)
559 kobject_put(ext4_feat
);
561 kobject_put(ext4_root
);
563 remove_proc_entry(proc_dirname
, NULL
);
564 ext4_proc_root
= NULL
;