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