xref: /freebsd/sys/geom/geom_dump.c (revision a3e8fd0b7f663db7eafff527d5c3ca3bcfa8a537)
1 /*-
2  * Copyright (c) 2002 Poul-Henning Kamp
3  * Copyright (c) 2002 Networks Associates Technology, Inc.
4  * All rights reserved.
5  *
6  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7  * and NAI Labs, the Security Research Division of Network Associates, Inc.
8  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9  * DARPA CHATS research program.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. The names of the authors may not be used to endorse or promote
20  *    products derived from this software without specific prior written
21  *    permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  * $FreeBSD$
36  */
37 
38 
39 #include <sys/param.h>
40 #include <sys/stdint.h>
41 #include <sys/sbuf.h>
42 #ifndef _KERNEL
43 #include <stdio.h>
44 #include <unistd.h>
45 #include <stdlib.h>
46 #include <err.h>
47 #else
48 #include <sys/systm.h>
49 #include <sys/malloc.h>
50 #endif
51 #include <machine/stdarg.h>
52 
53 #include <geom/geom.h>
54 #include <geom/geom_int.h>
55 
56 
57 static void
58 g_confdot_consumer(struct sbuf *sb, struct g_consumer *cp)
59 {
60 
61 	sbuf_printf(sb, "z%p [label=\"r%dw%de%d\\nbio #%d\"];\n",
62 	    cp, cp->acr, cp->acw, cp->ace, cp->biocount);
63 	if (cp->provider)
64 		sbuf_printf(sb, "z%p -> z%p;\n", cp, cp->provider);
65 }
66 
67 static void
68 g_confdot_provider(struct sbuf *sb, struct g_provider *pp)
69 {
70 
71 	sbuf_printf(sb, "z%p [shape=hexagon,label=\"%s\\nr%dw%de%d\\nerr#%d\"];\n",
72 	    pp, pp->name, pp->acr, pp->acw, pp->ace, pp->error);
73 }
74 
75 static void
76 g_confdot_geom(struct sbuf *sb, struct g_geom *gp)
77 {
78 	struct g_consumer *cp;
79 	struct g_provider *pp;
80 
81 	sbuf_printf(sb, "z%p [shape=box,label=\"%s\\n%s\\nr#%d\"];\n",
82 	    gp, gp->class->name, gp->name, gp->rank);
83 	LIST_FOREACH(cp, &gp->consumer, consumer) {
84 		g_confdot_consumer(sb, cp);
85 		sbuf_printf(sb, "z%p -> z%p;\n", gp, cp);
86 	}
87 
88 	LIST_FOREACH(pp, &gp->provider, provider) {
89 		g_confdot_provider(sb, pp);
90 		sbuf_printf(sb, "z%p -> z%p;\n", pp, gp);
91 	}
92 }
93 
94 static void
95 g_confdot_class(struct sbuf *sb, struct g_class *mp)
96 {
97 	struct g_geom *gp;
98 
99 	LIST_FOREACH(gp, &mp->geom, geom)
100 		g_confdot_geom(sb, gp);
101 }
102 
103 void
104 g_confdot(void *p)
105 {
106 	struct g_class *mp;
107 	struct sbuf *sb;
108 
109 	sb = p;
110 	g_topology_assert();
111 	sbuf_printf(sb, "digraph geom {\n");
112 	LIST_FOREACH(mp, &g_classes, class)
113 		g_confdot_class(sb, mp);
114 	sbuf_printf(sb, "};\n");
115 	sbuf_finish(sb);
116 	wakeup(p);
117 }
118 
119 
120 static void
121 g_conf_consumer(struct sbuf *sb, struct g_consumer *cp)
122 {
123 
124 	sbuf_printf(sb, "\t<consumer id=\"%p\">\n", cp);
125 	sbuf_printf(sb, "\t  <geom ref=\"%p\"/>\n", cp->geom);
126 	if (cp->provider != NULL)
127 		sbuf_printf(sb, "\t  <provider ref=\"%p\"/>\n", cp->provider);
128 	sbuf_printf(sb, "\t  <mode>r%dw%de%d</mode>\n",
129 	    cp->acr, cp->acw, cp->ace);
130 	if (cp->geom->dumpconf) {
131 		sbuf_printf(sb, "\t  <config>\n");
132 		cp->geom->dumpconf(sb, "\t    ", cp->geom, cp, NULL);
133 		sbuf_printf(sb, "\t  </config>\n");
134 	}
135 	sbuf_printf(sb, "\t</consumer>\n");
136 }
137 
138 static void
139 g_conf_provider(struct sbuf *sb, struct g_provider *pp)
140 {
141 
142 	sbuf_printf(sb, "\t<provider id=\"%p\">\n", pp);
143 	sbuf_printf(sb, "\t  <geom ref=\"%p\"/>\n", pp->geom);
144 	sbuf_printf(sb, "\t  <mode>r%dw%de%d</mode>\n",
145 	    pp->acr, pp->acw, pp->ace);
146 	sbuf_printf(sb, "\t  <name>%s</name>\n", pp->name);
147 	sbuf_printf(sb, "\t  <mediasize>%jd</mediasize>\n",
148 	    (intmax_t)pp->mediasize);
149 	sbuf_printf(sb, "\t  <sectorsize>%u</sectorsize>\n", pp->sectorsize);
150 	if (pp->geom->dumpconf) {
151 		sbuf_printf(sb, "\t  <config>\n");
152 		pp->geom->dumpconf(sb, "\t    ", pp->geom, NULL, pp);
153 		sbuf_printf(sb, "\t  </config>\n");
154 	}
155 	sbuf_printf(sb, "\t</provider>\n");
156 }
157 
158 
159 static void
160 g_conf_geom(struct sbuf *sb, struct g_geom *gp, struct g_provider *pp, struct g_consumer *cp)
161 {
162 	struct g_consumer *cp2;
163 	struct g_provider *pp2;
164 
165 	sbuf_printf(sb, "    <geom id=\"%p\">\n", gp);
166 	sbuf_printf(sb, "      <class ref=\"%p\"/>\n", gp->class);
167 	sbuf_printf(sb, "      <name>%s</name>\n", gp->name);
168 	sbuf_printf(sb, "      <rank>%d</rank>\n", gp->rank);
169 	if (gp->dumpconf) {
170 		sbuf_printf(sb, "      <config>\n");
171 		gp->dumpconf(sb, "\t", gp, NULL, NULL);
172 		sbuf_printf(sb, "      </config>\n");
173 	}
174 	LIST_FOREACH(cp2, &gp->consumer, consumer) {
175 		if (cp != NULL && cp != cp2)
176 			continue;
177 		g_conf_consumer(sb, cp2);
178 	}
179 
180 	LIST_FOREACH(pp2, &gp->provider, provider) {
181 		if (pp != NULL && pp != pp2)
182 			continue;
183 		g_conf_provider(sb, pp2);
184 	}
185 	sbuf_printf(sb, "    </geom>\n");
186 }
187 
188 static void
189 g_conf_class(struct sbuf *sb, struct g_class *mp, struct g_geom *gp, struct g_provider *pp, struct g_consumer *cp)
190 {
191 	struct g_geom *gp2;
192 
193 	sbuf_printf(sb, "  <class id=\"%p\">\n", mp);
194 	sbuf_printf(sb, "    <name>%s</name>\n", mp->name);
195 	LIST_FOREACH(gp2, &mp->geom, geom) {
196 		if (gp != NULL && gp != gp2)
197 			continue;
198 		g_conf_geom(sb, gp2, pp, cp);
199 	}
200 	sbuf_printf(sb, "  </class>\n");
201 }
202 
203 void
204 g_conf_specific(struct sbuf *sb, struct g_class *mp, struct g_geom *gp, struct g_provider *pp, struct g_consumer *cp)
205 {
206 	struct g_class *mp2;
207 
208 	g_topology_assert();
209 	sbuf_printf(sb, "<mesh>\n");
210 #ifndef _KERNEL
211 	sbuf_printf(sb, "  <FreeBSD>%cFreeBSD%c</FreeBSD>\n", '$', '$');
212 #endif
213 	LIST_FOREACH(mp2, &g_classes, class) {
214 		if (mp != NULL && mp != mp2)
215 			continue;
216 		g_conf_class(sb, mp2, gp, pp, cp);
217 	}
218 	sbuf_printf(sb, "</mesh>\n");
219 	sbuf_finish(sb);
220 }
221 
222 void
223 g_confxml(void *p)
224 {
225 
226 	g_topology_assert();
227 	g_conf_specific(p, NULL, NULL, NULL, NULL);
228 	wakeup(p);
229 }
230 
231 void
232 g_trace(int level, char *fmt, ...)
233 {
234 	va_list ap;
235 
236 	g_sanity(NULL);
237 	if (!(g_debugflags & level))
238 		return;
239 	va_start(ap, fmt);
240 	vprintf(fmt, ap);
241 	printf("\n");
242 }
243 
244 void
245 g_hexdump(void *ptr, int length)
246 {
247 	int i, j, k;
248 	unsigned char *cp;
249 
250 	cp = ptr;
251 	for (i = 0; i < length; i+= 16) {
252 		printf("%04x  ", i);
253 		for (j = 0; j < 16; j++) {
254 			k = i + j;
255 			if (k < length)
256 				printf(" %02x", cp[k]);
257 			else
258 				printf("   ");
259 		}
260 		printf("  |");
261 		for (j = 0; j < 16; j++) {
262 			k = i + j;
263 			if (k >= length)
264 				printf(" ");
265 			else if (cp[k] >= ' ' && cp[k] <= '~')
266 				printf("%c", cp[k]);
267 			else
268 				printf(".");
269 		}
270 		printf("|\n");
271 	}
272 }
273 
274