xref: /dragonfly/sbin/hammer/cmd_blockmap.c (revision 799ba435)
1 /*
2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sbin/hammer/cmd_blockmap.c,v 1.4 2008/07/19 18:48:14 dillon Exp $
35  */
36 
37 #include "hammer.h"
38 
39 /*
40  * Each collect covers 1<<(19+23) bytes address space of layer 1.
41  * (plus a copy of 1<<23 bytes that holds layer2 entries in layer 1).
42  */
43 typedef struct collect {
44 	RB_ENTRY(collect) entry;
45 	hammer_off_t	phys_offset;  /* layer2 address pointed by layer1 */
46 	hammer_off_t	*offsets;  /* big-block offset for layer2[i] */
47 	hammer_blockmap_layer2_t track2;  /* track of layer2 entries */
48 	hammer_blockmap_layer2_t layer2;  /* 1<<19 x 16 bytes entries */
49 	int error;  /* # of inconsistencies */
50 } *collect_t;
51 
52 static int
53 collect_compare(struct collect *c1, struct collect *c2)
54 {
55 	if (c1->phys_offset < c2->phys_offset)
56 		return(-1);
57 	if (c1->phys_offset > c2->phys_offset)
58 		return(1);
59 	return(0);
60 }
61 
62 RB_HEAD(collect_rb_tree, collect) CollectTree = RB_INITIALIZER(&CollectTree);
63 RB_PROTOTYPE2(collect_rb_tree, collect, entry, collect_compare, hammer_off_t);
64 RB_GENERATE2(collect_rb_tree, collect, entry, collect_compare, hammer_off_t,
65 	phys_offset);
66 
67 static void dump_blockmap(int zone);
68 static void check_freemap(hammer_blockmap_t freemap);
69 static void check_btree_node(hammer_off_t node_offset, int depth);
70 static void check_undo(hammer_blockmap_t undomap);
71 static __inline void collect_btree_root(hammer_off_t node_offset);
72 static __inline void collect_btree_internal(hammer_btree_elm_t elm);
73 static __inline void collect_btree_leaf(hammer_btree_elm_t elm);
74 static __inline void collect_freemap_layer1(hammer_blockmap_t freemap);
75 static __inline void collect_freemap_layer2(hammer_blockmap_layer1_t layer1);
76 static __inline void collect_undo(hammer_off_t scan_offset,
77 	hammer_fifo_head_t head);
78 static void collect_blockmap(hammer_off_t offset, int32_t length, int zone);
79 static hammer_blockmap_layer2_t collect_get_track(
80 	collect_t collect, hammer_off_t offset, int zone,
81 	hammer_blockmap_layer2_t layer2);
82 static collect_t collect_get(hammer_off_t phys_offset);
83 static void dump_collect_table(void);
84 static void dump_collect(collect_t collect, struct zone_stat *stats);
85 
86 static int num_bad_layer1 = 0;
87 static int num_bad_layer2 = 0;
88 static int num_bad_node = 0;
89 
90 void
91 hammer_cmd_blockmap(void)
92 {
93 	dump_blockmap(HAMMER_ZONE_FREEMAP_INDEX);
94 }
95 
96 static
97 void
98 dump_blockmap(int zone)
99 {
100 	struct volume_info *root_volume;
101 	hammer_blockmap_t rootmap;
102 	hammer_blockmap_layer1_t layer1;
103 	hammer_blockmap_layer2_t layer2;
104 	struct buffer_info *buffer1 = NULL;
105 	struct buffer_info *buffer2 = NULL;
106 	hammer_off_t layer1_offset;
107 	hammer_off_t layer2_offset;
108 	hammer_off_t phys_offset;
109 	hammer_off_t block_offset;
110 	struct zone_stat *stats = NULL;
111 	int xerr, aerr, ferr;
112 
113 	root_volume = get_root_volume();
114 	rootmap = &root_volume->ondisk->vol0_blockmap[zone];
115 	assert(rootmap->phys_offset != 0);
116 
117 	print_blockmap(root_volume);
118 
119 	if (VerboseOpt)
120 		stats = hammer_init_zone_stat();
121 
122 	for (phys_offset = HAMMER_ZONE_ENCODE(zone, 0);
123 	     phys_offset < HAMMER_ZONE_ENCODE(zone, HAMMER_OFF_LONG_MASK);
124 	     phys_offset += HAMMER_BLOCKMAP_LAYER2) {
125 		/*
126 		 * Dive layer 1.
127 		 */
128 		layer1_offset = rootmap->phys_offset +
129 				HAMMER_BLOCKMAP_LAYER1_OFFSET(phys_offset);
130 		layer1 = get_buffer_data(layer1_offset, &buffer1, 0);
131 
132 		xerr = ' ';  /* good */
133 		if (!hammer_crc_test_layer1(HammerVersion, layer1)) {
134 			xerr = 'B';
135 			++num_bad_layer1;
136 		}
137 		if (xerr == ' ' &&
138 		    layer1->phys_offset == HAMMER_BLOCKMAP_UNAVAIL) {
139 			continue;
140 		}
141 		printf("%c layer1 %016jx @%016jx blocks-free %jd\n",
142 			xerr,
143 			(uintmax_t)phys_offset,
144 			(uintmax_t)layer1->phys_offset,
145 			(intmax_t)layer1->blocks_free);
146 
147 		for (block_offset = 0;
148 		     block_offset < HAMMER_BLOCKMAP_LAYER2;
149 		     block_offset += HAMMER_BIGBLOCK_SIZE) {
150 			hammer_off_t zone_offset = phys_offset + block_offset;
151 			/*
152 			 * Dive layer 2, each entry represents a big-block.
153 			 */
154 			layer2_offset = layer1->phys_offset +
155 					HAMMER_BLOCKMAP_LAYER2_OFFSET(block_offset);
156 			layer2 = get_buffer_data(layer2_offset, &buffer2, 0);
157 
158 			xerr = aerr = ferr = ' ';  /* good */
159 			if (!hammer_crc_test_layer2(HammerVersion, layer2)) {
160 				xerr = 'B';
161 				++num_bad_layer2;
162 			}
163 			if (layer2->append_off > HAMMER_BIGBLOCK_SIZE) {
164 				aerr = 'A';
165 				++num_bad_layer2;
166 			}
167 			if (layer2->bytes_free < 0 ||
168 			    layer2->bytes_free > HAMMER_BIGBLOCK_SIZE) {
169 				ferr = 'F';
170 				++num_bad_layer2;
171 			}
172 
173 			if (VerboseOpt < 2 &&
174 			    xerr == ' ' && aerr == ' ' && ferr == ' ' &&
175 			    layer2->zone == HAMMER_ZONE_UNAVAIL_INDEX) {
176 				break;
177 			}
178 			printf("%c%c%c     %016jx zone=%-2d ",
179 				xerr, aerr, ferr, (uintmax_t)zone_offset, layer2->zone);
180 			if (VerboseOpt) {
181 				printf("vol=%-3d L1#=%-6d L2#=%-6d L1=%-7lu L2=%-7lu ",
182 					HAMMER_VOL_DECODE(zone_offset),
183 					HAMMER_BLOCKMAP_LAYER1_INDEX(zone_offset),
184 					HAMMER_BLOCKMAP_LAYER2_INDEX(zone_offset),
185 					HAMMER_BLOCKMAP_LAYER1_OFFSET(zone_offset),
186 					HAMMER_BLOCKMAP_LAYER2_OFFSET(zone_offset));
187 			}
188 			printf("app=%-7d free=%-7d",
189 				layer2->append_off,
190 				layer2->bytes_free);
191 			if (VerboseOpt) {
192 				double bytes_used = HAMMER_BIGBLOCK_SIZE -
193 					layer2->bytes_free;
194 				printf(" fill=%-5.1lf crc=%08x-%08x\n",
195 					bytes_used * 100 / HAMMER_BIGBLOCK_SIZE,
196 					layer1->layer1_crc,
197 					layer2->entry_crc);
198 			} else {
199 				printf("\n");
200 			}
201 
202 			if (stats)
203 				hammer_add_zone_stat_layer2(stats, layer2);
204 		}
205 	}
206 	rel_buffer(buffer1);
207 	rel_buffer(buffer2);
208 
209 	if (stats) {
210 		hammer_print_zone_stat(stats);
211 		hammer_cleanup_zone_stat(stats);
212 	}
213 
214 	if (num_bad_layer1 || VerboseOpt) {
215 		printf("%d bad layer1\n", num_bad_layer1);
216 	}
217 	if (num_bad_layer2 || VerboseOpt) {
218 		printf("%d bad layer2\n", num_bad_layer1);
219 	}
220 }
221 
222 void
223 hammer_cmd_checkmap(void)
224 {
225 	struct volume_info *volume;
226 	hammer_blockmap_t freemap;
227 	hammer_blockmap_t undomap;
228 	hammer_off_t node_offset;
229 
230 	volume = get_root_volume();
231 	node_offset = volume->ondisk->vol0_btree_root;
232 	freemap = &volume->ondisk->vol0_blockmap[HAMMER_ZONE_FREEMAP_INDEX];
233 	undomap = &volume->ondisk->vol0_blockmap[HAMMER_ZONE_UNDO_INDEX];
234 
235 	print_blockmap(volume);
236 
237 	printf("Collecting allocation info from freemap: ");
238 	fflush(stdout);
239 	check_freemap(freemap);
240 	printf("done\n");
241 
242 	printf("Collecting allocation info from B-Tree: ");
243 	fflush(stdout);
244 	check_btree_node(node_offset, 0);
245 	printf("done\n");
246 
247 	printf("Collecting allocation info from UNDO: ");
248 	fflush(stdout);
249 	check_undo(undomap);
250 	printf("done\n");
251 
252 	dump_collect_table();
253 }
254 
255 static void
256 check_freemap(hammer_blockmap_t freemap)
257 {
258 	hammer_off_t offset;
259 	struct buffer_info *buffer1 = NULL;
260 	hammer_blockmap_layer1_t layer1;
261 	int i;
262 
263 	collect_freemap_layer1(freemap);
264 
265 	for (i = 0; i < HAMMER_BLOCKMAP_RADIX1; ++i) {
266 		offset = freemap->phys_offset + i * sizeof(*layer1);
267 		layer1 = get_buffer_data(offset, &buffer1, 0);
268 		if (layer1->phys_offset != HAMMER_BLOCKMAP_UNAVAIL)
269 			collect_freemap_layer2(layer1);
270 	}
271 	rel_buffer(buffer1);
272 }
273 
274 static void
275 check_btree_node(hammer_off_t node_offset, int depth)
276 {
277 	struct buffer_info *buffer = NULL;
278 	hammer_node_ondisk_t node;
279 	hammer_btree_elm_t elm;
280 	int i;
281 	char badc = ' ';  /* good */
282 	char badm = ' ';  /* good */
283 
284 	if (depth == 0)
285 		collect_btree_root(node_offset);
286 	node = get_buffer_data(node_offset, &buffer, 0);
287 
288 	if (node == NULL) {
289 		badc = 'B';
290 		badm = 'I';
291 	} else if (!hammer_crc_test_btree(HammerVersion, node)) {
292 		badc = 'B';
293 	}
294 
295 	if (badm != ' ' || badc != ' ') {  /* not good */
296 		++num_bad_node;
297 		printf("%c%c   NODE %016jx ",
298 			badc, badm, (uintmax_t)node_offset);
299 		if (node == NULL) {
300 			printf("(IO ERROR)\n");
301 			rel_buffer(buffer);
302 			return;
303 		} else {
304 			printf("cnt=%02d p=%016jx type=%c depth=%d mirror=%016jx\n",
305 			       node->count,
306 			       (uintmax_t)node->parent,
307 			       (node->type ? node->type : '?'),
308 			       depth,
309 			       (uintmax_t)node->mirror_tid);
310 		}
311 	}
312 
313 	for (i = 0; i < node->count; ++i) {
314 		elm = &node->elms[i];
315 
316 		switch(node->type) {
317 		case HAMMER_BTREE_TYPE_INTERNAL:
318 			if (elm->internal.subtree_offset) {
319 				collect_btree_internal(elm);
320 				check_btree_node(elm->internal.subtree_offset,
321 						 depth + 1);
322 			}
323 			break;
324 		case HAMMER_BTREE_TYPE_LEAF:
325 			if (elm->leaf.data_offset)
326 				collect_btree_leaf(elm);
327 			break;
328 		default:
329 			assert(!DebugOpt);
330 			break;
331 		}
332 	}
333 	rel_buffer(buffer);
334 }
335 
336 static void
337 check_undo(hammer_blockmap_t undomap)
338 {
339 	struct buffer_info *buffer = NULL;
340 	hammer_off_t scan_offset;
341 	hammer_fifo_head_t head;
342 
343 	scan_offset = HAMMER_ENCODE_UNDO(0);
344 	while (scan_offset < undomap->alloc_offset) {
345 		head = get_buffer_data(scan_offset, &buffer, 0);
346 		switch (head->hdr_type) {
347 		case HAMMER_HEAD_TYPE_PAD:
348 		case HAMMER_HEAD_TYPE_DUMMY:
349 		case HAMMER_HEAD_TYPE_UNDO:
350 		case HAMMER_HEAD_TYPE_REDO:
351 			collect_undo(scan_offset, head);
352 			break;
353 		default:
354 			assert(!DebugOpt);
355 			break;
356 		}
357 		if ((head->hdr_size & HAMMER_HEAD_ALIGN_MASK) ||
358 		     head->hdr_size == 0 ||
359 		     head->hdr_size > HAMMER_UNDO_ALIGN -
360 			((u_int)scan_offset & HAMMER_UNDO_MASK)) {
361 			printf("Illegal size, skipping to next boundary\n");
362 			scan_offset = HAMMER_UNDO_DOALIGN(scan_offset);
363 		} else {
364 			scan_offset += head->hdr_size;
365 		}
366 	}
367 	rel_buffer(buffer);
368 }
369 
370 static __inline
371 void
372 collect_freemap_layer1(hammer_blockmap_t freemap)
373 {
374 	/*
375 	 * This translation is necessary to do checkmap properly
376 	 * as zone4 is really just zone2 address space.
377 	 */
378 	hammer_off_t zone4_offset = hammer_xlate_to_zoneX(
379 		HAMMER_ZONE_FREEMAP_INDEX, freemap->phys_offset);
380 	collect_blockmap(zone4_offset, HAMMER_BIGBLOCK_SIZE,
381 		HAMMER_ZONE_FREEMAP_INDEX);
382 }
383 
384 static __inline
385 void
386 collect_freemap_layer2(hammer_blockmap_layer1_t layer1)
387 {
388 	/*
389 	 * This translation is necessary to do checkmap properly
390 	 * as zone4 is really just zone2 address space.
391 	 */
392 	hammer_off_t zone4_offset = hammer_xlate_to_zoneX(
393 		HAMMER_ZONE_FREEMAP_INDEX, layer1->phys_offset);
394 	collect_blockmap(zone4_offset, HAMMER_BIGBLOCK_SIZE,
395 		HAMMER_ZONE_FREEMAP_INDEX);
396 }
397 
398 static __inline
399 void
400 collect_btree_root(hammer_off_t node_offset)
401 {
402 	collect_blockmap(node_offset,
403 		sizeof(struct hammer_node_ondisk),  /* 4KB */
404 		HAMMER_ZONE_BTREE_INDEX);
405 }
406 
407 static __inline
408 void
409 collect_btree_internal(hammer_btree_elm_t elm)
410 {
411 	collect_blockmap(elm->internal.subtree_offset,
412 		sizeof(struct hammer_node_ondisk),  /* 4KB */
413 		HAMMER_ZONE_BTREE_INDEX);
414 }
415 
416 static __inline
417 void
418 collect_btree_leaf(hammer_btree_elm_t elm)
419 {
420 	int zone;
421 
422 	switch (elm->base.rec_type) {
423 	case HAMMER_RECTYPE_INODE:
424 	case HAMMER_RECTYPE_DIRENTRY:
425 	case HAMMER_RECTYPE_EXT:
426 	case HAMMER_RECTYPE_FIX:
427 	case HAMMER_RECTYPE_PFS:
428 	case HAMMER_RECTYPE_SNAPSHOT:
429 	case HAMMER_RECTYPE_CONFIG:
430 		zone = HAMMER_ZONE_META_INDEX;
431 		break;
432 	case HAMMER_RECTYPE_DATA:
433 	case HAMMER_RECTYPE_DB:
434 		zone = hammer_data_zone_index(elm->leaf.data_len);
435 		break;
436 	default:
437 		zone = HAMMER_ZONE_UNAVAIL_INDEX;
438 		break;
439 	}
440 	collect_blockmap(elm->leaf.data_offset,
441 		HAMMER_DATA_DOALIGN(elm->leaf.data_len), zone);
442 }
443 
444 static __inline
445 void
446 collect_undo(hammer_off_t scan_offset, hammer_fifo_head_t head)
447 {
448 	collect_blockmap(scan_offset, head->hdr_size,
449 		HAMMER_ZONE_UNDO_INDEX);
450 }
451 
452 static
453 void
454 collect_blockmap(hammer_off_t offset, int32_t length, int zone)
455 {
456 	struct hammer_blockmap_layer1 layer1;
457 	struct hammer_blockmap_layer2 layer2;
458 	hammer_blockmap_layer2_t track2;
459 	hammer_off_t result_offset;
460 	collect_t collect;
461 	int error;
462 
463 	result_offset = blockmap_lookup_save(offset, &layer1, &layer2, &error);
464 	if (DebugOpt) {
465 		assert(HAMMER_ZONE_DECODE(offset) == zone);
466 		assert(hammer_is_zone_raw_buffer(result_offset));
467 		assert(error == 0);
468 	}
469 	collect = collect_get(layer1.phys_offset); /* layer2 address */
470 	track2 = collect_get_track(collect, result_offset, zone, &layer2);
471 	track2->bytes_free -= length;
472 }
473 
474 static
475 collect_t
476 collect_get(hammer_off_t phys_offset)
477 {
478 	collect_t collect;
479 
480 	collect = RB_LOOKUP(collect_rb_tree, &CollectTree, phys_offset);
481 	if (collect)
482 		return(collect);
483 
484 	collect = calloc(1, sizeof(*collect));
485 	collect->track2 = calloc(1, HAMMER_BIGBLOCK_SIZE);  /* 1<<23 bytes */
486 	collect->layer2 = calloc(1, HAMMER_BIGBLOCK_SIZE);  /* 1<<23 bytes */
487 	collect->offsets = calloc(HAMMER_BLOCKMAP_RADIX2, sizeof(hammer_off_t));
488 	collect->phys_offset = phys_offset;
489 	RB_INSERT(collect_rb_tree, &CollectTree, collect);
490 
491 	return (collect);
492 }
493 
494 static
495 void
496 collect_rel(collect_t collect)
497 {
498 	free(collect->offsets);
499 	free(collect->layer2);
500 	free(collect->track2);
501 	free(collect);
502 }
503 
504 static
505 hammer_blockmap_layer2_t
506 collect_get_track(collect_t collect, hammer_off_t offset, int zone,
507 		  hammer_blockmap_layer2_t layer2)
508 {
509 	hammer_blockmap_layer2_t track2;
510 	size_t i;
511 
512 	i = HAMMER_BLOCKMAP_LAYER2_INDEX(offset);
513 	track2 = &collect->track2[i];
514 	if (track2->entry_crc == 0) {
515 		collect->layer2[i] = *layer2;
516 		collect->offsets[i] = offset & ~HAMMER_BIGBLOCK_MASK64;
517 		track2->zone = zone;
518 		track2->bytes_free = HAMMER_BIGBLOCK_SIZE;
519 		track2->entry_crc = 1;	/* steal field to tag track load */
520 	}
521 	return (track2);
522 }
523 
524 static
525 void
526 dump_collect_table(void)
527 {
528 	collect_t collect;
529 	int error = 0;
530 	struct zone_stat *stats = NULL;
531 
532 	if (VerboseOpt)
533 		stats = hammer_init_zone_stat();
534 
535 	RB_FOREACH(collect, collect_rb_tree, &CollectTree) {
536 		dump_collect(collect, stats);
537 		error += collect->error;
538 	}
539 
540 	while ((collect = RB_ROOT(&CollectTree)) != NULL) {
541 		RB_REMOVE(collect_rb_tree, &CollectTree, collect);
542 		collect_rel(collect);
543 	}
544 	assert(RB_EMPTY(&CollectTree));
545 
546 	if (stats) {
547 		hammer_print_zone_stat(stats);
548 		hammer_cleanup_zone_stat(stats);
549 	}
550 
551 	if (num_bad_node || VerboseOpt) {
552 		printf("%d bad nodes\n", num_bad_node);
553 	}
554 	if (error || VerboseOpt) {
555 		printf("%d errors\n", error);
556 	}
557 }
558 
559 static
560 void
561 dump_collect(collect_t collect, struct zone_stat *stats)
562 {
563 	hammer_blockmap_layer2_t track2;
564 	hammer_blockmap_layer2_t layer2;
565 	hammer_off_t offset;
566 	int i, zone;
567 
568 	for (i = 0; i < HAMMER_BLOCKMAP_RADIX2; ++i) {
569 		track2 = &collect->track2[i];
570 		layer2 = &collect->layer2[i];
571 		offset = collect->offsets[i];
572 
573 		/*
574 		 * Check big-blocks referenced by freemap, data,
575 		 * B-Tree nodes and UNDO fifo.
576 		 */
577 		if (track2->entry_crc == 0)
578 			continue;
579 
580 		zone = layer2->zone;
581 		if (DebugOpt) {
582 			assert((zone == HAMMER_ZONE_UNDO_INDEX) ||
583 				(zone == HAMMER_ZONE_FREEMAP_INDEX) ||
584 				hammer_is_index_record(zone));
585 		}
586 		if (stats)
587 			hammer_add_zone_stat_layer2(stats, layer2);
588 
589 		if (track2->zone != layer2->zone) {
590 			printf("BZ\tblock=%016jx calc zone=%-2d, got zone=%-2d\n",
591 				(intmax_t)offset,
592 				track2->zone,
593 				layer2->zone);
594 			collect->error++;
595 		} else if (track2->bytes_free != layer2->bytes_free) {
596 			printf("BM\tblock=%016jx zone=%-2d calc %d free, got %d\n",
597 				(intmax_t)offset,
598 				layer2->zone,
599 				track2->bytes_free,
600 				layer2->bytes_free);
601 			collect->error++;
602 		} else if (VerboseOpt) {
603 			printf("\tblock=%016jx zone=%-2d %d free (correct)\n",
604 				(intmax_t)offset,
605 				layer2->zone,
606 				track2->bytes_free);
607 		}
608 	}
609 }
610