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