xref: /openbmc/linux/fs/btrfs/print-tree.c (revision 2cf1c348)
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_DATA_RELOC_TREE_OBJECTID,	"DATA_RELOC_TREE"	},
27 };
28 
29 const 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 
48 static 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 }
61 static 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 }
69 static 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 
79 static 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(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
151 			 * must be aligned to nodesize.
152 			 */
153 			if (!IS_ALIGNED(offset, eb->fs_info->nodesize))
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 
168 static 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", le64_to_cpu(subvol_id));
181 		item_size -= sizeof(u64);
182 		offset += sizeof(u64);
183 	}
184 }
185 
186 /*
187  * Helper to output refs and locking status of extent buffer.  Useful to debug
188  * race condition related problems.
189  */
190 static void print_eb_refs_lock(struct extent_buffer *eb)
191 {
192 #ifdef CONFIG_BTRFS_DEBUG
193 	btrfs_info(eb->fs_info, "refs %u lock_owner %u current %u",
194 		   atomic_read(&eb->refs), eb->lock_owner, current->pid);
195 #endif
196 }
197 
198 void btrfs_print_leaf(struct extent_buffer *l)
199 {
200 	struct btrfs_fs_info *fs_info;
201 	int i;
202 	u32 type, nr;
203 	struct btrfs_root_item *ri;
204 	struct btrfs_dir_item *di;
205 	struct btrfs_inode_item *ii;
206 	struct btrfs_block_group_item *bi;
207 	struct btrfs_file_extent_item *fi;
208 	struct btrfs_extent_data_ref *dref;
209 	struct btrfs_shared_data_ref *sref;
210 	struct btrfs_dev_extent *dev_extent;
211 	struct btrfs_key key;
212 	struct btrfs_key found_key;
213 
214 	if (!l)
215 		return;
216 
217 	fs_info = l->fs_info;
218 	nr = btrfs_header_nritems(l);
219 
220 	btrfs_info(fs_info,
221 		   "leaf %llu gen %llu total ptrs %d free space %d owner %llu",
222 		   btrfs_header_bytenr(l), btrfs_header_generation(l), nr,
223 		   btrfs_leaf_free_space(l), btrfs_header_owner(l));
224 	print_eb_refs_lock(l);
225 	for (i = 0 ; i < nr ; i++) {
226 		btrfs_item_key_to_cpu(l, &key, i);
227 		type = key.type;
228 		pr_info("\titem %d key (%llu %u %llu) itemoff %d itemsize %d\n",
229 			i, key.objectid, type, key.offset,
230 			btrfs_item_offset(l, i), btrfs_item_size(l, i));
231 		switch (type) {
232 		case BTRFS_INODE_ITEM_KEY:
233 			ii = btrfs_item_ptr(l, i, struct btrfs_inode_item);
234 			pr_info("\t\tinode generation %llu size %llu mode %o\n",
235 			       btrfs_inode_generation(l, ii),
236 			       btrfs_inode_size(l, ii),
237 			       btrfs_inode_mode(l, ii));
238 			break;
239 		case BTRFS_DIR_ITEM_KEY:
240 			di = btrfs_item_ptr(l, i, struct btrfs_dir_item);
241 			btrfs_dir_item_key_to_cpu(l, di, &found_key);
242 			pr_info("\t\tdir oid %llu type %u\n",
243 				found_key.objectid,
244 				btrfs_dir_type(l, di));
245 			break;
246 		case BTRFS_ROOT_ITEM_KEY:
247 			ri = btrfs_item_ptr(l, i, struct btrfs_root_item);
248 			pr_info("\t\troot data bytenr %llu refs %u\n",
249 				btrfs_disk_root_bytenr(l, ri),
250 				btrfs_disk_root_refs(l, ri));
251 			break;
252 		case BTRFS_EXTENT_ITEM_KEY:
253 		case BTRFS_METADATA_ITEM_KEY:
254 			print_extent_item(l, i, type);
255 			break;
256 		case BTRFS_TREE_BLOCK_REF_KEY:
257 			pr_info("\t\ttree block backref\n");
258 			break;
259 		case BTRFS_SHARED_BLOCK_REF_KEY:
260 			pr_info("\t\tshared block backref\n");
261 			break;
262 		case BTRFS_EXTENT_DATA_REF_KEY:
263 			dref = btrfs_item_ptr(l, i,
264 					      struct btrfs_extent_data_ref);
265 			print_extent_data_ref(l, dref);
266 			break;
267 		case BTRFS_SHARED_DATA_REF_KEY:
268 			sref = btrfs_item_ptr(l, i,
269 					      struct btrfs_shared_data_ref);
270 			pr_info("\t\tshared data backref count %u\n",
271 			       btrfs_shared_data_ref_count(l, sref));
272 			break;
273 		case BTRFS_EXTENT_DATA_KEY:
274 			fi = btrfs_item_ptr(l, i,
275 					    struct btrfs_file_extent_item);
276 			if (btrfs_file_extent_type(l, fi) ==
277 			    BTRFS_FILE_EXTENT_INLINE) {
278 				pr_info("\t\tinline extent data size %llu\n",
279 				       btrfs_file_extent_ram_bytes(l, fi));
280 				break;
281 			}
282 			pr_info("\t\textent data disk bytenr %llu nr %llu\n",
283 			       btrfs_file_extent_disk_bytenr(l, fi),
284 			       btrfs_file_extent_disk_num_bytes(l, fi));
285 			pr_info("\t\textent data offset %llu nr %llu ram %llu\n",
286 			       btrfs_file_extent_offset(l, fi),
287 			       btrfs_file_extent_num_bytes(l, fi),
288 			       btrfs_file_extent_ram_bytes(l, fi));
289 			break;
290 		case BTRFS_EXTENT_REF_V0_KEY:
291 			btrfs_print_v0_err(fs_info);
292 			btrfs_handle_fs_error(fs_info, -EINVAL, NULL);
293 			break;
294 		case BTRFS_BLOCK_GROUP_ITEM_KEY:
295 			bi = btrfs_item_ptr(l, i,
296 					    struct btrfs_block_group_item);
297 			pr_info(
298 		   "\t\tblock group used %llu chunk_objectid %llu flags %llu\n",
299 				btrfs_block_group_used(l, bi),
300 				btrfs_block_group_chunk_objectid(l, bi),
301 				btrfs_block_group_flags(l, bi));
302 			break;
303 		case BTRFS_CHUNK_ITEM_KEY:
304 			print_chunk(l, btrfs_item_ptr(l, i,
305 						      struct btrfs_chunk));
306 			break;
307 		case BTRFS_DEV_ITEM_KEY:
308 			print_dev_item(l, btrfs_item_ptr(l, i,
309 					struct btrfs_dev_item));
310 			break;
311 		case BTRFS_DEV_EXTENT_KEY:
312 			dev_extent = btrfs_item_ptr(l, i,
313 						    struct btrfs_dev_extent);
314 			pr_info("\t\tdev extent chunk_tree %llu\n\t\tchunk objectid %llu chunk offset %llu length %llu\n",
315 			       btrfs_dev_extent_chunk_tree(l, dev_extent),
316 			       btrfs_dev_extent_chunk_objectid(l, dev_extent),
317 			       btrfs_dev_extent_chunk_offset(l, dev_extent),
318 			       btrfs_dev_extent_length(l, dev_extent));
319 			break;
320 		case BTRFS_PERSISTENT_ITEM_KEY:
321 			pr_info("\t\tpersistent item objectid %llu offset %llu\n",
322 					key.objectid, key.offset);
323 			switch (key.objectid) {
324 			case BTRFS_DEV_STATS_OBJECTID:
325 				pr_info("\t\tdevice stats\n");
326 				break;
327 			default:
328 				pr_info("\t\tunknown persistent item\n");
329 			}
330 			break;
331 		case BTRFS_TEMPORARY_ITEM_KEY:
332 			pr_info("\t\ttemporary item objectid %llu offset %llu\n",
333 					key.objectid, key.offset);
334 			switch (key.objectid) {
335 			case BTRFS_BALANCE_OBJECTID:
336 				pr_info("\t\tbalance status\n");
337 				break;
338 			default:
339 				pr_info("\t\tunknown temporary item\n");
340 			}
341 			break;
342 		case BTRFS_DEV_REPLACE_KEY:
343 			pr_info("\t\tdev replace\n");
344 			break;
345 		case BTRFS_UUID_KEY_SUBVOL:
346 		case BTRFS_UUID_KEY_RECEIVED_SUBVOL:
347 			print_uuid_item(l, btrfs_item_ptr_offset(l, i),
348 					btrfs_item_size(l, i));
349 			break;
350 		}
351 	}
352 }
353 
354 void btrfs_print_tree(struct extent_buffer *c, bool follow)
355 {
356 	struct btrfs_fs_info *fs_info;
357 	int i; u32 nr;
358 	struct btrfs_key key;
359 	int level;
360 
361 	if (!c)
362 		return;
363 	fs_info = c->fs_info;
364 	nr = btrfs_header_nritems(c);
365 	level = btrfs_header_level(c);
366 	if (level == 0) {
367 		btrfs_print_leaf(c);
368 		return;
369 	}
370 	btrfs_info(fs_info,
371 		   "node %llu level %d gen %llu total ptrs %d free spc %u owner %llu",
372 		   btrfs_header_bytenr(c), level, btrfs_header_generation(c),
373 		   nr, (u32)BTRFS_NODEPTRS_PER_BLOCK(fs_info) - nr,
374 		   btrfs_header_owner(c));
375 	print_eb_refs_lock(c);
376 	for (i = 0; i < nr; i++) {
377 		btrfs_node_key_to_cpu(c, &key, i);
378 		pr_info("\tkey %d (%llu %u %llu) block %llu gen %llu\n",
379 		       i, key.objectid, key.type, key.offset,
380 		       btrfs_node_blockptr(c, i),
381 		       btrfs_node_ptr_generation(c, i));
382 	}
383 	if (!follow)
384 		return;
385 	for (i = 0; i < nr; i++) {
386 		struct btrfs_key first_key;
387 		struct extent_buffer *next;
388 
389 		btrfs_node_key_to_cpu(c, &first_key, i);
390 		next = read_tree_block(fs_info, btrfs_node_blockptr(c, i),
391 				       btrfs_header_owner(c),
392 				       btrfs_node_ptr_generation(c, i),
393 				       level - 1, &first_key);
394 		if (IS_ERR(next)) {
395 			continue;
396 		} else if (!extent_buffer_uptodate(next)) {
397 			free_extent_buffer(next);
398 			continue;
399 		}
400 
401 		if (btrfs_is_leaf(next) &&
402 		   level != 1)
403 			BUG();
404 		if (btrfs_header_level(next) !=
405 		       level - 1)
406 			BUG();
407 		btrfs_print_tree(next, follow);
408 		free_extent_buffer(next);
409 	}
410 }
411