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