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