]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/debug.c
Update bcachefs sources to 90a9c61e2b bcachefs: Switch bch2_btree_delete_range()...
[bcachefs-tools-debian] / libbcachefs / debug.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Assorted bcachefs debug code
4  *
5  * Copyright 2010, 2011 Kent Overstreet <kent.overstreet@gmail.com>
6  * Copyright 2012 Google, Inc.
7  */
8
9 #include "bcachefs.h"
10 #include "bkey_methods.h"
11 #include "btree_cache.h"
12 #include "btree_io.h"
13 #include "btree_iter.h"
14 #include "btree_update.h"
15 #include "buckets.h"
16 #include "debug.h"
17 #include "error.h"
18 #include "extents.h"
19 #include "fsck.h"
20 #include "inode.h"
21 #include "io.h"
22 #include "super.h"
23
24 #include <linux/console.h>
25 #include <linux/debugfs.h>
26 #include <linux/module.h>
27 #include <linux/pretty-printers.h>
28 #include <linux/random.h>
29 #include <linux/seq_file.h>
30
31 static struct dentry *bch_debug;
32
33 static bool bch2_btree_verify_replica(struct bch_fs *c, struct btree *b,
34                                       struct extent_ptr_decoded pick)
35 {
36         struct btree *v = c->verify_data;
37         struct btree_node *n_ondisk = c->verify_ondisk;
38         struct btree_node *n_sorted = c->verify_data->data;
39         struct bset *sorted, *inmemory = &b->data->keys;
40         struct bch_dev *ca = bch_dev_bkey_exists(c, pick.ptr.dev);
41         struct bio *bio;
42         bool failed = false;
43
44         if (!bch2_dev_get_ioref(ca, READ))
45                 return false;
46
47         bio = bio_alloc_bioset(ca->disk_sb.bdev,
48                                buf_pages(n_sorted, btree_bytes(c)),
49                                REQ_OP_READ|REQ_META,
50                                GFP_NOIO,
51                                &c->btree_bio);
52         bio->bi_iter.bi_sector  = pick.ptr.offset;
53         bch2_bio_map(bio, n_sorted, btree_bytes(c));
54
55         submit_bio_wait(bio);
56
57         bio_put(bio);
58         percpu_ref_put(&ca->io_ref);
59
60         memcpy(n_ondisk, n_sorted, btree_bytes(c));
61
62         v->written = 0;
63         if (bch2_btree_node_read_done(c, ca, v, false))
64                 return false;
65
66         n_sorted = c->verify_data->data;
67         sorted = &n_sorted->keys;
68
69         if (inmemory->u64s != sorted->u64s ||
70             memcmp(inmemory->start,
71                    sorted->start,
72                    vstruct_end(inmemory) - (void *) inmemory->start)) {
73                 unsigned offset = 0, sectors;
74                 struct bset *i;
75                 unsigned j;
76
77                 console_lock();
78
79                 printk(KERN_ERR "*** in memory:\n");
80                 bch2_dump_bset(c, b, inmemory, 0);
81
82                 printk(KERN_ERR "*** read back in:\n");
83                 bch2_dump_bset(c, v, sorted, 0);
84
85                 while (offset < v->written) {
86                         if (!offset) {
87                                 i = &n_ondisk->keys;
88                                 sectors = vstruct_blocks(n_ondisk, c->block_bits) <<
89                                         c->block_bits;
90                         } else {
91                                 struct btree_node_entry *bne =
92                                         (void *) n_ondisk + (offset << 9);
93                                 i = &bne->keys;
94
95                                 sectors = vstruct_blocks(bne, c->block_bits) <<
96                                         c->block_bits;
97                         }
98
99                         printk(KERN_ERR "*** on disk block %u:\n", offset);
100                         bch2_dump_bset(c, b, i, offset);
101
102                         offset += sectors;
103                 }
104
105                 for (j = 0; j < le16_to_cpu(inmemory->u64s); j++)
106                         if (inmemory->_data[j] != sorted->_data[j])
107                                 break;
108
109                 console_unlock();
110                 bch_err(c, "verify failed at key %u", j);
111
112                 failed = true;
113         }
114
115         if (v->written != b->written) {
116                 bch_err(c, "written wrong: expected %u, got %u",
117                         b->written, v->written);
118                 failed = true;
119         }
120
121         return failed;
122 }
123
124 void __bch2_btree_verify(struct bch_fs *c, struct btree *b)
125 {
126         struct bkey_ptrs_c ptrs;
127         struct extent_ptr_decoded p;
128         const union bch_extent_entry *entry;
129         struct btree *v;
130         struct bset *inmemory = &b->data->keys;
131         struct bkey_packed *k;
132         bool failed = false;
133
134         if (c->opts.nochanges)
135                 return;
136
137         bch2_btree_node_io_lock(b);
138         mutex_lock(&c->verify_lock);
139
140         if (!c->verify_ondisk) {
141                 c->verify_ondisk = kvpmalloc(btree_bytes(c), GFP_KERNEL);
142                 if (!c->verify_ondisk)
143                         goto out;
144         }
145
146         if (!c->verify_data) {
147                 c->verify_data = __bch2_btree_node_mem_alloc(c);
148                 if (!c->verify_data)
149                         goto out;
150
151                 list_del_init(&c->verify_data->list);
152         }
153
154         BUG_ON(b->nsets != 1);
155
156         for (k = inmemory->start; k != vstruct_last(inmemory); k = bkey_next(k))
157                 if (k->type == KEY_TYPE_btree_ptr_v2) {
158                         struct bch_btree_ptr_v2 *v = (void *) bkeyp_val(&b->format, k);
159                         v->mem_ptr = 0;
160                 }
161
162         v = c->verify_data;
163         bkey_copy(&v->key, &b->key);
164         v->c.level      = b->c.level;
165         v->c.btree_id   = b->c.btree_id;
166         bch2_btree_keys_init(v);
167
168         ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key));
169         bkey_for_each_ptr_decode(&b->key.k, ptrs, p, entry)
170                 failed |= bch2_btree_verify_replica(c, b, p);
171
172         if (failed) {
173                 struct printbuf buf = PRINTBUF;
174
175                 bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key));
176                 bch2_fs_fatal_error(c, "btree node verify failed for : %s\n", buf.buf);
177                 printbuf_exit(&buf);
178         }
179 out:
180         mutex_unlock(&c->verify_lock);
181         bch2_btree_node_io_unlock(b);
182 }
183
184 #ifdef CONFIG_DEBUG_FS
185
186 /* XXX: bch_fs refcounting */
187
188 struct dump_iter {
189         struct bch_fs           *c;
190         enum btree_id           id;
191         struct bpos             from;
192         struct bpos             prev_node;
193         u64                     iter;
194
195         struct printbuf         buf;
196
197         char __user             *ubuf;  /* destination user buffer */
198         size_t                  size;   /* size of requested read */
199         ssize_t                 ret;    /* bytes read so far */
200 };
201
202 static int flush_buf(struct dump_iter *i)
203 {
204         if (i->buf.pos) {
205                 size_t bytes = min_t(size_t, i->buf.pos, i->size);
206                 int err = copy_to_user(i->ubuf, i->buf.buf, bytes);
207
208                 if (err)
209                         return err;
210
211                 i->ret   += bytes;
212                 i->ubuf  += bytes;
213                 i->size  -= bytes;
214                 i->buf.pos -= bytes;
215                 memmove(i->buf.buf, i->buf.buf + bytes, i->buf.pos);
216         }
217
218         return 0;
219 }
220
221 static int bch2_dump_open(struct inode *inode, struct file *file)
222 {
223         struct btree_debug *bd = inode->i_private;
224         struct dump_iter *i;
225
226         i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
227         if (!i)
228                 return -ENOMEM;
229
230         file->private_data = i;
231         i->from = POS_MIN;
232         i->iter = 0;
233         i->c    = container_of(bd, struct bch_fs, btree_debug[bd->id]);
234         i->id   = bd->id;
235         i->buf  = PRINTBUF;
236
237         return 0;
238 }
239
240 static int bch2_dump_release(struct inode *inode, struct file *file)
241 {
242         struct dump_iter *i = file->private_data;
243
244         printbuf_exit(&i->buf);
245         kfree(i);
246         return 0;
247 }
248
249 static ssize_t bch2_read_btree(struct file *file, char __user *buf,
250                                size_t size, loff_t *ppos)
251 {
252         struct dump_iter *i = file->private_data;
253         struct btree_trans trans;
254         struct btree_iter iter;
255         struct bkey_s_c k;
256         int err;
257
258         i->ubuf = buf;
259         i->size = size;
260         i->ret  = 0;
261
262         bch2_trans_init(&trans, i->c, 0, 0);
263
264         err = for_each_btree_key2(&trans, iter, i->id, i->from,
265                                   BTREE_ITER_PREFETCH|
266                                   BTREE_ITER_ALL_SNAPSHOTS, k, ({
267                 err = flush_buf(i);
268                 if (err)
269                         break;
270
271                 if (!i->size)
272                         break;
273
274                 bch2_bkey_val_to_text(&i->buf, i->c, k);
275                 prt_newline(&i->buf);
276                 0;
277         }));
278         i->from = iter.pos;
279
280         if (!err)
281                 err = flush_buf(i);
282
283         bch2_trans_exit(&trans);
284
285         return err ?: i->ret;
286 }
287
288 static const struct file_operations btree_debug_ops = {
289         .owner          = THIS_MODULE,
290         .open           = bch2_dump_open,
291         .release        = bch2_dump_release,
292         .read           = bch2_read_btree,
293 };
294
295 static ssize_t bch2_read_btree_formats(struct file *file, char __user *buf,
296                                        size_t size, loff_t *ppos)
297 {
298         struct dump_iter *i = file->private_data;
299         struct btree_trans trans;
300         struct btree_iter iter;
301         struct btree *b;
302         int err;
303
304         i->ubuf = buf;
305         i->size = size;
306         i->ret  = 0;
307
308         err = flush_buf(i);
309         if (err)
310                 return err;
311
312         if (!i->size || !bpos_cmp(SPOS_MAX, i->from))
313                 return i->ret;
314
315         bch2_trans_init(&trans, i->c, 0, 0);
316
317         for_each_btree_node(&trans, iter, i->id, i->from, 0, b, err) {
318                 bch2_btree_node_to_text(&i->buf, i->c, b);
319                 err = flush_buf(i);
320                 if (err)
321                         break;
322
323                 /*
324                  * can't easily correctly restart a btree node traversal across
325                  * all nodes, meh
326                  */
327                 i->from = bpos_cmp(SPOS_MAX, b->key.k.p)
328                         ? bpos_successor(b->key.k.p)
329                         : b->key.k.p;
330
331                 if (!i->size)
332                         break;
333         }
334         bch2_trans_iter_exit(&trans, &iter);
335
336         bch2_trans_exit(&trans);
337
338         return err < 0 ? err : i->ret;
339 }
340
341 static const struct file_operations btree_format_debug_ops = {
342         .owner          = THIS_MODULE,
343         .open           = bch2_dump_open,
344         .release        = bch2_dump_release,
345         .read           = bch2_read_btree_formats,
346 };
347
348 static ssize_t bch2_read_bfloat_failed(struct file *file, char __user *buf,
349                                        size_t size, loff_t *ppos)
350 {
351         struct dump_iter *i = file->private_data;
352         struct btree_trans trans;
353         struct btree_iter iter;
354         struct bkey_s_c k;
355         int err;
356
357         i->ubuf = buf;
358         i->size = size;
359         i->ret  = 0;
360
361         err = flush_buf(i);
362         if (err)
363                 return err;
364
365         if (!i->size)
366                 return i->ret;
367
368         bch2_trans_init(&trans, i->c, 0, 0);
369
370         err = for_each_btree_key2(&trans, iter, i->id, i->from,
371                                   BTREE_ITER_PREFETCH|
372                                   BTREE_ITER_ALL_SNAPSHOTS, k, ({
373                 struct btree_path_level *l = &iter.path->l[0];
374                 struct bkey_packed *_k =
375                         bch2_btree_node_iter_peek(&l->iter, l->b);
376
377                 err = flush_buf(i);
378                 if (err)
379                         break;
380
381                 if (!i->size)
382                         break;
383
384                 if (bpos_cmp(l->b->key.k.p, i->prev_node) > 0) {
385                         bch2_btree_node_to_text(&i->buf, i->c, l->b);
386                         i->prev_node = l->b->key.k.p;
387                 }
388
389                 bch2_bfloat_to_text(&i->buf, l->b, _k);
390                 0;
391         }));
392         i->from = iter.pos;
393
394         if (!err)
395                 err = flush_buf(i);
396
397         bch2_trans_exit(&trans);
398
399         return err ?: i->ret;
400 }
401
402 static const struct file_operations bfloat_failed_debug_ops = {
403         .owner          = THIS_MODULE,
404         .open           = bch2_dump_open,
405         .release        = bch2_dump_release,
406         .read           = bch2_read_bfloat_failed,
407 };
408
409 static void bch2_cached_btree_node_to_text(struct printbuf *out, struct bch_fs *c,
410                                            struct btree *b)
411 {
412         out->tabstops[0] = 32;
413
414         prt_printf(out, "%px btree=%s l=%u ",
415                b,
416                bch2_btree_ids[b->c.btree_id],
417                b->c.level);
418         prt_newline(out);
419
420         printbuf_indent_add(out, 2);
421
422         bch2_bkey_val_to_text(out, c, bkey_i_to_s_c(&b->key));
423         prt_newline(out);
424
425         prt_printf(out, "flags: ");
426         prt_tab(out);
427         prt_bitflags(out, bch2_btree_node_flags, b->flags);
428         prt_newline(out);
429
430         prt_printf(out, "pcpu read locks: ");
431         prt_tab(out);
432         prt_printf(out, "%u", b->c.lock.readers != NULL);
433         prt_newline(out);
434
435         prt_printf(out, "written:");
436         prt_tab(out);
437         prt_printf(out, "%u", b->written);
438         prt_newline(out);
439
440         prt_printf(out, "writes blocked:");
441         prt_tab(out);
442         prt_printf(out, "%u", !list_empty_careful(&b->write_blocked));
443         prt_newline(out);
444
445         prt_printf(out, "will make reachable:");
446         prt_tab(out);
447         prt_printf(out, "%lx", b->will_make_reachable);
448         prt_newline(out);
449
450         prt_printf(out, "journal pin %px:", &b->writes[0].journal);
451         prt_tab(out);
452         prt_printf(out, "%llu", b->writes[0].journal.seq);
453         prt_newline(out);
454
455         prt_printf(out, "journal pin %px:", &b->writes[1].journal);
456         prt_tab(out);
457         prt_printf(out, "%llu", b->writes[1].journal.seq);
458         prt_newline(out);
459
460         printbuf_indent_sub(out, 2);
461 }
462
463 static ssize_t bch2_cached_btree_nodes_read(struct file *file, char __user *buf,
464                                             size_t size, loff_t *ppos)
465 {
466         struct dump_iter *i = file->private_data;
467         struct bch_fs *c = i->c;
468         bool done = false;
469         int err;
470
471         i->ubuf = buf;
472         i->size = size;
473         i->ret  = 0;
474
475         do {
476                 struct bucket_table *tbl;
477                 struct rhash_head *pos;
478                 struct btree *b;
479
480                 err = flush_buf(i);
481                 if (err)
482                         return err;
483
484                 if (!i->size)
485                         break;
486
487                 rcu_read_lock();
488                 i->buf.atomic++;
489                 tbl = rht_dereference_rcu(c->btree_cache.table.tbl,
490                                           &c->btree_cache.table);
491                 if (i->iter < tbl->size) {
492                         rht_for_each_entry_rcu(b, pos, tbl, i->iter, hash)
493                                 bch2_cached_btree_node_to_text(&i->buf, c, b);
494                         i->iter++;;
495                 } else {
496                         done = true;
497                 }
498                 --i->buf.atomic;
499                 rcu_read_unlock();
500         } while (!done);
501
502         if (i->buf.allocation_failure)
503                 return -ENOMEM;
504
505         return i->ret;
506 }
507
508 static const struct file_operations cached_btree_nodes_ops = {
509         .owner          = THIS_MODULE,
510         .open           = bch2_dump_open,
511         .release        = bch2_dump_release,
512         .read           = bch2_cached_btree_nodes_read,
513 };
514
515 static int prt_backtrace(struct printbuf *out, struct task_struct *task)
516 {
517         unsigned long entries[32];
518         unsigned i, nr_entries;
519         int ret;
520
521         ret = down_read_killable(&task->signal->exec_update_lock);
522         if (ret)
523                 return ret;
524
525         nr_entries = stack_trace_save_tsk(task, entries, ARRAY_SIZE(entries), 0);
526         for (i = 0; i < nr_entries; i++) {
527                 prt_printf(out, "[<0>] %pB", (void *)entries[i]);
528                 prt_newline(out);
529         }
530
531         up_read(&task->signal->exec_update_lock);
532         return 0;
533 }
534
535 static ssize_t bch2_btree_transactions_read(struct file *file, char __user *buf,
536                                             size_t size, loff_t *ppos)
537 {
538         struct dump_iter *i = file->private_data;
539         struct bch_fs *c = i->c;
540         struct btree_trans *trans;
541         int err;
542
543         i->ubuf = buf;
544         i->size = size;
545         i->ret  = 0;
546
547         mutex_lock(&c->btree_trans_lock);
548         list_for_each_entry(trans, &c->btree_trans_list, list) {
549                 if (trans->task->pid <= i->iter)
550                         continue;
551
552                 err = flush_buf(i);
553                 if (err)
554                         return err;
555
556                 if (!i->size)
557                         break;
558
559                 bch2_btree_trans_to_text(&i->buf, trans);
560
561                 prt_printf(&i->buf, "backtrace:");
562                 prt_newline(&i->buf);
563                 printbuf_indent_add(&i->buf, 2);
564                 prt_backtrace(&i->buf, trans->task);
565                 printbuf_indent_sub(&i->buf, 2);
566                 prt_newline(&i->buf);
567
568                 i->iter = trans->task->pid;
569         }
570         mutex_unlock(&c->btree_trans_lock);
571
572         if (i->buf.allocation_failure)
573                 return -ENOMEM;
574
575         return i->ret;
576 }
577
578 static const struct file_operations btree_transactions_ops = {
579         .owner          = THIS_MODULE,
580         .open           = bch2_dump_open,
581         .release        = bch2_dump_release,
582         .read           = bch2_btree_transactions_read,
583 };
584
585 static ssize_t bch2_journal_pins_read(struct file *file, char __user *buf,
586                                       size_t size, loff_t *ppos)
587 {
588         struct dump_iter *i = file->private_data;
589         struct bch_fs *c = i->c;
590         bool done = false;
591         int err;
592
593         i->ubuf = buf;
594         i->size = size;
595         i->ret  = 0;
596
597         do {
598                 err = flush_buf(i);
599                 if (err)
600                         return err;
601
602                 if (!i->size)
603                         break;
604
605                 done = bch2_journal_seq_pins_to_text(&i->buf, &c->journal, &i->iter);
606                 i->iter++;
607         } while (!done);
608
609         if (i->buf.allocation_failure)
610                 return -ENOMEM;
611
612         return i->ret;
613 }
614
615 static const struct file_operations journal_pins_ops = {
616         .owner          = THIS_MODULE,
617         .open           = bch2_dump_open,
618         .release        = bch2_dump_release,
619         .read           = bch2_journal_pins_read,
620 };
621
622 static int lock_held_stats_open(struct inode *inode, struct file *file)
623 {
624         struct bch_fs *c = inode->i_private;
625         struct dump_iter *i;
626
627         i = kzalloc(sizeof(struct dump_iter), GFP_KERNEL);
628
629         if (!i)
630                 return -ENOMEM;
631
632         i->iter = 0;
633         i->c    = c;
634         i->buf  = PRINTBUF;
635         file->private_data = i;
636
637         return 0;
638 }
639
640 static int lock_held_stats_release(struct inode *inode, struct file *file)
641 {
642         struct dump_iter *i = file->private_data;
643
644         printbuf_exit(&i->buf);
645         kfree(i);
646
647         return 0;
648 }
649
650 static ssize_t lock_held_stats_read(struct file *file, char __user *buf,
651                                       size_t size, loff_t *ppos)
652 {
653         struct dump_iter        *i = file->private_data;
654         struct lock_held_stats *lhs = &i->c->lock_held_stats;
655         int err;
656
657         i->ubuf = buf;
658         i->size = size;
659         i->ret  = 0;
660
661         while (lhs->names[i->iter] != 0 && i->iter < BCH_LOCK_TIME_NR) {
662                 err = flush_buf(i);
663                 if (err)
664                         return err;
665
666                 if (!i->size)
667                         break;
668
669                 prt_printf(&i->buf, "%s:", lhs->names[i->iter]);
670                 prt_newline(&i->buf);
671                 printbuf_indent_add(&i->buf, 8);
672                 bch2_time_stats_to_text(&i->buf, &lhs->times[i->iter]);
673                 printbuf_indent_sub(&i->buf, 8);
674                 prt_newline(&i->buf);
675                 i->iter++;
676         }
677
678         if (i->buf.allocation_failure)
679                 return -ENOMEM;
680
681         return i->ret;
682 }
683
684 static const struct file_operations lock_held_stats_op = {
685         .owner = THIS_MODULE,
686         .open = lock_held_stats_open,
687         .release = lock_held_stats_release,
688         .read = lock_held_stats_read,
689 };
690
691 void bch2_fs_debug_exit(struct bch_fs *c)
692 {
693         if (!IS_ERR_OR_NULL(c->fs_debug_dir))
694                 debugfs_remove_recursive(c->fs_debug_dir);
695 }
696
697 void bch2_fs_debug_init(struct bch_fs *c)
698 {
699         struct btree_debug *bd;
700         char name[100];
701
702         if (IS_ERR_OR_NULL(bch_debug))
703                 return;
704
705         snprintf(name, sizeof(name), "%pU", c->sb.user_uuid.b);
706         c->fs_debug_dir = debugfs_create_dir(name, bch_debug);
707         if (IS_ERR_OR_NULL(c->fs_debug_dir))
708                 return;
709
710         debugfs_create_file("cached_btree_nodes", 0400, c->fs_debug_dir,
711                             c->btree_debug, &cached_btree_nodes_ops);
712
713         debugfs_create_file("btree_transactions", 0400, c->fs_debug_dir,
714                             c->btree_debug, &btree_transactions_ops);
715
716         debugfs_create_file("journal_pins", 0400, c->fs_debug_dir,
717                             c->btree_debug, &journal_pins_ops);
718
719         if (IS_ENABLED(CONFIG_BCACHEFS_LOCK_TIME_STATS)) {
720                 debugfs_create_file("lock_held_stats", 0400, c->fs_debug_dir,
721                                 c, &lock_held_stats_op);
722         }
723
724         c->btree_debug_dir = debugfs_create_dir("btrees", c->fs_debug_dir);
725         if (IS_ERR_OR_NULL(c->btree_debug_dir))
726                 return;
727
728         for (bd = c->btree_debug;
729              bd < c->btree_debug + ARRAY_SIZE(c->btree_debug);
730              bd++) {
731                 bd->id = bd - c->btree_debug;
732                 debugfs_create_file(bch2_btree_ids[bd->id],
733                                     0400, c->btree_debug_dir, bd,
734                                     &btree_debug_ops);
735
736                 snprintf(name, sizeof(name), "%s-formats",
737                          bch2_btree_ids[bd->id]);
738
739                 debugfs_create_file(name, 0400, c->btree_debug_dir, bd,
740                                     &btree_format_debug_ops);
741
742                 snprintf(name, sizeof(name), "%s-bfloat-failed",
743                          bch2_btree_ids[bd->id]);
744
745                 debugfs_create_file(name, 0400, c->btree_debug_dir, bd,
746                                     &bfloat_failed_debug_ops);
747         }
748 }
749
750 #endif
751
752 void bch2_debug_exit(void)
753 {
754         if (!IS_ERR_OR_NULL(bch_debug))
755                 debugfs_remove_recursive(bch_debug);
756 }
757
758 int __init bch2_debug_init(void)
759 {
760         int ret = 0;
761
762         bch_debug = debugfs_create_dir("bcachefs", NULL);
763         return ret;
764 }