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 
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD: stable/10/sys/geom/geom_subr.c 332096 2018-04-06 12:23:59Z avg $");
38 
39 #include "opt_ddb.h"
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/devicestat.h>
44 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/bio.h>
47 #include <sys/sysctl.h>
48 #include <sys/proc.h>
49 #include <sys/kthread.h>
50 #include <sys/lock.h>
51 #include <sys/mutex.h>
52 #include <sys/errno.h>
53 #include <sys/sbuf.h>
54 #include <geom/geom.h>
55 #include <geom/geom_int.h>
56 #include <machine/stdarg.h>
57 
58 #ifdef DDB
59 #include <ddb/ddb.h>
60 #endif
61 
62 #ifdef KDB
63 #include <sys/kdb.h>
64 #endif
65 
66 struct class_list_head g_classes = LIST_HEAD_INITIALIZER(g_classes);
67 static struct g_tailq_head geoms = TAILQ_HEAD_INITIALIZER(geoms);
68 char *g_wait_event, *g_wait_up, *g_wait_down, *g_wait_sim;
69 
70 struct g_hh00 {
71 	struct g_class		*mp;
72 	struct g_provider	*pp;
73 	off_t			size;
74 	int			error;
75 	int			post;
76 };
77 
78 /*
79  * This event offers a new class a chance to taste all preexisting providers.
80  */
81 static void
g_load_class(void * arg,int flag)82 g_load_class(void *arg, int flag)
83 {
84 	struct g_hh00 *hh;
85 	struct g_class *mp2, *mp;
86 	struct g_geom *gp;
87 	struct g_provider *pp;
88 
89 	g_topology_assert();
90 	if (flag == EV_CANCEL)	/* XXX: can't happen ? */
91 		return;
92 	if (g_shutdown)
93 		return;
94 
95 	hh = arg;
96 	mp = hh->mp;
97 	hh->error = 0;
98 	if (hh->post) {
99 		g_free(hh);
100 		hh = NULL;
101 	}
102 	g_trace(G_T_TOPOLOGY, "g_load_class(%s)", mp->name);
103 	KASSERT(mp->name != NULL && *mp->name != '\0',
104 	    ("GEOM class has no name"));
105 	LIST_FOREACH(mp2, &g_classes, class) {
106 		if (mp2 == mp) {
107 			printf("The GEOM class %s is already loaded.\n",
108 			    mp2->name);
109 			if (hh != NULL)
110 				hh->error = EEXIST;
111 			return;
112 		} else if (strcmp(mp2->name, mp->name) == 0) {
113 			printf("A GEOM class %s is already loaded.\n",
114 			    mp2->name);
115 			if (hh != NULL)
116 				hh->error = EEXIST;
117 			return;
118 		}
119 	}
120 
121 	LIST_INIT(&mp->geom);
122 	LIST_INSERT_HEAD(&g_classes, mp, class);
123 	if (mp->init != NULL)
124 		mp->init(mp);
125 	if (mp->taste == NULL)
126 		return;
127 	LIST_FOREACH(mp2, &g_classes, class) {
128 		if (mp == mp2)
129 			continue;
130 		LIST_FOREACH(gp, &mp2->geom, geom) {
131 			LIST_FOREACH(pp, &gp->provider, provider) {
132 				mp->taste(mp, pp, 0);
133 				g_topology_assert();
134 			}
135 		}
136 	}
137 }
138 
139 static int
g_unload_class(struct g_class * mp)140 g_unload_class(struct g_class *mp)
141 {
142 	struct g_geom *gp;
143 	struct g_provider *pp;
144 	struct g_consumer *cp;
145 	int error;
146 
147 	g_topology_lock();
148 	g_trace(G_T_TOPOLOGY, "g_unload_class(%s)", mp->name);
149 retry:
150 	G_VALID_CLASS(mp);
151 	LIST_FOREACH(gp, &mp->geom, geom) {
152 		/* We refuse to unload if anything is open */
153 		LIST_FOREACH(pp, &gp->provider, provider)
154 			if (pp->acr || pp->acw || pp->ace) {
155 				g_topology_unlock();
156 				return (EBUSY);
157 			}
158 		LIST_FOREACH(cp, &gp->consumer, consumer)
159 			if (cp->acr || cp->acw || cp->ace) {
160 				g_topology_unlock();
161 				return (EBUSY);
162 			}
163 		/* If the geom is withering, wait for it to finish. */
164 		if (gp->flags & G_GEOM_WITHER) {
165 			g_topology_sleep(mp, 1);
166 			goto retry;
167 		}
168 	}
169 
170 	/*
171 	 * We allow unloading if we have no geoms, or a class
172 	 * method we can use to get rid of them.
173 	 */
174 	if (!LIST_EMPTY(&mp->geom) && mp->destroy_geom == NULL) {
175 		g_topology_unlock();
176 		return (EOPNOTSUPP);
177 	}
178 
179 	/* Bar new entries */
180 	mp->taste = NULL;
181 	mp->config = NULL;
182 
183 	LIST_FOREACH(gp, &mp->geom, geom) {
184 		error = mp->destroy_geom(NULL, mp, gp);
185 		if (error != 0) {
186 			g_topology_unlock();
187 			return (error);
188 		}
189 	}
190 	/* Wait for withering to finish. */
191 	for (;;) {
192 		gp = LIST_FIRST(&mp->geom);
193 		if (gp == NULL)
194 			break;
195 		KASSERT(gp->flags & G_GEOM_WITHER,
196 		   ("Non-withering geom in class %s", mp->name));
197 		g_topology_sleep(mp, 1);
198 	}
199 	G_VALID_CLASS(mp);
200 	if (mp->fini != NULL)
201 		mp->fini(mp);
202 	LIST_REMOVE(mp, class);
203 	g_topology_unlock();
204 
205 	return (0);
206 }
207 
208 int
g_modevent(module_t mod,int type,void * data)209 g_modevent(module_t mod, int type, void *data)
210 {
211 	struct g_hh00 *hh;
212 	int error;
213 	static int g_ignition;
214 	struct g_class *mp;
215 
216 	mp = data;
217 	if (mp->version != G_VERSION) {
218 		printf("GEOM class %s has Wrong version %x\n",
219 		    mp->name, mp->version);
220 		return (EINVAL);
221 	}
222 	if (!g_ignition) {
223 		g_ignition++;
224 		g_init();
225 	}
226 	error = EOPNOTSUPP;
227 	switch (type) {
228 	case MOD_LOAD:
229 		g_trace(G_T_TOPOLOGY, "g_modevent(%s, LOAD)", mp->name);
230 		hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
231 		hh->mp = mp;
232 		/*
233 		 * Once the system is not cold, MOD_LOAD calls will be
234 		 * from the userland and the g_event thread will be able
235 		 * to acknowledge their completion.
236 		 */
237 		if (cold) {
238 			hh->post = 1;
239 			error = g_post_event(g_load_class, hh, M_WAITOK, NULL);
240 		} else {
241 			error = g_waitfor_event(g_load_class, hh, M_WAITOK,
242 			    NULL);
243 			if (error == 0)
244 				error = hh->error;
245 			g_free(hh);
246 		}
247 		break;
248 	case MOD_UNLOAD:
249 		g_trace(G_T_TOPOLOGY, "g_modevent(%s, UNLOAD)", mp->name);
250 		DROP_GIANT();
251 		error = g_unload_class(mp);
252 		PICKUP_GIANT();
253 		if (error == 0) {
254 			KASSERT(LIST_EMPTY(&mp->geom),
255 			    ("Unloaded class (%s) still has geom", mp->name));
256 		}
257 		break;
258 	}
259 	return (error);
260 }
261 
262 static void
g_retaste_event(void * arg,int flag)263 g_retaste_event(void *arg, int flag)
264 {
265 	struct g_class *mp, *mp2;
266 	struct g_geom *gp;
267 	struct g_hh00 *hh;
268 	struct g_provider *pp;
269 	struct g_consumer *cp;
270 
271 	g_topology_assert();
272 	if (flag == EV_CANCEL)  /* XXX: can't happen ? */
273 		return;
274 	if (g_shutdown || g_notaste)
275 		return;
276 
277 	hh = arg;
278 	mp = hh->mp;
279 	hh->error = 0;
280 	if (hh->post) {
281 		g_free(hh);
282 		hh = NULL;
283 	}
284 	g_trace(G_T_TOPOLOGY, "g_retaste(%s)", mp->name);
285 
286 	LIST_FOREACH(mp2, &g_classes, class) {
287 		LIST_FOREACH(gp, &mp2->geom, geom) {
288 			LIST_FOREACH(pp, &gp->provider, provider) {
289 				if (pp->acr || pp->acw || pp->ace)
290 					continue;
291 				LIST_FOREACH(cp, &pp->consumers, consumers) {
292 					if (cp->geom->class == mp &&
293 					    (cp->flags & G_CF_ORPHAN) == 0)
294 						break;
295 				}
296 				if (cp != NULL) {
297 					cp->flags |= G_CF_ORPHAN;
298 					g_wither_geom(cp->geom, ENXIO);
299 				}
300 				mp->taste(mp, pp, 0);
301 				g_topology_assert();
302 			}
303 		}
304 	}
305 }
306 
307 int
g_retaste(struct g_class * mp)308 g_retaste(struct g_class *mp)
309 {
310 	struct g_hh00 *hh;
311 	int error;
312 
313 	if (mp->taste == NULL)
314 		return (EINVAL);
315 
316 	hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
317 	hh->mp = mp;
318 
319 	if (cold) {
320 		hh->post = 1;
321 		error = g_post_event(g_retaste_event, hh, M_WAITOK, NULL);
322 	} else {
323 		error = g_waitfor_event(g_retaste_event, hh, M_WAITOK, NULL);
324 		if (error == 0)
325 			error = hh->error;
326 		g_free(hh);
327 	}
328 
329 	return (error);
330 }
331 
332 struct g_geom *
g_new_geomf(struct g_class * mp,const char * fmt,...)333 g_new_geomf(struct g_class *mp, const char *fmt, ...)
334 {
335 	struct g_geom *gp;
336 	va_list ap;
337 	struct sbuf *sb;
338 
339 	g_topology_assert();
340 	G_VALID_CLASS(mp);
341 	sb = sbuf_new_auto();
342 	va_start(ap, fmt);
343 	sbuf_vprintf(sb, fmt, ap);
344 	va_end(ap);
345 	sbuf_finish(sb);
346 	gp = g_malloc(sizeof *gp, M_WAITOK | M_ZERO);
347 	gp->name = g_malloc(sbuf_len(sb) + 1, M_WAITOK | M_ZERO);
348 	gp->class = mp;
349 	gp->rank = 1;
350 	LIST_INIT(&gp->consumer);
351 	LIST_INIT(&gp->provider);
352 	LIST_INSERT_HEAD(&mp->geom, gp, geom);
353 	TAILQ_INSERT_HEAD(&geoms, gp, geoms);
354 	strcpy(gp->name, sbuf_data(sb));
355 	sbuf_delete(sb);
356 	/* Fill in defaults from class */
357 	gp->start = mp->start;
358 	gp->spoiled = mp->spoiled;
359 	gp->attrchanged = mp->attrchanged;
360 	gp->providergone = mp->providergone;
361 	gp->dumpconf = mp->dumpconf;
362 	gp->access = mp->access;
363 	gp->orphan = mp->orphan;
364 	gp->ioctl = mp->ioctl;
365 	gp->resize = mp->resize;
366 	return (gp);
367 }
368 
369 void
g_destroy_geom(struct g_geom * gp)370 g_destroy_geom(struct g_geom *gp)
371 {
372 
373 	g_topology_assert();
374 	G_VALID_GEOM(gp);
375 	g_trace(G_T_TOPOLOGY, "g_destroy_geom(%p(%s))", gp, gp->name);
376 	KASSERT(LIST_EMPTY(&gp->consumer),
377 	    ("g_destroy_geom(%s) with consumer(s) [%p]",
378 	    gp->name, LIST_FIRST(&gp->consumer)));
379 	KASSERT(LIST_EMPTY(&gp->provider),
380 	    ("g_destroy_geom(%s) with provider(s) [%p]",
381 	    gp->name, LIST_FIRST(&gp->provider)));
382 	g_cancel_event(gp);
383 	LIST_REMOVE(gp, geom);
384 	TAILQ_REMOVE(&geoms, gp, geoms);
385 	g_free(gp->name);
386 	g_free(gp);
387 }
388 
389 /*
390  * This function is called (repeatedly) until the geom has withered away.
391  */
392 void
g_wither_geom(struct g_geom * gp,int error)393 g_wither_geom(struct g_geom *gp, int error)
394 {
395 	struct g_provider *pp;
396 
397 	g_topology_assert();
398 	G_VALID_GEOM(gp);
399 	g_trace(G_T_TOPOLOGY, "g_wither_geom(%p(%s))", gp, gp->name);
400 	if (!(gp->flags & G_GEOM_WITHER)) {
401 		gp->flags |= G_GEOM_WITHER;
402 		LIST_FOREACH(pp, &gp->provider, provider)
403 			if (!(pp->flags & G_PF_ORPHAN))
404 				g_orphan_provider(pp, error);
405 	}
406 	g_do_wither();
407 }
408 
409 /*
410  * Convenience function to destroy a particular provider.
411  */
412 void
g_wither_provider(struct g_provider * pp,int error)413 g_wither_provider(struct g_provider *pp, int error)
414 {
415 
416 	pp->flags |= G_PF_WITHER;
417 	if (!(pp->flags & G_PF_ORPHAN))
418 		g_orphan_provider(pp, error);
419 }
420 
421 /*
422  * This function is called (repeatedly) until the has withered away.
423  */
424 void
g_wither_geom_close(struct g_geom * gp,int error)425 g_wither_geom_close(struct g_geom *gp, int error)
426 {
427 	struct g_consumer *cp;
428 
429 	g_topology_assert();
430 	G_VALID_GEOM(gp);
431 	g_trace(G_T_TOPOLOGY, "g_wither_geom_close(%p(%s))", gp, gp->name);
432 	LIST_FOREACH(cp, &gp->consumer, consumer)
433 		if (cp->acr || cp->acw || cp->ace)
434 			g_access(cp, -cp->acr, -cp->acw, -cp->ace);
435 	g_wither_geom(gp, error);
436 }
437 
438 /*
439  * This function is called (repeatedly) until we cant wash away more
440  * withered bits at present.
441  */
442 void
g_wither_washer()443 g_wither_washer()
444 {
445 	struct g_class *mp;
446 	struct g_geom *gp, *gp2;
447 	struct g_provider *pp, *pp2;
448 	struct g_consumer *cp, *cp2;
449 
450 	g_topology_assert();
451 	LIST_FOREACH(mp, &g_classes, class) {
452 		LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
453 			LIST_FOREACH_SAFE(pp, &gp->provider, provider, pp2) {
454 				if (!(pp->flags & G_PF_WITHER))
455 					continue;
456 				if (LIST_EMPTY(&pp->consumers))
457 					g_destroy_provider(pp);
458 			}
459 			if (!(gp->flags & G_GEOM_WITHER))
460 				continue;
461 			LIST_FOREACH_SAFE(pp, &gp->provider, provider, pp2) {
462 				if (LIST_EMPTY(&pp->consumers))
463 					g_destroy_provider(pp);
464 			}
465 			LIST_FOREACH_SAFE(cp, &gp->consumer, consumer, cp2) {
466 				if (cp->acr || cp->acw || cp->ace)
467 					continue;
468 				if (cp->provider != NULL)
469 					g_detach(cp);
470 				g_destroy_consumer(cp);
471 			}
472 			if (LIST_EMPTY(&gp->provider) &&
473 			    LIST_EMPTY(&gp->consumer))
474 				g_destroy_geom(gp);
475 		}
476 	}
477 }
478 
479 struct g_consumer *
g_new_consumer(struct g_geom * gp)480 g_new_consumer(struct g_geom *gp)
481 {
482 	struct g_consumer *cp;
483 
484 	g_topology_assert();
485 	G_VALID_GEOM(gp);
486 	KASSERT(!(gp->flags & G_GEOM_WITHER),
487 	    ("g_new_consumer on WITHERing geom(%s) (class %s)",
488 	    gp->name, gp->class->name));
489 	KASSERT(gp->orphan != NULL,
490 	    ("g_new_consumer on geom(%s) (class %s) without orphan",
491 	    gp->name, gp->class->name));
492 
493 	cp = g_malloc(sizeof *cp, M_WAITOK | M_ZERO);
494 	cp->geom = gp;
495 	cp->stat = devstat_new_entry(cp, -1, 0, DEVSTAT_ALL_SUPPORTED,
496 	    DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
497 	LIST_INSERT_HEAD(&gp->consumer, cp, consumer);
498 	return(cp);
499 }
500 
501 void
g_destroy_consumer(struct g_consumer * cp)502 g_destroy_consumer(struct g_consumer *cp)
503 {
504 	struct g_geom *gp;
505 
506 	g_topology_assert();
507 	G_VALID_CONSUMER(cp);
508 	g_trace(G_T_TOPOLOGY, "g_destroy_consumer(%p)", cp);
509 	KASSERT (cp->provider == NULL, ("g_destroy_consumer but attached"));
510 	KASSERT (cp->acr == 0, ("g_destroy_consumer with acr"));
511 	KASSERT (cp->acw == 0, ("g_destroy_consumer with acw"));
512 	KASSERT (cp->ace == 0, ("g_destroy_consumer with ace"));
513 	g_cancel_event(cp);
514 	gp = cp->geom;
515 	LIST_REMOVE(cp, consumer);
516 	devstat_remove_entry(cp->stat);
517 	g_free(cp);
518 	if (gp->flags & G_GEOM_WITHER)
519 		g_do_wither();
520 }
521 
522 static void
g_new_provider_event(void * arg,int flag)523 g_new_provider_event(void *arg, int flag)
524 {
525 	struct g_class *mp;
526 	struct g_provider *pp;
527 	struct g_consumer *cp, *next_cp;
528 
529 	g_topology_assert();
530 	if (flag == EV_CANCEL)
531 		return;
532 	if (g_shutdown)
533 		return;
534 	pp = arg;
535 	G_VALID_PROVIDER(pp);
536 	KASSERT(!(pp->flags & G_PF_WITHER),
537 	    ("g_new_provider_event but withered"));
538 	LIST_FOREACH_SAFE(cp, &pp->consumers, consumers, next_cp) {
539 		if ((cp->flags & G_CF_ORPHAN) == 0 &&
540 		    cp->geom->attrchanged != NULL)
541 			cp->geom->attrchanged(cp, "GEOM::media");
542 	}
543 	if (g_notaste)
544 		return;
545 	LIST_FOREACH(mp, &g_classes, class) {
546 		if (mp->taste == NULL)
547 			continue;
548 		LIST_FOREACH(cp, &pp->consumers, consumers)
549 			if (cp->geom->class == mp &&
550 			    (cp->flags & G_CF_ORPHAN) == 0)
551 				break;
552 		if (cp != NULL)
553 			continue;
554 		mp->taste(mp, pp, 0);
555 		g_topology_assert();
556 	}
557 }
558 
559 
560 struct g_provider *
g_new_providerf(struct g_geom * gp,const char * fmt,...)561 g_new_providerf(struct g_geom *gp, const char *fmt, ...)
562 {
563 	struct g_provider *pp;
564 	struct sbuf *sb;
565 	va_list ap;
566 
567 	g_topology_assert();
568 	G_VALID_GEOM(gp);
569 	KASSERT(gp->access != NULL,
570 	    ("new provider on geom(%s) without ->access (class %s)",
571 	    gp->name, gp->class->name));
572 	KASSERT(gp->start != NULL,
573 	    ("new provider on geom(%s) without ->start (class %s)",
574 	    gp->name, gp->class->name));
575 	KASSERT(!(gp->flags & G_GEOM_WITHER),
576 	    ("new provider on WITHERing geom(%s) (class %s)",
577 	    gp->name, gp->class->name));
578 	sb = sbuf_new_auto();
579 	va_start(ap, fmt);
580 	sbuf_vprintf(sb, fmt, ap);
581 	va_end(ap);
582 	sbuf_finish(sb);
583 	pp = g_malloc(sizeof *pp + sbuf_len(sb) + 1, M_WAITOK | M_ZERO);
584 	pp->name = (char *)(pp + 1);
585 	strcpy(pp->name, sbuf_data(sb));
586 	sbuf_delete(sb);
587 	LIST_INIT(&pp->consumers);
588 	pp->error = ENXIO;
589 	pp->geom = gp;
590 	pp->stat = devstat_new_entry(pp, -1, 0, DEVSTAT_ALL_SUPPORTED,
591 	    DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
592 	LIST_INSERT_HEAD(&gp->provider, pp, provider);
593 	g_post_event(g_new_provider_event, pp, M_WAITOK, pp, gp, NULL);
594 	return (pp);
595 }
596 
597 void
g_error_provider(struct g_provider * pp,int error)598 g_error_provider(struct g_provider *pp, int error)
599 {
600 
601 	/* G_VALID_PROVIDER(pp);  We may not have g_topology */
602 	pp->error = error;
603 }
604 
605 static void
g_resize_provider_event(void * arg,int flag)606 g_resize_provider_event(void *arg, int flag)
607 {
608 	struct g_hh00 *hh;
609 	struct g_class *mp;
610 	struct g_geom *gp;
611 	struct g_provider *pp;
612 	struct g_consumer *cp, *cp2;
613 	off_t size;
614 
615 	g_topology_assert();
616 	if (g_shutdown)
617 		return;
618 
619 	hh = arg;
620 	pp = hh->pp;
621 	size = hh->size;
622 	g_free(hh);
623 
624 	G_VALID_PROVIDER(pp);
625 	g_trace(G_T_TOPOLOGY, "g_resize_provider_event(%p)", pp);
626 
627 	LIST_FOREACH_SAFE(cp, &pp->consumers, consumers, cp2) {
628 		gp = cp->geom;
629 		if (gp->resize == NULL && size < pp->mediasize) {
630 			cp->flags |= G_CF_ORPHAN;
631 			cp->geom->orphan(cp);
632 		}
633 	}
634 
635 	pp->mediasize = size;
636 
637 	LIST_FOREACH_SAFE(cp, &pp->consumers, consumers, cp2) {
638 		gp = cp->geom;
639 		if (gp->resize != NULL)
640 			gp->resize(cp);
641 	}
642 
643 	/*
644 	 * After resizing, the previously invalid GEOM class metadata
645 	 * might become valid.  This means we should retaste.
646 	 */
647 	LIST_FOREACH(mp, &g_classes, class) {
648 		if (mp->taste == NULL)
649 			continue;
650 		LIST_FOREACH(cp, &pp->consumers, consumers)
651 			if (cp->geom->class == mp &&
652 			    (cp->flags & G_CF_ORPHAN) == 0)
653 				break;
654 		if (cp != NULL)
655 			continue;
656 		mp->taste(mp, pp, 0);
657 		g_topology_assert();
658 	}
659 }
660 
661 void
g_resize_provider(struct g_provider * pp,off_t size)662 g_resize_provider(struct g_provider *pp, off_t size)
663 {
664 	struct g_hh00 *hh;
665 
666 	G_VALID_PROVIDER(pp);
667 
668 	if (size == pp->mediasize)
669 		return;
670 
671 	hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
672 	hh->pp = pp;
673 	hh->size = size;
674 	g_post_event(g_resize_provider_event, hh, M_WAITOK, NULL);
675 }
676 
677 #ifndef	_PATH_DEV
678 #define	_PATH_DEV	"/dev/"
679 #endif
680 
681 struct g_provider *
g_provider_by_name(char const * arg)682 g_provider_by_name(char const *arg)
683 {
684 	struct g_class *cp;
685 	struct g_geom *gp;
686 	struct g_provider *pp, *wpp;
687 
688 	if (strncmp(arg, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
689 		arg += sizeof(_PATH_DEV) - 1;
690 
691 	wpp = NULL;
692 	LIST_FOREACH(cp, &g_classes, class) {
693 		LIST_FOREACH(gp, &cp->geom, geom) {
694 			LIST_FOREACH(pp, &gp->provider, provider) {
695 				if (strcmp(arg, pp->name) != 0)
696 					continue;
697 				if ((gp->flags & G_GEOM_WITHER) == 0 &&
698 				    (pp->flags & G_PF_WITHER) == 0)
699 					return (pp);
700 				else
701 					wpp = pp;
702 			}
703 		}
704 	}
705 
706 	return (wpp);
707 }
708 
709 void
g_destroy_provider(struct g_provider * pp)710 g_destroy_provider(struct g_provider *pp)
711 {
712 	struct g_geom *gp;
713 
714 	g_topology_assert();
715 	G_VALID_PROVIDER(pp);
716 	KASSERT(LIST_EMPTY(&pp->consumers),
717 	    ("g_destroy_provider but attached"));
718 	KASSERT (pp->acr == 0, ("g_destroy_provider with acr"));
719 	KASSERT (pp->acw == 0, ("g_destroy_provider with acw"));
720 	KASSERT (pp->ace == 0, ("g_destroy_provider with ace"));
721 	g_cancel_event(pp);
722 	LIST_REMOVE(pp, provider);
723 	gp = pp->geom;
724 	devstat_remove_entry(pp->stat);
725 	/*
726 	 * If a callback was provided, send notification that the provider
727 	 * is now gone.
728 	 */
729 	if (gp->providergone != NULL)
730 		gp->providergone(pp);
731 
732 	g_free(pp);
733 	if ((gp->flags & G_GEOM_WITHER))
734 		g_do_wither();
735 }
736 
737 /*
738  * We keep the "geoms" list sorted by topological order (== increasing
739  * numerical rank) at all times.
740  * When an attach is done, the attaching geoms rank is invalidated
741  * and it is moved to the tail of the list.
742  * All geoms later in the sequence has their ranks reevaluated in
743  * sequence.  If we cannot assign rank to a geom because it's
744  * prerequisites do not have rank, we move that element to the tail
745  * of the sequence with invalid rank as well.
746  * At some point we encounter our original geom and if we stil fail
747  * to assign it a rank, there must be a loop and we fail back to
748  * g_attach() which detach again and calls redo_rank again
749  * to fix up the damage.
750  * It would be much simpler code wise to do it recursively, but we
751  * can't risk that on the kernel stack.
752  */
753 
754 static int
redo_rank(struct g_geom * gp)755 redo_rank(struct g_geom *gp)
756 {
757 	struct g_consumer *cp;
758 	struct g_geom *gp1, *gp2;
759 	int n, m;
760 
761 	g_topology_assert();
762 	G_VALID_GEOM(gp);
763 
764 	/* Invalidate this geoms rank and move it to the tail */
765 	gp1 = TAILQ_NEXT(gp, geoms);
766 	if (gp1 != NULL) {
767 		gp->rank = 0;
768 		TAILQ_REMOVE(&geoms, gp, geoms);
769 		TAILQ_INSERT_TAIL(&geoms, gp, geoms);
770 	} else {
771 		gp1 = gp;
772 	}
773 
774 	/* re-rank the rest of the sequence */
775 	for (; gp1 != NULL; gp1 = gp2) {
776 		gp1->rank = 0;
777 		m = 1;
778 		LIST_FOREACH(cp, &gp1->consumer, consumer) {
779 			if (cp->provider == NULL)
780 				continue;
781 			n = cp->provider->geom->rank;
782 			if (n == 0) {
783 				m = 0;
784 				break;
785 			} else if (n >= m)
786 				m = n + 1;
787 		}
788 		gp1->rank = m;
789 		gp2 = TAILQ_NEXT(gp1, geoms);
790 
791 		/* got a rank, moving on */
792 		if (m != 0)
793 			continue;
794 
795 		/* no rank to original geom means loop */
796 		if (gp == gp1)
797 			return (ELOOP);
798 
799 		/* no rank, put it at the end move on */
800 		TAILQ_REMOVE(&geoms, gp1, geoms);
801 		TAILQ_INSERT_TAIL(&geoms, gp1, geoms);
802 	}
803 	return (0);
804 }
805 
806 int
g_attach(struct g_consumer * cp,struct g_provider * pp)807 g_attach(struct g_consumer *cp, struct g_provider *pp)
808 {
809 	int error;
810 
811 	g_topology_assert();
812 	G_VALID_CONSUMER(cp);
813 	G_VALID_PROVIDER(pp);
814 	g_trace(G_T_TOPOLOGY, "g_attach(%p, %p)", cp, pp);
815 	KASSERT(cp->provider == NULL, ("attach but attached"));
816 	cp->provider = pp;
817 	LIST_INSERT_HEAD(&pp->consumers, cp, consumers);
818 	error = redo_rank(cp->geom);
819 	if (error) {
820 		LIST_REMOVE(cp, consumers);
821 		cp->provider = NULL;
822 		redo_rank(cp->geom);
823 	}
824 	return (error);
825 }
826 
827 void
g_detach(struct g_consumer * cp)828 g_detach(struct g_consumer *cp)
829 {
830 	struct g_provider *pp;
831 
832 	g_topology_assert();
833 	G_VALID_CONSUMER(cp);
834 	g_trace(G_T_TOPOLOGY, "g_detach(%p)", cp);
835 	KASSERT(cp->provider != NULL, ("detach but not attached"));
836 	KASSERT(cp->acr == 0, ("detach but nonzero acr"));
837 	KASSERT(cp->acw == 0, ("detach but nonzero acw"));
838 	KASSERT(cp->ace == 0, ("detach but nonzero ace"));
839 	KASSERT(cp->nstart == cp->nend,
840 	    ("detach with active requests"));
841 	pp = cp->provider;
842 	LIST_REMOVE(cp, consumers);
843 	cp->provider = NULL;
844 	if ((cp->geom->flags & G_GEOM_WITHER) ||
845 	    (pp->geom->flags & G_GEOM_WITHER) ||
846 	    (pp->flags & G_PF_WITHER))
847 		g_do_wither();
848 	redo_rank(cp->geom);
849 }
850 
851 /*
852  * g_access()
853  *
854  * Access-check with delta values.  The question asked is "can provider
855  * "cp" change the access counters by the relative amounts dc[rwe] ?"
856  */
857 
858 int
g_access(struct g_consumer * cp,int dcr,int dcw,int dce)859 g_access(struct g_consumer *cp, int dcr, int dcw, int dce)
860 {
861 	struct g_provider *pp;
862 	struct g_geom *gp;
863 	int pw, pe;
864 #ifdef INVARIANTS
865 	int sr, sw, se;
866 #endif
867 	int error;
868 
869 	g_topology_assert();
870 	G_VALID_CONSUMER(cp);
871 	pp = cp->provider;
872 	KASSERT(pp != NULL, ("access but not attached"));
873 	G_VALID_PROVIDER(pp);
874 	gp = pp->geom;
875 
876 	g_trace(G_T_ACCESS, "g_access(%p(%s), %d, %d, %d)",
877 	    cp, pp->name, dcr, dcw, dce);
878 
879 	KASSERT(cp->acr + dcr >= 0, ("access resulting in negative acr"));
880 	KASSERT(cp->acw + dcw >= 0, ("access resulting in negative acw"));
881 	KASSERT(cp->ace + dce >= 0, ("access resulting in negative ace"));
882 	KASSERT(dcr != 0 || dcw != 0 || dce != 0, ("NOP access request"));
883 	KASSERT(gp->access != NULL, ("NULL geom->access"));
884 
885 	/*
886 	 * If our class cares about being spoiled, and we have been, we
887 	 * are probably just ahead of the event telling us that.  Fail
888 	 * now rather than having to unravel this later.
889 	 */
890 	if (cp->geom->spoiled != NULL && (cp->flags & G_CF_SPOILED) &&
891 	    (dcr > 0 || dcw > 0 || dce > 0))
892 		return (ENXIO);
893 
894 	/*
895 	 * A number of GEOM classes either need to perform an I/O on the first
896 	 * open or to acquire a different subsystem's lock.  To do that they
897 	 * may have to drop the topology lock.
898 	 * Other GEOM classes perform special actions when opening a lower rank
899 	 * geom for the first time.  As a result, more than one thread may
900 	 * end up performing the special actions.
901 	 * So, we prevent concurrent "first" opens by marking the consumer with
902 	 * special flag.
903 	 *
904 	 * Note that if the geom's access method never drops the topology lock,
905 	 * then we will never see G_GEOM_IN_ACCESS here.
906 	 */
907 	while ((gp->flags & G_GEOM_IN_ACCESS) != 0) {
908 		g_trace(G_T_ACCESS,
909 		    "%s: race on geom %s via provider %s and consumer of %s",
910 		    __func__, gp->name, pp->name, cp->geom->name);
911 		gp->flags |= G_GEOM_ACCESS_WAIT;
912 		g_topology_sleep(gp, 0);
913 	}
914 
915 	/*
916 	 * Figure out what counts the provider would have had, if this
917 	 * consumer had (r0w0e0) at this time.
918 	 */
919 	pw = pp->acw - cp->acw;
920 	pe = pp->ace - cp->ace;
921 
922 	g_trace(G_T_ACCESS,
923     "open delta:[r%dw%de%d] old:[r%dw%de%d] provider:[r%dw%de%d] %p(%s)",
924 	    dcr, dcw, dce,
925 	    cp->acr, cp->acw, cp->ace,
926 	    pp->acr, pp->acw, pp->ace,
927 	    pp, pp->name);
928 
929 	/* If foot-shooting is enabled, any open on rank#1 is OK */
930 	if ((g_debugflags & 16) && gp->rank == 1)
931 		;
932 	/* If we try exclusive but already write: fail */
933 	else if (dce > 0 && pw > 0)
934 		return (EPERM);
935 	/* If we try write but already exclusive: fail */
936 	else if (dcw > 0 && pe > 0)
937 		return (EPERM);
938 	/* If we try to open more but provider is error'ed: fail */
939 	else if ((dcr > 0 || dcw > 0 || dce > 0) && pp->error != 0)
940 		return (pp->error);
941 
942 	/* Ok then... */
943 
944 #ifdef INVARIANTS
945 	sr = cp->acr;
946 	sw = cp->acw;
947 	se = cp->ace;
948 #endif
949 	gp->flags |= G_GEOM_IN_ACCESS;
950 	error = gp->access(pp, dcr, dcw, dce);
951 	KASSERT(dcr > 0 || dcw > 0 || dce > 0 || error == 0,
952 	    ("Geom provider %s::%s dcr=%d dcw=%d dce=%d error=%d failed "
953 	    "closing ->access()", gp->class->name, pp->name, dcr, dcw,
954 	    dce, error));
955 
956 	g_topology_assert();
957 	gp->flags &= ~G_GEOM_IN_ACCESS;
958 	KASSERT(cp->acr == sr && cp->acw == sw && cp->ace == se,
959 	    ("Access counts changed during geom->access"));
960 	if ((gp->flags & G_GEOM_ACCESS_WAIT) != 0) {
961 		gp->flags &= ~G_GEOM_ACCESS_WAIT;
962 		wakeup(gp);
963 	}
964 
965 	if (!error) {
966 		/*
967 		 * If we open first write, spoil any partner consumers.
968 		 * If we close last write and provider is not errored,
969 		 * trigger re-taste.
970 		 */
971 		if (pp->acw == 0 && dcw != 0)
972 			g_spoil(pp, cp);
973 		else if (pp->acw != 0 && pp->acw == -dcw && pp->error == 0 &&
974 		    !(gp->flags & G_GEOM_WITHER))
975 			g_post_event(g_new_provider_event, pp, M_WAITOK,
976 			    pp, NULL);
977 
978 		pp->acr += dcr;
979 		pp->acw += dcw;
980 		pp->ace += dce;
981 		cp->acr += dcr;
982 		cp->acw += dcw;
983 		cp->ace += dce;
984 		if (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)
985 			KASSERT(pp->sectorsize > 0,
986 			    ("Provider %s lacks sectorsize", pp->name));
987 		if ((cp->geom->flags & G_GEOM_WITHER) &&
988 		    cp->acr == 0 && cp->acw == 0 && cp->ace == 0)
989 			g_do_wither();
990 	}
991 	return (error);
992 }
993 
994 int
g_handleattr_int(struct bio * bp,const char * attribute,int val)995 g_handleattr_int(struct bio *bp, const char *attribute, int val)
996 {
997 
998 	return (g_handleattr(bp, attribute, &val, sizeof val));
999 }
1000 
1001 int
g_handleattr_uint16_t(struct bio * bp,const char * attribute,uint16_t val)1002 g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val)
1003 {
1004 
1005 	return (g_handleattr(bp, attribute, &val, sizeof val));
1006 }
1007 
1008 int
g_handleattr_off_t(struct bio * bp,const char * attribute,off_t val)1009 g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val)
1010 {
1011 
1012 	return (g_handleattr(bp, attribute, &val, sizeof val));
1013 }
1014 
1015 int
g_handleattr_str(struct bio * bp,const char * attribute,const char * str)1016 g_handleattr_str(struct bio *bp, const char *attribute, const char *str)
1017 {
1018 
1019 	return (g_handleattr(bp, attribute, str, 0));
1020 }
1021 
1022 int
g_handleattr(struct bio * bp,const char * attribute,const void * val,int len)1023 g_handleattr(struct bio *bp, const char *attribute, const void *val, int len)
1024 {
1025 	int error = 0;
1026 
1027 	if (strcmp(bp->bio_attribute, attribute))
1028 		return (0);
1029 	if (len == 0) {
1030 		bzero(bp->bio_data, bp->bio_length);
1031 		if (strlcpy(bp->bio_data, val, bp->bio_length) >=
1032 		    bp->bio_length) {
1033 			printf("%s: %s bio_length %jd len %zu -> EFAULT\n",
1034 			    __func__, bp->bio_to->name,
1035 			    (intmax_t)bp->bio_length, strlen(val));
1036 			error = EFAULT;
1037 		}
1038 	} else if (bp->bio_length == len) {
1039 		bcopy(val, bp->bio_data, len);
1040 	} else {
1041 		printf("%s: %s bio_length %jd len %d -> EFAULT\n", __func__,
1042 		    bp->bio_to->name, (intmax_t)bp->bio_length, len);
1043 		error = EFAULT;
1044 	}
1045 	if (error == 0)
1046 		bp->bio_completed = bp->bio_length;
1047 	g_io_deliver(bp, error);
1048 	return (1);
1049 }
1050 
1051 int
g_std_access(struct g_provider * pp,int dr __unused,int dw __unused,int de __unused)1052 g_std_access(struct g_provider *pp,
1053 	int dr __unused, int dw __unused, int de __unused)
1054 {
1055 
1056 	g_topology_assert();
1057 	G_VALID_PROVIDER(pp);
1058         return (0);
1059 }
1060 
1061 void
g_std_done(struct bio * bp)1062 g_std_done(struct bio *bp)
1063 {
1064 	struct bio *bp2;
1065 
1066 	bp2 = bp->bio_parent;
1067 	if (bp2->bio_error == 0)
1068 		bp2->bio_error = bp->bio_error;
1069 	bp2->bio_completed += bp->bio_completed;
1070 	g_destroy_bio(bp);
1071 	bp2->bio_inbed++;
1072 	if (bp2->bio_children == bp2->bio_inbed)
1073 		g_io_deliver(bp2, bp2->bio_error);
1074 }
1075 
1076 /* XXX: maybe this is only g_slice_spoiled */
1077 
1078 void
g_std_spoiled(struct g_consumer * cp)1079 g_std_spoiled(struct g_consumer *cp)
1080 {
1081 	struct g_geom *gp;
1082 	struct g_provider *pp;
1083 
1084 	g_topology_assert();
1085 	G_VALID_CONSUMER(cp);
1086 	g_trace(G_T_TOPOLOGY, "g_std_spoiled(%p)", cp);
1087 	cp->flags |= G_CF_ORPHAN;
1088 	g_detach(cp);
1089 	gp = cp->geom;
1090 	LIST_FOREACH(pp, &gp->provider, provider)
1091 		g_orphan_provider(pp, ENXIO);
1092 	g_destroy_consumer(cp);
1093 	if (LIST_EMPTY(&gp->provider) && LIST_EMPTY(&gp->consumer))
1094 		g_destroy_geom(gp);
1095 	else
1096 		gp->flags |= G_GEOM_WITHER;
1097 }
1098 
1099 /*
1100  * Spoiling happens when a provider is opened for writing, but consumers
1101  * which are configured by in-band data are attached (slicers for instance).
1102  * Since the write might potentially change the in-band data, such consumers
1103  * need to re-evaluate their existence after the writing session closes.
1104  * We do this by (offering to) tear them down when the open for write happens
1105  * in return for a re-taste when it closes again.
1106  * Together with the fact that such consumers grab an 'e' bit whenever they
1107  * are open, regardless of mode, this ends up DTRT.
1108  */
1109 
1110 static void
g_spoil_event(void * arg,int flag)1111 g_spoil_event(void *arg, int flag)
1112 {
1113 	struct g_provider *pp;
1114 	struct g_consumer *cp, *cp2;
1115 
1116 	g_topology_assert();
1117 	if (flag == EV_CANCEL)
1118 		return;
1119 	pp = arg;
1120 	G_VALID_PROVIDER(pp);
1121 	g_trace(G_T_TOPOLOGY, "%s %p(%s:%s:%s)", __func__, pp,
1122 	    pp->geom->class->name, pp->geom->name, pp->name);
1123 	for (cp = LIST_FIRST(&pp->consumers); cp != NULL; cp = cp2) {
1124 		cp2 = LIST_NEXT(cp, consumers);
1125 		if ((cp->flags & G_CF_SPOILED) == 0)
1126 			continue;
1127 		cp->flags &= ~G_CF_SPOILED;
1128 		if (cp->geom->spoiled == NULL)
1129 			continue;
1130 		cp->geom->spoiled(cp);
1131 		g_topology_assert();
1132 	}
1133 }
1134 
1135 void
g_spoil(struct g_provider * pp,struct g_consumer * cp)1136 g_spoil(struct g_provider *pp, struct g_consumer *cp)
1137 {
1138 	struct g_consumer *cp2;
1139 
1140 	g_topology_assert();
1141 	G_VALID_PROVIDER(pp);
1142 	G_VALID_CONSUMER(cp);
1143 
1144 	LIST_FOREACH(cp2, &pp->consumers, consumers) {
1145 		if (cp2 == cp)
1146 			continue;
1147 /*
1148 		KASSERT(cp2->acr == 0, ("spoiling cp->acr = %d", cp2->acr));
1149 		KASSERT(cp2->acw == 0, ("spoiling cp->acw = %d", cp2->acw));
1150 */
1151 		KASSERT(cp2->ace == 0, ("spoiling cp->ace = %d", cp2->ace));
1152 		cp2->flags |= G_CF_SPOILED;
1153 	}
1154 	g_post_event(g_spoil_event, pp, M_WAITOK, pp, NULL);
1155 }
1156 
1157 static void
g_media_changed_event(void * arg,int flag)1158 g_media_changed_event(void *arg, int flag)
1159 {
1160 	struct g_provider *pp;
1161 	int retaste;
1162 
1163 	g_topology_assert();
1164 	if (flag == EV_CANCEL)
1165 		return;
1166 	pp = arg;
1167 	G_VALID_PROVIDER(pp);
1168 
1169 	/*
1170 	 * If provider was not open for writing, queue retaste after spoiling.
1171 	 * If it was, retaste will happen automatically on close.
1172 	 */
1173 	retaste = (pp->acw == 0 && pp->error == 0 &&
1174 	    !(pp->geom->flags & G_GEOM_WITHER));
1175 	g_spoil_event(arg, flag);
1176 	if (retaste)
1177 		g_post_event(g_new_provider_event, pp, M_WAITOK, pp, NULL);
1178 }
1179 
1180 int
g_media_changed(struct g_provider * pp,int flag)1181 g_media_changed(struct g_provider *pp, int flag)
1182 {
1183 	struct g_consumer *cp;
1184 
1185 	LIST_FOREACH(cp, &pp->consumers, consumers)
1186 		cp->flags |= G_CF_SPOILED;
1187 	return (g_post_event(g_media_changed_event, pp, flag, pp, NULL));
1188 }
1189 
1190 int
g_media_gone(struct g_provider * pp,int flag)1191 g_media_gone(struct g_provider *pp, int flag)
1192 {
1193 	struct g_consumer *cp;
1194 
1195 	LIST_FOREACH(cp, &pp->consumers, consumers)
1196 		cp->flags |= G_CF_SPOILED;
1197 	return (g_post_event(g_spoil_event, pp, flag, pp, NULL));
1198 }
1199 
1200 int
g_getattr__(const char * attr,struct g_consumer * cp,void * var,int len)1201 g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len)
1202 {
1203 	int error, i;
1204 
1205 	i = len;
1206 	error = g_io_getattr(attr, cp, &i, var);
1207 	if (error)
1208 		return (error);
1209 	if (i != len)
1210 		return (EINVAL);
1211 	return (0);
1212 }
1213 
1214 static int
g_get_device_prefix_len(const char * name)1215 g_get_device_prefix_len(const char *name)
1216 {
1217 	int len;
1218 
1219 	if (strncmp(name, "ada", 3) == 0)
1220 		len = 3;
1221 	else if (strncmp(name, "ad", 2) == 0)
1222 		len = 2;
1223 	else
1224 		return (0);
1225 	if (name[len] < '0' || name[len] > '9')
1226 		return (0);
1227 	do {
1228 		len++;
1229 	} while (name[len] >= '0' && name[len] <= '9');
1230 	return (len);
1231 }
1232 
1233 int
g_compare_names(const char * namea,const char * nameb)1234 g_compare_names(const char *namea, const char *nameb)
1235 {
1236 	int deva, devb;
1237 
1238 	if (strcmp(namea, nameb) == 0)
1239 		return (1);
1240 	deva = g_get_device_prefix_len(namea);
1241 	if (deva == 0)
1242 		return (0);
1243 	devb = g_get_device_prefix_len(nameb);
1244 	if (devb == 0)
1245 		return (0);
1246 	if (strcmp(namea + deva, nameb + devb) == 0)
1247 		return (1);
1248 	return (0);
1249 }
1250 
1251 #if defined(DIAGNOSTIC) || defined(DDB)
1252 /*
1253  * This function walks the mesh and returns a non-zero integer if it
1254  * finds the argument pointer is an object. The return value indicates
1255  * which type of object it is believed to be. If topology is not locked,
1256  * this function is potentially dangerous, but we don't assert that the
1257  * topology lock is held when called from debugger.
1258  */
1259 int
g_valid_obj(void const * ptr)1260 g_valid_obj(void const *ptr)
1261 {
1262 	struct g_class *mp;
1263 	struct g_geom *gp;
1264 	struct g_consumer *cp;
1265 	struct g_provider *pp;
1266 
1267 #ifdef KDB
1268 	if (kdb_active == 0)
1269 #endif
1270 		g_topology_assert();
1271 
1272 	LIST_FOREACH(mp, &g_classes, class) {
1273 		if (ptr == mp)
1274 			return (1);
1275 		LIST_FOREACH(gp, &mp->geom, geom) {
1276 			if (ptr == gp)
1277 				return (2);
1278 			LIST_FOREACH(cp, &gp->consumer, consumer)
1279 				if (ptr == cp)
1280 					return (3);
1281 			LIST_FOREACH(pp, &gp->provider, provider)
1282 				if (ptr == pp)
1283 					return (4);
1284 		}
1285 	}
1286 	return(0);
1287 }
1288 #endif
1289 
1290 #ifdef DDB
1291 
1292 #define	gprintf(...)	do {						\
1293 	db_printf("%*s", indent, "");					\
1294 	db_printf(__VA_ARGS__);						\
1295 } while (0)
1296 #define	gprintln(...)	do {						\
1297 	gprintf(__VA_ARGS__);						\
1298 	db_printf("\n");						\
1299 } while (0)
1300 
1301 #define	ADDFLAG(obj, flag, sflag)	do {				\
1302 	if ((obj)->flags & (flag)) {					\
1303 		if (comma)						\
1304 			strlcat(str, ",", size);			\
1305 		strlcat(str, (sflag), size);				\
1306 		comma = 1;						\
1307 	}								\
1308 } while (0)
1309 
1310 static char *
provider_flags_to_string(struct g_provider * pp,char * str,size_t size)1311 provider_flags_to_string(struct g_provider *pp, char *str, size_t size)
1312 {
1313 	int comma = 0;
1314 
1315 	bzero(str, size);
1316 	if (pp->flags == 0) {
1317 		strlcpy(str, "NONE", size);
1318 		return (str);
1319 	}
1320 	ADDFLAG(pp, G_PF_WITHER, "G_PF_WITHER");
1321 	ADDFLAG(pp, G_PF_ORPHAN, "G_PF_ORPHAN");
1322 	return (str);
1323 }
1324 
1325 static char *
geom_flags_to_string(struct g_geom * gp,char * str,size_t size)1326 geom_flags_to_string(struct g_geom *gp, char *str, size_t size)
1327 {
1328 	int comma = 0;
1329 
1330 	bzero(str, size);
1331 	if (gp->flags == 0) {
1332 		strlcpy(str, "NONE", size);
1333 		return (str);
1334 	}
1335 	ADDFLAG(gp, G_GEOM_WITHER, "G_GEOM_WITHER");
1336 	return (str);
1337 }
1338 static void
db_show_geom_consumer(int indent,struct g_consumer * cp)1339 db_show_geom_consumer(int indent, struct g_consumer *cp)
1340 {
1341 
1342 	if (indent == 0) {
1343 		gprintln("consumer: %p", cp);
1344 		gprintln("  class:    %s (%p)", cp->geom->class->name,
1345 		    cp->geom->class);
1346 		gprintln("  geom:     %s (%p)", cp->geom->name, cp->geom);
1347 		if (cp->provider == NULL)
1348 			gprintln("  provider: none");
1349 		else {
1350 			gprintln("  provider: %s (%p)", cp->provider->name,
1351 			    cp->provider);
1352 		}
1353 		gprintln("  access:   r%dw%de%d", cp->acr, cp->acw, cp->ace);
1354 		gprintln("  flags:    0x%04x", cp->flags);
1355 		gprintln("  nstart:   %u", cp->nstart);
1356 		gprintln("  nend:     %u", cp->nend);
1357 	} else {
1358 		gprintf("consumer: %p (%s), access=r%dw%de%d", cp,
1359 		    cp->provider != NULL ? cp->provider->name : "none",
1360 		    cp->acr, cp->acw, cp->ace);
1361 		if (cp->flags)
1362 			db_printf(", flags=0x%04x", cp->flags);
1363 		db_printf("\n");
1364 	}
1365 }
1366 
1367 static void
db_show_geom_provider(int indent,struct g_provider * pp)1368 db_show_geom_provider(int indent, struct g_provider *pp)
1369 {
1370 	struct g_consumer *cp;
1371 	char flags[64];
1372 
1373 	if (indent == 0) {
1374 		gprintln("provider: %s (%p)", pp->name, pp);
1375 		gprintln("  class:        %s (%p)", pp->geom->class->name,
1376 		    pp->geom->class);
1377 		gprintln("  geom:         %s (%p)", pp->geom->name, pp->geom);
1378 		gprintln("  mediasize:    %jd", (intmax_t)pp->mediasize);
1379 		gprintln("  sectorsize:   %u", pp->sectorsize);
1380 		gprintln("  stripesize:   %u", pp->stripesize);
1381 		gprintln("  stripeoffset: %u", pp->stripeoffset);
1382 		gprintln("  access:       r%dw%de%d", pp->acr, pp->acw,
1383 		    pp->ace);
1384 		gprintln("  flags:        %s (0x%04x)",
1385 		    provider_flags_to_string(pp, flags, sizeof(flags)),
1386 		    pp->flags);
1387 		gprintln("  error:        %d", pp->error);
1388 		gprintln("  nstart:       %u", pp->nstart);
1389 		gprintln("  nend:         %u", pp->nend);
1390 		if (LIST_EMPTY(&pp->consumers))
1391 			gprintln("  consumers:    none");
1392 	} else {
1393 		gprintf("provider: %s (%p), access=r%dw%de%d",
1394 		    pp->name, pp, pp->acr, pp->acw, pp->ace);
1395 		if (pp->flags != 0) {
1396 			db_printf(", flags=%s (0x%04x)",
1397 			    provider_flags_to_string(pp, flags, sizeof(flags)),
1398 			    pp->flags);
1399 		}
1400 		db_printf("\n");
1401 	}
1402 	if (!LIST_EMPTY(&pp->consumers)) {
1403 		LIST_FOREACH(cp, &pp->consumers, consumers) {
1404 			db_show_geom_consumer(indent + 2, cp);
1405 			if (db_pager_quit)
1406 				break;
1407 		}
1408 	}
1409 }
1410 
1411 static void
db_show_geom_geom(int indent,struct g_geom * gp)1412 db_show_geom_geom(int indent, struct g_geom *gp)
1413 {
1414 	struct g_provider *pp;
1415 	struct g_consumer *cp;
1416 	char flags[64];
1417 
1418 	if (indent == 0) {
1419 		gprintln("geom: %s (%p)", gp->name, gp);
1420 		gprintln("  class:     %s (%p)", gp->class->name, gp->class);
1421 		gprintln("  flags:     %s (0x%04x)",
1422 		    geom_flags_to_string(gp, flags, sizeof(flags)), gp->flags);
1423 		gprintln("  rank:      %d", gp->rank);
1424 		if (LIST_EMPTY(&gp->provider))
1425 			gprintln("  providers: none");
1426 		if (LIST_EMPTY(&gp->consumer))
1427 			gprintln("  consumers: none");
1428 	} else {
1429 		gprintf("geom: %s (%p), rank=%d", gp->name, gp, gp->rank);
1430 		if (gp->flags != 0) {
1431 			db_printf(", flags=%s (0x%04x)",
1432 			    geom_flags_to_string(gp, flags, sizeof(flags)),
1433 			    gp->flags);
1434 		}
1435 		db_printf("\n");
1436 	}
1437 	if (!LIST_EMPTY(&gp->provider)) {
1438 		LIST_FOREACH(pp, &gp->provider, provider) {
1439 			db_show_geom_provider(indent + 2, pp);
1440 			if (db_pager_quit)
1441 				break;
1442 		}
1443 	}
1444 	if (!LIST_EMPTY(&gp->consumer)) {
1445 		LIST_FOREACH(cp, &gp->consumer, consumer) {
1446 			db_show_geom_consumer(indent + 2, cp);
1447 			if (db_pager_quit)
1448 				break;
1449 		}
1450 	}
1451 }
1452 
1453 static void
db_show_geom_class(struct g_class * mp)1454 db_show_geom_class(struct g_class *mp)
1455 {
1456 	struct g_geom *gp;
1457 
1458 	db_printf("class: %s (%p)\n", mp->name, mp);
1459 	LIST_FOREACH(gp, &mp->geom, geom) {
1460 		db_show_geom_geom(2, gp);
1461 		if (db_pager_quit)
1462 			break;
1463 	}
1464 }
1465 
1466 /*
1467  * Print the GEOM topology or the given object.
1468  */
DB_SHOW_COMMAND(geom,db_show_geom)1469 DB_SHOW_COMMAND(geom, db_show_geom)
1470 {
1471 	struct g_class *mp;
1472 
1473 	if (!have_addr) {
1474 		/* No address given, print the entire topology. */
1475 		LIST_FOREACH(mp, &g_classes, class) {
1476 			db_show_geom_class(mp);
1477 			db_printf("\n");
1478 			if (db_pager_quit)
1479 				break;
1480 		}
1481 	} else {
1482 		switch (g_valid_obj((void *)addr)) {
1483 		case 1:
1484 			db_show_geom_class((struct g_class *)addr);
1485 			break;
1486 		case 2:
1487 			db_show_geom_geom(0, (struct g_geom *)addr);
1488 			break;
1489 		case 3:
1490 			db_show_geom_consumer(0, (struct g_consumer *)addr);
1491 			break;
1492 		case 4:
1493 			db_show_geom_provider(0, (struct g_provider *)addr);
1494 			break;
1495 		default:
1496 			db_printf("Not a GEOM object.\n");
1497 			break;
1498 		}
1499 	}
1500 }
1501 
1502 static void
db_print_bio_cmd(struct bio * bp)1503 db_print_bio_cmd(struct bio *bp)
1504 {
1505 	db_printf("  cmd: ");
1506 	switch (bp->bio_cmd) {
1507 	case BIO_READ: db_printf("BIO_READ"); break;
1508 	case BIO_WRITE: db_printf("BIO_WRITE"); break;
1509 	case BIO_DELETE: db_printf("BIO_DELETE"); break;
1510 	case BIO_GETATTR: db_printf("BIO_GETATTR"); break;
1511 	case BIO_FLUSH: db_printf("BIO_FLUSH"); break;
1512 	case BIO_CMD0: db_printf("BIO_CMD0"); break;
1513 	case BIO_CMD1: db_printf("BIO_CMD1"); break;
1514 	case BIO_CMD2: db_printf("BIO_CMD2"); break;
1515 	default: db_printf("UNKNOWN"); break;
1516 	}
1517 	db_printf("\n");
1518 }
1519 
1520 static void
db_print_bio_flags(struct bio * bp)1521 db_print_bio_flags(struct bio *bp)
1522 {
1523 	int comma;
1524 
1525 	comma = 0;
1526 	db_printf("  flags: ");
1527 	if (bp->bio_flags & BIO_ERROR) {
1528 		db_printf("BIO_ERROR");
1529 		comma = 1;
1530 	}
1531 	if (bp->bio_flags & BIO_DONE) {
1532 		db_printf("%sBIO_DONE", (comma ? ", " : ""));
1533 		comma = 1;
1534 	}
1535 	if (bp->bio_flags & BIO_ONQUEUE)
1536 		db_printf("%sBIO_ONQUEUE", (comma ? ", " : ""));
1537 	db_printf("\n");
1538 }
1539 
1540 /*
1541  * Print useful information in a BIO
1542  */
DB_SHOW_COMMAND(bio,db_show_bio)1543 DB_SHOW_COMMAND(bio, db_show_bio)
1544 {
1545 	struct bio *bp;
1546 
1547 	if (have_addr) {
1548 		bp = (struct bio *)addr;
1549 		db_printf("BIO %p\n", bp);
1550 		db_print_bio_cmd(bp);
1551 		db_print_bio_flags(bp);
1552 		db_printf("  cflags: 0x%hhx\n", bp->bio_cflags);
1553 		db_printf("  pflags: 0x%hhx\n", bp->bio_pflags);
1554 		db_printf("  offset: %jd\n", (intmax_t)bp->bio_offset);
1555 		db_printf("  length: %jd\n", (intmax_t)bp->bio_length);
1556 		db_printf("  bcount: %ld\n", bp->bio_bcount);
1557 		db_printf("  resid: %ld\n", bp->bio_resid);
1558 		db_printf("  completed: %jd\n", (intmax_t)bp->bio_completed);
1559 		db_printf("  children: %u\n", bp->bio_children);
1560 		db_printf("  inbed: %u\n", bp->bio_inbed);
1561 		db_printf("  error: %d\n", bp->bio_error);
1562 		db_printf("  parent: %p\n", bp->bio_parent);
1563 		db_printf("  driver1: %p\n", bp->bio_driver1);
1564 		db_printf("  driver2: %p\n", bp->bio_driver2);
1565 		db_printf("  caller1: %p\n", bp->bio_caller1);
1566 		db_printf("  caller2: %p\n", bp->bio_caller2);
1567 		db_printf("  bio_from: %p\n", bp->bio_from);
1568 		db_printf("  bio_to: %p\n", bp->bio_to);
1569 	}
1570 }
1571 
1572 #undef	gprintf
1573 #undef	gprintln
1574 #undef	ADDFLAG
1575 
1576 #endif	/* DDB */
1577