xref: /freebsd/sys/geom/geom_dump.c (revision 729362425c09cf6b362366aabc6fb547eee8035a)
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/sbuf.h>
41 #ifndef _KERNEL
42 #include <stdio.h>
43 #include <string.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\"];\n",
62 	    cp, cp->acr, cp->acw, cp->ace);
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 static void
120 g_conftxt_geom(struct sbuf *sb, struct g_geom *gp, int level)
121 {
122 	struct g_provider *pp;
123 	struct g_consumer *cp;
124 
125 	LIST_FOREACH(pp, &gp->provider, provider) {
126 		sbuf_printf(sb, "%d %s %s %ju %u", level, gp->class->name,
127 		    pp->name, (uintmax_t)pp->mediasize, pp->sectorsize);
128 		if (gp->dumpconf != NULL)
129 			gp->dumpconf(sb, NULL, gp, NULL, pp);
130 		sbuf_printf(sb, "\n");
131 		LIST_FOREACH(cp, &pp->consumers, consumers)
132 			g_conftxt_geom(sb, cp->geom, level + 1);
133 	}
134 }
135 
136 static void
137 g_conftxt_class(struct sbuf *sb, struct g_class *mp)
138 {
139 	struct g_geom *gp;
140 
141 	LIST_FOREACH(gp, &mp->geom, geom)
142 		g_conftxt_geom(sb, gp, 0);
143 }
144 
145 void
146 g_conftxt(void *p)
147 {
148 	struct g_class *mp;
149 	struct sbuf *sb;
150 
151 	sb = p;
152 	g_topology_assert();
153 	LIST_FOREACH(mp, &g_classes, class)
154 		if (!strcmp(mp->name, "DISK"))
155 			break;
156 	if (mp != NULL)
157 		g_conftxt_class(sb, mp);
158 	sbuf_finish(sb);
159 	wakeup(p);
160 }
161 
162 
163 static void
164 g_conf_consumer(struct sbuf *sb, struct g_consumer *cp)
165 {
166 
167 	sbuf_printf(sb, "\t<consumer id=\"%p\">\n", cp);
168 	sbuf_printf(sb, "\t  <geom ref=\"%p\"/>\n", cp->geom);
169 	if (cp->provider != NULL)
170 		sbuf_printf(sb, "\t  <provider ref=\"%p\"/>\n", cp->provider);
171 	sbuf_printf(sb, "\t  <mode>r%dw%de%d</mode>\n",
172 	    cp->acr, cp->acw, cp->ace);
173 	if (cp->geom->dumpconf != NULL) {
174 		sbuf_printf(sb, "\t  <config>\n");
175 		cp->geom->dumpconf(sb, "\t    ", cp->geom, cp, NULL);
176 		sbuf_printf(sb, "\t  </config>\n");
177 	}
178 	sbuf_printf(sb, "\t</consumer>\n");
179 }
180 
181 static void
182 g_conf_provider(struct sbuf *sb, struct g_provider *pp)
183 {
184 
185 	sbuf_printf(sb, "\t<provider id=\"%p\">\n", pp);
186 	sbuf_printf(sb, "\t  <geom ref=\"%p\"/>\n", pp->geom);
187 	sbuf_printf(sb, "\t  <mode>r%dw%de%d</mode>\n",
188 	    pp->acr, pp->acw, pp->ace);
189 	sbuf_printf(sb, "\t  <name>%s</name>\n", pp->name);
190 	sbuf_printf(sb, "\t  <mediasize>%jd</mediasize>\n",
191 	    (intmax_t)pp->mediasize);
192 	sbuf_printf(sb, "\t  <sectorsize>%u</sectorsize>\n", pp->sectorsize);
193 	if (pp->geom->dumpconf != NULL) {
194 		sbuf_printf(sb, "\t  <config>\n");
195 		pp->geom->dumpconf(sb, "\t    ", pp->geom, NULL, pp);
196 		sbuf_printf(sb, "\t  </config>\n");
197 	}
198 	sbuf_printf(sb, "\t</provider>\n");
199 }
200 
201 
202 static void
203 g_conf_geom(struct sbuf *sb, struct g_geom *gp, struct g_provider *pp, struct g_consumer *cp)
204 {
205 	struct g_consumer *cp2;
206 	struct g_provider *pp2;
207 
208 	sbuf_printf(sb, "    <geom id=\"%p\">\n", gp);
209 	sbuf_printf(sb, "      <class ref=\"%p\"/>\n", gp->class);
210 	sbuf_printf(sb, "      <name>%s</name>\n", gp->name);
211 	sbuf_printf(sb, "      <rank>%d</rank>\n", gp->rank);
212 	if (gp->dumpconf != NULL) {
213 		sbuf_printf(sb, "      <config>\n");
214 		gp->dumpconf(sb, "\t", gp, NULL, NULL);
215 		sbuf_printf(sb, "      </config>\n");
216 	}
217 	LIST_FOREACH(cp2, &gp->consumer, consumer) {
218 		if (cp != NULL && cp != cp2)
219 			continue;
220 		g_conf_consumer(sb, cp2);
221 	}
222 
223 	LIST_FOREACH(pp2, &gp->provider, provider) {
224 		if (pp != NULL && pp != pp2)
225 			continue;
226 		g_conf_provider(sb, pp2);
227 	}
228 	sbuf_printf(sb, "    </geom>\n");
229 }
230 
231 static void
232 g_conf_class(struct sbuf *sb, struct g_class *mp, struct g_geom *gp, struct g_provider *pp, struct g_consumer *cp)
233 {
234 	struct g_geom *gp2;
235 
236 	sbuf_printf(sb, "  <class id=\"%p\">\n", mp);
237 	sbuf_printf(sb, "    <name>%s</name>\n", mp->name);
238 	LIST_FOREACH(gp2, &mp->geom, geom) {
239 		if (gp != NULL && gp != gp2)
240 			continue;
241 		g_conf_geom(sb, gp2, pp, cp);
242 	}
243 	sbuf_printf(sb, "  </class>\n");
244 }
245 
246 void
247 g_conf_specific(struct sbuf *sb, struct g_class *mp, struct g_geom *gp, struct g_provider *pp, struct g_consumer *cp)
248 {
249 	struct g_class *mp2;
250 
251 	g_topology_assert();
252 	sbuf_printf(sb, "<mesh>\n");
253 #ifndef _KERNEL
254 	sbuf_printf(sb, "  <FreeBSD>%cFreeBSD%c</FreeBSD>\n", '$', '$');
255 #endif
256 	LIST_FOREACH(mp2, &g_classes, class) {
257 		if (mp != NULL && mp != mp2)
258 			continue;
259 		g_conf_class(sb, mp2, gp, pp, cp);
260 	}
261 	sbuf_printf(sb, "</mesh>\n");
262 	sbuf_finish(sb);
263 }
264 
265 void
266 g_confxml(void *p)
267 {
268 
269 	g_topology_assert();
270 	g_conf_specific(p, NULL, NULL, NULL, NULL);
271 	wakeup(p);
272 }
273 
274 void
275 g_trace(int level, const char *fmt, ...)
276 {
277 	va_list ap;
278 
279 	g_sanity(NULL);
280 	if (!(g_debugflags & level))
281 		return;
282 	va_start(ap, fmt);
283 	vprintf(fmt, ap);
284 	printf("\n");
285 }
286 
287 void
288 g_hexdump(void *ptr, int length)
289 {
290 	int i, j, k;
291 	unsigned char *cp;
292 
293 	cp = ptr;
294 	for (i = 0; i < length; i+= 16) {
295 		printf("%04x  ", i);
296 		for (j = 0; j < 16; j++) {
297 			k = i + j;
298 			if (k < length)
299 				printf(" %02x", cp[k]);
300 			else
301 				printf("   ");
302 		}
303 		printf("  |");
304 		for (j = 0; j < 16; j++) {
305 			k = i + j;
306 			if (k >= length)
307 				printf(" ");
308 			else if (cp[k] >= ' ' && cp[k] <= '~')
309 				printf("%c", cp[k]);
310 			else
311 				printf(".");
312 		}
313 		printf("|\n");
314 	}
315 }
316 
317