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