1 // SPDX-License-Identifier: GPL-2.0
3 * bcache sysfs interfaces
5 * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
6 * Copyright 2012 Google, Inc.
9 #ifndef NO_BCACHEFS_SYSFS
12 #include "alloc_background.h"
13 #include "alloc_foreground.h"
15 #include "btree_cache.h"
17 #include "btree_iter.h"
18 #include "btree_key_cache.h"
19 #include "btree_update.h"
20 #include "btree_update_interior.h"
24 #include "disk_groups.h"
31 #include "rebalance.h"
36 #include <linux/blkdev.h>
37 #include <linux/sort.h>
38 #include <linux/sched/clock.h>
42 #define SYSFS_OPS(type) \
43 struct sysfs_ops type ## _sysfs_ops = { \
44 .show = type ## _show, \
45 .store = type ## _store \
49 static ssize_t fn ## _to_text(struct printbuf *, \
50 struct kobject *, struct attribute *);\
52 static ssize_t fn ## _show(struct kobject *kobj, struct attribute *attr,\
55 struct printbuf out = PRINTBUF; \
56 ssize_t ret = fn ## _to_text(&out, kobj, attr); \
58 if (!ret && out.allocation_failure) \
62 ret = min_t(size_t, out.pos, PAGE_SIZE - 1); \
63 memcpy(buf, out.buf, ret); \
65 printbuf_exit(&out); \
69 static ssize_t fn ## _to_text(struct printbuf *out, struct kobject *kobj,\
70 struct attribute *attr)
73 static ssize_t fn ## _store(struct kobject *kobj, struct attribute *attr,\
74 const char *buf, size_t size) \
76 #define __sysfs_attribute(_name, _mode) \
77 static struct attribute sysfs_##_name = \
78 { .name = #_name, .mode = _mode }
80 #define write_attribute(n) __sysfs_attribute(n, S_IWUSR)
81 #define read_attribute(n) __sysfs_attribute(n, S_IRUGO)
82 #define rw_attribute(n) __sysfs_attribute(n, S_IRUGO|S_IWUSR)
84 #define sysfs_printf(file, fmt, ...) \
86 if (attr == &sysfs_ ## file) \
87 pr_buf(out, fmt "\n", __VA_ARGS__); \
90 #define sysfs_print(file, var) \
92 if (attr == &sysfs_ ## file) \
96 #define sysfs_hprint(file, val) \
98 if (attr == &sysfs_ ## file) \
99 bch2_hprint(out, val); \
102 #define var_printf(_var, fmt) sysfs_printf(_var, fmt, var(_var))
103 #define var_print(_var) sysfs_print(_var, var(_var))
104 #define var_hprint(_var) sysfs_hprint(_var, var(_var))
106 #define sysfs_strtoul(file, var) \
108 if (attr == &sysfs_ ## file) \
109 return strtoul_safe(buf, var) ?: (ssize_t) size; \
112 #define sysfs_strtoul_clamp(file, var, min, max) \
114 if (attr == &sysfs_ ## file) \
115 return strtoul_safe_clamp(buf, var, min, max) \
119 #define strtoul_or_return(cp) \
122 int _r = kstrtoul(cp, 10, &_v); \
128 #define strtoul_restrict_or_return(cp, min, max) \
130 unsigned long __v = 0; \
131 int _r = strtoul_safe_restrict(cp, __v, min, max); \
137 #define strtoi_h_or_return(cp) \
140 int _r = strtoi_h(cp, &_v); \
146 #define sysfs_hatoi(file, var) \
148 if (attr == &sysfs_ ## file) \
149 return strtoi_h(buf, &var) ?: (ssize_t) size; \
152 write_attribute(trigger_gc);
153 write_attribute(trigger_discards);
154 write_attribute(prune_cache);
155 rw_attribute(btree_gc_periodic);
156 rw_attribute(gc_gens_pos);
158 read_attribute(uuid);
159 read_attribute(minor);
160 read_attribute(bucket_size);
161 read_attribute(first_bucket);
162 read_attribute(nbuckets);
163 read_attribute(durability);
164 read_attribute(iodone);
166 read_attribute(io_latency_read);
167 read_attribute(io_latency_write);
168 read_attribute(io_latency_stats_read);
169 read_attribute(io_latency_stats_write);
170 read_attribute(congested);
172 read_attribute(btree_avg_write_size);
174 read_attribute(btree_cache_size);
175 read_attribute(compression_stats);
176 read_attribute(journal_debug);
177 read_attribute(btree_updates);
178 read_attribute(btree_cache);
179 read_attribute(btree_key_cache);
180 read_attribute(btree_transactions);
181 read_attribute(stripes_heap);
182 read_attribute(open_buckets);
184 read_attribute(internal_uuid);
186 read_attribute(has_data);
187 read_attribute(alloc_debug);
189 read_attribute(read_realloc_races);
190 read_attribute(extent_migrate_done);
191 read_attribute(extent_migrate_raced);
192 read_attribute(bucket_alloc_fail);
194 rw_attribute(discard);
197 rw_attribute(copy_gc_enabled);
198 read_attribute(copy_gc_wait);
200 rw_attribute(rebalance_enabled);
201 sysfs_pd_controller_attribute(rebalance);
202 read_attribute(rebalance_work);
203 rw_attribute(promote_whole_extents);
205 read_attribute(new_stripes);
207 read_attribute(io_timers_read);
208 read_attribute(io_timers_write);
210 read_attribute(data_jobs);
212 #ifdef CONFIG_BCACHEFS_TESTS
213 write_attribute(perf_test);
214 #endif /* CONFIG_BCACHEFS_TESTS */
217 static struct attribute sysfs_time_stat_##_name = \
218 { .name = #_name, .mode = S_IRUGO };
222 static struct attribute sysfs_state_rw = {
227 static size_t bch2_btree_cache_size(struct bch_fs *c)
232 mutex_lock(&c->btree_cache.lock);
233 list_for_each_entry(b, &c->btree_cache.live, list)
234 ret += btree_bytes(c);
236 mutex_unlock(&c->btree_cache.lock);
240 static size_t bch2_btree_avg_write_size(struct bch_fs *c)
242 u64 nr = atomic64_read(&c->btree_writes_nr);
243 u64 sectors = atomic64_read(&c->btree_writes_sectors);
245 return nr ? div64_u64(sectors, nr) : 0;
248 static long data_progress_to_text(struct printbuf *out, struct bch_fs *c)
251 struct bch_move_stats *stats;
253 mutex_lock(&c->data_progress_lock);
254 list_for_each_entry(stats, &c->data_progress_list, list) {
255 pr_buf(out, "%s: data type %s btree_id %s position: ",
257 bch2_data_types[stats->data_type],
258 bch2_btree_ids[stats->btree_id]);
259 bch2_bpos_to_text(out, stats->pos);
260 pr_buf(out, "%s", "\n");
263 mutex_unlock(&c->data_progress_lock);
267 static int bch2_compression_stats_to_text(struct printbuf *out, struct bch_fs *c)
269 struct btree_trans trans;
270 struct btree_iter iter;
273 u64 nr_uncompressed_extents = 0,
274 nr_compressed_extents = 0,
275 nr_incompressible_extents = 0,
276 uncompressed_sectors = 0,
277 incompressible_sectors = 0,
278 compressed_sectors_compressed = 0,
279 compressed_sectors_uncompressed = 0;
282 if (!test_bit(BCH_FS_STARTED, &c->flags))
285 bch2_trans_init(&trans, c, 0, 0);
287 for (id = 0; id < BTREE_ID_NR; id++) {
288 if (!((1U << id) & BTREE_ID_HAS_PTRS))
291 for_each_btree_key(&trans, iter, id, POS_MIN,
292 BTREE_ITER_ALL_SNAPSHOTS, k, ret) {
293 struct bkey_ptrs_c ptrs = bch2_bkey_ptrs_c(k);
294 const union bch_extent_entry *entry;
295 struct extent_ptr_decoded p;
296 bool compressed = false, uncompressed = false, incompressible = false;
298 bkey_for_each_ptr_decode(k.k, ptrs, p, entry) {
299 switch (p.crc.compression_type) {
300 case BCH_COMPRESSION_TYPE_none:
302 uncompressed_sectors += k.k->size;
304 case BCH_COMPRESSION_TYPE_incompressible:
305 incompressible = true;
306 incompressible_sectors += k.k->size;
309 compressed_sectors_compressed +=
310 p.crc.compressed_size;
311 compressed_sectors_uncompressed +=
312 p.crc.uncompressed_size;
319 nr_incompressible_extents++;
320 else if (uncompressed)
321 nr_uncompressed_extents++;
323 nr_compressed_extents++;
325 bch2_trans_iter_exit(&trans, &iter);
328 bch2_trans_exit(&trans);
333 pr_buf(out, "uncompressed:\n");
334 pr_buf(out, " nr extents: %llu\n", nr_uncompressed_extents);
335 pr_buf(out, " size: ");
336 bch2_hprint(out, uncompressed_sectors << 9);
339 pr_buf(out, "compressed:\n");
340 pr_buf(out, " nr extents: %llu\n", nr_compressed_extents);
341 pr_buf(out, " compressed size: ");
342 bch2_hprint(out, compressed_sectors_compressed << 9);
344 pr_buf(out, " uncompressed size: ");
345 bch2_hprint(out, compressed_sectors_uncompressed << 9);
348 pr_buf(out, "incompressible:\n");
349 pr_buf(out, " nr extents: %llu\n", nr_incompressible_extents);
350 pr_buf(out, " size: ");
351 bch2_hprint(out, incompressible_sectors << 9);
356 static void bch2_gc_gens_pos_to_text(struct printbuf *out, struct bch_fs *c)
358 pr_buf(out, "%s: ", bch2_btree_ids[c->gc_gens_btree]);
359 bch2_bpos_to_text(out, c->gc_gens_pos);
365 struct bch_fs *c = container_of(kobj, struct bch_fs, kobj);
367 sysfs_print(minor, c->minor);
368 sysfs_printf(internal_uuid, "%pU", c->sb.uuid.b);
370 sysfs_hprint(btree_cache_size, bch2_btree_cache_size(c));
371 sysfs_hprint(btree_avg_write_size, bch2_btree_avg_write_size(c));
373 sysfs_print(read_realloc_races,
374 atomic_long_read(&c->read_realloc_races));
375 sysfs_print(extent_migrate_done,
376 atomic_long_read(&c->extent_migrate_done));
377 sysfs_print(extent_migrate_raced,
378 atomic_long_read(&c->extent_migrate_raced));
379 sysfs_print(bucket_alloc_fail,
380 atomic_long_read(&c->bucket_alloc_fail));
382 sysfs_printf(btree_gc_periodic, "%u", (int) c->btree_gc_periodic);
384 if (attr == &sysfs_gc_gens_pos)
385 bch2_gc_gens_pos_to_text(out, c);
387 sysfs_printf(copy_gc_enabled, "%i", c->copy_gc_enabled);
389 sysfs_printf(rebalance_enabled, "%i", c->rebalance.enabled);
390 sysfs_pd_controller_show(rebalance, &c->rebalance.pd); /* XXX */
391 sysfs_hprint(copy_gc_wait,
392 max(0LL, c->copygc_wait -
393 atomic64_read(&c->io_clock[WRITE].now)) << 9);
395 if (attr == &sysfs_rebalance_work)
396 bch2_rebalance_work_to_text(out, c);
398 sysfs_print(promote_whole_extents, c->promote_whole_extents);
402 if (attr == &sysfs_journal_debug)
403 bch2_journal_debug_to_text(out, &c->journal);
405 if (attr == &sysfs_btree_updates)
406 bch2_btree_updates_to_text(out, c);
408 if (attr == &sysfs_btree_cache)
409 bch2_btree_cache_to_text(out, c);
411 if (attr == &sysfs_btree_key_cache)
412 bch2_btree_key_cache_to_text(out, &c->btree_key_cache);
414 if (attr == &sysfs_btree_transactions)
415 bch2_btree_trans_to_text(out, c);
417 if (attr == &sysfs_stripes_heap)
418 bch2_stripes_heap_to_text(out, c);
420 if (attr == &sysfs_open_buckets)
421 bch2_open_buckets_to_text(out, c);
423 if (attr == &sysfs_compression_stats)
424 bch2_compression_stats_to_text(out, c);
426 if (attr == &sysfs_new_stripes)
427 bch2_new_stripes_to_text(out, c);
429 if (attr == &sysfs_io_timers_read)
430 bch2_io_timers_to_text(out, &c->io_clock[READ]);
432 if (attr == &sysfs_io_timers_write)
433 bch2_io_timers_to_text(out, &c->io_clock[WRITE]);
435 if (attr == &sysfs_data_jobs)
436 data_progress_to_text(out, c);
443 struct bch_fs *c = container_of(kobj, struct bch_fs, kobj);
445 if (attr == &sysfs_btree_gc_periodic) {
446 ssize_t ret = strtoul_safe(buf, c->btree_gc_periodic)
449 wake_up_process(c->gc_thread);
453 if (attr == &sysfs_copy_gc_enabled) {
454 ssize_t ret = strtoul_safe(buf, c->copy_gc_enabled)
457 if (c->copygc_thread)
458 wake_up_process(c->copygc_thread);
462 if (attr == &sysfs_rebalance_enabled) {
463 ssize_t ret = strtoul_safe(buf, c->rebalance.enabled)
470 sysfs_pd_controller_store(rebalance, &c->rebalance.pd);
472 sysfs_strtoul(promote_whole_extents, c->promote_whole_extents);
476 if (!test_bit(BCH_FS_STARTED, &c->flags))
481 if (!test_bit(BCH_FS_RW, &c->flags))
484 if (attr == &sysfs_prune_cache) {
485 struct shrink_control sc;
487 sc.gfp_mask = GFP_KERNEL;
488 sc.nr_to_scan = strtoul_or_return(buf);
489 c->btree_cache.shrink.scan_objects(&c->btree_cache.shrink, &sc);
492 if (attr == &sysfs_trigger_gc) {
494 * Full gc is currently incompatible with btree key cache:
497 down_read(&c->state_lock);
498 bch2_gc(c, false, false);
499 up_read(&c->state_lock);
505 if (attr == &sysfs_trigger_discards)
508 #ifdef CONFIG_BCACHEFS_TESTS
509 if (attr == &sysfs_perf_test) {
510 char *tmp = kstrdup(buf, GFP_KERNEL), *p = tmp;
511 char *test = strsep(&p, " \t\n");
512 char *nr_str = strsep(&p, " \t\n");
513 char *threads_str = strsep(&p, " \t\n");
519 !(ret = kstrtouint(threads_str, 10, &threads)) &&
520 !(ret = bch2_strtoull_h(nr_str, &nr)))
521 ret = bch2_btree_perf_test(c, test, nr, threads);
532 struct attribute *bch2_fs_files[] = {
534 &sysfs_btree_cache_size,
535 &sysfs_btree_avg_write_size,
537 &sysfs_promote_whole_extents,
539 &sysfs_compression_stats,
541 #ifdef CONFIG_BCACHEFS_TESTS
547 /* internal dir - just a wrapper */
549 SHOW(bch2_fs_internal)
551 struct bch_fs *c = container_of(kobj, struct bch_fs, internal);
552 return bch2_fs_to_text(out, &c->kobj, attr);
555 STORE(bch2_fs_internal)
557 struct bch_fs *c = container_of(kobj, struct bch_fs, internal);
558 return bch2_fs_store(&c->kobj, attr, buf, size);
560 SYSFS_OPS(bch2_fs_internal);
562 struct attribute *bch2_fs_internal_files[] = {
563 &sysfs_journal_debug,
564 &sysfs_btree_updates,
566 &sysfs_btree_key_cache,
567 &sysfs_btree_transactions,
571 &sysfs_io_timers_read,
572 &sysfs_io_timers_write,
575 &sysfs_trigger_discards,
578 &sysfs_read_realloc_races,
579 &sysfs_extent_migrate_done,
580 &sysfs_extent_migrate_raced,
581 &sysfs_bucket_alloc_fail,
585 &sysfs_copy_gc_enabled,
588 &sysfs_rebalance_enabled,
589 &sysfs_rebalance_work,
590 sysfs_pd_controller_files(rebalance),
594 &sysfs_internal_uuid,
600 SHOW(bch2_fs_opts_dir)
602 struct bch_fs *c = container_of(kobj, struct bch_fs, opts_dir);
603 const struct bch_option *opt = container_of(attr, struct bch_option, attr);
604 int id = opt - bch2_opt_table;
605 u64 v = bch2_opt_get_by_id(&c->opts, id);
607 bch2_opt_to_text(out, c, c->disk_sb.sb, opt, v, OPT_SHOW_FULL_LIST);
613 STORE(bch2_fs_opts_dir)
615 struct bch_fs *c = container_of(kobj, struct bch_fs, opts_dir);
616 const struct bch_option *opt = container_of(attr, struct bch_option, attr);
617 int ret = size, id = opt - bch2_opt_table;
622 * We don't need to take c->writes for correctness, but it eliminates an
623 * unsightly error message in the dmesg log when we're RO:
625 if (unlikely(!percpu_ref_tryget(&c->writes)))
628 tmp = kstrdup(buf, GFP_KERNEL);
634 ret = bch2_opt_parse(c, opt, strim(tmp), &v, NULL);
640 ret = bch2_opt_check_may_set(c, id, v);
644 bch2_opt_set_sb(c, opt, v);
645 bch2_opt_set_by_id(&c->opts, id, v);
647 if ((id == Opt_background_target ||
648 id == Opt_background_compression) && v) {
649 bch2_rebalance_add_work(c, S64_MAX);
653 percpu_ref_put(&c->writes);
656 SYSFS_OPS(bch2_fs_opts_dir);
658 struct attribute *bch2_fs_opts_dir_files[] = { NULL };
660 int bch2_opts_create_sysfs_files(struct kobject *kobj)
662 const struct bch_option *i;
665 for (i = bch2_opt_table;
666 i < bch2_opt_table + bch2_opts_nr;
668 if (!(i->flags & OPT_FS))
671 ret = sysfs_create_file(kobj, &i->attr);
681 SHOW(bch2_fs_time_stats)
683 struct bch_fs *c = container_of(kobj, struct bch_fs, time_stats);
686 if (attr == &sysfs_time_stat_##name) \
687 bch2_time_stats_to_text(out, &c->times[BCH_TIME_##name]);
694 STORE(bch2_fs_time_stats)
698 SYSFS_OPS(bch2_fs_time_stats);
700 struct attribute *bch2_fs_time_stats_files[] = {
702 &sysfs_time_stat_##name,
708 static void dev_alloc_debug_to_text(struct printbuf *out, struct bch_dev *ca)
710 struct bch_fs *c = ca->fs;
711 struct bch_dev_usage stats = bch2_dev_usage_read(ca);
712 unsigned i, nr[BCH_DATA_NR];
714 memset(nr, 0, sizeof(nr));
716 for (i = 0; i < ARRAY_SIZE(c->open_buckets); i++)
717 nr[c->open_buckets[i].data_type]++;
720 "\t\t\t buckets\t sectors fragmented\n"
721 "capacity\t%16llu\n",
722 ca->mi.nbuckets - ca->mi.first_bucket);
724 for (i = 0; i < BCH_DATA_NR; i++)
725 pr_buf(out, "%-16s%16llu%16llu%16llu\n",
726 bch2_data_types[i], stats.d[i].buckets,
727 stats.d[i].sectors, stats.d[i].fragmented);
732 "freelist_wait\t\t%s\n"
733 "open buckets allocated\t%u\n"
734 "open buckets this dev\t%u\n"
735 "open buckets total\t%u\n"
736 "open_buckets_wait\t%s\n"
737 "open_buckets_btree\t%u\n"
738 "open_buckets_user\t%u\n"
739 "btree reserve cache\t%u\n",
741 c->freelist_wait.list.first ? "waiting" : "empty",
742 OPEN_BUCKETS_COUNT - c->open_buckets_nr_free,
745 c->open_buckets_wait.list.first ? "waiting" : "empty",
748 c->btree_reserve_cache_nr);
751 static const char * const bch2_rw[] = {
757 static void dev_iodone_to_text(struct printbuf *out, struct bch_dev *ca)
761 for (rw = 0; rw < 2; rw++) {
762 pr_buf(out, "%s:\n", bch2_rw[rw]);
764 for (i = 1; i < BCH_DATA_NR; i++)
765 pr_buf(out, "%-12s:%12llu\n",
767 percpu_u64_get(&ca->io_done->sectors[rw][i]) << 9);
773 struct bch_dev *ca = container_of(kobj, struct bch_dev, kobj);
774 struct bch_fs *c = ca->fs;
776 sysfs_printf(uuid, "%pU\n", ca->uuid.b);
778 sysfs_print(bucket_size, bucket_bytes(ca));
779 sysfs_print(first_bucket, ca->mi.first_bucket);
780 sysfs_print(nbuckets, ca->mi.nbuckets);
781 sysfs_print(durability, ca->mi.durability);
782 sysfs_print(discard, ca->mi.discard);
784 if (attr == &sysfs_label) {
786 mutex_lock(&c->sb_lock);
787 bch2_disk_path_to_text(out, c->disk_sb.sb,
789 mutex_unlock(&c->sb_lock);
795 if (attr == &sysfs_has_data) {
796 bch2_flags_to_text(out, bch2_data_types,
797 bch2_dev_has_data(c, ca));
801 if (attr == &sysfs_state_rw) {
802 bch2_string_opt_to_text(out, bch2_member_states,
807 if (attr == &sysfs_iodone)
808 dev_iodone_to_text(out, ca);
810 sysfs_print(io_latency_read, atomic64_read(&ca->cur_latency[READ]));
811 sysfs_print(io_latency_write, atomic64_read(&ca->cur_latency[WRITE]));
813 if (attr == &sysfs_io_latency_stats_read)
814 bch2_time_stats_to_text(out, &ca->io_latency[READ]);
816 if (attr == &sysfs_io_latency_stats_write)
817 bch2_time_stats_to_text(out, &ca->io_latency[WRITE]);
819 sysfs_printf(congested, "%u%%",
820 clamp(atomic_read(&ca->congested), 0, CONGESTED_MAX)
821 * 100 / CONGESTED_MAX);
823 if (attr == &sysfs_alloc_debug)
824 dev_alloc_debug_to_text(out, ca);
831 struct bch_dev *ca = container_of(kobj, struct bch_dev, kobj);
832 struct bch_fs *c = ca->fs;
833 struct bch_member *mi;
835 if (attr == &sysfs_discard) {
836 bool v = strtoul_or_return(buf);
838 mutex_lock(&c->sb_lock);
839 mi = &bch2_sb_get_members(c->disk_sb.sb)->members[ca->dev_idx];
841 if (v != BCH_MEMBER_DISCARD(mi)) {
842 SET_BCH_MEMBER_DISCARD(mi, v);
845 mutex_unlock(&c->sb_lock);
848 if (attr == &sysfs_label) {
852 tmp = kstrdup(buf, GFP_KERNEL);
856 ret = bch2_dev_group_set(c, ca, strim(tmp));
866 struct attribute *bch2_dev_files[] = {
881 &sysfs_io_latency_read,
882 &sysfs_io_latency_write,
883 &sysfs_io_latency_stats_read,
884 &sysfs_io_latency_stats_write,
892 #endif /* _BCACHEFS_SYSFS_H_ */