1 // SPDX-License-Identifier: GPL-2.0
3 * Assorted bcachefs debug code
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"
23 #include "journal_reclaim.h"
26 #include <linux/console.h>
27 #include <linux/debugfs.h>
28 #include <linux/module.h>
29 #include <linux/random.h>
30 #include <linux/seq_file.h>
32 static struct dentry *bch_debug;
34 static bool bch2_btree_verify_replica(struct bch_fs *c, struct btree *b,
35 struct extent_ptr_decoded pick)
37 struct btree *v = c->verify_data;
38 struct btree_node *n_ondisk = c->verify_ondisk;
39 struct btree_node *n_sorted = c->verify_data->data;
40 struct bset *sorted, *inmemory = &b->data->keys;
42 bool failed = false, saw_error = false;
44 struct bch_dev *ca = bch2_dev_get_ioref(c, pick.ptr.dev, READ);
48 bio = bio_alloc_bioset(ca->disk_sb.bdev,
49 buf_pages(n_sorted, btree_buf_bytes(b)),
53 bio->bi_iter.bi_sector = pick.ptr.offset;
54 bch2_bio_map(bio, n_sorted, btree_buf_bytes(b));
59 percpu_ref_put(&ca->io_ref);
61 memcpy(n_ondisk, n_sorted, btree_buf_bytes(b));
64 if (bch2_btree_node_read_done(c, ca, v, false, &saw_error) || saw_error)
67 n_sorted = c->verify_data->data;
68 sorted = &n_sorted->keys;
70 if (inmemory->u64s != sorted->u64s ||
71 memcmp(inmemory->start,
73 vstruct_end(inmemory) - (void *) inmemory->start)) {
74 unsigned offset = 0, sectors;
80 printk(KERN_ERR "*** in memory:\n");
81 bch2_dump_bset(c, b, inmemory, 0);
83 printk(KERN_ERR "*** read back in:\n");
84 bch2_dump_bset(c, v, sorted, 0);
86 while (offset < v->written) {
89 sectors = vstruct_blocks(n_ondisk, c->block_bits) <<
92 struct btree_node_entry *bne =
93 (void *) n_ondisk + (offset << 9);
96 sectors = vstruct_blocks(bne, c->block_bits) <<
100 printk(KERN_ERR "*** on disk block %u:\n", offset);
101 bch2_dump_bset(c, b, i, offset);
106 for (j = 0; j < le16_to_cpu(inmemory->u64s); j++)
107 if (inmemory->_data[j] != sorted->_data[j])
111 bch_err(c, "verify failed at key %u", j);
116 if (v->written != b->written) {
117 bch_err(c, "written wrong: expected %u, got %u",
118 b->written, v->written);
125 void __bch2_btree_verify(struct bch_fs *c, struct btree *b)
127 struct bkey_ptrs_c ptrs;
128 struct extent_ptr_decoded p;
129 const union bch_extent_entry *entry;
131 struct bset *inmemory = &b->data->keys;
132 struct bkey_packed *k;
135 if (c->opts.nochanges)
138 bch2_btree_node_io_lock(b);
139 mutex_lock(&c->verify_lock);
141 if (!c->verify_ondisk) {
142 c->verify_ondisk = kvmalloc(btree_buf_bytes(b), GFP_KERNEL);
143 if (!c->verify_ondisk)
147 if (!c->verify_data) {
148 c->verify_data = __bch2_btree_node_mem_alloc(c);
152 list_del_init(&c->verify_data->list);
155 BUG_ON(b->nsets != 1);
157 for (k = inmemory->start; k != vstruct_last(inmemory); k = bkey_p_next(k))
158 if (k->type == KEY_TYPE_btree_ptr_v2)
159 ((struct bch_btree_ptr_v2 *) bkeyp_val(&b->format, k))->mem_ptr = 0;
162 bkey_copy(&v->key, &b->key);
163 v->c.level = b->c.level;
164 v->c.btree_id = b->c.btree_id;
165 bch2_btree_keys_init(v);
167 ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key));
168 bkey_for_each_ptr_decode(&b->key.k, ptrs, p, entry)
169 failed |= bch2_btree_verify_replica(c, b, p);
172 struct printbuf buf = PRINTBUF;
174 bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key));
175 bch2_fs_fatal_error(c, ": btree node verify failed for: %s\n", buf.buf);
179 mutex_unlock(&c->verify_lock);
180 bch2_btree_node_io_unlock(b);
183 void bch2_btree_node_ondisk_to_text(struct printbuf *out, struct bch_fs *c,
184 const struct btree *b)
186 struct btree_node *n_ondisk = NULL;
187 struct extent_ptr_decoded pick;
189 struct bio *bio = NULL;
193 if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) {
194 prt_printf(out, "error getting device to read from: invalid device\n");
198 ca = bch2_dev_get_ioref(c, pick.ptr.dev, READ);
200 prt_printf(out, "error getting device to read from: not online\n");
204 n_ondisk = kvmalloc(btree_buf_bytes(b), GFP_KERNEL);
206 prt_printf(out, "memory allocation failure\n");
210 bio = bio_alloc_bioset(ca->disk_sb.bdev,
211 buf_pages(n_ondisk, btree_buf_bytes(b)),
212 REQ_OP_READ|REQ_META,
215 bio->bi_iter.bi_sector = pick.ptr.offset;
216 bch2_bio_map(bio, n_ondisk, btree_buf_bytes(b));
218 ret = submit_bio_wait(bio);
220 prt_printf(out, "IO error reading btree node: %s\n", bch2_err_str(ret));
224 while (offset < btree_sectors(c)) {
227 struct bch_csum csum;
228 struct bkey_packed *k;
234 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) {
235 prt_printf(out, "unknown checksum type at offset %u: %llu\n",
236 offset, BSET_CSUM_TYPE(i));
240 nonce = btree_nonce(i, offset << 9);
241 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk);
243 if (bch2_crc_cmp(csum, n_ondisk->csum)) {
244 prt_printf(out, "invalid checksum\n");
248 bset_encrypt(c, i, offset << 9);
250 sectors = vstruct_sectors(n_ondisk, c->block_bits);
252 struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9);
256 if (i->seq != n_ondisk->keys.seq)
259 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) {
260 prt_printf(out, "unknown checksum type at offset %u: %llu\n",
261 offset, BSET_CSUM_TYPE(i));
265 nonce = btree_nonce(i, offset << 9);
266 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne);
268 if (bch2_crc_cmp(csum, bne->csum)) {
269 prt_printf(out, "invalid checksum");
273 bset_encrypt(c, i, offset << 9);
275 sectors = vstruct_sectors(bne, c->block_bits);
278 prt_printf(out, " offset %u version %u, journal seq %llu\n",
280 le16_to_cpu(i->version),
281 le64_to_cpu(i->journal_seq));
284 printbuf_indent_add(out, 4);
286 for (k = i->start; k != vstruct_last(i); k = bkey_p_next(k)) {
289 bch2_bkey_val_to_text(out, c, bkey_disassemble(b, k, &u));
293 printbuf_indent_sub(out, 4);
299 percpu_ref_put(&ca->io_ref);
302 #ifdef CONFIG_DEBUG_FS
304 /* XXX: bch_fs refcounting */
310 struct bpos prev_node;
315 char __user *ubuf; /* destination user buffer */
316 size_t size; /* size of requested read */
317 ssize_t ret; /* bytes read so far */
320 static ssize_t flush_buf(struct dump_iter *i)
323 size_t bytes = min_t(size_t, i->buf.pos, i->size);
324 int copied = bytes - copy_to_user(i->ubuf, i->buf.buf, bytes);
329 i->buf.pos -= copied;
330 memmove(i->buf.buf, i->buf.buf + copied, i->buf.pos);
336 return i->size ? 0 : i->ret;
339 static int bch2_dump_open(struct inode *inode, struct file *file)
341 struct btree_debug *bd = inode->i_private;
344 i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
348 file->private_data = i;
351 i->c = container_of(bd, struct bch_fs, btree_debug[bd->id]);
358 static int bch2_dump_release(struct inode *inode, struct file *file)
360 struct dump_iter *i = file->private_data;
362 printbuf_exit(&i->buf);
367 static ssize_t bch2_read_btree(struct file *file, char __user *buf,
368 size_t size, loff_t *ppos)
370 struct dump_iter *i = file->private_data;
376 return flush_buf(i) ?:
378 for_each_btree_key(trans, iter, i->id, i->from,
380 BTREE_ITER_all_snapshots, k, ({
381 bch2_bkey_val_to_text(&i->buf, i->c, k);
382 prt_newline(&i->buf);
383 bch2_trans_unlock(trans);
384 i->from = bpos_successor(iter.pos);
390 static const struct file_operations btree_debug_ops = {
391 .owner = THIS_MODULE,
392 .open = bch2_dump_open,
393 .release = bch2_dump_release,
394 .read = bch2_read_btree,
397 static ssize_t bch2_read_btree_formats(struct file *file, char __user *buf,
398 size_t size, loff_t *ppos)
400 struct dump_iter *i = file->private_data;
406 ssize_t ret = flush_buf(i);
410 if (bpos_eq(SPOS_MAX, i->from))
413 return bch2_trans_run(i->c,
414 for_each_btree_node(trans, iter, i->id, i->from, 0, b, ({
415 bch2_btree_node_to_text(&i->buf, i->c, b);
416 i->from = !bpos_eq(SPOS_MAX, b->key.k.p)
417 ? bpos_successor(b->key.k.p)
420 drop_locks_do(trans, flush_buf(i));
424 static const struct file_operations btree_format_debug_ops = {
425 .owner = THIS_MODULE,
426 .open = bch2_dump_open,
427 .release = bch2_dump_release,
428 .read = bch2_read_btree_formats,
431 static ssize_t bch2_read_bfloat_failed(struct file *file, char __user *buf,
432 size_t size, loff_t *ppos)
434 struct dump_iter *i = file->private_data;
440 return flush_buf(i) ?:
442 for_each_btree_key(trans, iter, i->id, i->from,
444 BTREE_ITER_all_snapshots, k, ({
445 struct btree_path_level *l =
446 &btree_iter_path(trans, &iter)->l[0];
447 struct bkey_packed *_k =
448 bch2_btree_node_iter_peek(&l->iter, l->b);
450 if (bpos_gt(l->b->key.k.p, i->prev_node)) {
451 bch2_btree_node_to_text(&i->buf, i->c, l->b);
452 i->prev_node = l->b->key.k.p;
455 bch2_bfloat_to_text(&i->buf, l->b, _k);
456 bch2_trans_unlock(trans);
457 i->from = bpos_successor(iter.pos);
463 static const struct file_operations bfloat_failed_debug_ops = {
464 .owner = THIS_MODULE,
465 .open = bch2_dump_open,
466 .release = bch2_dump_release,
467 .read = bch2_read_bfloat_failed,
470 static void bch2_cached_btree_node_to_text(struct printbuf *out, struct bch_fs *c,
473 if (!out->nr_tabstops)
474 printbuf_tabstop_push(out, 32);
476 prt_printf(out, "%px ", b);
477 bch2_btree_id_level_to_text(out, b->c.btree_id, b->c.level);
478 prt_printf(out, "\n");
480 printbuf_indent_add(out, 2);
482 bch2_bkey_val_to_text(out, c, bkey_i_to_s_c(&b->key));
485 prt_printf(out, "flags:\t");
486 prt_bitflags(out, bch2_btree_node_flags, b->flags);
489 prt_printf(out, "pcpu read locks:\t%u\n", b->c.lock.readers != NULL);
490 prt_printf(out, "written:\t%u\n", b->written);
491 prt_printf(out, "writes blocked:\t%u\n", !list_empty_careful(&b->write_blocked));
492 prt_printf(out, "will make reachable:\t%lx\n", b->will_make_reachable);
494 prt_printf(out, "journal pin %px:\t%llu\n",
495 &b->writes[0].journal, b->writes[0].journal.seq);
496 prt_printf(out, "journal pin %px:\t%llu\n",
497 &b->writes[1].journal, b->writes[1].journal.seq);
499 printbuf_indent_sub(out, 2);
502 static ssize_t bch2_cached_btree_nodes_read(struct file *file, char __user *buf,
503 size_t size, loff_t *ppos)
505 struct dump_iter *i = file->private_data;
506 struct bch_fs *c = i->c;
515 struct bucket_table *tbl;
516 struct rhash_head *pos;
525 tbl = rht_dereference_rcu(c->btree_cache.table.tbl,
526 &c->btree_cache.table);
527 if (i->iter < tbl->size) {
528 rht_for_each_entry_rcu(b, pos, tbl, i->iter, hash)
529 bch2_cached_btree_node_to_text(&i->buf, c, b);
538 if (i->buf.allocation_failure)
544 return ret ?: i->ret;
547 static const struct file_operations cached_btree_nodes_ops = {
548 .owner = THIS_MODULE,
549 .open = bch2_dump_open,
550 .release = bch2_dump_release,
551 .read = bch2_cached_btree_nodes_read,
554 typedef int (*list_cmp_fn)(const struct list_head *l, const struct list_head *r);
556 static void list_sort(struct list_head *head, list_cmp_fn cmp)
558 struct list_head *pos;
560 list_for_each(pos, head)
561 while (!list_is_last(pos, head) &&
562 cmp(pos, pos->next) > 0) {
563 struct list_head *pos2, *next = pos->next;
566 list_for_each(pos2, head)
567 if (cmp(next, pos2) < 0)
571 list_add_tail(next, pos2);
575 static int list_ptr_order_cmp(const struct list_head *l, const struct list_head *r)
577 return cmp_int(l, r);
580 static ssize_t bch2_btree_transactions_read(struct file *file, char __user *buf,
581 size_t size, loff_t *ppos)
583 struct dump_iter *i = file->private_data;
584 struct bch_fs *c = i->c;
585 struct btree_trans *trans;
592 seqmutex_lock(&c->btree_trans_lock);
593 list_sort(&c->btree_trans_list, list_ptr_order_cmp);
595 list_for_each_entry(trans, &c->btree_trans_list, list) {
596 if ((ulong) trans <= i->iter)
599 i->iter = (ulong) trans;
601 if (!closure_get_not_zero(&trans->ref))
604 u32 seq = seqmutex_unlock(&c->btree_trans_lock);
606 bch2_btree_trans_to_text(&i->buf, trans);
608 prt_printf(&i->buf, "backtrace:\n");
609 printbuf_indent_add(&i->buf, 2);
610 bch2_prt_task_backtrace(&i->buf, trans->locking_wait.task, 0, GFP_KERNEL);
611 printbuf_indent_sub(&i->buf, 2);
612 prt_newline(&i->buf);
614 closure_put(&trans->ref);
620 if (!seqmutex_relock(&c->btree_trans_lock, seq))
623 seqmutex_unlock(&c->btree_trans_lock);
625 if (i->buf.allocation_failure)
631 return ret ?: i->ret;
634 static const struct file_operations btree_transactions_ops = {
635 .owner = THIS_MODULE,
636 .open = bch2_dump_open,
637 .release = bch2_dump_release,
638 .read = bch2_btree_transactions_read,
641 static ssize_t bch2_journal_pins_read(struct file *file, char __user *buf,
642 size_t size, loff_t *ppos)
644 struct dump_iter *i = file->private_data;
645 struct bch_fs *c = i->c;
664 done = bch2_journal_seq_pins_to_text(&i->buf, &c->journal, &i->iter);
668 if (i->buf.allocation_failure)
674 static const struct file_operations journal_pins_ops = {
675 .owner = THIS_MODULE,
676 .open = bch2_dump_open,
677 .release = bch2_dump_release,
678 .read = bch2_journal_pins_read,
681 static ssize_t bch2_btree_updates_read(struct file *file, char __user *buf,
682 size_t size, loff_t *ppos)
684 struct dump_iter *i = file->private_data;
685 struct bch_fs *c = i->c;
693 bch2_btree_updates_to_text(&i->buf, c);
701 if (i->buf.allocation_failure)
707 static const struct file_operations btree_updates_ops = {
708 .owner = THIS_MODULE,
709 .open = bch2_dump_open,
710 .release = bch2_dump_release,
711 .read = bch2_btree_updates_read,
714 static int btree_transaction_stats_open(struct inode *inode, struct file *file)
716 struct bch_fs *c = inode->i_private;
719 i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
726 file->private_data = i;
731 static int btree_transaction_stats_release(struct inode *inode, struct file *file)
733 struct dump_iter *i = file->private_data;
735 printbuf_exit(&i->buf);
741 static ssize_t btree_transaction_stats_read(struct file *file, char __user *buf,
742 size_t size, loff_t *ppos)
744 struct dump_iter *i = file->private_data;
745 struct bch_fs *c = i->c;
753 struct btree_transaction_stats *s = &c->btree_transaction_stats[i->iter];
762 if (i->iter == ARRAY_SIZE(bch2_btree_transaction_fns) ||
763 !bch2_btree_transaction_fns[i->iter])
766 prt_printf(&i->buf, "%s:\n", bch2_btree_transaction_fns[i->iter]);
767 printbuf_indent_add(&i->buf, 2);
769 mutex_lock(&s->lock);
771 prt_printf(&i->buf, "Max mem used: %u\n", s->max_mem);
772 prt_printf(&i->buf, "Transaction duration:\n");
774 printbuf_indent_add(&i->buf, 2);
775 bch2_time_stats_to_text(&i->buf, &s->duration);
776 printbuf_indent_sub(&i->buf, 2);
778 if (IS_ENABLED(CONFIG_BCACHEFS_LOCK_TIME_STATS)) {
779 prt_printf(&i->buf, "Lock hold times:\n");
781 printbuf_indent_add(&i->buf, 2);
782 bch2_time_stats_to_text(&i->buf, &s->lock_hold_times);
783 printbuf_indent_sub(&i->buf, 2);
786 if (s->max_paths_text) {
787 prt_printf(&i->buf, "Maximum allocated btree paths (%u):\n", s->nr_max_paths);
789 printbuf_indent_add(&i->buf, 2);
790 prt_str_indented(&i->buf, s->max_paths_text);
791 printbuf_indent_sub(&i->buf, 2);
794 mutex_unlock(&s->lock);
796 printbuf_indent_sub(&i->buf, 2);
797 prt_newline(&i->buf);
801 if (i->buf.allocation_failure)
807 static const struct file_operations btree_transaction_stats_op = {
808 .owner = THIS_MODULE,
809 .open = btree_transaction_stats_open,
810 .release = btree_transaction_stats_release,
811 .read = btree_transaction_stats_read,
814 /* walk btree transactions until we find a deadlock and print it */
815 static void btree_deadlock_to_text(struct printbuf *out, struct bch_fs *c)
817 struct btree_trans *trans;
820 seqmutex_lock(&c->btree_trans_lock);
821 list_sort(&c->btree_trans_list, list_ptr_order_cmp);
823 list_for_each_entry(trans, &c->btree_trans_list, list) {
824 if ((ulong) trans <= iter)
827 iter = (ulong) trans;
829 if (!closure_get_not_zero(&trans->ref))
832 u32 seq = seqmutex_unlock(&c->btree_trans_lock);
834 bool found = bch2_check_for_deadlock(trans, out) != 0;
836 closure_put(&trans->ref);
841 if (!seqmutex_relock(&c->btree_trans_lock, seq))
844 seqmutex_unlock(&c->btree_trans_lock);
847 static ssize_t bch2_btree_deadlock_read(struct file *file, char __user *buf,
848 size_t size, loff_t *ppos)
850 struct dump_iter *i = file->private_data;
851 struct bch_fs *c = i->c;
859 btree_deadlock_to_text(&i->buf, c);
863 if (i->buf.allocation_failure)
869 return ret ?: i->ret;
872 static const struct file_operations btree_deadlock_ops = {
873 .owner = THIS_MODULE,
874 .open = bch2_dump_open,
875 .release = bch2_dump_release,
876 .read = bch2_btree_deadlock_read,
879 void bch2_fs_debug_exit(struct bch_fs *c)
881 if (!IS_ERR_OR_NULL(c->fs_debug_dir))
882 debugfs_remove_recursive(c->fs_debug_dir);
885 static void bch2_fs_debug_btree_init(struct bch_fs *c, struct btree_debug *bd)
889 d = debugfs_create_dir(bch2_btree_id_str(bd->id), c->btree_debug_dir);
891 debugfs_create_file("keys", 0400, d, bd, &btree_debug_ops);
893 debugfs_create_file("formats", 0400, d, bd, &btree_format_debug_ops);
895 debugfs_create_file("bfloat-failed", 0400, d, bd,
896 &bfloat_failed_debug_ops);
899 void bch2_fs_debug_init(struct bch_fs *c)
901 struct btree_debug *bd;
904 if (IS_ERR_OR_NULL(bch_debug))
907 snprintf(name, sizeof(name), "%pU", c->sb.user_uuid.b);
908 c->fs_debug_dir = debugfs_create_dir(name, bch_debug);
909 if (IS_ERR_OR_NULL(c->fs_debug_dir))
912 debugfs_create_file("cached_btree_nodes", 0400, c->fs_debug_dir,
913 c->btree_debug, &cached_btree_nodes_ops);
915 debugfs_create_file("btree_transactions", 0400, c->fs_debug_dir,
916 c->btree_debug, &btree_transactions_ops);
918 debugfs_create_file("journal_pins", 0400, c->fs_debug_dir,
919 c->btree_debug, &journal_pins_ops);
921 debugfs_create_file("btree_updates", 0400, c->fs_debug_dir,
922 c->btree_debug, &btree_updates_ops);
924 debugfs_create_file("btree_transaction_stats", 0400, c->fs_debug_dir,
925 c, &btree_transaction_stats_op);
927 debugfs_create_file("btree_deadlock", 0400, c->fs_debug_dir,
928 c->btree_debug, &btree_deadlock_ops);
930 c->btree_debug_dir = debugfs_create_dir("btrees", c->fs_debug_dir);
931 if (IS_ERR_OR_NULL(c->btree_debug_dir))
934 for (bd = c->btree_debug;
935 bd < c->btree_debug + ARRAY_SIZE(c->btree_debug);
937 bd->id = bd - c->btree_debug;
938 bch2_fs_debug_btree_init(c, bd);
944 void bch2_debug_exit(void)
946 if (!IS_ERR_OR_NULL(bch_debug))
947 debugfs_remove_recursive(bch_debug);
950 int __init bch2_debug_init(void)
952 bch_debug = debugfs_create_dir("bcachefs", NULL);