xref: /freebsd/sys/geom/geom_subr.c (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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$");
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/devicestat.h>
42 #include <sys/kernel.h>
43 #include <sys/malloc.h>
44 #include <sys/bio.h>
45 #include <sys/sysctl.h>
46 #include <sys/proc.h>
47 #include <sys/kthread.h>
48 #include <sys/lock.h>
49 #include <sys/mutex.h>
50 #include <sys/errno.h>
51 #include <sys/sbuf.h>
52 #include <geom/geom.h>
53 #include <geom/geom_int.h>
54 #include <machine/stdarg.h>
55 
56 struct class_list_head g_classes = LIST_HEAD_INITIALIZER(g_classes);
57 static struct g_tailq_head geoms = TAILQ_HEAD_INITIALIZER(geoms);
58 char *g_wait_event, *g_wait_up, *g_wait_down, *g_wait_sim;
59 
60 struct g_hh00 {
61 	struct g_class	*mp;
62 	int		error;
63 };
64 
65 /*
66  * This event offers a new class a chance to taste all preexisting providers.
67  */
68 static void
69 g_load_class(void *arg, int flag)
70 {
71 	struct g_hh00 *hh;
72 	struct g_class *mp2, *mp;
73 	struct g_geom *gp;
74 	struct g_provider *pp;
75 
76 	g_topology_assert();
77 	if (flag == EV_CANCEL)	/* XXX: can't happen ? */
78 		return;
79 	if (g_shutdown)
80 		return;
81 
82 	hh = arg;
83 	mp = hh->mp;
84 	g_free(hh);
85 	g_trace(G_T_TOPOLOGY, "g_load_class(%s)", mp->name);
86 	KASSERT(mp->name != NULL && *mp->name != '\0',
87 	    ("GEOM class has no name"));
88 	LIST_FOREACH(mp2, &g_classes, class) {
89 		KASSERT(mp2 != mp,
90 		    ("The GEOM class %s already loaded", mp2->name));
91 		KASSERT(strcmp(mp2->name, mp->name) != 0,
92 		    ("A GEOM class named %s is already loaded", mp2->name));
93 	}
94 
95 	LIST_INIT(&mp->geom);
96 	LIST_INSERT_HEAD(&g_classes, mp, class);
97 	if (mp->init != NULL)
98 		mp->init(mp);
99 	if (mp->taste == NULL)
100 		return;
101 	LIST_FOREACH(mp2, &g_classes, class) {
102 		if (mp == mp2)
103 			continue;
104 		LIST_FOREACH(gp, &mp2->geom, geom) {
105 			LIST_FOREACH(pp, &gp->provider, provider) {
106 				mp->taste(mp, pp, 0);
107 				g_topology_assert();
108 			}
109 		}
110 	}
111 }
112 
113 static void
114 g_unload_class(void *arg, int flag)
115 {
116 	struct g_hh00 *hh;
117 	struct g_class *mp;
118 	struct g_geom *gp;
119 	struct g_provider *pp;
120 	struct g_consumer *cp;
121 	int error;
122 
123 	g_topology_assert();
124 	hh = arg;
125 	mp = hh->mp;
126 	G_VALID_CLASS(mp);
127 	g_trace(G_T_TOPOLOGY, "g_unload_class(%s)", mp->name);
128 
129 	/*
130 	 * We allow unloading if we have no geoms, or a class
131 	 * method we can use to get rid of them.
132 	 */
133 	if (!LIST_EMPTY(&mp->geom) && mp->destroy_geom == NULL) {
134 		hh->error = EOPNOTSUPP;
135 		return;
136 	}
137 
138 	/* We refuse to unload if anything is open */
139 	LIST_FOREACH(gp, &mp->geom, geom) {
140 		LIST_FOREACH(pp, &gp->provider, provider)
141 			if (pp->acr || pp->acw || pp->ace) {
142 				hh->error = EBUSY;
143 				return;
144 			}
145 		LIST_FOREACH(cp, &gp->consumer, consumer)
146 			if (cp->acr || cp->acw || cp->ace) {
147 				hh->error = EBUSY;
148 				return;
149 			}
150 	}
151 
152 	/* Bar new entries */
153 	mp->taste = NULL;
154 	mp->config = NULL;
155 
156 	error = 0;
157 	for (;;) {
158 		gp = LIST_FIRST(&mp->geom);
159 		if (gp == NULL)
160 			break;
161 		error = mp->destroy_geom(NULL, mp, gp);
162 		if (error != 0)
163 			break;
164 	}
165 	if (error == 0) {
166 		if (mp->fini != NULL)
167 			mp->fini(mp);
168 		LIST_REMOVE(mp, class);
169 	}
170 	hh->error = error;
171 	return;
172 }
173 
174 int
175 g_modevent(module_t mod, int type, void *data)
176 {
177 	struct g_hh00 *hh;
178 	int error;
179 	static int g_ignition;
180 
181 	if (!g_ignition) {
182 		g_ignition++;
183 		g_init();
184 	}
185 	hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
186 	hh->mp = data;
187 	error = EOPNOTSUPP;
188 	switch (type) {
189 	case MOD_LOAD:
190 		g_trace(G_T_TOPOLOGY, "g_modevent(%s, LOAD)", hh->mp->name);
191 		g_post_event(g_load_class, hh, M_WAITOK, NULL);
192 		error = 0;
193 		break;
194 	case MOD_UNLOAD:
195 		g_trace(G_T_TOPOLOGY, "g_modevent(%s, UNLOAD)", hh->mp->name);
196 		error = g_waitfor_event(g_unload_class, hh, M_WAITOK, NULL);
197 		if (error == 0)
198 			error = hh->error;
199 		if (error == 0) {
200 			g_waitidle();
201 			KASSERT(LIST_EMPTY(&hh->mp->geom),
202 			    ("Unloaded class (%s) still has geom", hh->mp->name));
203 		}
204 		g_free(hh);
205 		break;
206 	default:
207 		g_free(hh);
208 		break;
209 	}
210 	return (error);
211 }
212 
213 struct g_geom *
214 g_new_geomf(struct g_class *mp, const char *fmt, ...)
215 {
216 	struct g_geom *gp;
217 	va_list ap;
218 	struct sbuf *sb;
219 
220 	g_topology_assert();
221 	G_VALID_CLASS(mp);
222 	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
223 	va_start(ap, fmt);
224 	sbuf_vprintf(sb, fmt, ap);
225 	va_end(ap);
226 	sbuf_finish(sb);
227 	gp = g_malloc(sizeof *gp, M_WAITOK | M_ZERO);
228 	gp->name = g_malloc(sbuf_len(sb) + 1, M_WAITOK | M_ZERO);
229 	gp->class = mp;
230 	gp->rank = 1;
231 	LIST_INIT(&gp->consumer);
232 	LIST_INIT(&gp->provider);
233 	LIST_INSERT_HEAD(&mp->geom, gp, geom);
234 	TAILQ_INSERT_HEAD(&geoms, gp, geoms);
235 	strcpy(gp->name, sbuf_data(sb));
236 	sbuf_delete(sb);
237 	return (gp);
238 }
239 
240 void
241 g_destroy_geom(struct g_geom *gp)
242 {
243 
244 	g_topology_assert();
245 	G_VALID_GEOM(gp);
246 	g_trace(G_T_TOPOLOGY, "g_destroy_geom(%p(%s))", gp, gp->name);
247 	KASSERT(LIST_EMPTY(&gp->consumer),
248 	    ("g_destroy_geom(%s) with consumer(s) [%p]",
249 	    gp->name, LIST_FIRST(&gp->consumer)));
250 	KASSERT(LIST_EMPTY(&gp->provider),
251 	    ("g_destroy_geom(%s) with provider(s) [%p]",
252 	    gp->name, LIST_FIRST(&gp->provider)));
253 	g_cancel_event(gp);
254 	LIST_REMOVE(gp, geom);
255 	TAILQ_REMOVE(&geoms, gp, geoms);
256 	g_free(gp->name);
257 	g_free(gp);
258 }
259 
260 /*
261  * This function is called (repeatedly) until the has withered away.
262  */
263 void
264 g_wither_geom(struct g_geom *gp, int error)
265 {
266 	struct g_provider *pp;
267 
268 	g_topology_assert();
269 	G_VALID_GEOM(gp);
270 	g_trace(G_T_TOPOLOGY, "g_wither_geom(%p(%s))", gp, gp->name);
271 	if (!(gp->flags & G_GEOM_WITHER)) {
272 		gp->flags |= G_GEOM_WITHER;
273 		LIST_FOREACH(pp, &gp->provider, provider)
274 			if (!(pp->flags & G_PF_ORPHAN))
275 				g_orphan_provider(pp, error);
276 	}
277 	g_do_wither();
278 }
279 
280 /*
281  * This function is called (repeatedly) until we cant wash away more
282  * withered bits at present.  Return value contains two bits.  Bit 0
283  * set means "withering stuff we can't wash now", bit 1 means "call
284  * me again, there may be stuff I didn't get the first time around.
285  */
286 int
287 g_wither_washer()
288 {
289 	struct g_class *mp;
290 	struct g_geom *gp, *gp2;
291 	struct g_provider *pp, *pp2;
292 	struct g_consumer *cp, *cp2;
293 	int result;
294 
295 	result = 0;
296 	g_topology_assert();
297 	LIST_FOREACH(mp, &g_classes, class) {
298 		LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
299 			LIST_FOREACH_SAFE(pp, &gp->provider, provider, pp2) {
300 				if (!(pp->flags & G_PF_WITHER))
301 					continue;
302 				if (LIST_EMPTY(&pp->consumers))
303 					g_destroy_provider(pp);
304 				else
305 					result |= 1;
306 			}
307 			if (!(gp->flags & G_GEOM_WITHER))
308 				continue;
309 			LIST_FOREACH_SAFE(pp, &gp->provider, provider, pp2) {
310 				if (LIST_EMPTY(&pp->consumers))
311 					g_destroy_provider(pp);
312 				else
313 					result |= 1;
314 			}
315 			LIST_FOREACH_SAFE(cp, &gp->consumer, consumer, cp2) {
316 				if (cp->acr || cp->acw || cp->ace) {
317 					result |= 1;
318 					continue;
319 				}
320 				if (cp->provider != NULL)
321 					g_detach(cp);
322 				g_destroy_consumer(cp);
323 				result |= 2;
324 			}
325 			if (LIST_EMPTY(&gp->provider) &&
326 			    LIST_EMPTY(&gp->consumer))
327 				g_destroy_geom(gp);
328 			else
329 				result |= 1;
330 		}
331 	}
332 	return (result);
333 }
334 
335 struct g_consumer *
336 g_new_consumer(struct g_geom *gp)
337 {
338 	struct g_consumer *cp;
339 
340 	g_topology_assert();
341 	G_VALID_GEOM(gp);
342 	KASSERT(!(gp->flags & G_GEOM_WITHER),
343 	    ("g_new_consumer on WITHERing geom(%s) (class %s)",
344 	    gp->name, gp->class->name));
345 	KASSERT(gp->orphan != NULL,
346 	    ("g_new_consumer on geom(%s) (class %s) without orphan",
347 	    gp->name, gp->class->name));
348 
349 	cp = g_malloc(sizeof *cp, M_WAITOK | M_ZERO);
350 	cp->geom = gp;
351 	cp->stat = devstat_new_entry(cp, -1, 0, DEVSTAT_ALL_SUPPORTED,
352 	    DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
353 	LIST_INSERT_HEAD(&gp->consumer, cp, consumer);
354 	return(cp);
355 }
356 
357 void
358 g_destroy_consumer(struct g_consumer *cp)
359 {
360 	struct g_geom *gp;
361 
362 	g_topology_assert();
363 	G_VALID_CONSUMER(cp);
364 	g_trace(G_T_TOPOLOGY, "g_destroy_consumer(%p)", cp);
365 	KASSERT (cp->provider == NULL, ("g_destroy_consumer but attached"));
366 	KASSERT (cp->acr == 0, ("g_destroy_consumer with acr"));
367 	KASSERT (cp->acw == 0, ("g_destroy_consumer with acw"));
368 	KASSERT (cp->ace == 0, ("g_destroy_consumer with ace"));
369 	g_cancel_event(cp);
370 	gp = cp->geom;
371 	LIST_REMOVE(cp, consumer);
372 	devstat_remove_entry(cp->stat);
373 	g_free(cp);
374 	if (gp->flags & G_GEOM_WITHER)
375 		g_do_wither();
376 }
377 
378 static void
379 g_new_provider_event(void *arg, int flag)
380 {
381 	struct g_class *mp;
382 	struct g_provider *pp;
383 	struct g_consumer *cp;
384 	int i;
385 
386 	g_topology_assert();
387 	if (flag == EV_CANCEL)
388 		return;
389 	if (g_shutdown)
390 		return;
391 	pp = arg;
392 	G_VALID_PROVIDER(pp);
393 	LIST_FOREACH(mp, &g_classes, class) {
394 		if (mp->taste == NULL)
395 			continue;
396 		i = 1;
397 		LIST_FOREACH(cp, &pp->consumers, consumers)
398 			if (cp->geom->class == mp)
399 				i = 0;
400 		if (!i)
401 			continue;
402 		mp->taste(mp, pp, 0);
403 		g_topology_assert();
404 	}
405 }
406 
407 
408 struct g_provider *
409 g_new_providerf(struct g_geom *gp, const char *fmt, ...)
410 {
411 	struct g_provider *pp;
412 	struct sbuf *sb;
413 	va_list ap;
414 
415 	g_topology_assert();
416 	G_VALID_GEOM(gp);
417 	KASSERT(gp->access != NULL,
418 	    ("new provider on geom(%s) without ->access (class %s)",
419 	    gp->name, gp->class->name));
420 	KASSERT(gp->start != NULL,
421 	    ("new provider on geom(%s) without ->start (class %s)",
422 	    gp->name, gp->class->name));
423 	KASSERT(!(gp->flags & G_GEOM_WITHER),
424 	    ("new provider on WITHERing geom(%s) (class %s)",
425 	    gp->name, gp->class->name));
426 	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
427 	va_start(ap, fmt);
428 	sbuf_vprintf(sb, fmt, ap);
429 	va_end(ap);
430 	sbuf_finish(sb);
431 	pp = g_malloc(sizeof *pp + sbuf_len(sb) + 1, M_WAITOK | M_ZERO);
432 	pp->name = (char *)(pp + 1);
433 	strcpy(pp->name, sbuf_data(sb));
434 	sbuf_delete(sb);
435 	LIST_INIT(&pp->consumers);
436 	pp->error = ENXIO;
437 	pp->geom = gp;
438 	pp->stat = devstat_new_entry(pp, -1, 0, DEVSTAT_ALL_SUPPORTED,
439 	    DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
440 	LIST_INSERT_HEAD(&gp->provider, pp, provider);
441 	g_post_event(g_new_provider_event, pp, M_WAITOK, pp, gp, NULL);
442 	return (pp);
443 }
444 
445 void
446 g_error_provider(struct g_provider *pp, int error)
447 {
448 
449 	/* G_VALID_PROVIDER(pp);  We may not have g_topology */
450 	pp->error = error;
451 }
452 
453 struct g_provider *
454 g_provider_by_name(char const *arg)
455 {
456 	struct g_class *cp;
457 	struct g_geom *gp;
458 	struct g_provider *pp;
459 
460 	LIST_FOREACH(cp, &g_classes, class) {
461 		LIST_FOREACH(gp, &cp->geom, geom) {
462 			LIST_FOREACH(pp, &gp->provider, provider) {
463 				if (!strcmp(arg, pp->name))
464 					return (pp);
465 			}
466 		}
467 	}
468 	return (NULL);
469 }
470 
471 void
472 g_destroy_provider(struct g_provider *pp)
473 {
474 	struct g_geom *gp;
475 
476 	g_topology_assert();
477 	G_VALID_PROVIDER(pp);
478 	KASSERT(LIST_EMPTY(&pp->consumers),
479 	    ("g_destroy_provider but attached"));
480 	KASSERT (pp->acr == 0, ("g_destroy_provider with acr"));
481 	KASSERT (pp->acw == 0, ("g_destroy_provider with acw"));
482 	KASSERT (pp->acw == 0, ("g_destroy_provider with ace"));
483 	g_cancel_event(pp);
484 	LIST_REMOVE(pp, provider);
485 	gp = pp->geom;
486 	devstat_remove_entry(pp->stat);
487 	g_free(pp);
488 	if ((gp->flags & G_GEOM_WITHER))
489 		g_do_wither();
490 }
491 
492 /*
493  * We keep the "geoms" list sorted by topological order (== increasing
494  * numerical rank) at all times.
495  * When an attach is done, the attaching geoms rank is invalidated
496  * and it is moved to the tail of the list.
497  * All geoms later in the sequence has their ranks reevaluated in
498  * sequence.  If we cannot assign rank to a geom because it's
499  * prerequisites do not have rank, we move that element to the tail
500  * of the sequence with invalid rank as well.
501  * At some point we encounter our original geom and if we stil fail
502  * to assign it a rank, there must be a loop and we fail back to
503  * g_attach() which detach again and calls redo_rank again
504  * to fix up the damage.
505  * It would be much simpler code wise to do it recursively, but we
506  * can't risk that on the kernel stack.
507  */
508 
509 static int
510 redo_rank(struct g_geom *gp)
511 {
512 	struct g_consumer *cp;
513 	struct g_geom *gp1, *gp2;
514 	int n, m;
515 
516 	g_topology_assert();
517 	G_VALID_GEOM(gp);
518 
519 	/* Invalidate this geoms rank and move it to the tail */
520 	gp1 = TAILQ_NEXT(gp, geoms);
521 	if (gp1 != NULL) {
522 		gp->rank = 0;
523 		TAILQ_REMOVE(&geoms, gp, geoms);
524 		TAILQ_INSERT_TAIL(&geoms, gp, geoms);
525 	} else {
526 		gp1 = gp;
527 	}
528 
529 	/* re-rank the rest of the sequence */
530 	for (; gp1 != NULL; gp1 = gp2) {
531 		gp1->rank = 0;
532 		m = 1;
533 		LIST_FOREACH(cp, &gp1->consumer, consumer) {
534 			if (cp->provider == NULL)
535 				continue;
536 			n = cp->provider->geom->rank;
537 			if (n == 0) {
538 				m = 0;
539 				break;
540 			} else if (n >= m)
541 				m = n + 1;
542 		}
543 		gp1->rank = m;
544 		gp2 = TAILQ_NEXT(gp1, geoms);
545 
546 		/* got a rank, moving on */
547 		if (m != 0)
548 			continue;
549 
550 		/* no rank to original geom means loop */
551 		if (gp == gp1)
552 			return (ELOOP);
553 
554 		/* no rank, put it at the end move on */
555 		TAILQ_REMOVE(&geoms, gp1, geoms);
556 		TAILQ_INSERT_TAIL(&geoms, gp1, geoms);
557 	}
558 	return (0);
559 }
560 
561 int
562 g_attach(struct g_consumer *cp, struct g_provider *pp)
563 {
564 	int error;
565 
566 	g_topology_assert();
567 	G_VALID_CONSUMER(cp);
568 	G_VALID_PROVIDER(pp);
569 	KASSERT(cp->provider == NULL, ("attach but attached"));
570 	cp->provider = pp;
571 	LIST_INSERT_HEAD(&pp->consumers, cp, consumers);
572 	error = redo_rank(cp->geom);
573 	if (error) {
574 		LIST_REMOVE(cp, consumers);
575 		cp->provider = NULL;
576 		redo_rank(cp->geom);
577 	}
578 	return (error);
579 }
580 
581 void
582 g_detach(struct g_consumer *cp)
583 {
584 	struct g_provider *pp;
585 
586 	g_topology_assert();
587 	G_VALID_CONSUMER(cp);
588 	g_trace(G_T_TOPOLOGY, "g_detach(%p)", cp);
589 	KASSERT(cp->provider != NULL, ("detach but not attached"));
590 	KASSERT(cp->acr == 0, ("detach but nonzero acr"));
591 	KASSERT(cp->acw == 0, ("detach but nonzero acw"));
592 	KASSERT(cp->ace == 0, ("detach but nonzero ace"));
593 	KASSERT(cp->nstart == cp->nend,
594 	    ("detach with active requests"));
595 	pp = cp->provider;
596 	LIST_REMOVE(cp, consumers);
597 	cp->provider = NULL;
598 	if (pp->geom->flags & G_GEOM_WITHER)
599 		g_do_wither();
600 	else if (pp->flags & G_PF_WITHER)
601 		g_do_wither();
602 	redo_rank(cp->geom);
603 }
604 
605 /*
606  * g_access()
607  *
608  * Access-check with delta values.  The question asked is "can provider
609  * "cp" change the access counters by the relative amounts dc[rwe] ?"
610  */
611 
612 int
613 g_access(struct g_consumer *cp, int dcr, int dcw, int dce)
614 {
615 	struct g_provider *pp;
616 	int pr,pw,pe;
617 	int error;
618 
619 	g_topology_assert();
620 	G_VALID_CONSUMER(cp);
621 	pp = cp->provider;
622 	KASSERT(pp != NULL, ("access but not attached"));
623 	G_VALID_PROVIDER(pp);
624 
625 	g_trace(G_T_ACCESS, "g_access(%p(%s), %d, %d, %d)",
626 	    cp, pp->name, dcr, dcw, dce);
627 
628 	KASSERT(cp->acr + dcr >= 0, ("access resulting in negative acr"));
629 	KASSERT(cp->acw + dcw >= 0, ("access resulting in negative acw"));
630 	KASSERT(cp->ace + dce >= 0, ("access resulting in negative ace"));
631 	KASSERT(dcr != 0 || dcw != 0 || dce != 0, ("NOP access request"));
632 	KASSERT(pp->geom->access != NULL, ("NULL geom->access"));
633 
634 	/*
635 	 * If our class cares about being spoiled, and we have been, we
636 	 * are probably just ahead of the event telling us that.  Fail
637 	 * now rather than having to unravel this later.
638 	 */
639 	if (cp->geom->spoiled != NULL && cp->spoiled &&
640 	    (dcr > 0 || dcw > 0 || dce > 0))
641 		return (ENXIO);
642 
643 	/*
644 	 * Figure out what counts the provider would have had, if this
645 	 * consumer had (r0w0e0) at this time.
646 	 */
647 	pr = pp->acr - cp->acr;
648 	pw = pp->acw - cp->acw;
649 	pe = pp->ace - cp->ace;
650 
651 	g_trace(G_T_ACCESS,
652     "open delta:[r%dw%de%d] old:[r%dw%de%d] provider:[r%dw%de%d] %p(%s)",
653 	    dcr, dcw, dce,
654 	    cp->acr, cp->acw, cp->ace,
655 	    pp->acr, pp->acw, pp->ace,
656 	    pp, pp->name);
657 
658 	/* If foot-shooting is enabled, any open on rank#1 is OK */
659 	if ((g_debugflags & 16) && pp->geom->rank == 1)
660 		;
661 	/* If we try exclusive but already write: fail */
662 	else if (dce > 0 && pw > 0)
663 		return (EPERM);
664 	/* If we try write but already exclusive: fail */
665 	else if (dcw > 0 && pe > 0)
666 		return (EPERM);
667 	/* If we try to open more but provider is error'ed: fail */
668 	else if ((dcr > 0 || dcw > 0 || dce > 0) && pp->error != 0)
669 		return (pp->error);
670 
671 	/* Ok then... */
672 
673 	error = pp->geom->access(pp, dcr, dcw, dce);
674 	KASSERT(dcr > 0 || dcw > 0 || dce > 0 || error == 0,
675 	    ("Geom provider %s::%s failed closing ->access()",
676 	    pp->geom->class->name, pp->name));
677 	if (!error) {
678 		/*
679 		 * If we open first write, spoil any partner consumers.
680 		 * If we close last write, trigger re-taste.
681 		 */
682 		if (pp->acw == 0 && dcw != 0)
683 			g_spoil(pp, cp);
684 		else if (pp->acw != 0 && pp->acw == -dcw &&
685 		    !(pp->geom->flags & G_GEOM_WITHER))
686 			g_post_event(g_new_provider_event, pp, M_WAITOK,
687 			    pp, NULL);
688 
689 		pp->acr += dcr;
690 		pp->acw += dcw;
691 		pp->ace += dce;
692 		cp->acr += dcr;
693 		cp->acw += dcw;
694 		cp->ace += dce;
695 	}
696 	return (error);
697 }
698 
699 int
700 g_handleattr_int(struct bio *bp, const char *attribute, int val)
701 {
702 
703 	return (g_handleattr(bp, attribute, &val, sizeof val));
704 }
705 
706 int
707 g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val)
708 {
709 
710 	return (g_handleattr(bp, attribute, &val, sizeof val));
711 }
712 
713 int
714 g_handleattr(struct bio *bp, const char *attribute, void *val, int len)
715 {
716 	int error;
717 
718 	if (strcmp(bp->bio_attribute, attribute))
719 		return (0);
720 	if (bp->bio_length != len) {
721 		printf("bio_length %jd len %d -> EFAULT\n",
722 		    (intmax_t)bp->bio_length, len);
723 		error = EFAULT;
724 	} else {
725 		error = 0;
726 		bcopy(val, bp->bio_data, len);
727 		bp->bio_completed = len;
728 	}
729 	g_io_deliver(bp, error);
730 	return (1);
731 }
732 
733 int
734 g_std_access(struct g_provider *pp,
735 	int dr __unused, int dw __unused, int de __unused)
736 {
737 
738 	g_topology_assert();
739 	G_VALID_PROVIDER(pp);
740         return (0);
741 }
742 
743 void
744 g_std_done(struct bio *bp)
745 {
746 	struct bio *bp2;
747 
748 	bp2 = bp->bio_parent;
749 	if (bp2->bio_error == 0)
750 		bp2->bio_error = bp->bio_error;
751 	bp2->bio_completed += bp->bio_completed;
752 	g_destroy_bio(bp);
753 	bp2->bio_inbed++;
754 	if (bp2->bio_children == bp2->bio_inbed)
755 		g_io_deliver(bp2, bp2->bio_error);
756 }
757 
758 /* XXX: maybe this is only g_slice_spoiled */
759 
760 void
761 g_std_spoiled(struct g_consumer *cp)
762 {
763 	struct g_geom *gp;
764 	struct g_provider *pp;
765 
766 	g_topology_assert();
767 	G_VALID_CONSUMER(cp);
768 	g_trace(G_T_TOPOLOGY, "g_std_spoiled(%p)", cp);
769 	g_detach(cp);
770 	gp = cp->geom;
771 	LIST_FOREACH(pp, &gp->provider, provider)
772 		g_orphan_provider(pp, ENXIO);
773 	g_destroy_consumer(cp);
774 	if (LIST_EMPTY(&gp->provider) && LIST_EMPTY(&gp->consumer))
775 		g_destroy_geom(gp);
776 	else
777 		gp->flags |= G_GEOM_WITHER;
778 }
779 
780 /*
781  * Spoiling happens when a provider is opened for writing, but consumers
782  * which are configured by in-band data are attached (slicers for instance).
783  * Since the write might potentially change the in-band data, such consumers
784  * need to re-evaluate their existence after the writing session closes.
785  * We do this by (offering to) tear them down when the open for write happens
786  * in return for a re-taste when it closes again.
787  * Together with the fact that such consumers grab an 'e' bit whenever they
788  * are open, regardless of mode, this ends up DTRT.
789  */
790 
791 static void
792 g_spoil_event(void *arg, int flag)
793 {
794 	struct g_provider *pp;
795 	struct g_consumer *cp, *cp2;
796 
797 	g_topology_assert();
798 	if (flag == EV_CANCEL)
799 		return;
800 	pp = arg;
801 	G_VALID_PROVIDER(pp);
802 	for (cp = LIST_FIRST(&pp->consumers); cp != NULL; cp = cp2) {
803 		cp2 = LIST_NEXT(cp, consumers);
804 		if (!cp->spoiled)
805 			continue;
806 		cp->spoiled = 0;
807 		if (cp->geom->spoiled == NULL)
808 			continue;
809 		cp->geom->spoiled(cp);
810 		g_topology_assert();
811 	}
812 }
813 
814 void
815 g_spoil(struct g_provider *pp, struct g_consumer *cp)
816 {
817 	struct g_consumer *cp2;
818 
819 	g_topology_assert();
820 	G_VALID_PROVIDER(pp);
821 	G_VALID_CONSUMER(cp);
822 
823 	LIST_FOREACH(cp2, &pp->consumers, consumers) {
824 		if (cp2 == cp)
825 			continue;
826 /*
827 		KASSERT(cp2->acr == 0, ("spoiling cp->acr = %d", cp2->acr));
828 		KASSERT(cp2->acw == 0, ("spoiling cp->acw = %d", cp2->acw));
829 */
830 		KASSERT(cp2->ace == 0, ("spoiling cp->ace = %d", cp2->ace));
831 		cp2->spoiled++;
832 	}
833 	g_post_event(g_spoil_event, pp, M_WAITOK, pp, NULL);
834 }
835 
836 int
837 g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len)
838 {
839 	int error, i;
840 
841 	i = len;
842 	error = g_io_getattr(attr, cp, &i, var);
843 	if (error)
844 		return (error);
845 	if (i != len)
846 		return (EINVAL);
847 	return (0);
848 }
849 
850 #ifdef DIAGNOSTIC
851 /*
852  * This function walks (topologically unsafely) the mesh and return a
853  * non-zero integer if it finds the argument pointer is an object.
854  * The return value indicates which type of object it is belived to be.
855  * If topology is not locked, this function is potentially dangerous,
856  * but since it is for debugging purposes and can be useful for instance
857  * from DDB, we do not assert topology lock is held.
858  */
859 int
860 g_valid_obj(void const *ptr)
861 {
862 	struct g_class *mp;
863 	struct g_geom *gp;
864 	struct g_consumer *cp;
865 	struct g_provider *pp;
866 
867 	LIST_FOREACH(mp, &g_classes, class) {
868 		if (ptr == mp)
869 			return (1);
870 		LIST_FOREACH(gp, &mp->geom, geom) {
871 			if (ptr == gp)
872 				return (2);
873 			LIST_FOREACH(cp, &gp->consumer, consumer)
874 				if (ptr == cp)
875 					return (3);
876 			LIST_FOREACH(pp, &gp->provider, provider)
877 				if (ptr == pp)
878 					return (4);
879 		}
880 	}
881 	return(0);
882 }
883 #endif
884