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_update.h"
24 #include <linux/console.h>
25 #include <linux/debugfs.h>
26 #include <linux/module.h>
27 #include <linux/random.h>
28 #include <linux/seq_file.h>
30 static struct dentry *bch_debug;
32 static bool bch2_btree_verify_replica(struct bch_fs *c, struct btree *b,
33 struct extent_ptr_decoded pick)
35 struct btree *v = c->verify_data;
36 struct btree_node *n_ondisk = c->verify_ondisk;
37 struct btree_node *n_sorted = c->verify_data->data;
38 struct bset *sorted, *inmemory = &b->data->keys;
39 struct bch_dev *ca = bch_dev_bkey_exists(c, pick.ptr.dev);
43 if (!bch2_dev_get_ioref(ca, READ))
46 bio = bio_alloc_bioset(GFP_NOIO,
47 buf_pages(n_sorted, btree_bytes(c)),
49 bio_set_dev(bio, ca->disk_sb.bdev);
50 bio->bi_opf = REQ_OP_READ|REQ_META;
51 bio->bi_iter.bi_sector = pick.ptr.offset;
52 bch2_bio_map(bio, n_sorted, btree_bytes(c));
57 percpu_ref_put(&ca->io_ref);
59 memcpy(n_ondisk, n_sorted, btree_bytes(c));
62 if (bch2_btree_node_read_done(c, ca, v, false))
65 n_sorted = c->verify_data->data;
66 sorted = &n_sorted->keys;
68 if (inmemory->u64s != sorted->u64s ||
69 memcmp(inmemory->start,
71 vstruct_end(inmemory) - (void *) inmemory->start)) {
72 unsigned offset = 0, sectors;
78 printk(KERN_ERR "*** in memory:\n");
79 bch2_dump_bset(c, b, inmemory, 0);
81 printk(KERN_ERR "*** read back in:\n");
82 bch2_dump_bset(c, v, sorted, 0);
84 while (offset < v->written) {
87 sectors = vstruct_blocks(n_ondisk, c->block_bits) <<
90 struct btree_node_entry *bne =
91 (void *) n_ondisk + (offset << 9);
94 sectors = vstruct_blocks(bne, c->block_bits) <<
98 printk(KERN_ERR "*** on disk block %u:\n", offset);
99 bch2_dump_bset(c, b, i, offset);
104 for (j = 0; j < le16_to_cpu(inmemory->u64s); j++)
105 if (inmemory->_data[j] != sorted->_data[j])
109 bch_err(c, "verify failed at key %u", j);
114 if (v->written != b->written) {
115 bch_err(c, "written wrong: expected %u, got %u",
116 b->written, v->written);
123 void __bch2_btree_verify(struct bch_fs *c, struct btree *b)
125 struct bkey_ptrs_c ptrs;
126 struct extent_ptr_decoded p;
127 const union bch_extent_entry *entry;
129 struct bset *inmemory = &b->data->keys;
130 struct bkey_packed *k;
133 if (c->opts.nochanges)
136 btree_node_io_lock(b);
137 mutex_lock(&c->verify_lock);
139 if (!c->verify_ondisk) {
140 c->verify_ondisk = kvpmalloc(btree_bytes(c), GFP_KERNEL);
141 if (!c->verify_ondisk)
145 if (!c->verify_data) {
146 c->verify_data = __bch2_btree_node_mem_alloc(c);
150 list_del_init(&c->verify_data->list);
153 BUG_ON(b->nsets != 1);
155 for (k = inmemory->start; k != vstruct_last(inmemory); k = bkey_next(k))
156 if (k->type == KEY_TYPE_btree_ptr_v2) {
157 struct bch_btree_ptr_v2 *v = (void *) bkeyp_val(&b->format, k);
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);
174 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(&b->key));
175 bch2_fs_fatal_error(c, "btree node verify failed for : %s\n", buf);
178 mutex_unlock(&c->verify_lock);
179 btree_node_io_unlock(b);
182 #ifdef CONFIG_DEBUG_FS
184 /* XXX: bch_fs refcounting */
192 size_t bytes; /* what's currently in buf */
194 char __user *ubuf; /* destination user buffer */
195 size_t size; /* size of requested read */
196 ssize_t ret; /* bytes read so far */
199 static int flush_buf(struct dump_iter *i)
202 size_t bytes = min(i->bytes, i->size);
203 int err = copy_to_user(i->ubuf, i->buf, bytes);
212 memmove(i->buf, i->buf + bytes, i->bytes);
218 static int bch2_dump_open(struct inode *inode, struct file *file)
220 struct btree_debug *bd = inode->i_private;
223 i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
227 file->private_data = i;
229 i->c = container_of(bd, struct bch_fs, btree_debug[bd->id]);
235 static int bch2_dump_release(struct inode *inode, struct file *file)
237 kfree(file->private_data);
241 static ssize_t bch2_read_btree(struct file *file, char __user *buf,
242 size_t size, loff_t *ppos)
244 struct dump_iter *i = file->private_data;
245 struct btree_trans trans;
246 struct btree_iter *iter;
261 bch2_trans_init(&trans, i->c, 0, 0);
263 iter = bch2_trans_get_iter(&trans, i->id, i->from,
265 BTREE_ITER_ALL_SNAPSHOTS);
266 k = bch2_btree_iter_peek(iter);
268 while (k.k && !(err = bkey_err(k))) {
269 bch2_bkey_val_to_text(&PBUF(i->buf), i->c, k);
270 i->bytes = strlen(i->buf);
271 BUG_ON(i->bytes >= sizeof(i->buf));
272 i->buf[i->bytes] = '\n';
275 k = bch2_btree_iter_next(iter);
285 bch2_trans_iter_put(&trans, iter);
287 bch2_trans_exit(&trans);
289 return err < 0 ? err : i->ret;
292 static const struct file_operations btree_debug_ops = {
293 .owner = THIS_MODULE,
294 .open = bch2_dump_open,
295 .release = bch2_dump_release,
296 .read = bch2_read_btree,
299 static ssize_t bch2_read_btree_formats(struct file *file, char __user *buf,
300 size_t size, loff_t *ppos)
302 struct dump_iter *i = file->private_data;
303 struct btree_trans trans;
304 struct btree_iter *iter;
316 if (!i->size || !bpos_cmp(SPOS_MAX, i->from))
319 bch2_trans_init(&trans, i->c, 0, 0);
321 for_each_btree_node(&trans, iter, i->id, i->from, 0, b) {
322 bch2_btree_node_to_text(&PBUF(i->buf), i->c, b);
323 i->bytes = strlen(i->buf);
329 * can't easily correctly restart a btree node traversal across
332 i->from = bpos_cmp(SPOS_MAX, b->key.k.p)
333 ? bpos_successor(b->key.k.p)
339 bch2_trans_iter_put(&trans, iter);
341 bch2_trans_exit(&trans);
343 return err < 0 ? err : i->ret;
346 static const struct file_operations btree_format_debug_ops = {
347 .owner = THIS_MODULE,
348 .open = bch2_dump_open,
349 .release = bch2_dump_release,
350 .read = bch2_read_btree_formats,
353 static ssize_t bch2_read_bfloat_failed(struct file *file, char __user *buf,
354 size_t size, loff_t *ppos)
356 struct dump_iter *i = file->private_data;
357 struct btree_trans trans;
358 struct btree_iter *iter;
360 struct btree *prev_node = NULL;
374 bch2_trans_init(&trans, i->c, 0, 0);
376 iter = bch2_trans_get_iter(&trans, i->id, i->from, BTREE_ITER_PREFETCH);
378 while ((k = bch2_btree_iter_peek(iter)).k &&
379 !(err = bkey_err(k))) {
380 struct btree_iter_level *l = &iter->l[0];
381 struct bkey_packed *_k =
382 bch2_btree_node_iter_peek(&l->iter, l->b);
384 if (l->b != prev_node) {
385 bch2_btree_node_to_text(&PBUF(i->buf), i->c, l->b);
386 i->bytes = strlen(i->buf);
393 bch2_bfloat_to_text(&PBUF(i->buf), l->b, _k);
394 i->bytes = strlen(i->buf);
399 bch2_btree_iter_advance(iter);
409 bch2_trans_exit(&trans);
411 return err < 0 ? err : i->ret;
414 static const struct file_operations bfloat_failed_debug_ops = {
415 .owner = THIS_MODULE,
416 .open = bch2_dump_open,
417 .release = bch2_dump_release,
418 .read = bch2_read_bfloat_failed,
421 void bch2_fs_debug_exit(struct bch_fs *c)
423 if (!IS_ERR_OR_NULL(c->debug))
424 debugfs_remove_recursive(c->debug);
427 void bch2_fs_debug_init(struct bch_fs *c)
429 struct btree_debug *bd;
432 if (IS_ERR_OR_NULL(bch_debug))
435 snprintf(name, sizeof(name), "%pU", c->sb.user_uuid.b);
436 c->debug = debugfs_create_dir(name, bch_debug);
437 if (IS_ERR_OR_NULL(c->debug))
440 for (bd = c->btree_debug;
441 bd < c->btree_debug + ARRAY_SIZE(c->btree_debug);
443 bd->id = bd - c->btree_debug;
444 bd->btree = debugfs_create_file(bch2_btree_ids[bd->id],
448 snprintf(name, sizeof(name), "%s-formats",
449 bch2_btree_ids[bd->id]);
451 bd->btree_format = debugfs_create_file(name, 0400, c->debug, bd,
452 &btree_format_debug_ops);
454 snprintf(name, sizeof(name), "%s-bfloat-failed",
455 bch2_btree_ids[bd->id]);
457 bd->failed = debugfs_create_file(name, 0400, c->debug, bd,
458 &bfloat_failed_debug_ops);
464 void bch2_debug_exit(void)
466 if (!IS_ERR_OR_NULL(bch_debug))
467 debugfs_remove_recursive(bch_debug);
470 int __init bch2_debug_init(void)
474 bch_debug = debugfs_create_dir("bcachefs", NULL);