git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/debug.c

   1 /*
   2  * Assorted bcachefs debug code
   3  *
   4  * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
   5  * Copyright 2012 Google, Inc.
   6  */
   7
   8 #include "bcachefs.h"
   9 #include "bkey_methods.h"
  10 #include "btree_cache.h"
  11 #include "btree_io.h"
  12 #include "btree_iter.h"
  13 #include "btree_update.h"
  14 #include "buckets.h"
  15 #include "debug.h"
  16 #include "error.h"
  17 #include "extents.h"
  18 #include "fsck.h"
  19 #include "inode.h"
  20 #include "io.h"
  21 #include "super.h"
  22
  23 #include <linux/console.h>
  24 #include <linux/debugfs.h>
  25 #include <linux/module.h>
  26 #include <linux/random.h>
  27 #include <linux/seq_file.h>
  28
  29 static struct dentry *bch_debug;
  30
  31 #ifdef CONFIG_BCACHEFS_DEBUG
  32
  33 void __bch2_btree_verify(struct bch_fs *c, struct btree *b)
  34 {
  35         struct btree *v = c->verify_data;
  36         struct btree_node *n_ondisk, *n_sorted, *n_inmemory;
  37         struct bset *sorted, *inmemory;
  38         struct extent_pick_ptr pick;
  39         struct bio *bio;
  40
  41         if (c->opts.nochanges)
  42                 return;
  43
  44         btree_node_io_lock(b);
  45         mutex_lock(&c->verify_lock);
  46
  47         n_ondisk = c->verify_ondisk;
  48         n_sorted = c->verify_data->data;
  49         n_inmemory = b->data;
  50
  51         bkey_copy(&v->key, &b->key);
  52         v->written      = 0;
  53         v->level        = b->level;
  54         v->btree_id     = b->btree_id;
  55         bch2_btree_keys_init(v, &c->expensive_debug_checks);
  56
  57         pick = bch2_btree_pick_ptr(c, b);
  58         if (IS_ERR_OR_NULL(pick.ca))
  59                 return;
  60
  61         bio = bio_alloc_bioset(GFP_NOIO, btree_pages(c), &c->btree_read_bio);
  62         bio->bi_bdev            = pick.ca->disk_sb.bdev;
  63         bio->bi_opf             = REQ_OP_READ|REQ_META;
  64         bio->bi_iter.bi_sector  = pick.ptr.offset;
  65         bio->bi_iter.bi_size    = btree_bytes(c);
  66         bch2_bio_map(bio, n_sorted);
  67
  68         submit_bio_wait(bio);
  69
  70         bio_put(bio);
  71
  72         memcpy(n_ondisk, n_sorted, btree_bytes(c));
  73
  74         bch2_btree_node_read_done(c, v, pick.ca, &pick.ptr);
  75         n_sorted = c->verify_data->data;
  76
  77         percpu_ref_put(&pick.ca->io_ref);
  78
  79         sorted = &n_sorted->keys;
  80         inmemory = &n_inmemory->keys;
  81
  82         if (inmemory->u64s != sorted->u64s ||
  83             memcmp(inmemory->start,
  84                    sorted->start,
  85                    vstruct_end(inmemory) - (void *) inmemory->start)) {
  86                 unsigned offset = 0, sectors;
  87                 struct bset *i;
  88                 unsigned j;
  89
  90                 console_lock();
  91
  92                 printk(KERN_ERR "*** in memory:\n");
  93                 bch2_dump_bset(b, inmemory, 0);
  94
  95                 printk(KERN_ERR "*** read back in:\n");
  96                 bch2_dump_bset(v, sorted, 0);
  97
  98                 while (offset < b->written) {
  99                         if (!offset ) {
 100                                 i = &n_ondisk->keys;
 101                                 sectors = vstruct_blocks(n_ondisk, c->block_bits) <<
 102                                         c->block_bits;
 103                         } else {
 104                                 struct btree_node_entry *bne =
 105                                         (void *) n_ondisk + (offset << 9);
 106                                 i = &bne->keys;
 107
 108                                 sectors = vstruct_blocks(bne, c->block_bits) <<
 109                                         c->block_bits;
 110                         }
 111
 112                         printk(KERN_ERR "*** on disk block %u:\n", offset);
 113                         bch2_dump_bset(b, i, offset);
 114
 115                         offset += sectors;
 116                 }
 117
 118                 printk(KERN_ERR "*** block %u/%u not written\n",
 119                        offset >> c->block_bits, btree_blocks(c));
 120
 121                 for (j = 0; j < le16_to_cpu(inmemory->u64s); j++)
 122                         if (inmemory->_data[j] != sorted->_data[j])
 123                                 break;
 124
 125                 printk(KERN_ERR "b->written %u\n", b->written);
 126
 127                 console_unlock();
 128                 panic("verify failed at %u\n", j);
 129         }
 130
 131         mutex_unlock(&c->verify_lock);
 132         btree_node_io_unlock(b);
 133 }
 134
 135 #endif
 136
 137 #ifdef CONFIG_DEBUG_FS
 138
 139 /* XXX: bch_fs refcounting */
 140
 141 struct dump_iter {
 142         struct bpos             from;
 143         struct bch_fs   *c;
 144         enum btree_id           id;
 145
 146         char                    buf[PAGE_SIZE];
 147         size_t                  bytes;  /* what's currently in buf */
 148
 149         char __user             *ubuf;  /* destination user buffer */
 150         size_t                  size;   /* size of requested read */
 151         ssize_t                 ret;    /* bytes read so far */
 152 };
 153
 154 static int flush_buf(struct dump_iter *i)
 155 {
 156         if (i->bytes) {
 157                 size_t bytes = min(i->bytes, i->size);
 158                 int err = copy_to_user(i->ubuf, i->buf, bytes);
 159
 160                 if (err)
 161                         return err;
 162
 163                 i->ret   += bytes;
 164                 i->ubuf  += bytes;
 165                 i->size  -= bytes;
 166                 i->bytes -= bytes;
 167                 memmove(i->buf, i->buf + bytes, i->bytes);
 168         }
 169
 170         return 0;
 171 }
 172
 173 static int bch2_dump_open(struct inode *inode, struct file *file)
 174 {
 175         struct btree_debug *bd = inode->i_private;
 176         struct dump_iter *i;
 177
 178         i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
 179         if (!i)
 180                 return -ENOMEM;
 181
 182         file->private_data = i;
 183         i->from = POS_MIN;
 184         i->c    = container_of(bd, struct bch_fs, btree_debug[bd->id]);
 185         i->id   = bd->id;
 186
 187         return 0;
 188 }
 189
 190 static int bch2_dump_release(struct inode *inode, struct file *file)
 191 {
 192         kfree(file->private_data);
 193         return 0;
 194 }
 195
 196 static ssize_t bch2_read_btree(struct file *file, char __user *buf,
 197                                size_t size, loff_t *ppos)
 198 {
 199         struct dump_iter *i = file->private_data;
 200         struct btree_iter iter;
 201         struct bkey_s_c k;
 202         int err;
 203
 204         i->ubuf = buf;
 205         i->size = size;
 206         i->ret  = 0;
 207
 208         err = flush_buf(i);
 209         if (err)
 210                 return err;
 211
 212         if (!i->size)
 213                 return i->ret;
 214
 215         bch2_btree_iter_init(&iter, i->c, i->id, i->from, BTREE_ITER_PREFETCH);
 216
 217         while ((k = bch2_btree_iter_peek(&iter)).k &&
 218                !(err = btree_iter_err(k))) {
 219                 bch2_bkey_val_to_text(i->c, bkey_type(0, i->id),
 220                                      i->buf, sizeof(i->buf), k);
 221                 i->bytes = strlen(i->buf);
 222                 BUG_ON(i->bytes >= PAGE_SIZE);
 223                 i->buf[i->bytes] = '\n';
 224                 i->bytes++;
 225
 226                 bch2_btree_iter_advance_pos(&iter);
 227                 i->from = iter.pos;
 228
 229                 err = flush_buf(i);
 230                 if (err)
 231                         break;
 232
 233                 if (!i->size)
 234                         break;
 235         }
 236         bch2_btree_iter_unlock(&iter);
 237
 238         return err < 0 ? err : i->ret;
 239 }
 240
 241 static const struct file_operations btree_debug_ops = {
 242         .owner          = THIS_MODULE,
 243         .open           = bch2_dump_open,
 244         .release        = bch2_dump_release,
 245         .read           = bch2_read_btree,
 246 };
 247
 248 static ssize_t bch2_read_btree_formats(struct file *file, char __user *buf,
 249                                        size_t size, loff_t *ppos)
 250 {
 251         struct dump_iter *i = file->private_data;
 252         struct btree_iter iter;
 253         struct btree *b;
 254         int err;
 255
 256         i->ubuf = buf;
 257         i->size = size;
 258         i->ret  = 0;
 259
 260         err = flush_buf(i);
 261         if (err)
 262                 return err;
 263
 264         if (!i->size || !bkey_cmp(POS_MAX, i->from))
 265                 return i->ret;
 266
 267         for_each_btree_node(&iter, i->c, i->id, i->from, 0, b) {
 268                 i->bytes = bch2_print_btree_node(i->c, b, i->buf,
 269                                                 sizeof(i->buf));
 270                 err = flush_buf(i);
 271                 if (err)
 272                         break;
 273
 274                 /*
 275                  * can't easily correctly restart a btree node traversal across
 276                  * all nodes, meh
 277                  */
 278                 i->from = bkey_cmp(POS_MAX, b->key.k.p)
 279                         ? bkey_successor(b->key.k.p)
 280                         : b->key.k.p;
 281
 282                 if (!i->size)
 283                         break;
 284         }
 285         bch2_btree_iter_unlock(&iter);
 286
 287         return err < 0 ? err : i->ret;
 288 }
 289
 290 static const struct file_operations btree_format_debug_ops = {
 291         .owner          = THIS_MODULE,
 292         .open           = bch2_dump_open,
 293         .release        = bch2_dump_release,
 294         .read           = bch2_read_btree_formats,
 295 };
 296
 297 static ssize_t bch2_read_bfloat_failed(struct file *file, char __user *buf,
 298                                        size_t size, loff_t *ppos)
 299 {
 300         struct dump_iter *i = file->private_data;
 301         struct btree_iter iter;
 302         struct bkey_s_c k;
 303         struct btree *prev_node = NULL;
 304         int err;
 305
 306         i->ubuf = buf;
 307         i->size = size;
 308         i->ret  = 0;
 309
 310         err = flush_buf(i);
 311         if (err)
 312                 return err;
 313
 314         if (!i->size)
 315                 return i->ret;
 316
 317         bch2_btree_iter_init(&iter, i->c, i->id, i->from, BTREE_ITER_PREFETCH);
 318
 319         while ((k = bch2_btree_iter_peek(&iter)).k &&
 320                !(err = btree_iter_err(k))) {
 321                 struct btree *b = iter.nodes[0];
 322                 struct btree_node_iter *node_iter = &iter.node_iters[0];
 323                 struct bkey_packed *_k = bch2_btree_node_iter_peek(node_iter, b);
 324
 325                 if (iter.nodes[0] != prev_node) {
 326                         i->bytes = bch2_print_btree_node(i->c, b, i->buf,
 327                                                         sizeof(i->buf));
 328                         err = flush_buf(i);
 329                         if (err)
 330                                 break;
 331                 }
 332                 prev_node = iter.nodes[0];
 333
 334                 i->bytes = bch2_bkey_print_bfloat(b, _k, i->buf, sizeof(i->buf));
 335
 336                 err = flush_buf(i);
 337                 if (err)
 338                         break;
 339
 340                 bch2_btree_iter_advance_pos(&iter);
 341                 i->from = iter.pos;
 342
 343                 err = flush_buf(i);
 344                 if (err)
 345                         break;
 346
 347                 if (!i->size)
 348                         break;
 349         }
 350         bch2_btree_iter_unlock(&iter);
 351
 352         return err < 0 ? err : i->ret;
 353 }
 354
 355 static const struct file_operations bfloat_failed_debug_ops = {
 356         .owner          = THIS_MODULE,
 357         .open           = bch2_dump_open,
 358         .release        = bch2_dump_release,
 359         .read           = bch2_read_bfloat_failed,
 360 };
 361
 362 void bch2_fs_debug_exit(struct bch_fs *c)
 363 {
 364         if (!IS_ERR_OR_NULL(c->debug))
 365                 debugfs_remove_recursive(c->debug);
 366 }
 367
 368 void bch2_fs_debug_init(struct bch_fs *c)
 369 {
 370         struct btree_debug *bd;
 371         char name[100];
 372
 373         if (IS_ERR_OR_NULL(bch_debug))
 374                 return;
 375
 376         snprintf(name, sizeof(name), "%pU", c->sb.user_uuid.b);
 377         c->debug = debugfs_create_dir(name, bch_debug);
 378         if (IS_ERR_OR_NULL(c->debug))
 379                 return;
 380
 381         for (bd = c->btree_debug;
 382              bd < c->btree_debug + ARRAY_SIZE(c->btree_debug);
 383              bd++) {
 384                 bd->id = bd - c->btree_debug;
 385                 bd->btree = debugfs_create_file(bch2_btree_ids[bd->id],
 386                                                 0400, c->debug, bd,
 387                                                 &btree_debug_ops);
 388
 389                 snprintf(name, sizeof(name), "%s-formats",
 390                          bch2_btree_ids[bd->id]);
 391
 392                 bd->btree_format = debugfs_create_file(name, 0400, c->debug, bd,
 393                                                        &btree_format_debug_ops);
 394
 395                 snprintf(name, sizeof(name), "%s-bfloat-failed",
 396                          bch2_btree_ids[bd->id]);
 397
 398                 bd->failed = debugfs_create_file(name, 0400, c->debug, bd,
 399                                                  &bfloat_failed_debug_ops);
 400         }
 401 }
 402
 403 #endif
 404
 405 void bch2_debug_exit(void)
 406 {
 407         if (!IS_ERR_OR_NULL(bch_debug))
 408                 debugfs_remove_recursive(bch_debug);
 409 }
 410
 411 int __init bch2_debug_init(void)
 412 {
 413         int ret = 0;
 414
 415         bch_debug = debugfs_create_dir("bcachefs", NULL);
 416         return ret;
 417 }