drivers/md/bcache/debug.c

   1 /*
   2  * Assorted bcache debug code
   3  *
   4  * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
   5  * Copyright 2012 Google, Inc.
   6  */
   7
   8 #include "bcache.h"
   9 #include "btree.h"
  10 #include "debug.h"
  11
  12 #include <linux/console.h>
  13 #include <linux/debugfs.h>
  14 #include <linux/module.h>
  15 #include <linux/random.h>
  16 #include <linux/seq_file.h>
  17
  18 static struct dentry *debug;
  19
  20 const char *bch_ptr_status(struct cache_set *c, const struct bkey *k)
  21 {
  22         unsigned i;
  23
  24         for (i = 0; i < KEY_PTRS(k); i++)
  25                 if (ptr_available(c, k, i)) {
  26                         struct cache *ca = PTR_CACHE(c, k, i);
  27                         size_t bucket = PTR_BUCKET_NR(c, k, i);
  28                         size_t r = bucket_remainder(c, PTR_OFFSET(k, i));
  29
  30                         if (KEY_SIZE(k) + r > c->sb.bucket_size)
  31                                 return "bad, length too big";
  32                         if (bucket <  ca->sb.first_bucket)
  33                                 return "bad, short offset";
  34                         if (bucket >= ca->sb.nbuckets)
  35                                 return "bad, offset past end of device";
  36                         if (ptr_stale(c, k, i))
  37                                 return "stale";
  38                 }
  39
  40         if (!bkey_cmp(k, &ZERO_KEY))
  41                 return "bad, null key";
  42         if (!KEY_PTRS(k))
  43                 return "bad, no pointers";
  44         if (!KEY_SIZE(k))
  45                 return "zeroed key";
  46         return "";
  47 }
  48
  49 int bch_bkey_to_text(char *buf, size_t size, const struct bkey *k)
  50 {
  51         unsigned i = 0;
  52         char *out = buf, *end = buf + size;
  53
  54 #define p(...)  (out += scnprintf(out, end - out, __VA_ARGS__))
  55
  56         p("%llu:%llu len %llu -> [", KEY_INODE(k), KEY_OFFSET(k), KEY_SIZE(k));
  57
  58         if (KEY_PTRS(k))
  59                 while (1) {
  60                         p("%llu:%llu gen %llu",
  61                           PTR_DEV(k, i), PTR_OFFSET(k, i), PTR_GEN(k, i));
  62
  63                         if (++i == KEY_PTRS(k))
  64                                 break;
  65
  66                         p(", ");
  67                 }
  68
  69         p("]");
  70
  71         if (KEY_DIRTY(k))
  72                 p(" dirty");
  73         if (KEY_CSUM(k))
  74                 p(" cs%llu %llx", KEY_CSUM(k), k->ptr[1]);
  75 #undef p
  76         return out - buf;
  77 }
  78
  79 #ifdef CONFIG_BCACHE_DEBUG
  80
  81 static void dump_bset(struct btree *b, struct bset *i)
  82 {
  83         struct bkey *k, *next;
  84         unsigned j;
  85         char buf[80];
  86
  87         for (k = i->start; k < end(i); k = next) {
  88                 next = bkey_next(k);
  89
  90                 bch_bkey_to_text(buf, sizeof(buf), k);
  91                 printk(KERN_ERR "block %zu key %zi/%u: %s", index(i, b),
  92                        (uint64_t *) k - i->d, i->keys, buf);
  93
  94                 for (j = 0; j < KEY_PTRS(k); j++) {
  95                         size_t n = PTR_BUCKET_NR(b->c, k, j);
  96                         printk(" bucket %zu", n);
  97
  98                         if (n >= b->c->sb.first_bucket && n < b->c->sb.nbuckets)
  99                                 printk(" prio %i",
 100                                        PTR_BUCKET(b->c, k, j)->prio);
 101                 }
 102
 103                 printk(" %s\n", bch_ptr_status(b->c, k));
 104
 105                 if (next < end(i) &&
 106                     bkey_cmp(k, !b->level ? &START_KEY(next) : next) > 0)
 107                         printk(KERN_ERR "Key skipped backwards\n");
 108         }
 109 }
 110
 111 static void bch_dump_bucket(struct btree *b)
 112 {
 113         unsigned i;
 114
 115         console_lock();
 116         for (i = 0; i <= b->nsets; i++)
 117                 dump_bset(b, b->sets[i].data);
 118         console_unlock();
 119 }
 120
 121 void bch_btree_verify(struct btree *b, struct bset *new)
 122 {
 123         struct btree *v = b->c->verify_data;
 124         struct closure cl;
 125         closure_init_stack(&cl);
 126
 127         if (!b->c->verify)
 128                 return;
 129
 130         closure_wait_event(&b->io.wait, &cl,
 131                            atomic_read(&b->io.cl.remaining) == -1);
 132
 133         mutex_lock(&b->c->verify_lock);
 134
 135         bkey_copy(&v->key, &b->key);
 136         v->written = 0;
 137         v->level = b->level;
 138
 139         bch_btree_node_read(v);
 140         closure_wait_event(&v->io.wait, &cl,
 141                            atomic_read(&b->io.cl.remaining) == -1);
 142
 143         if (new->keys != v->sets[0].data->keys ||
 144             memcmp(new->start,
 145                    v->sets[0].data->start,
 146                    (void *) end(new) - (void *) new->start)) {
 147                 unsigned i, j;
 148
 149                 console_lock();
 150
 151                 printk(KERN_ERR "*** original memory node:\n");
 152                 for (i = 0; i <= b->nsets; i++)
 153                         dump_bset(b, b->sets[i].data);
 154
 155                 printk(KERN_ERR "*** sorted memory node:\n");
 156                 dump_bset(b, new);
 157
 158                 printk(KERN_ERR "*** on disk node:\n");
 159                 dump_bset(v, v->sets[0].data);
 160
 161                 for (j = 0; j < new->keys; j++)
 162                         if (new->d[j] != v->sets[0].data->d[j])
 163                                 break;
 164
 165                 console_unlock();
 166                 panic("verify failed at %u\n", j);
 167         }
 168
 169         mutex_unlock(&b->c->verify_lock);
 170 }
 171
 172 void bch_data_verify(struct cached_dev *dc, struct bio *bio)
 173 {
 174         char name[BDEVNAME_SIZE];
 175         struct bio *check;
 176         struct bio_vec bv, *bv2;
 177         struct bvec_iter iter;
 178         int i;
 179
 180         check = bio_clone(bio, GFP_NOIO);
 181         if (!check)
 182                 return;
 183
 184         if (bio_alloc_pages(check, GFP_NOIO))
 185                 goto out_put;
 186
 187         submit_bio_wait(READ_SYNC, check);
 188
 189         bio_for_each_segment(bv, bio, iter) {
 190                 void *p1 = kmap_atomic(bv.bv_page);
 191                 void *p2 = page_address(check->bi_io_vec[iter.bi_idx].bv_page);
 192
 193                 cache_set_err_on(memcmp(p1 + bv.bv_offset,
 194                                         p2 + bv.bv_offset,
 195                                         bv.bv_len),
 196                                  dc->disk.c,
 197                                  "verify failed at dev %s sector %llu",
 198                                  bdevname(dc->bdev, name),
 199                                  (uint64_t) bio->bi_iter.bi_sector);
 200
 201                 kunmap_atomic(p1);
 202         }
 203
 204         bio_for_each_segment_all(bv2, check, i)
 205                 __free_page(bv2->bv_page);
 206 out_put:
 207         bio_put(check);
 208 }
 209
 210 int __bch_count_data(struct btree *b)
 211 {
 212         unsigned ret = 0;
 213         struct btree_iter iter;
 214         struct bkey *k;
 215
 216         if (!b->level)
 217                 for_each_key(b, k, &iter)
 218                         ret += KEY_SIZE(k);
 219         return ret;
 220 }
 221
 222 void __bch_check_keys(struct btree *b, const char *fmt, ...)
 223 {
 224         va_list args;
 225         struct bkey *k, *p = NULL;
 226         struct btree_iter iter;
 227         const char *err;
 228
 229         for_each_key(b, k, &iter) {
 230                 if (!b->level) {
 231                         err = "Keys out of order";
 232                         if (p && bkey_cmp(&START_KEY(p), &START_KEY(k)) > 0)
 233                                 goto bug;
 234
 235                         if (bch_ptr_invalid(b, k))
 236                                 continue;
 237
 238                         err =  "Overlapping keys";
 239                         if (p && bkey_cmp(p, &START_KEY(k)) > 0)
 240                                 goto bug;
 241                 } else {
 242                         if (bch_ptr_bad(b, k))
 243                                 continue;
 244
 245                         err = "Duplicate keys";
 246                         if (p && !bkey_cmp(p, k))
 247                                 goto bug;
 248                 }
 249                 p = k;
 250         }
 251
 252         err = "Key larger than btree node key";
 253         if (p && bkey_cmp(p, &b->key) > 0)
 254                 goto bug;
 255
 256         return;
 257 bug:
 258         bch_dump_bucket(b);
 259
 260         va_start(args, fmt);
 261         vprintk(fmt, args);
 262         va_end(args);
 263
 264         panic("bcache error: %s:\n", err);
 265 }
 266
 267 void bch_btree_iter_next_check(struct btree_iter *iter)
 268 {
 269         struct bkey *k = iter->data->k, *next = bkey_next(k);
 270
 271         if (next < iter->data->end &&
 272             bkey_cmp(k, iter->b->level ? next : &START_KEY(next)) > 0) {
 273                 bch_dump_bucket(iter->b);
 274                 panic("Key skipped backwards\n");
 275         }
 276 }
 277
 278 #endif
 279
 280 #ifdef CONFIG_DEBUG_FS
 281
 282 /* XXX: cache set refcounting */
 283
 284 struct dump_iterator {
 285         char                    buf[PAGE_SIZE];
 286         size_t                  bytes;
 287         struct cache_set        *c;
 288         struct keybuf           keys;
 289 };
 290
 291 static bool dump_pred(struct keybuf *buf, struct bkey *k)
 292 {
 293         return true;
 294 }
 295
 296 static ssize_t bch_dump_read(struct file *file, char __user *buf,
 297                              size_t size, loff_t *ppos)
 298 {
 299         struct dump_iterator *i = file->private_data;
 300         ssize_t ret = 0;
 301         char kbuf[80];
 302
 303         while (size) {
 304                 struct keybuf_key *w;
 305                 unsigned bytes = min(i->bytes, size);
 306
 307                 int err = copy_to_user(buf, i->buf, bytes);
 308                 if (err)
 309                         return err;
 310
 311                 ret      += bytes;
 312                 buf      += bytes;
 313                 size     -= bytes;
 314                 i->bytes -= bytes;
 315                 memmove(i->buf, i->buf + bytes, i->bytes);
 316
 317                 if (i->bytes)
 318                         break;
 319
 320                 w = bch_keybuf_next_rescan(i->c, &i->keys, &MAX_KEY, dump_pred);
 321                 if (!w)
 322                         break;
 323
 324                 bch_bkey_to_text(kbuf, sizeof(kbuf), &w->key);
 325                 i->bytes = snprintf(i->buf, PAGE_SIZE, "%s\n", kbuf);
 326                 bch_keybuf_del(&i->keys, w);
 327         }
 328
 329         return ret;
 330 }
 331
 332 static int bch_dump_open(struct inode *inode, struct file *file)
 333 {
 334         struct cache_set *c = inode->i_private;
 335         struct dump_iterator *i;
 336
 337         i = kzalloc(sizeof(struct dump_iterator), GFP_KERNEL);
 338         if (!i)
 339                 return -ENOMEM;
 340
 341         file->private_data = i;
 342         i->c = c;
 343         bch_keybuf_init(&i->keys);
 344         i->keys.last_scanned = KEY(0, 0, 0);
 345
 346         return 0;
 347 }
 348
 349 static int bch_dump_release(struct inode *inode, struct file *file)
 350 {
 351         kfree(file->private_data);
 352         return 0;
 353 }
 354
 355 static const struct file_operations cache_set_debug_ops = {
 356         .owner          = THIS_MODULE,
 357         .open           = bch_dump_open,
 358         .read           = bch_dump_read,
 359         .release        = bch_dump_release
 360 };
 361
 362 void bch_debug_init_cache_set(struct cache_set *c)
 363 {
 364         if (!IS_ERR_OR_NULL(debug)) {
 365                 char name[50];
 366                 snprintf(name, 50, "bcache-%pU", c->sb.set_uuid);
 367
 368                 c->debug = debugfs_create_file(name, 0400, debug, c,
 369                                                &cache_set_debug_ops);
 370         }
 371 }
 372
 373 #endif
 374
 375 void bch_debug_exit(void)
 376 {
 377         if (!IS_ERR_OR_NULL(debug))
 378                 debugfs_remove_recursive(debug);
 379 }
 380
 381 int __init bch_debug_init(struct kobject *kobj)
 382 {
 383         int ret = 0;
 384
 385         debug = debugfs_create_dir("bcache", NULL);
 386         return ret;
 387 }