xref: /openbmc/linux/fs/btrfs/print-tree.c (revision de2bdb3d)
1 /*
2  * Copyright (C) 2007 Oracle.  All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public
6  * License v2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public
14  * License along with this program; if not, write to the
15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16  * Boston, MA 021110-1307, USA.
17  */
18 
19 #include "ctree.h"
20 #include "disk-io.h"
21 #include "print-tree.h"
22 
23 static void print_chunk(struct extent_buffer *eb, struct btrfs_chunk *chunk)
24 {
25 	int num_stripes = btrfs_chunk_num_stripes(eb, chunk);
26 	int i;
27 	pr_info("\t\tchunk length %llu owner %llu type %llu num_stripes %d\n",
28 	       btrfs_chunk_length(eb, chunk), btrfs_chunk_owner(eb, chunk),
29 	       btrfs_chunk_type(eb, chunk), num_stripes);
30 	for (i = 0 ; i < num_stripes ; i++) {
31 		pr_info("\t\t\tstripe %d devid %llu offset %llu\n", i,
32 		      btrfs_stripe_devid_nr(eb, chunk, i),
33 		      btrfs_stripe_offset_nr(eb, chunk, i));
34 	}
35 }
36 static void print_dev_item(struct extent_buffer *eb,
37 			   struct btrfs_dev_item *dev_item)
38 {
39 	pr_info("\t\tdev item devid %llu total_bytes %llu bytes used %llu\n",
40 	       btrfs_device_id(eb, dev_item),
41 	       btrfs_device_total_bytes(eb, dev_item),
42 	       btrfs_device_bytes_used(eb, dev_item));
43 }
44 static void print_extent_data_ref(struct extent_buffer *eb,
45 				  struct btrfs_extent_data_ref *ref)
46 {
47 	pr_info("\t\textent data backref root %llu objectid %llu offset %llu count %u\n",
48 	       btrfs_extent_data_ref_root(eb, ref),
49 	       btrfs_extent_data_ref_objectid(eb, ref),
50 	       btrfs_extent_data_ref_offset(eb, ref),
51 	       btrfs_extent_data_ref_count(eb, ref));
52 }
53 
54 static void print_extent_item(struct extent_buffer *eb, int slot, int type)
55 {
56 	struct btrfs_extent_item *ei;
57 	struct btrfs_extent_inline_ref *iref;
58 	struct btrfs_extent_data_ref *dref;
59 	struct btrfs_shared_data_ref *sref;
60 	struct btrfs_disk_key key;
61 	unsigned long end;
62 	unsigned long ptr;
63 	u32 item_size = btrfs_item_size_nr(eb, slot);
64 	u64 flags;
65 	u64 offset;
66 
67 	if (item_size < sizeof(*ei)) {
68 #ifdef BTRFS_COMPAT_EXTENT_TREE_V0
69 		struct btrfs_extent_item_v0 *ei0;
70 		BUG_ON(item_size != sizeof(*ei0));
71 		ei0 = btrfs_item_ptr(eb, slot, struct btrfs_extent_item_v0);
72 		pr_info("\t\textent refs %u\n",
73 		       btrfs_extent_refs_v0(eb, ei0));
74 		return;
75 #else
76 		BUG();
77 #endif
78 	}
79 
80 	ei = btrfs_item_ptr(eb, slot, struct btrfs_extent_item);
81 	flags = btrfs_extent_flags(eb, ei);
82 
83 	pr_info("\t\textent refs %llu gen %llu flags %llu\n",
84 	       btrfs_extent_refs(eb, ei), btrfs_extent_generation(eb, ei),
85 	       flags);
86 
87 	if ((type == BTRFS_EXTENT_ITEM_KEY) &&
88 	    flags & BTRFS_EXTENT_FLAG_TREE_BLOCK) {
89 		struct btrfs_tree_block_info *info;
90 		info = (struct btrfs_tree_block_info *)(ei + 1);
91 		btrfs_tree_block_key(eb, info, &key);
92 		pr_info("\t\ttree block key (%llu %u %llu) level %d\n",
93 		       btrfs_disk_key_objectid(&key), key.type,
94 		       btrfs_disk_key_offset(&key),
95 		       btrfs_tree_block_level(eb, info));
96 		iref = (struct btrfs_extent_inline_ref *)(info + 1);
97 	} else {
98 		iref = (struct btrfs_extent_inline_ref *)(ei + 1);
99 	}
100 
101 	ptr = (unsigned long)iref;
102 	end = (unsigned long)ei + item_size;
103 	while (ptr < end) {
104 		iref = (struct btrfs_extent_inline_ref *)ptr;
105 		type = btrfs_extent_inline_ref_type(eb, iref);
106 		offset = btrfs_extent_inline_ref_offset(eb, iref);
107 		switch (type) {
108 		case BTRFS_TREE_BLOCK_REF_KEY:
109 			pr_info("\t\ttree block backref root %llu\n", offset);
110 			break;
111 		case BTRFS_SHARED_BLOCK_REF_KEY:
112 			pr_info("\t\tshared block backref parent %llu\n", offset);
113 			break;
114 		case BTRFS_EXTENT_DATA_REF_KEY:
115 			dref = (struct btrfs_extent_data_ref *)(&iref->offset);
116 			print_extent_data_ref(eb, dref);
117 			break;
118 		case BTRFS_SHARED_DATA_REF_KEY:
119 			sref = (struct btrfs_shared_data_ref *)(iref + 1);
120 			pr_info("\t\tshared data backref parent %llu count %u\n",
121 			       offset, btrfs_shared_data_ref_count(eb, sref));
122 			break;
123 		default:
124 			BUG();
125 		}
126 		ptr += btrfs_extent_inline_ref_size(type);
127 	}
128 	WARN_ON(ptr > end);
129 }
130 
131 #ifdef BTRFS_COMPAT_EXTENT_TREE_V0
132 static void print_extent_ref_v0(struct extent_buffer *eb, int slot)
133 {
134 	struct btrfs_extent_ref_v0 *ref0;
135 
136 	ref0 = btrfs_item_ptr(eb, slot, struct btrfs_extent_ref_v0);
137 	printk("\t\textent back ref root %llu gen %llu owner %llu num_refs %lu\n",
138 		btrfs_ref_root_v0(eb, ref0),
139 		btrfs_ref_generation_v0(eb, ref0),
140 		btrfs_ref_objectid_v0(eb, ref0),
141 		(unsigned long)btrfs_ref_count_v0(eb, ref0));
142 }
143 #endif
144 
145 static void print_uuid_item(struct extent_buffer *l, unsigned long offset,
146 			    u32 item_size)
147 {
148 	if (!IS_ALIGNED(item_size, sizeof(u64))) {
149 		pr_warn("BTRFS: uuid item with illegal size %lu!\n",
150 			(unsigned long)item_size);
151 		return;
152 	}
153 	while (item_size) {
154 		__le64 subvol_id;
155 
156 		read_extent_buffer(l, &subvol_id, offset, sizeof(subvol_id));
157 		pr_info("\t\tsubvol_id %llu\n",
158 		       (unsigned long long)le64_to_cpu(subvol_id));
159 		item_size -= sizeof(u64);
160 		offset += sizeof(u64);
161 	}
162 }
163 
164 void btrfs_print_leaf(struct btrfs_root *root, struct extent_buffer *l)
165 {
166 	int i;
167 	u32 type, nr;
168 	struct btrfs_item *item;
169 	struct btrfs_root_item *ri;
170 	struct btrfs_dir_item *di;
171 	struct btrfs_inode_item *ii;
172 	struct btrfs_block_group_item *bi;
173 	struct btrfs_file_extent_item *fi;
174 	struct btrfs_extent_data_ref *dref;
175 	struct btrfs_shared_data_ref *sref;
176 	struct btrfs_dev_extent *dev_extent;
177 	struct btrfs_key key;
178 	struct btrfs_key found_key;
179 
180 	if (!l)
181 		return;
182 
183 	nr = btrfs_header_nritems(l);
184 
185 	btrfs_info(root->fs_info, "leaf %llu total ptrs %d free space %d",
186 		   btrfs_header_bytenr(l), nr, btrfs_leaf_free_space(root, l));
187 	for (i = 0 ; i < nr ; i++) {
188 		item = btrfs_item_nr(i);
189 		btrfs_item_key_to_cpu(l, &key, i);
190 		type = key.type;
191 		pr_info("\titem %d key (%llu %u %llu) itemoff %d itemsize %d\n",
192 			i, key.objectid, type, key.offset,
193 			btrfs_item_offset(l, item), btrfs_item_size(l, item));
194 		switch (type) {
195 		case BTRFS_INODE_ITEM_KEY:
196 			ii = btrfs_item_ptr(l, i, struct btrfs_inode_item);
197 			pr_info("\t\tinode generation %llu size %llu mode %o\n",
198 			       btrfs_inode_generation(l, ii),
199 			       btrfs_inode_size(l, ii),
200 			       btrfs_inode_mode(l, ii));
201 			break;
202 		case BTRFS_DIR_ITEM_KEY:
203 			di = btrfs_item_ptr(l, i, struct btrfs_dir_item);
204 			btrfs_dir_item_key_to_cpu(l, di, &found_key);
205 			pr_info("\t\tdir oid %llu type %u\n",
206 				found_key.objectid,
207 				btrfs_dir_type(l, di));
208 			break;
209 		case BTRFS_ROOT_ITEM_KEY:
210 			ri = btrfs_item_ptr(l, i, struct btrfs_root_item);
211 			pr_info("\t\troot data bytenr %llu refs %u\n",
212 				btrfs_disk_root_bytenr(l, ri),
213 				btrfs_disk_root_refs(l, ri));
214 			break;
215 		case BTRFS_EXTENT_ITEM_KEY:
216 		case BTRFS_METADATA_ITEM_KEY:
217 			print_extent_item(l, i, type);
218 			break;
219 		case BTRFS_TREE_BLOCK_REF_KEY:
220 			pr_info("\t\ttree block backref\n");
221 			break;
222 		case BTRFS_SHARED_BLOCK_REF_KEY:
223 			pr_info("\t\tshared block backref\n");
224 			break;
225 		case BTRFS_EXTENT_DATA_REF_KEY:
226 			dref = btrfs_item_ptr(l, i,
227 					      struct btrfs_extent_data_ref);
228 			print_extent_data_ref(l, dref);
229 			break;
230 		case BTRFS_SHARED_DATA_REF_KEY:
231 			sref = btrfs_item_ptr(l, i,
232 					      struct btrfs_shared_data_ref);
233 			pr_info("\t\tshared data backref count %u\n",
234 			       btrfs_shared_data_ref_count(l, sref));
235 			break;
236 		case BTRFS_EXTENT_DATA_KEY:
237 			fi = btrfs_item_ptr(l, i,
238 					    struct btrfs_file_extent_item);
239 			if (btrfs_file_extent_type(l, fi) ==
240 			    BTRFS_FILE_EXTENT_INLINE) {
241 				pr_info("\t\tinline extent data size %u\n",
242 				       btrfs_file_extent_inline_len(l, i, fi));
243 				break;
244 			}
245 			pr_info("\t\textent data disk bytenr %llu nr %llu\n",
246 			       btrfs_file_extent_disk_bytenr(l, fi),
247 			       btrfs_file_extent_disk_num_bytes(l, fi));
248 			pr_info("\t\textent data offset %llu nr %llu ram %llu\n",
249 			       btrfs_file_extent_offset(l, fi),
250 			       btrfs_file_extent_num_bytes(l, fi),
251 			       btrfs_file_extent_ram_bytes(l, fi));
252 			break;
253 		case BTRFS_EXTENT_REF_V0_KEY:
254 #ifdef BTRFS_COMPAT_EXTENT_TREE_V0
255 			print_extent_ref_v0(l, i);
256 #else
257 			BUG();
258 #endif
259 			break;
260 		case BTRFS_BLOCK_GROUP_ITEM_KEY:
261 			bi = btrfs_item_ptr(l, i,
262 					    struct btrfs_block_group_item);
263 			pr_info("\t\tblock group used %llu\n",
264 			       btrfs_disk_block_group_used(l, bi));
265 			break;
266 		case BTRFS_CHUNK_ITEM_KEY:
267 			print_chunk(l, btrfs_item_ptr(l, i,
268 						      struct btrfs_chunk));
269 			break;
270 		case BTRFS_DEV_ITEM_KEY:
271 			print_dev_item(l, btrfs_item_ptr(l, i,
272 					struct btrfs_dev_item));
273 			break;
274 		case BTRFS_DEV_EXTENT_KEY:
275 			dev_extent = btrfs_item_ptr(l, i,
276 						    struct btrfs_dev_extent);
277 			pr_info("\t\tdev extent chunk_tree %llu\n\t\tchunk objectid %llu chunk offset %llu length %llu\n",
278 			       btrfs_dev_extent_chunk_tree(l, dev_extent),
279 			       btrfs_dev_extent_chunk_objectid(l, dev_extent),
280 			       btrfs_dev_extent_chunk_offset(l, dev_extent),
281 			       btrfs_dev_extent_length(l, dev_extent));
282 			break;
283 		case BTRFS_PERSISTENT_ITEM_KEY:
284 			pr_info("\t\tpersistent item objectid %llu offset %llu\n",
285 					key.objectid, key.offset);
286 			switch (key.objectid) {
287 			case BTRFS_DEV_STATS_OBJECTID:
288 				pr_info("\t\tdevice stats\n");
289 				break;
290 			default:
291 				pr_info("\t\tunknown persistent item\n");
292 			}
293 			break;
294 		case BTRFS_TEMPORARY_ITEM_KEY:
295 			pr_info("\t\ttemporary item objectid %llu offset %llu\n",
296 					key.objectid, key.offset);
297 			switch (key.objectid) {
298 			case BTRFS_BALANCE_OBJECTID:
299 				pr_info("\t\tbalance status\n");
300 				break;
301 			default:
302 				pr_info("\t\tunknown temporary item\n");
303 			}
304 			break;
305 		case BTRFS_DEV_REPLACE_KEY:
306 			pr_info("\t\tdev replace\n");
307 			break;
308 		case BTRFS_UUID_KEY_SUBVOL:
309 		case BTRFS_UUID_KEY_RECEIVED_SUBVOL:
310 			print_uuid_item(l, btrfs_item_ptr_offset(l, i),
311 					btrfs_item_size_nr(l, i));
312 			break;
313 		};
314 	}
315 }
316 
317 void btrfs_print_tree(struct btrfs_root *root, struct extent_buffer *c)
318 {
319 	int i; u32 nr;
320 	struct btrfs_key key;
321 	int level;
322 
323 	if (!c)
324 		return;
325 	nr = btrfs_header_nritems(c);
326 	level = btrfs_header_level(c);
327 	if (level == 0) {
328 		btrfs_print_leaf(root, c);
329 		return;
330 	}
331 	btrfs_info(root->fs_info,
332 		   "node %llu level %d total ptrs %d free spc %u",
333 		   btrfs_header_bytenr(c), level, nr,
334 		   (u32)BTRFS_NODEPTRS_PER_BLOCK(root) - nr);
335 	for (i = 0; i < nr; i++) {
336 		btrfs_node_key_to_cpu(c, &key, i);
337 		pr_info("\tkey %d (%llu %u %llu) block %llu\n",
338 		       i, key.objectid, key.type, key.offset,
339 		       btrfs_node_blockptr(c, i));
340 	}
341 	for (i = 0; i < nr; i++) {
342 		struct extent_buffer *next = read_tree_block(root,
343 					btrfs_node_blockptr(c, i),
344 					btrfs_node_ptr_generation(c, i));
345 		if (IS_ERR(next)) {
346 			continue;
347 		} else if (!extent_buffer_uptodate(next)) {
348 			free_extent_buffer(next);
349 			continue;
350 		}
351 
352 		if (btrfs_is_leaf(next) &&
353 		   level != 1)
354 			BUG();
355 		if (btrfs_header_level(next) !=
356 		       level - 1)
357 			BUG();
358 		btrfs_print_tree(root, next);
359 		free_extent_buffer(next);
360 	}
361 }
362