1 // SPDX-License-Identifier: GPL-2.0
3 * Assorted bcachefs debug code
5 * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
6 * Copyright 2012 Google, Inc.
10 #include "bkey_methods.h"
11 #include "btree_cache.h"
13 #include "btree_iter.h"
14 #include "btree_locking.h"
15 #include "btree_update.h"
16 #include "btree_update_interior.h"
25 #include <linux/console.h>
26 #include <linux/debugfs.h>
27 #include <linux/module.h>
28 #include <linux/random.h>
29 #include <linux/seq_file.h>
31 static struct dentry *bch_debug;
33 static bool bch2_btree_verify_replica(struct bch_fs *c, struct btree *b,
34 struct extent_ptr_decoded pick)
36 struct btree *v = c->verify_data;
37 struct btree_node *n_ondisk = c->verify_ondisk;
38 struct btree_node *n_sorted = c->verify_data->data;
39 struct bset *sorted, *inmemory = &b->data->keys;
40 struct bch_dev *ca = bch_dev_bkey_exists(c, pick.ptr.dev);
42 bool failed = false, saw_error = false;
44 if (!bch2_dev_get_ioref(ca, READ))
47 bio = bio_alloc_bioset(ca->disk_sb.bdev,
48 buf_pages(n_sorted, btree_buf_bytes(b)),
52 bio->bi_iter.bi_sector = pick.ptr.offset;
53 bch2_bio_map(bio, n_sorted, btree_buf_bytes(b));
58 percpu_ref_put(&ca->io_ref);
60 memcpy(n_ondisk, n_sorted, btree_buf_bytes(b));
63 if (bch2_btree_node_read_done(c, ca, v, false, &saw_error) || saw_error)
66 n_sorted = c->verify_data->data;
67 sorted = &n_sorted->keys;
69 if (inmemory->u64s != sorted->u64s ||
70 memcmp(inmemory->start,
72 vstruct_end(inmemory) - (void *) inmemory->start)) {
73 unsigned offset = 0, sectors;
79 printk(KERN_ERR "*** in memory:\n");
80 bch2_dump_bset(c, b, inmemory, 0);
82 printk(KERN_ERR "*** read back in:\n");
83 bch2_dump_bset(c, v, sorted, 0);
85 while (offset < v->written) {
88 sectors = vstruct_blocks(n_ondisk, c->block_bits) <<
91 struct btree_node_entry *bne =
92 (void *) n_ondisk + (offset << 9);
95 sectors = vstruct_blocks(bne, c->block_bits) <<
99 printk(KERN_ERR "*** on disk block %u:\n", offset);
100 bch2_dump_bset(c, b, i, offset);
105 for (j = 0; j < le16_to_cpu(inmemory->u64s); j++)
106 if (inmemory->_data[j] != sorted->_data[j])
110 bch_err(c, "verify failed at key %u", j);
115 if (v->written != b->written) {
116 bch_err(c, "written wrong: expected %u, got %u",
117 b->written, v->written);
124 void __bch2_btree_verify(struct bch_fs *c, struct btree *b)
126 struct bkey_ptrs_c ptrs;
127 struct extent_ptr_decoded p;
128 const union bch_extent_entry *entry;
130 struct bset *inmemory = &b->data->keys;
131 struct bkey_packed *k;
134 if (c->opts.nochanges)
137 bch2_btree_node_io_lock(b);
138 mutex_lock(&c->verify_lock);
140 if (!c->verify_ondisk) {
141 c->verify_ondisk = kvmalloc(btree_buf_bytes(b), GFP_KERNEL);
142 if (!c->verify_ondisk)
146 if (!c->verify_data) {
147 c->verify_data = __bch2_btree_node_mem_alloc(c);
151 list_del_init(&c->verify_data->list);
154 BUG_ON(b->nsets != 1);
156 for (k = inmemory->start; k != vstruct_last(inmemory); k = bkey_p_next(k))
157 if (k->type == KEY_TYPE_btree_ptr_v2)
158 ((struct bch_btree_ptr_v2 *) bkeyp_val(&b->format, k))->mem_ptr = 0;
161 bkey_copy(&v->key, &b->key);
162 v->c.level = b->c.level;
163 v->c.btree_id = b->c.btree_id;
164 bch2_btree_keys_init(v);
166 ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key));
167 bkey_for_each_ptr_decode(&b->key.k, ptrs, p, entry)
168 failed |= bch2_btree_verify_replica(c, b, p);
171 struct printbuf buf = PRINTBUF;
173 bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key));
174 bch2_fs_fatal_error(c, ": btree node verify failed for: %s\n", buf.buf);
178 mutex_unlock(&c->verify_lock);
179 bch2_btree_node_io_unlock(b);
182 void bch2_btree_node_ondisk_to_text(struct printbuf *out, struct bch_fs *c,
183 const struct btree *b)
185 struct btree_node *n_ondisk = NULL;
186 struct extent_ptr_decoded pick;
188 struct bio *bio = NULL;
192 if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) {
193 prt_printf(out, "error getting device to read from: invalid device\n");
197 ca = bch_dev_bkey_exists(c, pick.ptr.dev);
198 if (!bch2_dev_get_ioref(ca, READ)) {
199 prt_printf(out, "error getting device to read from: not online\n");
203 n_ondisk = kvmalloc(btree_buf_bytes(b), GFP_KERNEL);
205 prt_printf(out, "memory allocation failure\n");
209 bio = bio_alloc_bioset(ca->disk_sb.bdev,
210 buf_pages(n_ondisk, btree_buf_bytes(b)),
211 REQ_OP_READ|REQ_META,
214 bio->bi_iter.bi_sector = pick.ptr.offset;
215 bch2_bio_map(bio, n_ondisk, btree_buf_bytes(b));
217 ret = submit_bio_wait(bio);
219 prt_printf(out, "IO error reading btree node: %s\n", bch2_err_str(ret));
223 while (offset < btree_sectors(c)) {
226 struct bch_csum csum;
227 struct bkey_packed *k;
233 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) {
234 prt_printf(out, "unknown checksum type at offset %u: %llu\n",
235 offset, BSET_CSUM_TYPE(i));
239 nonce = btree_nonce(i, offset << 9);
240 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk);
242 if (bch2_crc_cmp(csum, n_ondisk->csum)) {
243 prt_printf(out, "invalid checksum\n");
247 bset_encrypt(c, i, offset << 9);
249 sectors = vstruct_sectors(n_ondisk, c->block_bits);
251 struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9);
255 if (i->seq != n_ondisk->keys.seq)
258 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) {
259 prt_printf(out, "unknown checksum type at offset %u: %llu\n",
260 offset, BSET_CSUM_TYPE(i));
264 nonce = btree_nonce(i, offset << 9);
265 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne);
267 if (bch2_crc_cmp(csum, bne->csum)) {
268 prt_printf(out, "invalid checksum");
272 bset_encrypt(c, i, offset << 9);
274 sectors = vstruct_sectors(bne, c->block_bits);
277 prt_printf(out, " offset %u version %u, journal seq %llu\n",
279 le16_to_cpu(i->version),
280 le64_to_cpu(i->journal_seq));
283 printbuf_indent_add(out, 4);
285 for (k = i->start; k != vstruct_last(i); k = bkey_p_next(k)) {
288 bch2_bkey_val_to_text(out, c, bkey_disassemble(b, k, &u));
292 printbuf_indent_sub(out, 4);
298 percpu_ref_put(&ca->io_ref);
301 #ifdef CONFIG_DEBUG_FS
303 /* XXX: bch_fs refcounting */
309 struct bpos prev_node;
314 char __user *ubuf; /* destination user buffer */
315 size_t size; /* size of requested read */
316 ssize_t ret; /* bytes read so far */
319 static ssize_t flush_buf(struct dump_iter *i)
322 size_t bytes = min_t(size_t, i->buf.pos, i->size);
323 int copied = bytes - copy_to_user(i->ubuf, i->buf.buf, bytes);
328 i->buf.pos -= copied;
329 memmove(i->buf.buf, i->buf.buf + copied, i->buf.pos);
335 return i->size ? 0 : i->ret;
338 static int bch2_dump_open(struct inode *inode, struct file *file)
340 struct btree_debug *bd = inode->i_private;
343 i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
347 file->private_data = i;
350 i->c = container_of(bd, struct bch_fs, btree_debug[bd->id]);
357 static int bch2_dump_release(struct inode *inode, struct file *file)
359 struct dump_iter *i = file->private_data;
361 printbuf_exit(&i->buf);
366 static ssize_t bch2_read_btree(struct file *file, char __user *buf,
367 size_t size, loff_t *ppos)
369 struct dump_iter *i = file->private_data;
375 return flush_buf(i) ?:
377 for_each_btree_key(trans, iter, i->id, i->from,
379 BTREE_ITER_ALL_SNAPSHOTS, k, ({
380 bch2_bkey_val_to_text(&i->buf, i->c, k);
381 prt_newline(&i->buf);
382 bch2_trans_unlock(trans);
383 i->from = bpos_successor(iter.pos);
389 static const struct file_operations btree_debug_ops = {
390 .owner = THIS_MODULE,
391 .open = bch2_dump_open,
392 .release = bch2_dump_release,
393 .read = bch2_read_btree,
396 static ssize_t bch2_read_btree_formats(struct file *file, char __user *buf,
397 size_t size, loff_t *ppos)
399 struct dump_iter *i = file->private_data;
400 struct btree_trans *trans;
401 struct btree_iter iter;
413 if (bpos_eq(SPOS_MAX, i->from))
416 trans = bch2_trans_get(i->c);
418 bch2_trans_begin(trans);
420 for_each_btree_node(trans, iter, i->id, i->from, 0, b, ret) {
421 bch2_btree_node_to_text(&i->buf, i->c, b);
422 i->from = !bpos_eq(SPOS_MAX, b->key.k.p)
423 ? bpos_successor(b->key.k.p)
426 ret = drop_locks_do(trans, flush_buf(i));
430 bch2_trans_iter_exit(trans, &iter);
432 if (bch2_err_matches(ret, BCH_ERR_transaction_restart))
435 bch2_trans_put(trans);
440 return ret ?: i->ret;
443 static const struct file_operations btree_format_debug_ops = {
444 .owner = THIS_MODULE,
445 .open = bch2_dump_open,
446 .release = bch2_dump_release,
447 .read = bch2_read_btree_formats,
450 static ssize_t bch2_read_bfloat_failed(struct file *file, char __user *buf,
451 size_t size, loff_t *ppos)
453 struct dump_iter *i = file->private_data;
459 return flush_buf(i) ?:
461 for_each_btree_key(trans, iter, i->id, i->from,
463 BTREE_ITER_ALL_SNAPSHOTS, k, ({
464 struct btree_path_level *l =
465 &btree_iter_path(trans, &iter)->l[0];
466 struct bkey_packed *_k =
467 bch2_btree_node_iter_peek(&l->iter, l->b);
469 if (bpos_gt(l->b->key.k.p, i->prev_node)) {
470 bch2_btree_node_to_text(&i->buf, i->c, l->b);
471 i->prev_node = l->b->key.k.p;
474 bch2_bfloat_to_text(&i->buf, l->b, _k);
475 bch2_trans_unlock(trans);
476 i->from = bpos_successor(iter.pos);
482 static const struct file_operations bfloat_failed_debug_ops = {
483 .owner = THIS_MODULE,
484 .open = bch2_dump_open,
485 .release = bch2_dump_release,
486 .read = bch2_read_bfloat_failed,
489 static void bch2_cached_btree_node_to_text(struct printbuf *out, struct bch_fs *c,
492 if (!out->nr_tabstops)
493 printbuf_tabstop_push(out, 32);
495 prt_printf(out, "%px btree=%s l=%u ",
497 bch2_btree_id_str(b->c.btree_id),
501 printbuf_indent_add(out, 2);
503 bch2_bkey_val_to_text(out, c, bkey_i_to_s_c(&b->key));
506 prt_printf(out, "flags: ");
508 prt_bitflags(out, bch2_btree_node_flags, b->flags);
511 prt_printf(out, "pcpu read locks: ");
513 prt_printf(out, "%u", b->c.lock.readers != NULL);
516 prt_printf(out, "written:");
518 prt_printf(out, "%u", b->written);
521 prt_printf(out, "writes blocked:");
523 prt_printf(out, "%u", !list_empty_careful(&b->write_blocked));
526 prt_printf(out, "will make reachable:");
528 prt_printf(out, "%lx", b->will_make_reachable);
531 prt_printf(out, "journal pin %px:", &b->writes[0].journal);
533 prt_printf(out, "%llu", b->writes[0].journal.seq);
536 prt_printf(out, "journal pin %px:", &b->writes[1].journal);
538 prt_printf(out, "%llu", b->writes[1].journal.seq);
541 printbuf_indent_sub(out, 2);
544 static ssize_t bch2_cached_btree_nodes_read(struct file *file, char __user *buf,
545 size_t size, loff_t *ppos)
547 struct dump_iter *i = file->private_data;
548 struct bch_fs *c = i->c;
557 struct bucket_table *tbl;
558 struct rhash_head *pos;
567 tbl = rht_dereference_rcu(c->btree_cache.table.tbl,
568 &c->btree_cache.table);
569 if (i->iter < tbl->size) {
570 rht_for_each_entry_rcu(b, pos, tbl, i->iter, hash)
571 bch2_cached_btree_node_to_text(&i->buf, c, b);
580 if (i->buf.allocation_failure)
586 return ret ?: i->ret;
589 static const struct file_operations cached_btree_nodes_ops = {
590 .owner = THIS_MODULE,
591 .open = bch2_dump_open,
592 .release = bch2_dump_release,
593 .read = bch2_cached_btree_nodes_read,
596 static ssize_t bch2_btree_transactions_read(struct file *file, char __user *buf,
597 size_t size, loff_t *ppos)
599 struct dump_iter *i = file->private_data;
600 struct bch_fs *c = i->c;
601 struct btree_trans *trans;
609 seqmutex_lock(&c->btree_trans_lock);
610 list_for_each_entry(trans, &c->btree_trans_list, list) {
611 struct task_struct *task = READ_ONCE(trans->locking_wait.task);
613 if (!task || task->pid <= i->iter)
616 closure_get(&trans->ref);
617 seq = seqmutex_seq(&c->btree_trans_lock);
618 seqmutex_unlock(&c->btree_trans_lock);
622 closure_put(&trans->ref);
626 bch2_btree_trans_to_text(&i->buf, trans);
628 prt_printf(&i->buf, "backtrace:");
629 prt_newline(&i->buf);
630 printbuf_indent_add(&i->buf, 2);
631 bch2_prt_task_backtrace(&i->buf, task, 0, GFP_KERNEL);
632 printbuf_indent_sub(&i->buf, 2);
633 prt_newline(&i->buf);
637 closure_put(&trans->ref);
639 if (!seqmutex_relock(&c->btree_trans_lock, seq))
642 seqmutex_unlock(&c->btree_trans_lock);
644 if (i->buf.allocation_failure)
650 return ret ?: i->ret;
653 static const struct file_operations btree_transactions_ops = {
654 .owner = THIS_MODULE,
655 .open = bch2_dump_open,
656 .release = bch2_dump_release,
657 .read = bch2_btree_transactions_read,
660 static ssize_t bch2_journal_pins_read(struct file *file, char __user *buf,
661 size_t size, loff_t *ppos)
663 struct dump_iter *i = file->private_data;
664 struct bch_fs *c = i->c;
683 done = bch2_journal_seq_pins_to_text(&i->buf, &c->journal, &i->iter);
687 if (i->buf.allocation_failure)
693 static const struct file_operations journal_pins_ops = {
694 .owner = THIS_MODULE,
695 .open = bch2_dump_open,
696 .release = bch2_dump_release,
697 .read = bch2_journal_pins_read,
700 static ssize_t bch2_btree_updates_read(struct file *file, char __user *buf,
701 size_t size, loff_t *ppos)
703 struct dump_iter *i = file->private_data;
704 struct bch_fs *c = i->c;
712 bch2_btree_updates_to_text(&i->buf, c);
720 if (i->buf.allocation_failure)
726 static const struct file_operations btree_updates_ops = {
727 .owner = THIS_MODULE,
728 .open = bch2_dump_open,
729 .release = bch2_dump_release,
730 .read = bch2_btree_updates_read,
733 static int btree_transaction_stats_open(struct inode *inode, struct file *file)
735 struct bch_fs *c = inode->i_private;
738 i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
745 file->private_data = i;
750 static int btree_transaction_stats_release(struct inode *inode, struct file *file)
752 struct dump_iter *i = file->private_data;
754 printbuf_exit(&i->buf);
760 static ssize_t btree_transaction_stats_read(struct file *file, char __user *buf,
761 size_t size, loff_t *ppos)
763 struct dump_iter *i = file->private_data;
764 struct bch_fs *c = i->c;
772 struct btree_transaction_stats *s = &c->btree_transaction_stats[i->iter];
781 if (i->iter == ARRAY_SIZE(bch2_btree_transaction_fns) ||
782 !bch2_btree_transaction_fns[i->iter])
785 prt_printf(&i->buf, "%s: ", bch2_btree_transaction_fns[i->iter]);
786 prt_newline(&i->buf);
787 printbuf_indent_add(&i->buf, 2);
789 mutex_lock(&s->lock);
791 prt_printf(&i->buf, "Max mem used: %u", s->max_mem);
792 prt_newline(&i->buf);
794 prt_printf(&i->buf, "Transaction duration:");
795 prt_newline(&i->buf);
797 printbuf_indent_add(&i->buf, 2);
798 bch2_time_stats_to_text(&i->buf, &s->duration);
799 printbuf_indent_sub(&i->buf, 2);
801 if (IS_ENABLED(CONFIG_BCACHEFS_LOCK_TIME_STATS)) {
802 prt_printf(&i->buf, "Lock hold times:");
803 prt_newline(&i->buf);
805 printbuf_indent_add(&i->buf, 2);
806 bch2_time_stats_to_text(&i->buf, &s->lock_hold_times);
807 printbuf_indent_sub(&i->buf, 2);
810 if (s->max_paths_text) {
811 prt_printf(&i->buf, "Maximum allocated btree paths (%u):", s->nr_max_paths);
812 prt_newline(&i->buf);
814 printbuf_indent_add(&i->buf, 2);
815 prt_str_indented(&i->buf, s->max_paths_text);
816 printbuf_indent_sub(&i->buf, 2);
819 mutex_unlock(&s->lock);
821 printbuf_indent_sub(&i->buf, 2);
822 prt_newline(&i->buf);
826 if (i->buf.allocation_failure)
832 static const struct file_operations btree_transaction_stats_op = {
833 .owner = THIS_MODULE,
834 .open = btree_transaction_stats_open,
835 .release = btree_transaction_stats_release,
836 .read = btree_transaction_stats_read,
839 static ssize_t bch2_btree_deadlock_read(struct file *file, char __user *buf,
840 size_t size, loff_t *ppos)
842 struct dump_iter *i = file->private_data;
843 struct bch_fs *c = i->c;
844 struct btree_trans *trans;
855 seqmutex_lock(&c->btree_trans_lock);
856 list_for_each_entry(trans, &c->btree_trans_list, list) {
857 struct task_struct *task = READ_ONCE(trans->locking_wait.task);
859 if (!task || task->pid <= i->iter)
862 closure_get(&trans->ref);
863 seq = seqmutex_seq(&c->btree_trans_lock);
864 seqmutex_unlock(&c->btree_trans_lock);
868 closure_put(&trans->ref);
872 bch2_check_for_deadlock(trans, &i->buf);
876 closure_put(&trans->ref);
878 if (!seqmutex_relock(&c->btree_trans_lock, seq))
881 seqmutex_unlock(&c->btree_trans_lock);
883 if (i->buf.allocation_failure)
889 return ret ?: i->ret;
892 static const struct file_operations btree_deadlock_ops = {
893 .owner = THIS_MODULE,
894 .open = bch2_dump_open,
895 .release = bch2_dump_release,
896 .read = bch2_btree_deadlock_read,
899 void bch2_fs_debug_exit(struct bch_fs *c)
901 if (!IS_ERR_OR_NULL(c->fs_debug_dir))
902 debugfs_remove_recursive(c->fs_debug_dir);
905 static void bch2_fs_debug_btree_init(struct bch_fs *c, struct btree_debug *bd)
909 d = debugfs_create_dir(bch2_btree_id_str(bd->id), c->btree_debug_dir);
911 debugfs_create_file("keys", 0400, d, bd, &btree_debug_ops);
913 debugfs_create_file("formats", 0400, d, bd, &btree_format_debug_ops);
915 debugfs_create_file("bfloat-failed", 0400, d, bd,
916 &bfloat_failed_debug_ops);
919 void bch2_fs_debug_init(struct bch_fs *c)
921 struct btree_debug *bd;
924 if (IS_ERR_OR_NULL(bch_debug))
927 snprintf(name, sizeof(name), "%pU", c->sb.user_uuid.b);
928 c->fs_debug_dir = debugfs_create_dir(name, bch_debug);
929 if (IS_ERR_OR_NULL(c->fs_debug_dir))
932 debugfs_create_file("cached_btree_nodes", 0400, c->fs_debug_dir,
933 c->btree_debug, &cached_btree_nodes_ops);
935 debugfs_create_file("btree_transactions", 0400, c->fs_debug_dir,
936 c->btree_debug, &btree_transactions_ops);
938 debugfs_create_file("journal_pins", 0400, c->fs_debug_dir,
939 c->btree_debug, &journal_pins_ops);
941 debugfs_create_file("btree_updates", 0400, c->fs_debug_dir,
942 c->btree_debug, &btree_updates_ops);
944 debugfs_create_file("btree_transaction_stats", 0400, c->fs_debug_dir,
945 c, &btree_transaction_stats_op);
947 debugfs_create_file("btree_deadlock", 0400, c->fs_debug_dir,
948 c->btree_debug, &btree_deadlock_ops);
950 c->btree_debug_dir = debugfs_create_dir("btrees", c->fs_debug_dir);
951 if (IS_ERR_OR_NULL(c->btree_debug_dir))
954 for (bd = c->btree_debug;
955 bd < c->btree_debug + ARRAY_SIZE(c->btree_debug);
957 bd->id = bd - c->btree_debug;
958 bch2_fs_debug_btree_init(c, bd);
964 void bch2_debug_exit(void)
966 if (!IS_ERR_OR_NULL(bch_debug))
967 debugfs_remove_recursive(bch_debug);
970 int __init bch2_debug_init(void)
972 bch_debug = debugfs_create_dir("bcachefs", NULL);