xref: /dflybsd-src/lib/libc/db/btree/bt_debug.c (revision cbebfd39b369a289776677fb72f2eb81722dd172)
1 /*-
2  * Copyright (c) 1990, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Mike Olson.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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 the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * @(#)bt_debug.c	8.5 (Berkeley) 8/17/94
33  * $DragonFly: src/lib/libc/db/btree/bt_debug.c,v 1.3 2005/09/19 09:20:37 asmodai Exp $
34  */
35 
36 #include <sys/param.h>
37 
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41 
42 #include <db.h>
43 #include "btree.h"
44 
45 #ifdef DEBUG
46 /*
47  * BT_DUMP -- Dump the tree
48  *
49  * Parameters:
50  *	dbp:	pointer to the DB
51  */
52 void
53 __bt_dump(dbp)
54 	DB *dbp;
55 {
56 	BTREE *t;
57 	PAGE *h;
58 	pgno_t i;
59 	char *sep;
60 
61 	t = dbp->internal;
62 	(void)fprintf(stderr, "%s: pgsz %d",
63 	    F_ISSET(t, B_INMEM) ? "memory" : "disk", t->bt_psize);
64 	if (F_ISSET(t, R_RECNO))
65 		(void)fprintf(stderr, " keys %lu", t->bt_nrecs);
66 #undef X
67 #define	X(flag, name) \
68 	if (F_ISSET(t, flag)) { \
69 		(void)fprintf(stderr, "%s%s", sep, name); \
70 		sep = ", "; \
71 	}
72 	if (t->flags != 0) {
73 		sep = " flags (";
74 		X(R_FIXLEN,	"FIXLEN");
75 		X(B_INMEM,	"INMEM");
76 		X(B_NODUPS,	"NODUPS");
77 		X(B_RDONLY,	"RDONLY");
78 		X(R_RECNO,	"RECNO");
79 		X(B_METADIRTY,"METADIRTY");
80 		(void)fprintf(stderr, ")\n");
81 	}
82 #undef X
83 
84 	for (i = P_ROOT; (h = mpool_get(t->bt_mp, i, 0)) != NULL; ++i) {
85 		__bt_dpage(h);
86 		(void)mpool_put(t->bt_mp, h, 0);
87 	}
88 }
89 
90 /*
91  * BT_DMPAGE -- Dump the meta page
92  *
93  * Parameters:
94  *	h:	pointer to the PAGE
95  */
96 void
97 __bt_dmpage(h)
98 	PAGE *h;
99 {
100 	BTMETA *m;
101 	char *sep;
102 
103 	m = (BTMETA *)h;
104 	(void)fprintf(stderr, "magic %lx\n", m->magic);
105 	(void)fprintf(stderr, "version %lu\n", m->version);
106 	(void)fprintf(stderr, "psize %lu\n", m->psize);
107 	(void)fprintf(stderr, "free %lu\n", m->free);
108 	(void)fprintf(stderr, "nrecs %lu\n", m->nrecs);
109 	(void)fprintf(stderr, "flags %lu", m->flags);
110 #undef X
111 #define	X(flag, name) \
112 	if (m->flags & flag) { \
113 		(void)fprintf(stderr, "%s%s", sep, name); \
114 		sep = ", "; \
115 	}
116 	if (m->flags) {
117 		sep = " (";
118 		X(B_NODUPS,	"NODUPS");
119 		X(R_RECNO,	"RECNO");
120 		(void)fprintf(stderr, ")");
121 	}
122 }
123 
124 /*
125  * BT_DNPAGE -- Dump the page
126  *
127  * Parameters:
128  *	n:	page number to dump.
129  */
130 void
131 __bt_dnpage(dbp, pgno)
132 	DB *dbp;
133 	pgno_t pgno;
134 {
135 	BTREE *t;
136 	PAGE *h;
137 
138 	t = dbp->internal;
139 	if ((h = mpool_get(t->bt_mp, pgno, 0)) != NULL) {
140 		__bt_dpage(h);
141 		(void)mpool_put(t->bt_mp, h, 0);
142 	}
143 }
144 
145 /*
146  * BT_DPAGE -- Dump the page
147  *
148  * Parameters:
149  *	h:	pointer to the PAGE
150  */
151 void
152 __bt_dpage(h)
153 	PAGE *h;
154 {
155 	BINTERNAL *bi;
156 	BLEAF *bl;
157 	RINTERNAL *ri;
158 	RLEAF *rl;
159 	indx_t cur, top;
160 	char *sep;
161 
162 	(void)fprintf(stderr, "    page %d: (", h->pgno);
163 #undef X
164 #define	X(flag, name) \
165 	if (h->flags & flag) { \
166 		(void)fprintf(stderr, "%s%s", sep, name); \
167 		sep = ", "; \
168 	}
169 	sep = "";
170 	X(P_BINTERNAL,	"BINTERNAL")		/* types */
171 	X(P_BLEAF,	"BLEAF")
172 	X(P_RINTERNAL,	"RINTERNAL")		/* types */
173 	X(P_RLEAF,	"RLEAF")
174 	X(P_OVERFLOW,	"OVERFLOW")
175 	X(P_PRESERVE,	"PRESERVE");
176 	(void)fprintf(stderr, ")\n");
177 #undef X
178 
179 	(void)fprintf(stderr, "\tprev %2d next %2d", h->prevpg, h->nextpg);
180 	if (h->flags & P_OVERFLOW)
181 		return;
182 
183 	top = NEXTINDEX(h);
184 	(void)fprintf(stderr, " lower %3d upper %3d nextind %d\n",
185 	    h->lower, h->upper, top);
186 	for (cur = 0; cur < top; cur++) {
187 		(void)fprintf(stderr, "\t[%03d] %4d ", cur, h->linp[cur]);
188 		switch (h->flags & P_TYPE) {
189 		case P_BINTERNAL:
190 			bi = GETBINTERNAL(h, cur);
191 			(void)fprintf(stderr,
192 			    "size %03d pgno %03d", bi->ksize, bi->pgno);
193 			if (bi->flags & P_BIGKEY)
194 				(void)fprintf(stderr, " (indirect)");
195 			else if (bi->ksize)
196 				(void)fprintf(stderr,
197 				    " {%.*s}", (int)bi->ksize, bi->bytes);
198 			break;
199 		case P_RINTERNAL:
200 			ri = GETRINTERNAL(h, cur);
201 			(void)fprintf(stderr, "entries %03d pgno %03d",
202 				ri->nrecs, ri->pgno);
203 			break;
204 		case P_BLEAF:
205 			bl = GETBLEAF(h, cur);
206 			if (bl->flags & P_BIGKEY)
207 				(void)fprintf(stderr,
208 				    "big key page %lu size %u/",
209 				    *(pgno_t *)bl->bytes,
210 				    *(u_int32_t *)(bl->bytes + sizeof(pgno_t)));
211 			else if (bl->ksize)
212 				(void)fprintf(stderr, "%s/", bl->bytes);
213 			if (bl->flags & P_BIGDATA)
214 				(void)fprintf(stderr,
215 				    "big data page %lu size %u",
216 				    *(pgno_t *)(bl->bytes + bl->ksize),
217 				    *(u_int32_t *)(bl->bytes + bl->ksize +
218 				    sizeof(pgno_t)));
219 			else if (bl->dsize)
220 				(void)fprintf(stderr, "%.*s",
221 				    (int)bl->dsize, bl->bytes + bl->ksize);
222 			break;
223 		case P_RLEAF:
224 			rl = GETRLEAF(h, cur);
225 			if (rl->flags & P_BIGDATA)
226 				(void)fprintf(stderr,
227 				    "big data page %lu size %u",
228 				    *(pgno_t *)rl->bytes,
229 				    *(u_int32_t *)(rl->bytes + sizeof(pgno_t)));
230 			else if (rl->dsize)
231 				(void)fprintf(stderr,
232 				    "%.*s", (int)rl->dsize, rl->bytes);
233 			break;
234 		}
235 		(void)fprintf(stderr, "\n");
236 	}
237 }
238 #endif
239 
240 #ifdef STATISTICS
241 /*
242  * BT_STAT -- Gather/print the tree statistics
243  *
244  * Parameters:
245  *	dbp:	pointer to the DB
246  */
247 void
248 __bt_stat(dbp)
249 	DB *dbp;
250 {
251 	extern u_long bt_cache_hit, bt_cache_miss, bt_pfxsaved, bt_rootsplit;
252 	extern u_long bt_sortsplit, bt_split;
253 	BTREE *t;
254 	PAGE *h;
255 	pgno_t i, pcont, pinternal, pleaf;
256 	u_long ifree, lfree, nkeys;
257 	int levels;
258 
259 	t = dbp->internal;
260 	pcont = pinternal = pleaf = 0;
261 	nkeys = ifree = lfree = 0;
262 	for (i = P_ROOT; (h = mpool_get(t->bt_mp, i, 0)) != NULL; ++i) {
263 		switch (h->flags & P_TYPE) {
264 		case P_BINTERNAL:
265 		case P_RINTERNAL:
266 			++pinternal;
267 			ifree += h->upper - h->lower;
268 			break;
269 		case P_BLEAF:
270 		case P_RLEAF:
271 			++pleaf;
272 			lfree += h->upper - h->lower;
273 			nkeys += NEXTINDEX(h);
274 			break;
275 		case P_OVERFLOW:
276 			++pcont;
277 			break;
278 		}
279 		(void)mpool_put(t->bt_mp, h, 0);
280 	}
281 
282 	/* Count the levels of the tree. */
283 	for (i = P_ROOT, levels = 0 ;; ++levels) {
284 		h = mpool_get(t->bt_mp, i, 0);
285 		if (h->flags & (P_BLEAF|P_RLEAF)) {
286 			if (levels == 0)
287 				levels = 1;
288 			(void)mpool_put(t->bt_mp, h, 0);
289 			break;
290 		}
291 		i = F_ISSET(t, R_RECNO) ?
292 		    GETRINTERNAL(h, 0)->pgno :
293 		    GETBINTERNAL(h, 0)->pgno;
294 		(void)mpool_put(t->bt_mp, h, 0);
295 	}
296 
297 	(void)fprintf(stderr, "%d level%s with %ld keys",
298 	    levels, levels == 1 ? "" : "s", nkeys);
299 	if (F_ISSET(t, R_RECNO))
300 		(void)fprintf(stderr, " (%ld header count)", t->bt_nrecs);
301 	(void)fprintf(stderr,
302 	    "\n%lu pages (leaf %ld, internal %ld, overflow %ld)\n",
303 	    pinternal + pleaf + pcont, pleaf, pinternal, pcont);
304 	(void)fprintf(stderr, "%ld cache hits, %ld cache misses\n",
305 	    bt_cache_hit, bt_cache_miss);
306 	(void)fprintf(stderr, "%ld splits (%ld root splits, %ld sort splits)\n",
307 	    bt_split, bt_rootsplit, bt_sortsplit);
308 	pleaf *= t->bt_psize - BTDATAOFF;
309 	if (pleaf)
310 		(void)fprintf(stderr,
311 		    "%.0f%% leaf fill (%ld bytes used, %ld bytes free)\n",
312 		    ((double)(pleaf - lfree) / pleaf) * 100,
313 		    pleaf - lfree, lfree);
314 	pinternal *= t->bt_psize - BTDATAOFF;
315 	if (pinternal)
316 		(void)fprintf(stderr,
317 		    "%.0f%% internal fill (%ld bytes used, %ld bytes free\n",
318 		    ((double)(pinternal - ifree) / pinternal) * 100,
319 		    pinternal - ifree, ifree);
320 	if (bt_pfxsaved)
321 		(void)fprintf(stderr, "prefix checking removed %lu bytes.\n",
322 		    bt_pfxsaved);
323 }
324 #endif
325