2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2002 Poul-Henning Kamp
5 * Copyright (c) 2002 Networks Associates Technology, Inc.
8 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
9 * and NAI Labs, the Security Research Division of Network Associates, Inc.
10 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
11 * DARPA CHATS research program.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. The names of the authors may not be used to endorse or promote
22 * products derived from this software without specific prior written
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/devicestat.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
49 #include <sys/sysctl.h>
51 #include <sys/kthread.h>
53 #include <sys/mutex.h>
54 #include <sys/errno.h>
57 #include <geom/geom.h>
58 #include <geom/geom_dbg.h>
59 #include <geom/geom_int.h>
60 #include <machine/stdarg.h>
70 SDT_PROVIDER_DEFINE(geom);
72 struct class_list_head g_classes = LIST_HEAD_INITIALIZER(g_classes);
73 static struct g_tailq_head geoms = TAILQ_HEAD_INITIALIZER(geoms);
74 char *g_wait_event, *g_wait_up, *g_wait_down, *g_wait_sim;
78 struct g_provider *pp;
85 g_dbg_printf(const char *classname, int lvl, struct bio *bp,
89 #ifndef PRINTF_BUFR_SIZE
90 #define PRINTF_BUFR_SIZE 64
92 char bufr[PRINTF_BUFR_SIZE];
93 struct sbuf sb, *sbp __unused;
96 sbp = sbuf_new(&sb, bufr, sizeof(bufr), SBUF_FIXEDLEN);
97 KASSERT(sbp != NULL, ("sbuf_new misused?"));
99 sbuf_set_drain(&sb, sbuf_printf_drain, NULL);
101 sbuf_cat(&sb, classname);
103 sbuf_printf(&sb, "[%d]", lvl);
105 va_start(ap, format);
106 sbuf_vprintf(&sb, format, ap);
111 g_format_bio(&sb, bp);
114 /* Terminate the debug line with a single '\n'. */
115 sbuf_nl_terminate(&sb);
117 /* Flush line to printf. */
123 * This event offers a new class a chance to taste all preexisting providers.
126 g_load_class(void *arg, int flag)
129 struct g_class *mp2, *mp;
131 struct g_provider *pp;
134 if (flag == EV_CANCEL) /* XXX: can't happen ? */
146 g_trace(G_T_TOPOLOGY, "g_load_class(%s)", mp->name);
147 KASSERT(mp->name != NULL && *mp->name != '\0',
148 ("GEOM class has no name"));
149 LIST_FOREACH(mp2, &g_classes, class) {
151 printf("The GEOM class %s is already loaded.\n",
156 } else if (strcmp(mp2->name, mp->name) == 0) {
157 printf("A GEOM class %s is already loaded.\n",
165 LIST_INIT(&mp->geom);
166 LIST_INSERT_HEAD(&g_classes, mp, class);
167 if (mp->init != NULL)
169 if (mp->taste == NULL)
171 LIST_FOREACH(mp2, &g_classes, class) {
174 LIST_FOREACH(gp, &mp2->geom, geom) {
175 LIST_FOREACH(pp, &gp->provider, provider) {
176 mp->taste(mp, pp, 0);
184 g_unload_class(struct g_class *mp)
187 struct g_provider *pp;
188 struct g_consumer *cp;
192 g_trace(G_T_TOPOLOGY, "g_unload_class(%s)", mp->name);
195 LIST_FOREACH(gp, &mp->geom, geom) {
196 /* We refuse to unload if anything is open */
197 LIST_FOREACH(pp, &gp->provider, provider)
198 if (pp->acr || pp->acw || pp->ace) {
202 LIST_FOREACH(cp, &gp->consumer, consumer)
203 if (cp->acr || cp->acw || cp->ace) {
207 /* If the geom is withering, wait for it to finish. */
208 if (gp->flags & G_GEOM_WITHER) {
209 g_topology_sleep(mp, 1);
215 * We allow unloading if we have no geoms, or a class
216 * method we can use to get rid of them.
218 if (!LIST_EMPTY(&mp->geom) && mp->destroy_geom == NULL) {
223 /* Bar new entries */
227 LIST_FOREACH(gp, &mp->geom, geom) {
228 error = mp->destroy_geom(NULL, mp, gp);
234 /* Wait for withering to finish. */
236 gp = LIST_FIRST(&mp->geom);
239 KASSERT(gp->flags & G_GEOM_WITHER,
240 ("Non-withering geom in class %s", mp->name));
241 g_topology_sleep(mp, 1);
244 if (mp->fini != NULL)
246 LIST_REMOVE(mp, class);
253 g_modevent(module_t mod, int type, void *data)
257 static int g_ignition;
261 if (mp->version != G_VERSION) {
262 printf("GEOM class %s has Wrong version %x\n",
263 mp->name, mp->version);
273 g_trace(G_T_TOPOLOGY, "g_modevent(%s, LOAD)", mp->name);
274 hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
277 * Once the system is not cold, MOD_LOAD calls will be
278 * from the userland and the g_event thread will be able
279 * to acknowledge their completion.
283 error = g_post_event(g_load_class, hh, M_WAITOK, NULL);
285 error = g_waitfor_event(g_load_class, hh, M_WAITOK,
293 g_trace(G_T_TOPOLOGY, "g_modevent(%s, UNLOAD)", mp->name);
294 error = g_unload_class(mp);
296 KASSERT(LIST_EMPTY(&mp->geom),
297 ("Unloaded class (%s) still has geom", mp->name));
305 g_retaste_event(void *arg, int flag)
307 struct g_class *mp, *mp2;
310 struct g_provider *pp;
311 struct g_consumer *cp;
314 if (flag == EV_CANCEL) /* XXX: can't happen ? */
316 if (g_shutdown || g_notaste)
326 g_trace(G_T_TOPOLOGY, "g_retaste(%s)", mp->name);
328 LIST_FOREACH(mp2, &g_classes, class) {
329 LIST_FOREACH(gp, &mp2->geom, geom) {
330 LIST_FOREACH(pp, &gp->provider, provider) {
331 if (pp->acr || pp->acw || pp->ace)
333 LIST_FOREACH(cp, &pp->consumers, consumers) {
334 if (cp->geom->class == mp &&
335 (cp->flags & G_CF_ORPHAN) == 0)
339 cp->flags |= G_CF_ORPHAN;
340 g_wither_geom(cp->geom, ENXIO);
342 mp->taste(mp, pp, 0);
350 g_retaste(struct g_class *mp)
355 if (mp->taste == NULL)
358 hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
363 error = g_post_event(g_retaste_event, hh, M_WAITOK, NULL);
365 error = g_waitfor_event(g_retaste_event, hh, M_WAITOK, NULL);
375 g_new_geomf(struct g_class *mp, const char *fmt, ...)
383 sb = sbuf_new_auto();
385 sbuf_vprintf(sb, fmt, ap);
388 gp = g_malloc(sizeof *gp, M_WAITOK | M_ZERO);
389 gp->name = g_malloc(sbuf_len(sb) + 1, M_WAITOK | M_ZERO);
392 LIST_INIT(&gp->consumer);
393 LIST_INIT(&gp->provider);
394 LIST_INIT(&gp->aliases);
395 LIST_INSERT_HEAD(&mp->geom, gp, geom);
396 TAILQ_INSERT_HEAD(&geoms, gp, geoms);
397 strcpy(gp->name, sbuf_data(sb));
399 /* Fill in defaults from class */
400 gp->start = mp->start;
401 gp->spoiled = mp->spoiled;
402 gp->attrchanged = mp->attrchanged;
403 gp->providergone = mp->providergone;
404 gp->dumpconf = mp->dumpconf;
405 gp->access = mp->access;
406 gp->orphan = mp->orphan;
407 gp->ioctl = mp->ioctl;
408 gp->resize = mp->resize;
413 g_destroy_geom(struct g_geom *gp)
415 struct g_geom_alias *gap, *gaptmp;
419 g_trace(G_T_TOPOLOGY, "g_destroy_geom(%p(%s))", gp, gp->name);
420 KASSERT(LIST_EMPTY(&gp->consumer),
421 ("g_destroy_geom(%s) with consumer(s) [%p]",
422 gp->name, LIST_FIRST(&gp->consumer)));
423 KASSERT(LIST_EMPTY(&gp->provider),
424 ("g_destroy_geom(%s) with provider(s) [%p]",
425 gp->name, LIST_FIRST(&gp->provider)));
427 LIST_REMOVE(gp, geom);
428 TAILQ_REMOVE(&geoms, gp, geoms);
429 LIST_FOREACH_SAFE(gap, &gp->aliases, ga_next, gaptmp)
436 * This function is called (repeatedly) until the geom has withered away.
439 g_wither_geom(struct g_geom *gp, int error)
441 struct g_provider *pp;
445 g_trace(G_T_TOPOLOGY, "g_wither_geom(%p(%s))", gp, gp->name);
446 if (!(gp->flags & G_GEOM_WITHER)) {
447 gp->flags |= G_GEOM_WITHER;
448 LIST_FOREACH(pp, &gp->provider, provider)
449 if (!(pp->flags & G_PF_ORPHAN))
450 g_orphan_provider(pp, error);
456 * Convenience function to destroy a particular provider.
459 g_wither_provider(struct g_provider *pp, int error)
462 pp->flags |= G_PF_WITHER;
463 if (!(pp->flags & G_PF_ORPHAN))
464 g_orphan_provider(pp, error);
468 * This function is called (repeatedly) until the has withered away.
471 g_wither_geom_close(struct g_geom *gp, int error)
473 struct g_consumer *cp;
477 g_trace(G_T_TOPOLOGY, "g_wither_geom_close(%p(%s))", gp, gp->name);
478 LIST_FOREACH(cp, &gp->consumer, consumer)
479 if (cp->acr || cp->acw || cp->ace)
480 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
481 g_wither_geom(gp, error);
485 * This function is called (repeatedly) until we cant wash away more
486 * withered bits at present.
492 struct g_geom *gp, *gp2;
493 struct g_provider *pp, *pp2;
494 struct g_consumer *cp, *cp2;
497 LIST_FOREACH(mp, &g_classes, class) {
498 LIST_FOREACH_SAFE(gp, &mp->geom, geom, gp2) {
499 LIST_FOREACH_SAFE(pp, &gp->provider, provider, pp2) {
500 if (!(pp->flags & G_PF_WITHER))
502 if (LIST_EMPTY(&pp->consumers))
503 g_destroy_provider(pp);
505 if (!(gp->flags & G_GEOM_WITHER))
507 LIST_FOREACH_SAFE(pp, &gp->provider, provider, pp2) {
508 if (LIST_EMPTY(&pp->consumers))
509 g_destroy_provider(pp);
511 LIST_FOREACH_SAFE(cp, &gp->consumer, consumer, cp2) {
512 if (cp->acr || cp->acw || cp->ace)
514 if (cp->provider != NULL)
516 g_destroy_consumer(cp);
518 if (LIST_EMPTY(&gp->provider) &&
519 LIST_EMPTY(&gp->consumer))
526 g_new_consumer(struct g_geom *gp)
528 struct g_consumer *cp;
532 KASSERT(!(gp->flags & G_GEOM_WITHER),
533 ("g_new_consumer on WITHERing geom(%s) (class %s)",
534 gp->name, gp->class->name));
535 KASSERT(gp->orphan != NULL,
536 ("g_new_consumer on geom(%s) (class %s) without orphan",
537 gp->name, gp->class->name));
539 cp = g_malloc(sizeof *cp, M_WAITOK | M_ZERO);
541 cp->stat = devstat_new_entry(cp, -1, 0, DEVSTAT_ALL_SUPPORTED,
542 DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
543 LIST_INSERT_HEAD(&gp->consumer, cp, consumer);
548 g_destroy_consumer(struct g_consumer *cp)
553 G_VALID_CONSUMER(cp);
554 g_trace(G_T_TOPOLOGY, "g_destroy_consumer(%p)", cp);
555 KASSERT (cp->provider == NULL, ("g_destroy_consumer but attached"));
556 KASSERT (cp->acr == 0, ("g_destroy_consumer with acr"));
557 KASSERT (cp->acw == 0, ("g_destroy_consumer with acw"));
558 KASSERT (cp->ace == 0, ("g_destroy_consumer with ace"));
561 LIST_REMOVE(cp, consumer);
562 devstat_remove_entry(cp->stat);
564 if (gp->flags & G_GEOM_WITHER)
569 g_new_provider_event(void *arg, int flag)
572 struct g_provider *pp;
573 struct g_consumer *cp, *next_cp;
576 if (flag == EV_CANCEL)
581 G_VALID_PROVIDER(pp);
582 KASSERT(!(pp->flags & G_PF_WITHER),
583 ("g_new_provider_event but withered"));
584 LIST_FOREACH_SAFE(cp, &pp->consumers, consumers, next_cp) {
585 if ((cp->flags & G_CF_ORPHAN) == 0 &&
586 cp->geom->attrchanged != NULL)
587 cp->geom->attrchanged(cp, "GEOM::media");
591 LIST_FOREACH(mp, &g_classes, class) {
592 if (mp->taste == NULL)
594 LIST_FOREACH(cp, &pp->consumers, consumers)
595 if (cp->geom->class == mp &&
596 (cp->flags & G_CF_ORPHAN) == 0)
600 mp->taste(mp, pp, 0);
607 g_new_providerf(struct g_geom *gp, const char *fmt, ...)
609 struct g_provider *pp;
615 KASSERT(gp->access != NULL,
616 ("new provider on geom(%s) without ->access (class %s)",
617 gp->name, gp->class->name));
618 KASSERT(gp->start != NULL,
619 ("new provider on geom(%s) without ->start (class %s)",
620 gp->name, gp->class->name));
621 KASSERT(!(gp->flags & G_GEOM_WITHER),
622 ("new provider on WITHERing geom(%s) (class %s)",
623 gp->name, gp->class->name));
624 sb = sbuf_new_auto();
626 sbuf_vprintf(sb, fmt, ap);
629 pp = g_malloc(sizeof *pp + sbuf_len(sb) + 1, M_WAITOK | M_ZERO);
630 pp->name = (char *)(pp + 1);
631 strcpy(pp->name, sbuf_data(sb));
633 LIST_INIT(&pp->consumers);
636 pp->stat = devstat_new_entry(pp, -1, 0, DEVSTAT_ALL_SUPPORTED,
637 DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
638 LIST_INSERT_HEAD(&gp->provider, pp, provider);
639 g_post_event(g_new_provider_event, pp, M_WAITOK, pp, gp, NULL);
644 g_error_provider(struct g_provider *pp, int error)
647 /* G_VALID_PROVIDER(pp); We may not have g_topology */
652 g_resize_provider_event(void *arg, int flag)
657 struct g_provider *pp;
658 struct g_consumer *cp, *cp2;
670 G_VALID_PROVIDER(pp);
671 KASSERT(!(pp->flags & G_PF_WITHER),
672 ("g_resize_provider_event but withered"));
673 g_trace(G_T_TOPOLOGY, "g_resize_provider_event(%p)", pp);
675 LIST_FOREACH_SAFE(cp, &pp->consumers, consumers, cp2) {
677 if (gp->resize == NULL && size < pp->mediasize) {
679 * XXX: g_dev_orphan method does deferred destroying
680 * and it is possible, that other event could already
681 * call the orphan method. Check consumer's flags to
682 * do not schedule it twice.
684 if (cp->flags & G_CF_ORPHAN)
686 cp->flags |= G_CF_ORPHAN;
687 cp->geom->orphan(cp);
691 pp->mediasize = size;
693 LIST_FOREACH_SAFE(cp, &pp->consumers, consumers, cp2) {
695 if ((gp->flags & G_GEOM_WITHER) == 0 && gp->resize != NULL)
700 * After resizing, the previously invalid GEOM class metadata
701 * might become valid. This means we should retaste.
703 LIST_FOREACH(mp, &g_classes, class) {
704 if (mp->taste == NULL)
706 LIST_FOREACH(cp, &pp->consumers, consumers)
707 if (cp->geom->class == mp &&
708 (cp->flags & G_CF_ORPHAN) == 0)
712 mp->taste(mp, pp, 0);
718 g_resize_provider(struct g_provider *pp, off_t size)
722 G_VALID_PROVIDER(pp);
723 if (pp->flags & G_PF_WITHER)
726 if (size == pp->mediasize)
729 hh = g_malloc(sizeof *hh, M_WAITOK | M_ZERO);
732 g_post_event(g_resize_provider_event, hh, M_WAITOK, NULL);
736 #define _PATH_DEV "/dev/"
740 g_provider_by_name(char const *arg)
744 struct g_provider *pp, *wpp;
746 if (strncmp(arg, _PATH_DEV, sizeof(_PATH_DEV) - 1) == 0)
747 arg += sizeof(_PATH_DEV) - 1;
750 LIST_FOREACH(cp, &g_classes, class) {
751 LIST_FOREACH(gp, &cp->geom, geom) {
752 LIST_FOREACH(pp, &gp->provider, provider) {
753 if (strcmp(arg, pp->name) != 0)
755 if ((gp->flags & G_GEOM_WITHER) == 0 &&
756 (pp->flags & G_PF_WITHER) == 0)
768 g_destroy_provider(struct g_provider *pp)
773 G_VALID_PROVIDER(pp);
774 KASSERT(LIST_EMPTY(&pp->consumers),
775 ("g_destroy_provider but attached"));
776 KASSERT (pp->acr == 0, ("g_destroy_provider with acr"));
777 KASSERT (pp->acw == 0, ("g_destroy_provider with acw"));
778 KASSERT (pp->ace == 0, ("g_destroy_provider with ace"));
780 LIST_REMOVE(pp, provider);
782 devstat_remove_entry(pp->stat);
784 * If a callback was provided, send notification that the provider
787 if (gp->providergone != NULL)
788 gp->providergone(pp);
791 if ((gp->flags & G_GEOM_WITHER))
796 * We keep the "geoms" list sorted by topological order (== increasing
797 * numerical rank) at all times.
798 * When an attach is done, the attaching geoms rank is invalidated
799 * and it is moved to the tail of the list.
800 * All geoms later in the sequence has their ranks reevaluated in
801 * sequence. If we cannot assign rank to a geom because it's
802 * prerequisites do not have rank, we move that element to the tail
803 * of the sequence with invalid rank as well.
804 * At some point we encounter our original geom and if we stil fail
805 * to assign it a rank, there must be a loop and we fail back to
806 * g_attach() which detach again and calls redo_rank again
807 * to fix up the damage.
808 * It would be much simpler code wise to do it recursively, but we
809 * can't risk that on the kernel stack.
813 redo_rank(struct g_geom *gp)
815 struct g_consumer *cp;
816 struct g_geom *gp1, *gp2;
822 /* Invalidate this geoms rank and move it to the tail */
823 gp1 = TAILQ_NEXT(gp, geoms);
826 TAILQ_REMOVE(&geoms, gp, geoms);
827 TAILQ_INSERT_TAIL(&geoms, gp, geoms);
832 /* re-rank the rest of the sequence */
833 for (; gp1 != NULL; gp1 = gp2) {
836 LIST_FOREACH(cp, &gp1->consumer, consumer) {
837 if (cp->provider == NULL)
839 n = cp->provider->geom->rank;
847 gp2 = TAILQ_NEXT(gp1, geoms);
849 /* got a rank, moving on */
853 /* no rank to original geom means loop */
857 /* no rank, put it at the end move on */
858 TAILQ_REMOVE(&geoms, gp1, geoms);
859 TAILQ_INSERT_TAIL(&geoms, gp1, geoms);
865 g_attach(struct g_consumer *cp, struct g_provider *pp)
870 G_VALID_CONSUMER(cp);
871 G_VALID_PROVIDER(pp);
872 g_trace(G_T_TOPOLOGY, "g_attach(%p, %p)", cp, pp);
873 KASSERT(cp->provider == NULL, ("attach but attached"));
875 cp->flags &= ~G_CF_ORPHAN;
876 LIST_INSERT_HEAD(&pp->consumers, cp, consumers);
877 error = redo_rank(cp->geom);
879 LIST_REMOVE(cp, consumers);
887 g_detach(struct g_consumer *cp)
889 struct g_provider *pp;
892 G_VALID_CONSUMER(cp);
893 g_trace(G_T_TOPOLOGY, "g_detach(%p)", cp);
894 KASSERT(cp->provider != NULL, ("detach but not attached"));
895 KASSERT(cp->acr == 0, ("detach but nonzero acr"));
896 KASSERT(cp->acw == 0, ("detach but nonzero acw"));
897 KASSERT(cp->ace == 0, ("detach but nonzero ace"));
898 KASSERT(cp->nstart == cp->nend,
899 ("detach with active requests"));
901 LIST_REMOVE(cp, consumers);
903 if ((cp->geom->flags & G_GEOM_WITHER) ||
904 (pp->geom->flags & G_GEOM_WITHER) ||
905 (pp->flags & G_PF_WITHER))
913 * Access-check with delta values. The question asked is "can provider
914 * "cp" change the access counters by the relative amounts dc[rwe] ?"
918 g_access(struct g_consumer *cp, int dcr, int dcw, int dce)
920 struct g_provider *pp;
929 G_VALID_CONSUMER(cp);
931 KASSERT(pp != NULL, ("access but not attached"));
932 G_VALID_PROVIDER(pp);
935 g_trace(G_T_ACCESS, "g_access(%p(%s), %d, %d, %d)",
936 cp, pp->name, dcr, dcw, dce);
938 KASSERT(cp->acr + dcr >= 0, ("access resulting in negative acr"));
939 KASSERT(cp->acw + dcw >= 0, ("access resulting in negative acw"));
940 KASSERT(cp->ace + dce >= 0, ("access resulting in negative ace"));
941 KASSERT(dcr != 0 || dcw != 0 || dce != 0, ("NOP access request"));
942 KASSERT(cp->acr + dcr != 0 || cp->acw + dcw != 0 ||
943 cp->ace + dce != 0 || cp->nstart == cp->nend,
944 ("Last close with active requests"));
945 KASSERT(gp->access != NULL, ("NULL geom->access"));
948 * If our class cares about being spoiled, and we have been, we
949 * are probably just ahead of the event telling us that. Fail
950 * now rather than having to unravel this later.
952 if (cp->geom->spoiled != NULL && (cp->flags & G_CF_SPOILED) &&
953 (dcr > 0 || dcw > 0 || dce > 0))
957 * A number of GEOM classes either need to perform an I/O on the first
958 * open or to acquire a different subsystem's lock. To do that they
959 * may have to drop the topology lock.
960 * Other GEOM classes perform special actions when opening a lower rank
961 * geom for the first time. As a result, more than one thread may
962 * end up performing the special actions.
963 * So, we prevent concurrent "first" opens by marking the consumer with
966 * Note that if the geom's access method never drops the topology lock,
967 * then we will never see G_GEOM_IN_ACCESS here.
969 while ((gp->flags & G_GEOM_IN_ACCESS) != 0) {
971 "%s: race on geom %s via provider %s and consumer of %s",
972 __func__, gp->name, pp->name, cp->geom->name);
973 gp->flags |= G_GEOM_ACCESS_WAIT;
974 g_topology_sleep(gp, 0);
978 * Figure out what counts the provider would have had, if this
979 * consumer had (r0w0e0) at this time.
981 pw = pp->acw - cp->acw;
982 pe = pp->ace - cp->ace;
985 "open delta:[r%dw%de%d] old:[r%dw%de%d] provider:[r%dw%de%d] %p(%s)",
987 cp->acr, cp->acw, cp->ace,
988 pp->acr, pp->acw, pp->ace,
991 /* If foot-shooting is enabled, any open on rank#1 is OK */
992 if ((g_debugflags & G_F_FOOTSHOOTING) && gp->rank == 1)
994 /* If we try exclusive but already write: fail */
995 else if (dce > 0 && pw > 0)
997 /* If we try write but already exclusive: fail */
998 else if (dcw > 0 && pe > 0)
1000 /* If we try to open more but provider is error'ed: fail */
1001 else if ((dcr > 0 || dcw > 0 || dce > 0) && pp->error != 0) {
1002 printf("%s(%d): provider %s has error %d set\n",
1003 __func__, __LINE__, pp->name, pp->error);
1014 gp->flags |= G_GEOM_IN_ACCESS;
1015 error = gp->access(pp, dcr, dcw, dce);
1016 KASSERT(dcr > 0 || dcw > 0 || dce > 0 || error == 0,
1017 ("Geom provider %s::%s dcr=%d dcw=%d dce=%d error=%d failed "
1018 "closing ->access()", gp->class->name, pp->name, dcr, dcw,
1021 g_topology_assert();
1022 gp->flags &= ~G_GEOM_IN_ACCESS;
1023 KASSERT(cp->acr == sr && cp->acw == sw && cp->ace == se,
1024 ("Access counts changed during geom->access"));
1025 if ((gp->flags & G_GEOM_ACCESS_WAIT) != 0) {
1026 gp->flags &= ~G_GEOM_ACCESS_WAIT;
1032 * If we open first write, spoil any partner consumers.
1033 * If we close last write and provider is not errored,
1036 if (pp->acw == 0 && dcw != 0)
1038 else if (pp->acw != 0 && pp->acw == -dcw && pp->error == 0 &&
1039 !(gp->flags & G_GEOM_WITHER))
1040 g_post_event(g_new_provider_event, pp, M_WAITOK,
1049 if (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)
1050 KASSERT(pp->sectorsize > 0,
1051 ("Provider %s lacks sectorsize", pp->name));
1052 if ((cp->geom->flags & G_GEOM_WITHER) &&
1053 cp->acr == 0 && cp->acw == 0 && cp->ace == 0)
1060 g_handleattr_int(struct bio *bp, const char *attribute, int val)
1063 return (g_handleattr(bp, attribute, &val, sizeof val));
1067 g_handleattr_uint16_t(struct bio *bp, const char *attribute, uint16_t val)
1070 return (g_handleattr(bp, attribute, &val, sizeof val));
1074 g_handleattr_off_t(struct bio *bp, const char *attribute, off_t val)
1077 return (g_handleattr(bp, attribute, &val, sizeof val));
1081 g_handleattr_str(struct bio *bp, const char *attribute, const char *str)
1084 return (g_handleattr(bp, attribute, str, 0));
1088 g_handleattr(struct bio *bp, const char *attribute, const void *val, int len)
1092 if (strcmp(bp->bio_attribute, attribute))
1095 bzero(bp->bio_data, bp->bio_length);
1096 if (strlcpy(bp->bio_data, val, bp->bio_length) >=
1098 printf("%s: %s %s bio_length %jd strlen %zu -> EFAULT\n",
1099 __func__, bp->bio_to->name, attribute,
1100 (intmax_t)bp->bio_length, strlen(val));
1103 } else if (bp->bio_length == len) {
1104 bcopy(val, bp->bio_data, len);
1106 printf("%s: %s %s bio_length %jd len %d -> EFAULT\n", __func__,
1107 bp->bio_to->name, attribute, (intmax_t)bp->bio_length, len);
1111 bp->bio_completed = bp->bio_length;
1112 g_io_deliver(bp, error);
1117 g_std_access(struct g_provider *pp,
1118 int dr __unused, int dw __unused, int de __unused)
1121 g_topology_assert();
1122 G_VALID_PROVIDER(pp);
1127 g_std_done(struct bio *bp)
1131 bp2 = bp->bio_parent;
1132 if (bp2->bio_error == 0)
1133 bp2->bio_error = bp->bio_error;
1134 bp2->bio_completed += bp->bio_completed;
1137 if (bp2->bio_children == bp2->bio_inbed) {
1138 if (bp2->bio_cmd == BIO_SPEEDUP)
1139 bp2->bio_completed = bp2->bio_length;
1140 g_io_deliver(bp2, bp2->bio_error);
1144 /* XXX: maybe this is only g_slice_spoiled */
1147 g_std_spoiled(struct g_consumer *cp)
1150 struct g_provider *pp;
1152 g_topology_assert();
1153 G_VALID_CONSUMER(cp);
1154 g_trace(G_T_TOPOLOGY, "g_std_spoiled(%p)", cp);
1155 cp->flags |= G_CF_ORPHAN;
1158 LIST_FOREACH(pp, &gp->provider, provider)
1159 g_orphan_provider(pp, ENXIO);
1160 g_destroy_consumer(cp);
1161 if (LIST_EMPTY(&gp->provider) && LIST_EMPTY(&gp->consumer))
1164 gp->flags |= G_GEOM_WITHER;
1168 * Spoiling happens when a provider is opened for writing, but consumers
1169 * which are configured by in-band data are attached (slicers for instance).
1170 * Since the write might potentially change the in-band data, such consumers
1171 * need to re-evaluate their existence after the writing session closes.
1172 * We do this by (offering to) tear them down when the open for write happens
1173 * in return for a re-taste when it closes again.
1174 * Together with the fact that such consumers grab an 'e' bit whenever they
1175 * are open, regardless of mode, this ends up DTRT.
1179 g_spoil_event(void *arg, int flag)
1181 struct g_provider *pp;
1182 struct g_consumer *cp, *cp2;
1184 g_topology_assert();
1185 if (flag == EV_CANCEL)
1188 G_VALID_PROVIDER(pp);
1189 g_trace(G_T_TOPOLOGY, "%s %p(%s:%s:%s)", __func__, pp,
1190 pp->geom->class->name, pp->geom->name, pp->name);
1191 for (cp = LIST_FIRST(&pp->consumers); cp != NULL; cp = cp2) {
1192 cp2 = LIST_NEXT(cp, consumers);
1193 if ((cp->flags & G_CF_SPOILED) == 0)
1195 cp->flags &= ~G_CF_SPOILED;
1196 if (cp->geom->spoiled == NULL)
1198 cp->geom->spoiled(cp);
1199 g_topology_assert();
1204 g_spoil(struct g_provider *pp, struct g_consumer *cp)
1206 struct g_consumer *cp2;
1208 g_topology_assert();
1209 G_VALID_PROVIDER(pp);
1210 G_VALID_CONSUMER(cp);
1212 LIST_FOREACH(cp2, &pp->consumers, consumers) {
1216 KASSERT(cp2->acr == 0, ("spoiling cp->acr = %d", cp2->acr));
1217 KASSERT(cp2->acw == 0, ("spoiling cp->acw = %d", cp2->acw));
1219 KASSERT(cp2->ace == 0, ("spoiling cp->ace = %d", cp2->ace));
1220 cp2->flags |= G_CF_SPOILED;
1222 g_post_event(g_spoil_event, pp, M_WAITOK, pp, NULL);
1226 g_media_changed_event(void *arg, int flag)
1228 struct g_provider *pp;
1231 g_topology_assert();
1232 if (flag == EV_CANCEL)
1235 G_VALID_PROVIDER(pp);
1238 * If provider was not open for writing, queue retaste after spoiling.
1239 * If it was, retaste will happen automatically on close.
1241 retaste = (pp->acw == 0 && pp->error == 0 &&
1242 !(pp->geom->flags & G_GEOM_WITHER));
1243 g_spoil_event(arg, flag);
1245 g_post_event(g_new_provider_event, pp, M_WAITOK, pp, NULL);
1249 g_media_changed(struct g_provider *pp, int flag)
1251 struct g_consumer *cp;
1253 LIST_FOREACH(cp, &pp->consumers, consumers)
1254 cp->flags |= G_CF_SPOILED;
1255 return (g_post_event(g_media_changed_event, pp, flag, pp, NULL));
1259 g_media_gone(struct g_provider *pp, int flag)
1261 struct g_consumer *cp;
1263 LIST_FOREACH(cp, &pp->consumers, consumers)
1264 cp->flags |= G_CF_SPOILED;
1265 return (g_post_event(g_spoil_event, pp, flag, pp, NULL));
1269 g_getattr__(const char *attr, struct g_consumer *cp, void *var, int len)
1274 error = g_io_getattr(attr, cp, &i, var);
1283 g_get_device_prefix_len(const char *name)
1287 if (strncmp(name, "ada", 3) == 0)
1289 else if (strncmp(name, "ad", 2) == 0)
1293 if (name[len] < '0' || name[len] > '9')
1297 } while (name[len] >= '0' && name[len] <= '9');
1302 g_compare_names(const char *namea, const char *nameb)
1306 if (strcmp(namea, nameb) == 0)
1308 deva = g_get_device_prefix_len(namea);
1311 devb = g_get_device_prefix_len(nameb);
1314 if (strcmp(namea + deva, nameb + devb) == 0)
1320 g_geom_add_alias(struct g_geom *gp, const char *alias)
1322 struct g_geom_alias *gap;
1324 gap = (struct g_geom_alias *)g_malloc(
1325 sizeof(struct g_geom_alias) + strlen(alias) + 1, M_WAITOK);
1326 strcpy((char *)(gap + 1), alias);
1327 gap->ga_alias = (const char *)(gap + 1);
1328 LIST_INSERT_HEAD(&gp->aliases, gap, ga_next);
1331 #if defined(DIAGNOSTIC) || defined(DDB)
1333 * This function walks the mesh and returns a non-zero integer if it
1334 * finds the argument pointer is an object. The return value indicates
1335 * which type of object it is believed to be. If topology is not locked,
1336 * this function is potentially dangerous, but we don't assert that the
1337 * topology lock is held when called from debugger.
1340 g_valid_obj(void const *ptr)
1344 struct g_consumer *cp;
1345 struct g_provider *pp;
1348 if (kdb_active == 0)
1350 g_topology_assert();
1352 LIST_FOREACH(mp, &g_classes, class) {
1355 LIST_FOREACH(gp, &mp->geom, geom) {
1358 LIST_FOREACH(cp, &gp->consumer, consumer)
1361 LIST_FOREACH(pp, &gp->provider, provider)
1372 #define gprintf(...) do { \
1373 db_printf("%*s", indent, ""); \
1374 db_printf(__VA_ARGS__); \
1376 #define gprintln(...) do { \
1377 gprintf(__VA_ARGS__); \
1381 #define ADDFLAG(obj, flag, sflag) do { \
1382 if ((obj)->flags & (flag)) { \
1384 strlcat(str, ",", size); \
1385 strlcat(str, (sflag), size); \
1391 provider_flags_to_string(struct g_provider *pp, char *str, size_t size)
1396 if (pp->flags == 0) {
1397 strlcpy(str, "NONE", size);
1400 ADDFLAG(pp, G_PF_WITHER, "G_PF_WITHER");
1401 ADDFLAG(pp, G_PF_ORPHAN, "G_PF_ORPHAN");
1406 geom_flags_to_string(struct g_geom *gp, char *str, size_t size)
1411 if (gp->flags == 0) {
1412 strlcpy(str, "NONE", size);
1415 ADDFLAG(gp, G_GEOM_WITHER, "G_GEOM_WITHER");
1419 db_show_geom_consumer(int indent, struct g_consumer *cp)
1423 gprintln("consumer: %p", cp);
1424 gprintln(" class: %s (%p)", cp->geom->class->name,
1426 gprintln(" geom: %s (%p)", cp->geom->name, cp->geom);
1427 if (cp->provider == NULL)
1428 gprintln(" provider: none");
1430 gprintln(" provider: %s (%p)", cp->provider->name,
1433 gprintln(" access: r%dw%de%d", cp->acr, cp->acw, cp->ace);
1434 gprintln(" flags: 0x%04x", cp->flags);
1436 gprintln(" nstart: %u", cp->nstart);
1437 gprintln(" nend: %u", cp->nend);
1440 gprintf("consumer: %p (%s), access=r%dw%de%d", cp,
1441 cp->provider != NULL ? cp->provider->name : "none",
1442 cp->acr, cp->acw, cp->ace);
1444 db_printf(", flags=0x%04x", cp->flags);
1450 db_show_geom_provider(int indent, struct g_provider *pp)
1452 struct g_consumer *cp;
1456 gprintln("provider: %s (%p)", pp->name, pp);
1457 gprintln(" class: %s (%p)", pp->geom->class->name,
1459 gprintln(" geom: %s (%p)", pp->geom->name, pp->geom);
1460 gprintln(" mediasize: %jd", (intmax_t)pp->mediasize);
1461 gprintln(" sectorsize: %u", pp->sectorsize);
1462 gprintln(" stripesize: %ju", (uintmax_t)pp->stripesize);
1463 gprintln(" stripeoffset: %ju", (uintmax_t)pp->stripeoffset);
1464 gprintln(" access: r%dw%de%d", pp->acr, pp->acw,
1466 gprintln(" flags: %s (0x%04x)",
1467 provider_flags_to_string(pp, flags, sizeof(flags)),
1469 gprintln(" error: %d", pp->error);
1470 if (LIST_EMPTY(&pp->consumers))
1471 gprintln(" consumers: none");
1473 gprintf("provider: %s (%p), access=r%dw%de%d",
1474 pp->name, pp, pp->acr, pp->acw, pp->ace);
1475 if (pp->flags != 0) {
1476 db_printf(", flags=%s (0x%04x)",
1477 provider_flags_to_string(pp, flags, sizeof(flags)),
1482 if (!LIST_EMPTY(&pp->consumers)) {
1483 LIST_FOREACH(cp, &pp->consumers, consumers) {
1484 db_show_geom_consumer(indent + 2, cp);
1492 db_show_geom_geom(int indent, struct g_geom *gp)
1494 struct g_provider *pp;
1495 struct g_consumer *cp;
1499 gprintln("geom: %s (%p)", gp->name, gp);
1500 gprintln(" class: %s (%p)", gp->class->name, gp->class);
1501 gprintln(" flags: %s (0x%04x)",
1502 geom_flags_to_string(gp, flags, sizeof(flags)), gp->flags);
1503 gprintln(" rank: %d", gp->rank);
1504 if (LIST_EMPTY(&gp->provider))
1505 gprintln(" providers: none");
1506 if (LIST_EMPTY(&gp->consumer))
1507 gprintln(" consumers: none");
1509 gprintf("geom: %s (%p), rank=%d", gp->name, gp, gp->rank);
1510 if (gp->flags != 0) {
1511 db_printf(", flags=%s (0x%04x)",
1512 geom_flags_to_string(gp, flags, sizeof(flags)),
1517 if (!LIST_EMPTY(&gp->provider)) {
1518 LIST_FOREACH(pp, &gp->provider, provider) {
1519 db_show_geom_provider(indent + 2, pp);
1524 if (!LIST_EMPTY(&gp->consumer)) {
1525 LIST_FOREACH(cp, &gp->consumer, consumer) {
1526 db_show_geom_consumer(indent + 2, cp);
1534 db_show_geom_class(struct g_class *mp)
1538 db_printf("class: %s (%p)\n", mp->name, mp);
1539 LIST_FOREACH(gp, &mp->geom, geom) {
1540 db_show_geom_geom(2, gp);
1547 * Print the GEOM topology or the given object.
1549 DB_SHOW_COMMAND(geom, db_show_geom)
1554 /* No address given, print the entire topology. */
1555 LIST_FOREACH(mp, &g_classes, class) {
1556 db_show_geom_class(mp);
1562 switch (g_valid_obj((void *)addr)) {
1564 db_show_geom_class((struct g_class *)addr);
1567 db_show_geom_geom(0, (struct g_geom *)addr);
1570 db_show_geom_consumer(0, (struct g_consumer *)addr);
1573 db_show_geom_provider(0, (struct g_provider *)addr);
1576 db_printf("Not a GEOM object.\n");
1583 db_print_bio_cmd(struct bio *bp)
1585 db_printf(" cmd: ");
1586 switch (bp->bio_cmd) {
1587 case BIO_READ: db_printf("BIO_READ"); break;
1588 case BIO_WRITE: db_printf("BIO_WRITE"); break;
1589 case BIO_DELETE: db_printf("BIO_DELETE"); break;
1590 case BIO_GETATTR: db_printf("BIO_GETATTR"); break;
1591 case BIO_FLUSH: db_printf("BIO_FLUSH"); break;
1592 case BIO_CMD0: db_printf("BIO_CMD0"); break;
1593 case BIO_CMD1: db_printf("BIO_CMD1"); break;
1594 case BIO_CMD2: db_printf("BIO_CMD2"); break;
1595 case BIO_ZONE: db_printf("BIO_ZONE"); break;
1596 default: db_printf("UNKNOWN"); break;
1602 db_print_bio_flags(struct bio *bp)
1607 db_printf(" flags: ");
1608 if (bp->bio_flags & BIO_ERROR) {
1609 db_printf("BIO_ERROR");
1612 if (bp->bio_flags & BIO_DONE) {
1613 db_printf("%sBIO_DONE", (comma ? ", " : ""));
1616 if (bp->bio_flags & BIO_ONQUEUE)
1617 db_printf("%sBIO_ONQUEUE", (comma ? ", " : ""));
1622 * Print useful information in a BIO
1624 DB_SHOW_COMMAND(bio, db_show_bio)
1629 bp = (struct bio *)addr;
1630 db_printf("BIO %p\n", bp);
1631 db_print_bio_cmd(bp);
1632 db_print_bio_flags(bp);
1633 db_printf(" cflags: 0x%hx\n", bp->bio_cflags);
1634 db_printf(" pflags: 0x%hx\n", bp->bio_pflags);
1635 db_printf(" offset: %jd\n", (intmax_t)bp->bio_offset);
1636 db_printf(" length: %jd\n", (intmax_t)bp->bio_length);
1637 db_printf(" bcount: %ld\n", bp->bio_bcount);
1638 db_printf(" resid: %ld\n", bp->bio_resid);
1639 db_printf(" completed: %jd\n", (intmax_t)bp->bio_completed);
1640 db_printf(" children: %u\n", bp->bio_children);
1641 db_printf(" inbed: %u\n", bp->bio_inbed);
1642 db_printf(" error: %d\n", bp->bio_error);
1643 db_printf(" parent: %p\n", bp->bio_parent);
1644 db_printf(" driver1: %p\n", bp->bio_driver1);
1645 db_printf(" driver2: %p\n", bp->bio_driver2);
1646 db_printf(" caller1: %p\n", bp->bio_caller1);
1647 db_printf(" caller2: %p\n", bp->bio_caller2);
1648 db_printf(" bio_from: %p\n", bp->bio_from);
1649 db_printf(" bio_to: %p\n", bp->bio_to);
1651 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
1652 db_printf(" bio_track_bp: %p\n", bp->bio_track_bp);