fs/btrfs/print-tree.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2007 Oracle.  All rights reserved.
   4  */
   5
   6 #include "messages.h"
   7 #include "ctree.h"
   8 #include "disk-io.h"
   9 #include "print-tree.h"
  10 #include "accessors.h"
  11 #include "tree-checker.h"
  12
  13 struct root_name_map {
  14         u64 id;
  15         char name[16];
  16 };
  17
  18 static const struct root_name_map root_map[] = {
  19         { BTRFS_ROOT_TREE_OBJECTID,             "ROOT_TREE"             },
  20         { BTRFS_EXTENT_TREE_OBJECTID,           "EXTENT_TREE"           },
  21         { BTRFS_CHUNK_TREE_OBJECTID,            "CHUNK_TREE"            },
  22         { BTRFS_DEV_TREE_OBJECTID,              "DEV_TREE"              },
  23         { BTRFS_FS_TREE_OBJECTID,               "FS_TREE"               },
  24         { BTRFS_CSUM_TREE_OBJECTID,             "CSUM_TREE"             },
  25         { BTRFS_TREE_LOG_OBJECTID,              "TREE_LOG"              },
  26         { BTRFS_QUOTA_TREE_OBJECTID,            "QUOTA_TREE"            },
  27         { BTRFS_UUID_TREE_OBJECTID,             "UUID_TREE"             },
  28         { BTRFS_FREE_SPACE_TREE_OBJECTID,       "FREE_SPACE_TREE"       },
  29         { BTRFS_BLOCK_GROUP_TREE_OBJECTID,      "BLOCK_GROUP_TREE"      },
  30         { BTRFS_DATA_RELOC_TREE_OBJECTID,       "DATA_RELOC_TREE"       },
  31 };
  32
  33 const char *btrfs_root_name(const struct btrfs_key *key, char *buf)
  34 {
  35         int i;
  36
  37         if (key->objectid == BTRFS_TREE_RELOC_OBJECTID) {
  38                 snprintf(buf, BTRFS_ROOT_NAME_BUF_LEN,
  39                          "TREE_RELOC offset=%llu", key->offset);
  40                 return buf;
  41         }
  42
  43         for (i = 0; i < ARRAY_SIZE(root_map); i++) {
  44                 if (root_map[i].id == key->objectid)
  45                         return root_map[i].name;
  46         }
  47
  48         snprintf(buf, BTRFS_ROOT_NAME_BUF_LEN, "%llu", key->objectid);
  49         return buf;
  50 }
  51
  52 static void print_chunk(const struct extent_buffer *eb, struct btrfs_chunk *chunk)
  53 {
  54         int num_stripes = btrfs_chunk_num_stripes(eb, chunk);
  55         int i;
  56         pr_info("\t\tchunk length %llu owner %llu type %llu num_stripes %d\n",
  57                btrfs_chunk_length(eb, chunk), btrfs_chunk_owner(eb, chunk),
  58                btrfs_chunk_type(eb, chunk), num_stripes);
  59         for (i = 0 ; i < num_stripes ; i++) {
  60                 pr_info("\t\t\tstripe %d devid %llu offset %llu\n", i,
  61                       btrfs_stripe_devid_nr(eb, chunk, i),
  62                       btrfs_stripe_offset_nr(eb, chunk, i));
  63         }
  64 }
  65 static void print_dev_item(const struct extent_buffer *eb,
  66                            struct btrfs_dev_item *dev_item)
  67 {
  68         pr_info("\t\tdev item devid %llu total_bytes %llu bytes used %llu\n",
  69                btrfs_device_id(eb, dev_item),
  70                btrfs_device_total_bytes(eb, dev_item),
  71                btrfs_device_bytes_used(eb, dev_item));
  72 }
  73 static void print_extent_data_ref(const struct extent_buffer *eb,
  74                                   struct btrfs_extent_data_ref *ref)
  75 {
  76         pr_cont("extent data backref root %llu objectid %llu offset %llu count %u\n",
  77                btrfs_extent_data_ref_root(eb, ref),
  78                btrfs_extent_data_ref_objectid(eb, ref),
  79                btrfs_extent_data_ref_offset(eb, ref),
  80                btrfs_extent_data_ref_count(eb, ref));
  81 }
  82
  83 static void print_extent_item(const struct extent_buffer *eb, int slot, int type)
  84 {
  85         struct btrfs_extent_item *ei;
  86         struct btrfs_extent_inline_ref *iref;
  87         struct btrfs_extent_data_ref *dref;
  88         struct btrfs_shared_data_ref *sref;
  89         struct btrfs_disk_key key;
  90         unsigned long end;
  91         unsigned long ptr;
  92         u32 item_size = btrfs_item_size(eb, slot);
  93         u64 flags;
  94         u64 offset;
  95         int ref_index = 0;
  96
  97         if (unlikely(item_size < sizeof(*ei))) {
  98                 btrfs_err(eb->fs_info,
  99                           "unexpected extent item size, has %u expect >= %zu",
 100                           item_size, sizeof(*ei));
 101                 btrfs_handle_fs_error(eb->fs_info, -EUCLEAN, NULL);
 102         }
 103
 104         ei = btrfs_item_ptr(eb, slot, struct btrfs_extent_item);
 105         flags = btrfs_extent_flags(eb, ei);
 106
 107         pr_info("\t\textent refs %llu gen %llu flags %llu\n",
 108                btrfs_extent_refs(eb, ei), btrfs_extent_generation(eb, ei),
 109                flags);
 110
 111         if ((type == BTRFS_EXTENT_ITEM_KEY) &&
 112             flags & BTRFS_EXTENT_FLAG_TREE_BLOCK) {
 113                 struct btrfs_tree_block_info *info;
 114                 info = (struct btrfs_tree_block_info *)(ei + 1);
 115                 btrfs_tree_block_key(eb, info, &key);
 116                 pr_info("\t\ttree block key (%llu %u %llu) level %d\n",
 117                        btrfs_disk_key_objectid(&key), key.type,
 118                        btrfs_disk_key_offset(&key),
 119                        btrfs_tree_block_level(eb, info));
 120                 iref = (struct btrfs_extent_inline_ref *)(info + 1);
 121         } else {
 122                 iref = (struct btrfs_extent_inline_ref *)(ei + 1);
 123         }
 124
 125         ptr = (unsigned long)iref;
 126         end = (unsigned long)ei + item_size;
 127         while (ptr < end) {
 128                 iref = (struct btrfs_extent_inline_ref *)ptr;
 129                 type = btrfs_extent_inline_ref_type(eb, iref);
 130                 offset = btrfs_extent_inline_ref_offset(eb, iref);
 131                 pr_info("\t\tref#%d: ", ref_index++);
 132                 switch (type) {
 133                 case BTRFS_TREE_BLOCK_REF_KEY:
 134                         pr_cont("tree block backref root %llu\n", offset);
 135                         break;
 136                 case BTRFS_SHARED_BLOCK_REF_KEY:
 137                         pr_cont("shared block backref parent %llu\n", offset);
 138                         /*
 139                          * offset is supposed to be a tree block which
 140                          * must be aligned to nodesize.
 141                          */
 142                         if (!IS_ALIGNED(offset, eb->fs_info->sectorsize))
 143                                 pr_info(
 144                         "\t\t\t(parent %llu not aligned to sectorsize %u)\n",
 145                                         offset, eb->fs_info->sectorsize);
 146                         break;
 147                 case BTRFS_EXTENT_DATA_REF_KEY:
 148                         dref = (struct btrfs_extent_data_ref *)(&iref->offset);
 149                         print_extent_data_ref(eb, dref);
 150                         break;
 151                 case BTRFS_SHARED_DATA_REF_KEY:
 152                         sref = (struct btrfs_shared_data_ref *)(iref + 1);
 153                         pr_cont("shared data backref parent %llu count %u\n",
 154                                offset, btrfs_shared_data_ref_count(eb, sref));
 155                         /*
 156                          * Offset is supposed to be a tree block which must be
 157                          * aligned to sectorsize.
 158                          */
 159                         if (!IS_ALIGNED(offset, eb->fs_info->sectorsize))
 160                                 pr_info(
 161                         "\t\t\t(parent %llu not aligned to sectorsize %u)\n",
 162                                      offset, eb->fs_info->sectorsize);
 163                         break;
 164                 default:
 165                         pr_cont("(extent %llu has INVALID ref type %d)\n",
 166                                   eb->start, type);
 167                         return;
 168                 }
 169                 ptr += btrfs_extent_inline_ref_size(type);
 170         }
 171         WARN_ON(ptr > end);
 172 }
 173
 174 static void print_uuid_item(const struct extent_buffer *l, unsigned long offset,
 175                             u32 item_size)
 176 {
 177         if (!IS_ALIGNED(item_size, sizeof(u64))) {
 178                 pr_warn("BTRFS: uuid item with illegal size %lu!\n",
 179                         (unsigned long)item_size);
 180                 return;
 181         }
 182         while (item_size) {
 183                 __le64 subvol_id;
 184
 185                 read_extent_buffer(l, &subvol_id, offset, sizeof(subvol_id));
 186                 pr_info("\t\tsubvol_id %llu\n", le64_to_cpu(subvol_id));
 187                 item_size -= sizeof(u64);
 188                 offset += sizeof(u64);
 189         }
 190 }
 191
 192 /*
 193  * Helper to output refs and locking status of extent buffer.  Useful to debug
 194  * race condition related problems.
 195  */
 196 static void print_eb_refs_lock(const struct extent_buffer *eb)
 197 {
 198 #ifdef CONFIG_BTRFS_DEBUG
 199         btrfs_info(eb->fs_info, "refs %u lock_owner %u current %u",
 200                    atomic_read(&eb->refs), eb->lock_owner, current->pid);
 201 #endif
 202 }
 203
 204 void btrfs_print_leaf(const struct extent_buffer *l)
 205 {
 206         struct btrfs_fs_info *fs_info;
 207         int i;
 208         u32 type, nr;
 209         struct btrfs_root_item *ri;
 210         struct btrfs_dir_item *di;
 211         struct btrfs_inode_item *ii;
 212         struct btrfs_block_group_item *bi;
 213         struct btrfs_file_extent_item *fi;
 214         struct btrfs_extent_data_ref *dref;
 215         struct btrfs_shared_data_ref *sref;
 216         struct btrfs_dev_extent *dev_extent;
 217         struct btrfs_key key;
 218         struct btrfs_key found_key;
 219
 220         if (!l)
 221                 return;
 222
 223         fs_info = l->fs_info;
 224         nr = btrfs_header_nritems(l);
 225
 226         btrfs_info(fs_info,
 227                    "leaf %llu gen %llu total ptrs %d free space %d owner %llu",
 228                    btrfs_header_bytenr(l), btrfs_header_generation(l), nr,
 229                    btrfs_leaf_free_space(l), btrfs_header_owner(l));
 230         print_eb_refs_lock(l);
 231         for (i = 0 ; i < nr ; i++) {
 232                 btrfs_item_key_to_cpu(l, &key, i);
 233                 type = key.type;
 234                 pr_info("\titem %d key (%llu %u %llu) itemoff %d itemsize %d\n",
 235                         i, key.objectid, type, key.offset,
 236                         btrfs_item_offset(l, i), btrfs_item_size(l, i));
 237                 switch (type) {
 238                 case BTRFS_INODE_ITEM_KEY:
 239                         ii = btrfs_item_ptr(l, i, struct btrfs_inode_item);
 240                         pr_info("\t\tinode generation %llu size %llu mode %o\n",
 241                                btrfs_inode_generation(l, ii),
 242                                btrfs_inode_size(l, ii),
 243                                btrfs_inode_mode(l, ii));
 244                         break;
 245                 case BTRFS_DIR_ITEM_KEY:
 246                         di = btrfs_item_ptr(l, i, struct btrfs_dir_item);
 247                         btrfs_dir_item_key_to_cpu(l, di, &found_key);
 248                         pr_info("\t\tdir oid %llu flags %u\n",
 249                                 found_key.objectid,
 250                                 btrfs_dir_flags(l, di));
 251                         break;
 252                 case BTRFS_ROOT_ITEM_KEY:
 253                         ri = btrfs_item_ptr(l, i, struct btrfs_root_item);
 254                         pr_info("\t\troot data bytenr %llu refs %u\n",
 255                                 btrfs_disk_root_bytenr(l, ri),
 256                                 btrfs_disk_root_refs(l, ri));
 257                         break;
 258                 case BTRFS_EXTENT_ITEM_KEY:
 259                 case BTRFS_METADATA_ITEM_KEY:
 260                         print_extent_item(l, i, type);
 261                         break;
 262                 case BTRFS_TREE_BLOCK_REF_KEY:
 263                         pr_info("\t\ttree block backref\n");
 264                         break;
 265                 case BTRFS_SHARED_BLOCK_REF_KEY:
 266                         pr_info("\t\tshared block backref\n");
 267                         break;
 268                 case BTRFS_EXTENT_DATA_REF_KEY:
 269                         dref = btrfs_item_ptr(l, i,
 270                                               struct btrfs_extent_data_ref);
 271                         print_extent_data_ref(l, dref);
 272                         break;
 273                 case BTRFS_SHARED_DATA_REF_KEY:
 274                         sref = btrfs_item_ptr(l, i,
 275                                               struct btrfs_shared_data_ref);
 276                         pr_info("\t\tshared data backref count %u\n",
 277                                btrfs_shared_data_ref_count(l, sref));
 278                         break;
 279                 case BTRFS_EXTENT_DATA_KEY:
 280                         fi = btrfs_item_ptr(l, i,
 281                                             struct btrfs_file_extent_item);
 282                         if (btrfs_file_extent_type(l, fi) ==
 283                             BTRFS_FILE_EXTENT_INLINE) {
 284                                 pr_info("\t\tinline extent data size %llu\n",
 285                                        btrfs_file_extent_ram_bytes(l, fi));
 286                                 break;
 287                         }
 288                         pr_info("\t\textent data disk bytenr %llu nr %llu\n",
 289                                btrfs_file_extent_disk_bytenr(l, fi),
 290                                btrfs_file_extent_disk_num_bytes(l, fi));
 291                         pr_info("\t\textent data offset %llu nr %llu ram %llu\n",
 292                                btrfs_file_extent_offset(l, fi),
 293                                btrfs_file_extent_num_bytes(l, fi),
 294                                btrfs_file_extent_ram_bytes(l, fi));
 295                         break;
 296                 case BTRFS_BLOCK_GROUP_ITEM_KEY:
 297                         bi = btrfs_item_ptr(l, i,
 298                                             struct btrfs_block_group_item);
 299                         pr_info(
 300                    "\t\tblock group used %llu chunk_objectid %llu flags %llu\n",
 301                                 btrfs_block_group_used(l, bi),
 302                                 btrfs_block_group_chunk_objectid(l, bi),
 303                                 btrfs_block_group_flags(l, bi));
 304                         break;
 305                 case BTRFS_CHUNK_ITEM_KEY:
 306                         print_chunk(l, btrfs_item_ptr(l, i,
 307                                                       struct btrfs_chunk));
 308                         break;
 309                 case BTRFS_DEV_ITEM_KEY:
 310                         print_dev_item(l, btrfs_item_ptr(l, i,
 311                                         struct btrfs_dev_item));
 312                         break;
 313                 case BTRFS_DEV_EXTENT_KEY:
 314                         dev_extent = btrfs_item_ptr(l, i,
 315                                                     struct btrfs_dev_extent);
 316                         pr_info("\t\tdev extent chunk_tree %llu\n\t\tchunk objectid %llu chunk offset %llu length %llu\n",
 317                                btrfs_dev_extent_chunk_tree(l, dev_extent),
 318                                btrfs_dev_extent_chunk_objectid(l, dev_extent),
 319                                btrfs_dev_extent_chunk_offset(l, dev_extent),
 320                                btrfs_dev_extent_length(l, dev_extent));
 321                         break;
 322                 case BTRFS_PERSISTENT_ITEM_KEY:
 323                         pr_info("\t\tpersistent item objectid %llu offset %llu\n",
 324                                         key.objectid, key.offset);
 325                         switch (key.objectid) {
 326                         case BTRFS_DEV_STATS_OBJECTID:
 327                                 pr_info("\t\tdevice stats\n");
 328                                 break;
 329                         default:
 330                                 pr_info("\t\tunknown persistent item\n");
 331                         }
 332                         break;
 333                 case BTRFS_TEMPORARY_ITEM_KEY:
 334                         pr_info("\t\ttemporary item objectid %llu offset %llu\n",
 335                                         key.objectid, key.offset);
 336                         switch (key.objectid) {
 337                         case BTRFS_BALANCE_OBJECTID:
 338                                 pr_info("\t\tbalance status\n");
 339                                 break;
 340                         default:
 341                                 pr_info("\t\tunknown temporary item\n");
 342                         }
 343                         break;
 344                 case BTRFS_DEV_REPLACE_KEY:
 345                         pr_info("\t\tdev replace\n");
 346                         break;
 347                 case BTRFS_UUID_KEY_SUBVOL:
 348                 case BTRFS_UUID_KEY_RECEIVED_SUBVOL:
 349                         print_uuid_item(l, btrfs_item_ptr_offset(l, i),
 350                                         btrfs_item_size(l, i));
 351                         break;
 352                 }
 353         }
 354 }
 355
 356 void btrfs_print_tree(const struct extent_buffer *c, bool follow)
 357 {
 358         struct btrfs_fs_info *fs_info;
 359         int i; u32 nr;
 360         struct btrfs_key key;
 361         int level;
 362
 363         if (!c)
 364                 return;
 365         fs_info = c->fs_info;
 366         nr = btrfs_header_nritems(c);
 367         level = btrfs_header_level(c);
 368         if (level == 0) {
 369                 btrfs_print_leaf(c);
 370                 return;
 371         }
 372         btrfs_info(fs_info,
 373                    "node %llu level %d gen %llu total ptrs %d free spc %u owner %llu",
 374                    btrfs_header_bytenr(c), level, btrfs_header_generation(c),
 375                    nr, (u32)BTRFS_NODEPTRS_PER_BLOCK(fs_info) - nr,
 376                    btrfs_header_owner(c));
 377         print_eb_refs_lock(c);
 378         for (i = 0; i < nr; i++) {
 379                 btrfs_node_key_to_cpu(c, &key, i);
 380                 pr_info("\tkey %d (%llu %u %llu) block %llu gen %llu\n",
 381                        i, key.objectid, key.type, key.offset,
 382                        btrfs_node_blockptr(c, i),
 383                        btrfs_node_ptr_generation(c, i));
 384         }
 385         if (!follow)
 386                 return;
 387         for (i = 0; i < nr; i++) {
 388                 struct btrfs_tree_parent_check check = {
 389                         .level = level - 1,
 390                         .transid = btrfs_node_ptr_generation(c, i),
 391                         .owner_root = btrfs_header_owner(c),
 392                         .has_first_key = true
 393                 };
 394                 struct extent_buffer *next;
 395
 396                 btrfs_node_key_to_cpu(c, &check.first_key, i);
 397                 next = read_tree_block(fs_info, btrfs_node_blockptr(c, i), &check);
 398                 if (IS_ERR(next))
 399                         continue;
 400                 if (!extent_buffer_uptodate(next)) {
 401                         free_extent_buffer(next);
 402                         continue;
 403                 }
 404
 405                 if (btrfs_is_leaf(next) &&
 406                    level != 1)
 407                         BUG();
 408                 if (btrfs_header_level(next) !=
 409                        level - 1)
 410                         BUG();
 411                 btrfs_print_tree(next, follow);
 412                 free_extent_buffer(next);
 413         }
 414 }