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

   1 #include <fcntl.h>
   2 #include <string.h>
   3 #include <sys/stat.h>
   4 #include <sys/types.h>
   5
   6 #include "cmds.h"
   7 #include "libbcachefs.h"
   8 #include "qcow2.h"
   9 #include "tools-util.h"
  10
  11 #include "libbcachefs/bcachefs.h"
  12 #include "libbcachefs/btree_cache.h"
  13 #include "libbcachefs/btree_io.h"
  14 #include "libbcachefs/btree_iter.h"
  15 #include "libbcachefs/checksum.h"
  16 #include "libbcachefs/error.h"
  17 #include "libbcachefs/extents.h"
  18 #include "libbcachefs/super.h"
  19
  20 static void list_keys(struct bch_fs *c, enum btree_id btree_id,
  21                       struct bpos start, struct bpos end)
  22 {
  23         struct btree_trans trans;
  24         struct btree_iter iter;
  25         struct bkey_s_c k;
  26         struct printbuf buf = PRINTBUF;
  27         int ret;
  28
  29         bch2_trans_init(&trans, c, 0, 0);
  30
  31         for_each_btree_key(&trans, iter, btree_id, start,
  32                            BTREE_ITER_ALL_SNAPSHOTS|
  33                            BTREE_ITER_PREFETCH, k, ret) {
  34                 if (bkey_cmp(k.k->p, end) > 0)
  35                         break;
  36
  37                 printbuf_reset(&buf);
  38                 bch2_bkey_val_to_text(&buf, c, k);
  39                 puts(buf.buf);
  40         }
  41         bch2_trans_iter_exit(&trans, &iter);
  42
  43         bch2_trans_exit(&trans);
  44
  45         printbuf_exit(&buf);
  46 }
  47
  48 static void list_btree_formats(struct bch_fs *c, enum btree_id btree_id, unsigned level,
  49                                struct bpos start, struct bpos end)
  50 {
  51         struct btree_trans trans;
  52         struct btree_iter iter;
  53         struct btree *b;
  54         struct printbuf buf = PRINTBUF;
  55         int ret;
  56
  57         bch2_trans_init(&trans, c, 0, 0);
  58
  59         __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) {
  60                 if (bkey_cmp(b->key.k.p, end) > 0)
  61                         break;
  62
  63                 printbuf_reset(&buf);
  64                 bch2_btree_node_to_text(&buf, c, b);
  65                 puts(buf.buf);
  66         }
  67         bch2_trans_iter_exit(&trans, &iter);
  68
  69         if (ret)
  70                 die("error %s walking btree nodes", strerror(-ret));
  71
  72         bch2_trans_exit(&trans);
  73         printbuf_exit(&buf);
  74 }
  75
  76 static void list_nodes(struct bch_fs *c, enum btree_id btree_id, unsigned level,
  77                        struct bpos start, struct bpos end)
  78 {
  79         struct btree_trans trans;
  80         struct btree_iter iter;
  81         struct btree *b;
  82         struct printbuf buf = PRINTBUF;
  83         int ret;
  84
  85         bch2_trans_init(&trans, c, 0, 0);
  86
  87         __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) {
  88                 if (bkey_cmp(b->key.k.p, end) > 0)
  89                         break;
  90
  91                 printbuf_reset(&buf);
  92                 bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key));
  93                 fputs(buf.buf, stdout);
  94                 putchar('\n');
  95         }
  96         bch2_trans_iter_exit(&trans, &iter);
  97
  98         if (ret)
  99                 die("error %s walking btree nodes", strerror(-ret));
 100
 101         bch2_trans_exit(&trans);
 102         printbuf_exit(&buf);
 103 }
 104
 105 static void print_node_ondisk(struct bch_fs *c, struct btree *b)
 106 {
 107         struct btree_node *n_ondisk;
 108         struct extent_ptr_decoded pick;
 109         struct bch_dev *ca;
 110         struct bio *bio;
 111         unsigned offset = 0;
 112
 113         if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) {
 114                 printf("error getting device to read from\n");
 115                 return;
 116         }
 117
 118         ca = bch_dev_bkey_exists(c, pick.ptr.dev);
 119         if (!bch2_dev_get_ioref(ca, READ)) {
 120                 printf("error getting device to read from\n");
 121                 return;
 122         }
 123
 124         n_ondisk = malloc(btree_bytes(c));
 125
 126         bio = bio_alloc_bioset(ca->disk_sb.bdev,
 127                                buf_pages(n_ondisk, btree_bytes(c)),
 128                                REQ_OP_READ|REQ_META,
 129                                GFP_NOIO,
 130                                &c->btree_bio);
 131         bio->bi_iter.bi_sector  = pick.ptr.offset;
 132         bch2_bio_map(bio, n_ondisk, btree_bytes(c));
 133
 134         submit_bio_wait(bio);
 135
 136         bio_put(bio);
 137         percpu_ref_put(&ca->io_ref);
 138
 139         while (offset < btree_sectors(c)) {
 140                 struct bset *i;
 141                 struct nonce nonce;
 142                 struct bch_csum csum;
 143                 struct bkey_packed *k;
 144                 unsigned sectors;
 145
 146                 if (!offset) {
 147                         i = &n_ondisk->keys;
 148
 149                         if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i)))
 150                                 die("unknown checksum type");
 151
 152                         nonce = btree_nonce(i, offset << 9);
 153                         csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk);
 154
 155                         if (bch2_crc_cmp(csum, n_ondisk->csum))
 156                                 die("invalid checksum\n");
 157
 158                         bset_encrypt(c, i, offset << 9);
 159
 160                         sectors = vstruct_sectors(n_ondisk, c->block_bits);
 161                 } else {
 162                         struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9);
 163
 164                         i = &bne->keys;
 165
 166                         if (i->seq != n_ondisk->keys.seq)
 167                                 break;
 168
 169                         if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i)))
 170                                 die("unknown checksum type");
 171
 172                         nonce = btree_nonce(i, offset << 9);
 173                         csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne);
 174
 175                         if (bch2_crc_cmp(csum, bne->csum))
 176                                 die("invalid checksum");
 177
 178                         bset_encrypt(c, i, offset << 9);
 179
 180                         sectors = vstruct_sectors(bne, c->block_bits);
 181                 }
 182
 183                 fprintf(stdout, "  offset %u version %u, journal seq %llu\n",
 184                         offset,
 185                         le16_to_cpu(i->version),
 186                         le64_to_cpu(i->journal_seq));
 187                 offset += sectors;
 188
 189                 for (k = i->start; k != vstruct_last(i); k = bkey_next(k)) {
 190                         struct bkey u;
 191                         struct printbuf buf = PRINTBUF;
 192
 193                         bch2_bkey_val_to_text(&buf, c, bkey_disassemble(b, k, &u));
 194                         fprintf(stdout, "    %s\n", buf.buf);
 195
 196                         printbuf_exit(&buf);
 197                 }
 198         }
 199
 200         free(n_ondisk);
 201 }
 202
 203 static void list_nodes_ondisk(struct bch_fs *c, enum btree_id btree_id, unsigned level,
 204                               struct bpos start, struct bpos end)
 205 {
 206         struct btree_trans trans;
 207         struct btree_iter iter;
 208         struct btree *b;
 209         struct printbuf buf = PRINTBUF;
 210         int ret;
 211
 212         bch2_trans_init(&trans, c, 0, 0);
 213
 214         __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) {
 215                 if (bkey_cmp(b->key.k.p, end) > 0)
 216                         break;
 217
 218                 printbuf_reset(&buf);
 219                 bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key));
 220                 fputs(buf.buf, stdout);
 221                 putchar('\n');
 222
 223                 print_node_ondisk(c, b);
 224         }
 225         bch2_trans_iter_exit(&trans, &iter);
 226
 227         if (ret)
 228                 die("error %s walking btree nodes", strerror(-ret));
 229
 230         bch2_trans_exit(&trans);
 231         printbuf_exit(&buf);
 232 }
 233
 234 static void list_nodes_keys(struct bch_fs *c, enum btree_id btree_id, unsigned level,
 235                             struct bpos start, struct bpos end)
 236 {
 237         struct btree_trans trans;
 238         struct btree_iter iter;
 239         struct btree_node_iter node_iter;
 240         struct bkey unpacked;
 241         struct bkey_s_c k;
 242         struct btree *b;
 243         struct printbuf buf = PRINTBUF;
 244         int ret;
 245
 246         bch2_trans_init(&trans, c, 0, 0);
 247
 248         __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) {
 249                 if (bkey_cmp(b->key.k.p, end) > 0)
 250                         break;
 251
 252                 printbuf_reset(&buf);
 253                 bch2_btree_node_to_text(&buf, c, b);
 254                 fputs(buf.buf, stdout);
 255
 256                 for_each_btree_node_key_unpack(b, k, &node_iter, &unpacked) {
 257                         printbuf_reset(&buf);
 258                         bch2_bkey_val_to_text(&buf, c, k);
 259                         putchar('\t');
 260                         puts(buf.buf);
 261                 }
 262         }
 263         bch2_trans_iter_exit(&trans, &iter);
 264
 265         if (ret)
 266                 die("error %s walking btree nodes", strerror(-ret));
 267
 268         bch2_trans_exit(&trans);
 269         printbuf_exit(&buf);
 270 }
 271
 272 static void list_keys_usage(void)
 273 {
 274         puts("bcachefs list - list filesystem metadata to stdout\n"
 275              "Usage: bcachefs list [OPTION]... <devices>\n"
 276              "\n"
 277              "Options:\n"
 278              "  -b (extents|inodes|dirents|xattrs)    Btree to list from\n"
 279              "  -l level                              Btree depth to descend to (0 == leaves)\n"
 280              "  -s inode:offset                       Start position to list from\n"
 281              "  -e inode:offset                       End position\n"
 282              "  -i inode                              List keys for a given inode number\n"
 283              "  -m (keys|formats|nodes|nodes_ondisk|nodes_keys)\n"
 284              "                                        List mode\n"
 285              "  -f                                    Check (fsck) the filesystem first\n"
 286              "  -v                                    Verbose mode\n"
 287              "  -h                                    Display this help and exit\n"
 288              "Report bugs to <linux-bcachefs@vger.kernel.org>");
 289 }
 290
 291 #define LIST_MODES()            \
 292         x(keys)                 \
 293         x(formats)              \
 294         x(nodes)                \
 295         x(nodes_ondisk)         \
 296         x(nodes_keys)
 297
 298 enum list_modes {
 299 #define x(n)    LIST_MODE_##n,
 300         LIST_MODES()
 301 #undef x
 302 };
 303
 304 static const char * const list_modes[] = {
 305 #define x(n)    #n,
 306         LIST_MODES()
 307 #undef x
 308         NULL
 309 };
 310
 311 int cmd_list(int argc, char *argv[])
 312 {
 313         struct bch_opts opts = bch2_opts_empty();
 314         enum btree_id btree_id_start    = 0;
 315         enum btree_id btree_id_end      = BTREE_ID_NR;
 316         enum btree_id btree_id;
 317         unsigned level = 0;
 318         struct bpos start = POS_MIN, end = POS_MAX;
 319         u64 inum = 0;
 320         int mode = 0, opt;
 321
 322         opt_set(opts, nochanges,        true);
 323         opt_set(opts, norecovery,       true);
 324         opt_set(opts, degraded,         true);
 325         opt_set(opts, errors,           BCH_ON_ERROR_continue);
 326
 327         while ((opt = getopt(argc, argv, "b:l:s:e:i:m:fvh")) != -1)
 328                 switch (opt) {
 329                 case 'b':
 330                         btree_id_start = read_string_list_or_die(optarg,
 331                                                 bch2_btree_ids, "btree id");
 332                         btree_id_end = btree_id_start + 1;
 333                         break;
 334                 case 'l':
 335                         if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH)
 336                                 die("invalid level");
 337                         break;
 338                 case 's':
 339                         start   = bpos_parse(optarg);
 340                         break;
 341                 case 'e':
 342                         end     = bpos_parse(optarg);
 343                         break;
 344                 case 'i':
 345                         if (kstrtoull(optarg, 10, &inum))
 346                                 die("invalid inode %s", optarg);
 347                         start   = POS(inum, 0);
 348                         end     = POS(inum + 1, 0);
 349                         break;
 350                 case 'm':
 351                         mode = read_string_list_or_die(optarg,
 352                                                 list_modes, "list mode");
 353                         break;
 354                 case 'f':
 355                         opt_set(opts, fix_errors, FSCK_OPT_YES);
 356                         opt_set(opts, norecovery, false);
 357                         break;
 358                 case 'v':
 359                         opt_set(opts, verbose, true);
 360                         break;
 361                 case 'h':
 362                         list_keys_usage();
 363                         exit(EXIT_SUCCESS);
 364                 }
 365         args_shift(optind);
 366
 367         if (!argc)
 368                 die("Please supply device(s)");
 369
 370         struct bch_fs *c = bch2_fs_open(argv, argc, opts);
 371         if (IS_ERR(c))
 372                 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
 373
 374
 375         for (btree_id = btree_id_start;
 376              btree_id < btree_id_end;
 377              btree_id++) {
 378                 switch (mode) {
 379                 case LIST_MODE_keys:
 380                         list_keys(c, btree_id, start, end);
 381                         break;
 382                 case LIST_MODE_formats:
 383                         list_btree_formats(c, btree_id, level, start, end);
 384                         break;
 385                 case LIST_MODE_nodes:
 386                         list_nodes(c, btree_id, level, start, end);
 387                         break;
 388                 case LIST_MODE_nodes_ondisk:
 389                         list_nodes_ondisk(c, btree_id, level, start, end);
 390                         break;
 391                 case LIST_MODE_nodes_keys:
 392                         list_nodes_keys(c, btree_id, level, start, end);
 393                         break;
 394                 default:
 395                         die("Invalid mode");
 396                 }
 397         }
 398
 399         bch2_fs_stop(c);
 400         return 0;
 401 }