blob: 6230dfdd9286ee1fe780a6989fab2783dac4ccba [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Kent Overstreetcafe5632013-03-23 16:11:31 -07002/*
3 * Assorted bcache debug code
4 *
5 * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
6 * Copyright 2012 Google, Inc.
7 */
8
9#include "bcache.h"
10#include "btree.h"
11#include "debug.h"
Kent Overstreetdc9d98d62013-12-17 23:47:33 -080012#include "extents.h"
Kent Overstreetcafe5632013-03-23 16:11:31 -070013
14#include <linux/console.h>
15#include <linux/debugfs.h>
16#include <linux/module.h>
17#include <linux/random.h>
18#include <linux/seq_file.h>
19
Chengguang Xudf2b9432018-03-18 17:36:23 -070020struct dentry *bcache_debug;
Kent Overstreetcafe5632013-03-23 16:11:31 -070021
Kent Overstreet280481d2013-10-24 16:36:03 -070022#ifdef CONFIG_BCACHE_DEBUG
Kent Overstreetcafe5632013-03-23 16:11:31 -070023
Kent Overstreet78b77bf2013-12-17 22:49:08 -080024#define for_each_written_bset(b, start, i) \
25 for (i = (start); \
26 (void *) i < (void *) (start) + (KEY_SIZE(&b->key) << 9) &&\
27 i->seq == (start)->seq; \
Coly Li4e1ebae2020-10-01 14:50:49 +080028 i = (void *) i + set_blocks(i, block_bytes(b->c->cache)) * \
29 block_bytes(b->c->cache))
Kent Overstreet78b77bf2013-12-17 22:49:08 -080030
31void bch_btree_verify(struct btree *b)
Kent Overstreetcafe5632013-03-23 16:11:31 -070032{
33 struct btree *v = b->c->verify_data;
Kent Overstreet78b77bf2013-12-17 22:49:08 -080034 struct bset *ondisk, *sorted, *inmemory;
35 struct bio *bio;
Kent Overstreetcafe5632013-03-23 16:11:31 -070036
Kent Overstreet78b77bf2013-12-17 22:49:08 -080037 if (!b->c->verify || !b->c->verify_ondisk)
Kent Overstreetcafe5632013-03-23 16:11:31 -070038 return;
39
Kent Overstreetcb7a5832013-12-16 15:27:25 -080040 down(&b->io_mutex);
Kent Overstreetcafe5632013-03-23 16:11:31 -070041 mutex_lock(&b->c->verify_lock);
42
Kent Overstreet78b77bf2013-12-17 22:49:08 -080043 ondisk = b->c->verify_ondisk;
Kent Overstreeta85e9682013-12-20 17:28:16 -080044 sorted = b->c->verify_data->keys.set->data;
45 inmemory = b->keys.set->data;
Kent Overstreet78b77bf2013-12-17 22:49:08 -080046
Kent Overstreetcafe5632013-03-23 16:11:31 -070047 bkey_copy(&v->key, &b->key);
48 v->written = 0;
49 v->level = b->level;
Kent Overstreeta85e9682013-12-20 17:28:16 -080050 v->keys.ops = b->keys.ops;
Kent Overstreetcafe5632013-03-23 16:11:31 -070051
Kent Overstreet78b77bf2013-12-17 22:49:08 -080052 bio = bch_bbio_alloc(b->c);
Coly Li33ec5df2021-04-11 21:43:16 +080053 bio_set_dev(bio, b->c->cache->bdev);
Kent Overstreet78b77bf2013-12-17 22:49:08 -080054 bio->bi_iter.bi_sector = PTR_OFFSET(&b->key, 0);
55 bio->bi_iter.bi_size = KEY_SIZE(&v->key) << 9;
Christoph Hellwig70fd7612016-11-01 07:40:10 -060056 bio->bi_opf = REQ_OP_READ | REQ_META;
Kent Overstreet78b77bf2013-12-17 22:49:08 -080057 bch_bio_map(bio, sorted);
Kent Overstreetcafe5632013-03-23 16:11:31 -070058
Mike Christie4e49ea42016-06-05 14:31:41 -050059 submit_bio_wait(bio);
Kent Overstreet78b77bf2013-12-17 22:49:08 -080060 bch_bbio_free(bio, b->c);
61
62 memcpy(ondisk, sorted, KEY_SIZE(&v->key) << 9);
63
64 bch_btree_node_read_done(v);
Kent Overstreeta85e9682013-12-20 17:28:16 -080065 sorted = v->keys.set->data;
Kent Overstreet78b77bf2013-12-17 22:49:08 -080066
67 if (inmemory->keys != sorted->keys ||
68 memcmp(inmemory->start,
69 sorted->start,
Coly Lib0d30982018-08-11 13:19:47 +080070 (void *) bset_bkey_last(inmemory) -
71 (void *) inmemory->start)) {
Kent Overstreet78b77bf2013-12-17 22:49:08 -080072 struct bset *i;
Coly Li6f10f7d2018-08-11 13:19:44 +080073 unsigned int j;
Kent Overstreetcafe5632013-03-23 16:11:31 -070074
75 console_lock();
76
Coly Li6ae63e32018-08-11 13:19:49 +080077 pr_err("*** in memory:\n");
Kent Overstreetdc9d98d62013-12-17 23:47:33 -080078 bch_dump_bset(&b->keys, inmemory, 0);
Kent Overstreetcafe5632013-03-23 16:11:31 -070079
Coly Li6ae63e32018-08-11 13:19:49 +080080 pr_err("*** read back in:\n");
Kent Overstreetdc9d98d62013-12-17 23:47:33 -080081 bch_dump_bset(&v->keys, sorted, 0);
Kent Overstreetcafe5632013-03-23 16:11:31 -070082
Kent Overstreet78b77bf2013-12-17 22:49:08 -080083 for_each_written_bset(b, ondisk, i) {
Coly Li6f10f7d2018-08-11 13:19:44 +080084 unsigned int block = ((void *) i - (void *) ondisk) /
Coly Li4e1ebae2020-10-01 14:50:49 +080085 block_bytes(b->c->cache);
Kent Overstreetcafe5632013-03-23 16:11:31 -070086
Coly Li6ae63e32018-08-11 13:19:49 +080087 pr_err("*** on disk block %u:\n", block);
Kent Overstreetdc9d98d62013-12-17 23:47:33 -080088 bch_dump_bset(&b->keys, i, block);
Kent Overstreet78b77bf2013-12-17 22:49:08 -080089 }
90
Coly Li6ae63e32018-08-11 13:19:49 +080091 pr_err("*** block %zu not written\n",
Coly Li4e1ebae2020-10-01 14:50:49 +080092 ((void *) i - (void *) ondisk) / block_bytes(b->c->cache));
Kent Overstreet78b77bf2013-12-17 22:49:08 -080093
94 for (j = 0; j < inmemory->keys; j++)
95 if (inmemory->d[j] != sorted->d[j])
Kent Overstreetcafe5632013-03-23 16:11:31 -070096 break;
97
Coly Li6ae63e32018-08-11 13:19:49 +080098 pr_err("b->written %u\n", b->written);
Kent Overstreet78b77bf2013-12-17 22:49:08 -080099
Kent Overstreetcafe5632013-03-23 16:11:31 -0700100 console_unlock();
101 panic("verify failed at %u\n", j);
102 }
103
104 mutex_unlock(&b->c->verify_lock);
Kent Overstreetcb7a5832013-12-16 15:27:25 -0800105 up(&b->io_mutex);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700106}
107
Kent Overstreet220bb382013-09-10 19:02:45 -0700108void bch_data_verify(struct cached_dev *dc, struct bio *bio)
Kent Overstreetcafe5632013-03-23 16:11:31 -0700109{
Kent Overstreetcafe5632013-03-23 16:11:31 -0700110 struct bio *check;
Ming Lei4113b882016-11-11 20:05:33 +0800111 struct bio_vec bv, cbv;
112 struct bvec_iter iter, citer = { 0 };
Kent Overstreetcafe5632013-03-23 16:11:31 -0700113
Christoph Hellwigc8b27ac2018-07-24 09:52:30 +0200114 check = bio_kmalloc(GFP_NOIO, bio_segments(bio));
Kent Overstreetcafe5632013-03-23 16:11:31 -0700115 if (!check)
116 return;
Christoph Hellwigf65b95f2021-01-26 15:33:07 +0100117 bio_set_dev(check, bio->bi_bdev);
Christoph Hellwig70fd7612016-11-01 07:40:10 -0600118 check->bi_opf = REQ_OP_READ;
Christoph Hellwigc8b27ac2018-07-24 09:52:30 +0200119 check->bi_iter.bi_sector = bio->bi_iter.bi_sector;
120 check->bi_iter.bi_size = bio->bi_iter.bi_size;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700121
Christoph Hellwigc8b27ac2018-07-24 09:52:30 +0200122 bch_bio_map(check, NULL);
Ming Lei25d8be72017-12-18 20:22:10 +0800123 if (bch_bio_alloc_pages(check, GFP_NOIO))
Kent Overstreetcafe5632013-03-23 16:11:31 -0700124 goto out_put;
125
Mike Christie4e49ea42016-06-05 14:31:41 -0500126 submit_bio_wait(check);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700127
Ming Lei4113b882016-11-11 20:05:33 +0800128 citer.bi_size = UINT_MAX;
Kent Overstreet79886132013-11-23 17:19:00 -0800129 bio_for_each_segment(bv, bio, iter) {
Christoph Hellwig00387bd2021-10-20 22:38:11 +0800130 void *p1 = bvec_kmap_local(&bv);
Ming Lei4113b882016-11-11 20:05:33 +0800131 void *p2;
132
133 cbv = bio_iter_iovec(check, citer);
Christoph Hellwig00387bd2021-10-20 22:38:11 +0800134 p2 = bvec_kmap_local(&cbv);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700135
Christoph Hellwig00387bd2021-10-20 22:38:11 +0800136 cache_set_err_on(memcmp(p1, p2, bv.bv_len),
Kent Overstreet5ceaaad2013-09-10 14:27:42 -0700137 dc->disk.c,
Christoph Hellwig0f5cd782021-10-20 22:38:10 +0800138 "verify failed at dev %pg sector %llu",
139 dc->bdev,
Kent Overstreet4f024f32013-10-11 15:44:27 -0700140 (uint64_t) bio->bi_iter.bi_sector);
Kent Overstreet5ceaaad2013-09-10 14:27:42 -0700141
Christoph Hellwig00387bd2021-10-20 22:38:11 +0800142 kunmap_local(p2);
143 kunmap_local(p1);
Ming Lei4113b882016-11-11 20:05:33 +0800144 bio_advance_iter(check, &citer, bv.bv_len);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700145 }
146
Guoqing Jiang491221f2016-09-22 03:10:01 -0400147 bio_free_pages(check);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700148out_put:
149 bio_put(check);
150}
151
Kent Overstreetcafe5632013-03-23 16:11:31 -0700152#endif
153
154#ifdef CONFIG_DEBUG_FS
155
156/* XXX: cache set refcounting */
157
158struct dump_iterator {
159 char buf[PAGE_SIZE];
160 size_t bytes;
161 struct cache_set *c;
162 struct keybuf keys;
163};
164
165static bool dump_pred(struct keybuf *buf, struct bkey *k)
166{
167 return true;
168}
169
170static ssize_t bch_dump_read(struct file *file, char __user *buf,
171 size_t size, loff_t *ppos)
172{
173 struct dump_iterator *i = file->private_data;
174 ssize_t ret = 0;
Kent Overstreet85b14922013-05-14 20:33:16 -0700175 char kbuf[80];
Kent Overstreetcafe5632013-03-23 16:11:31 -0700176
177 while (size) {
178 struct keybuf_key *w;
Coly Li6f10f7d2018-08-11 13:19:44 +0800179 unsigned int bytes = min(i->bytes, size);
Coly Li1fae7cf2018-08-11 13:19:45 +0800180
Dan Carpenterd66c9922019-09-03 21:25:44 +0800181 if (copy_to_user(buf, i->buf, bytes))
182 return -EFAULT;
Kent Overstreetcafe5632013-03-23 16:11:31 -0700183
184 ret += bytes;
185 buf += bytes;
186 size -= bytes;
187 i->bytes -= bytes;
188 memmove(i->buf, i->buf + bytes, i->bytes);
189
190 if (i->bytes)
191 break;
192
Kent Overstreet72c27062013-06-05 06:24:39 -0700193 w = bch_keybuf_next_rescan(i->c, &i->keys, &MAX_KEY, dump_pred);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700194 if (!w)
195 break;
196
Kent Overstreetdc9d98d62013-12-17 23:47:33 -0800197 bch_extent_to_text(kbuf, sizeof(kbuf), &w->key);
Kent Overstreet85b14922013-05-14 20:33:16 -0700198 i->bytes = snprintf(i->buf, PAGE_SIZE, "%s\n", kbuf);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700199 bch_keybuf_del(&i->keys, w);
200 }
201
202 return ret;
203}
204
205static int bch_dump_open(struct inode *inode, struct file *file)
206{
207 struct cache_set *c = inode->i_private;
208 struct dump_iterator *i;
209
210 i = kzalloc(sizeof(struct dump_iterator), GFP_KERNEL);
211 if (!i)
212 return -ENOMEM;
213
214 file->private_data = i;
215 i->c = c;
Kent Overstreet72c27062013-06-05 06:24:39 -0700216 bch_keybuf_init(&i->keys);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700217 i->keys.last_scanned = KEY(0, 0, 0);
218
219 return 0;
220}
221
222static int bch_dump_release(struct inode *inode, struct file *file)
223{
224 kfree(file->private_data);
225 return 0;
226}
227
228static const struct file_operations cache_set_debug_ops = {
229 .owner = THIS_MODULE,
230 .open = bch_dump_open,
231 .read = bch_dump_read,
232 .release = bch_dump_release
233};
234
235void bch_debug_init_cache_set(struct cache_set *c)
236{
Chengguang Xudf2b9432018-03-18 17:36:23 -0700237 if (!IS_ERR_OR_NULL(bcache_debug)) {
Kent Overstreetcafe5632013-03-23 16:11:31 -0700238 char name[50];
Kent Overstreetcafe5632013-03-23 16:11:31 -0700239
Coly Li1132e562020-10-01 14:50:48 +0800240 snprintf(name, 50, "bcache-%pU", c->set_uuid);
Chengguang Xudf2b9432018-03-18 17:36:23 -0700241 c->debug = debugfs_create_file(name, 0400, bcache_debug, c,
Kent Overstreetcafe5632013-03-23 16:11:31 -0700242 &cache_set_debug_ops);
243 }
244}
245
246#endif
247
Kent Overstreetcafe5632013-03-23 16:11:31 -0700248void bch_debug_exit(void)
249{
Shenghui Wangae171022018-12-13 22:53:47 +0800250 debugfs_remove_recursive(bcache_debug);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700251}
252
Dongbo Cao91bafdf2018-10-08 20:41:17 +0800253void __init bch_debug_init(void)
Kent Overstreetcafe5632013-03-23 16:11:31 -0700254{
Coly Li78ac2102018-08-09 15:48:42 +0800255 /*
256 * it is unnecessary to check return value of
257 * debugfs_create_file(), we should not care
258 * about this.
259 */
Coly Li1c1a2ee2018-05-17 23:33:26 +0800260 bcache_debug = debugfs_create_dir("bcache", NULL);
Kent Overstreetcafe5632013-03-23 16:11:31 -0700261}