2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2011-2013 Alexander Motin <mav@FreeBSD.org>
5 * Copyright (c) 2006-2007 Matthew Jacob <mjacob@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Based upon work by Pawel Jakub Dawidek <pjd@FreeBSD.org> for all of the
31 * fine geom examples, and by Poul Henning Kamp <phk@FreeBSD.org> for GEOM
32 * itself, all of which is most gratefully acknowledged.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
41 #include <sys/limits.h>
43 #include <sys/mutex.h>
47 #include <sys/sysctl.h>
48 #include <sys/kthread.h>
49 #include <sys/malloc.h>
50 #include <geom/geom.h>
51 #include <geom/multipath/g_multipath.h>
53 FEATURE(geom_multipath, "GEOM multipath support");
55 SYSCTL_DECL(_kern_geom);
56 static SYSCTL_NODE(_kern_geom, OID_AUTO, multipath,
57 CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
58 "GEOM_MULTIPATH tunables");
59 static u_int g_multipath_debug = 0;
60 SYSCTL_UINT(_kern_geom_multipath, OID_AUTO, debug, CTLFLAG_RW,
61 &g_multipath_debug, 0, "Debug level");
62 static u_int g_multipath_exclusive = 1;
63 SYSCTL_UINT(_kern_geom_multipath, OID_AUTO, exclusive, CTLFLAG_RW,
64 &g_multipath_exclusive, 0, "Exclusively open providers");
66 SDT_PROVIDER_DECLARE(geom);
67 SDT_PROBE_DEFINE2(geom, multipath, config, restore, "char*", "char*");
68 SDT_PROBE_DEFINE2(geom, multipath, config, remove, "char*", "char*");
69 SDT_PROBE_DEFINE2(geom, multipath, config, disconnect, "char*", "char*");
70 SDT_PROBE_DEFINE3(geom, multipath, config, fail, "char*", "char*", "int");
71 SDT_PROBE_DEFINE2(geom, multipath, config, taste, "char*", "char*");
72 SDT_PROBE_DEFINE2(geom, multipath, io, restart, "struct bio*", "struct bio*");
78 } g_multipath_kt_state;
79 static struct bio_queue_head gmtbq;
80 static struct mtx gmtbq_mtx;
82 static int g_multipath_read_metadata(struct g_consumer *cp,
83 struct g_multipath_metadata *md);
84 static int g_multipath_write_metadata(struct g_consumer *cp,
85 struct g_multipath_metadata *md);
87 static void g_multipath_orphan(struct g_consumer *);
88 static void g_multipath_resize(struct g_consumer *);
89 static void g_multipath_start(struct bio *);
90 static void g_multipath_done(struct bio *);
91 static void g_multipath_done_error(struct bio *);
92 static void g_multipath_kt(void *);
94 static int g_multipath_destroy(struct g_geom *);
96 g_multipath_destroy_geom(struct gctl_req *, struct g_class *, struct g_geom *);
98 static struct g_geom *g_multipath_find_geom(struct g_class *, const char *);
99 static int g_multipath_rotate(struct g_geom *);
101 static g_taste_t g_multipath_taste;
102 static g_ctl_req_t g_multipath_config;
103 static g_init_t g_multipath_init;
104 static g_fini_t g_multipath_fini;
105 static g_dumpconf_t g_multipath_dumpconf;
107 struct g_class g_multipath_class = {
108 .name = G_MULTIPATH_CLASS_NAME,
109 .version = G_VERSION,
110 .ctlreq = g_multipath_config,
111 .taste = g_multipath_taste,
112 .destroy_geom = g_multipath_destroy_geom,
113 .init = g_multipath_init,
114 .fini = g_multipath_fini
117 #define MP_FAIL 0x00000001
118 #define MP_LOST 0x00000002
119 #define MP_NEW 0x00000004
120 #define MP_POSTED 0x00000008
121 #define MP_BAD (MP_FAIL | MP_LOST | MP_NEW)
122 #define MP_WITHER 0x00000010
123 #define MP_IDLE 0x00000020
124 #define MP_IDLE_MASK 0xffffffe0
127 g_multipath_good(struct g_geom *gp)
129 struct g_consumer *cp;
132 LIST_FOREACH(cp, &gp->consumer, consumer) {
133 if ((cp->index & MP_BAD) == 0)
140 g_multipath_fault(struct g_consumer *cp, int cause)
142 struct g_multipath_softc *sc;
143 struct g_consumer *lcp;
149 if (g_multipath_good(gp) == 0 && sc->sc_ndisks > 0) {
150 LIST_FOREACH(lcp, &gp->consumer, consumer) {
151 if (lcp->provider == NULL ||
152 (lcp->index & (MP_LOST | MP_NEW)))
154 if (sc->sc_ndisks > 1 && lcp == cp)
156 printf("GEOM_MULTIPATH: "
157 "all paths in %s were marked FAIL, restore %s\n",
158 sc->sc_name, lcp->provider->name);
159 SDT_PROBE2(geom, multipath, config, restore,
160 sc->sc_name, lcp->provider->name);
161 lcp->index &= ~MP_FAIL;
164 if (cp != sc->sc_active)
166 sc->sc_active = NULL;
167 LIST_FOREACH(lcp, &gp->consumer, consumer) {
168 if ((lcp->index & MP_BAD) == 0) {
173 if (sc->sc_active == NULL) {
174 printf("GEOM_MULTIPATH: out of providers for %s\n",
176 } else if (sc->sc_active_active != 1) {
177 printf("GEOM_MULTIPATH: %s is now active path in %s\n",
178 sc->sc_active->provider->name, sc->sc_name);
182 static struct g_consumer *
183 g_multipath_choose(struct g_geom *gp, struct bio *bp)
185 struct g_multipath_softc *sc;
186 struct g_consumer *best, *cp;
189 if (sc->sc_active_active == 0 ||
190 (sc->sc_active_active == 2 && bp->bio_cmd != BIO_READ))
191 return (sc->sc_active);
193 LIST_FOREACH(cp, &gp->consumer, consumer) {
194 if (cp->index & MP_BAD)
196 cp->index += MP_IDLE;
197 if (best == NULL || cp->private < best->private ||
198 (cp->private == best->private && cp->index > best->index))
202 best->index &= ~MP_IDLE_MASK;
207 g_mpd(void *arg, int flags __unused)
210 struct g_multipath_softc *sc;
211 struct g_consumer *cp;
217 if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0) {
219 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
220 if (w > 0 && cp->provider != NULL &&
221 (cp->provider->geom->flags & G_GEOM_WITHER) == 0) {
222 cp->index |= MP_WITHER;
223 g_post_event(g_mpd, cp, M_WAITOK, NULL);
228 mtx_lock(&sc->sc_mtx);
230 printf("GEOM_MULTIPATH: %s removed from %s\n",
231 cp->provider->name, gp->name);
232 SDT_PROBE2(geom, multipath, config, remove,
233 gp->name, cp->provider->name);
236 g_destroy_consumer(cp);
237 mtx_unlock(&sc->sc_mtx);
238 if (LIST_EMPTY(&gp->consumer))
239 g_multipath_destroy(gp);
243 g_multipath_orphan(struct g_consumer *cp)
245 struct g_multipath_softc *sc;
249 printf("GEOM_MULTIPATH: %s in %s was disconnected\n",
250 cp->provider->name, cp->geom->name);
251 SDT_PROBE2(geom, multipath, config, disconnect,
252 cp->geom->name, cp->provider->name);
253 sc = cp->geom->softc;
254 cnt = (uintptr_t *)&cp->private;
255 mtx_lock(&sc->sc_mtx);
257 g_multipath_fault(cp, MP_LOST);
258 if (*cnt == 0 && (cp->index & MP_POSTED) == 0) {
259 cp->index |= MP_POSTED;
260 mtx_unlock(&sc->sc_mtx);
263 mtx_unlock(&sc->sc_mtx);
267 g_multipath_resize(struct g_consumer *cp)
269 struct g_multipath_softc *sc;
271 struct g_consumer *cp1;
272 struct g_provider *pp;
273 struct g_multipath_metadata md;
274 off_t size, psize, ssize;
286 if (pp->mediasize < sc->sc_size) {
287 size = pp->mediasize;
288 ssize = pp->sectorsize;
290 size = ssize = OFF_MAX;
291 mtx_lock(&sc->sc_mtx);
292 LIST_FOREACH(cp1, &gp->consumer, consumer) {
296 if (pp->mediasize < size) {
297 size = pp->mediasize;
298 ssize = pp->sectorsize;
301 mtx_unlock(&sc->sc_mtx);
302 if (size == OFF_MAX || size == sc->sc_size)
305 psize = size - ((sc->sc_uuid[0] != 0) ? ssize : 0);
306 printf("GEOM_MULTIPATH: %s size changed from %jd to %jd\n",
307 sc->sc_name, sc->sc_pp->mediasize, psize);
308 if (sc->sc_uuid[0] != 0 && size < sc->sc_size) {
309 error = g_multipath_read_metadata(cp, &md);
311 (strcmp(md.md_magic, G_MULTIPATH_MAGIC) != 0) ||
312 (memcmp(md.md_uuid, sc->sc_uuid, sizeof(sc->sc_uuid)) != 0) ||
313 (strcmp(md.md_name, sc->sc_name) != 0) ||
314 (md.md_size != 0 && md.md_size != size) ||
315 (md.md_sectorsize != 0 && md.md_sectorsize != ssize)) {
316 g_multipath_destroy(gp);
321 g_resize_provider(sc->sc_pp, psize);
323 if (sc->sc_uuid[0] != 0) {
325 strlcpy(md.md_magic, G_MULTIPATH_MAGIC, sizeof(md.md_magic));
326 memcpy(md.md_uuid, sc->sc_uuid, sizeof (sc->sc_uuid));
327 strlcpy(md.md_name, sc->sc_name, sizeof(md.md_name));
328 md.md_version = G_MULTIPATH_VERSION;
330 md.md_sectorsize = ssize;
331 md.md_active_active = sc->sc_active_active;
332 error = g_multipath_write_metadata(cp, &md);
334 printf("GEOM_MULTIPATH: Can't update metadata on %s "
335 "(%d)\n", pp->name, error);
340 g_multipath_start(struct bio *bp)
342 struct g_multipath_softc *sc;
344 struct g_consumer *cp;
348 gp = bp->bio_to->geom;
350 KASSERT(sc != NULL, ("NULL sc"));
351 cbp = g_clone_bio(bp);
353 g_io_deliver(bp, ENOMEM);
356 mtx_lock(&sc->sc_mtx);
357 cp = g_multipath_choose(gp, bp);
359 mtx_unlock(&sc->sc_mtx);
361 g_io_deliver(bp, ENXIO);
364 if ((uintptr_t)bp->bio_driver1 < sc->sc_ndisks)
365 bp->bio_driver1 = (void *)(uintptr_t)sc->sc_ndisks;
366 cnt = (uintptr_t *)&cp->private;
368 mtx_unlock(&sc->sc_mtx);
369 cbp->bio_done = g_multipath_done;
370 g_io_request(cbp, cp);
374 g_multipath_done(struct bio *bp)
376 struct g_multipath_softc *sc;
377 struct g_consumer *cp;
380 if (bp->bio_error == ENXIO || bp->bio_error == EIO) {
381 mtx_lock(&gmtbq_mtx);
382 bioq_insert_tail(&gmtbq, bp);
383 mtx_unlock(&gmtbq_mtx);
384 wakeup(&g_multipath_kt_state);
387 sc = cp->geom->softc;
388 cnt = (uintptr_t *)&cp->private;
389 mtx_lock(&sc->sc_mtx);
391 if (*cnt == 0 && (cp->index & MP_LOST)) {
392 if (g_post_event(g_mpd, cp, M_NOWAIT, NULL) == 0)
393 cp->index |= MP_POSTED;
394 mtx_unlock(&sc->sc_mtx);
396 mtx_unlock(&sc->sc_mtx);
397 if (bp->bio_error == 0 &&
398 bp->bio_cmd == BIO_GETATTR &&
399 !strcmp(bp->bio_attribute, "GEOM::physpath"))
401 strlcat(bp->bio_data, "/mp", bp->bio_length);
408 g_multipath_done_error(struct bio *bp)
412 struct g_multipath_softc *sc;
413 struct g_consumer *cp;
414 struct g_provider *pp;
418 * If we had a failure, we have to check first to see
419 * whether the consumer it failed on was the currently
420 * active consumer (i.e., this is the first in perhaps
421 * a number of failures). If so, we then switch consumers
422 * to the next available consumer.
425 pbp = bp->bio_parent;
426 gp = pbp->bio_to->geom;
430 cnt = (uintptr_t *)&cp->private;
432 mtx_lock(&sc->sc_mtx);
433 if ((cp->index & MP_FAIL) == 0) {
434 printf("GEOM_MULTIPATH: Error %d, %s in %s marked FAIL\n",
435 bp->bio_error, pp->name, sc->sc_name);
436 SDT_PROBE3(geom, multipath, config, fail,
437 sc->sc_name, pp->name, bp->bio_error);
438 g_multipath_fault(cp, MP_FAIL);
441 if (*cnt == 0 && (cp->index & (MP_LOST | MP_POSTED)) == MP_LOST) {
442 cp->index |= MP_POSTED;
443 mtx_unlock(&sc->sc_mtx);
444 g_post_event(g_mpd, cp, M_WAITOK, NULL);
446 mtx_unlock(&sc->sc_mtx);
449 * If we can fruitfully restart the I/O, do so.
451 if (pbp->bio_children < (uintptr_t)pbp->bio_driver1) {
453 SDT_PROBE2(geom, multipath, io, restart, bp, pbp);
455 g_multipath_start(pbp);
462 g_multipath_kt(void *arg)
465 g_multipath_kt_state = GKT_RUN;
466 mtx_lock(&gmtbq_mtx);
467 while (g_multipath_kt_state == GKT_RUN) {
471 bp = bioq_takefirst(&gmtbq);
474 mtx_unlock(&gmtbq_mtx);
475 g_multipath_done_error(bp);
476 mtx_lock(&gmtbq_mtx);
478 if (g_multipath_kt_state != GKT_RUN)
480 msleep(&g_multipath_kt_state, &gmtbq_mtx, PRIBIO,
483 mtx_unlock(&gmtbq_mtx);
484 wakeup(&g_multipath_kt_state);
489 g_multipath_access(struct g_provider *pp, int dr, int dw, int de)
492 struct g_consumer *cp, *badcp = NULL;
493 struct g_multipath_softc *sc;
498 /* Error used if we have no valid consumers. */
499 error = (dr > 0 || dw > 0 || de > 0) ? ENXIO : 0;
501 LIST_FOREACH(cp, &gp->consumer, consumer) {
502 if (cp->index & MP_WITHER)
505 error = g_access(cp, dr, dw, de);
516 sc->sc_opened += dr + dw + de;
517 if (sc->sc_stopping && sc->sc_opened == 0)
518 g_multipath_destroy(gp);
523 LIST_FOREACH(cp, &gp->consumer, consumer) {
526 if (cp->index & MP_WITHER)
529 (void) g_access(cp, -dr, -dw, -de);
534 static struct g_geom *
535 g_multipath_create(struct g_class *mp, struct g_multipath_metadata *md)
537 struct g_multipath_softc *sc;
539 struct g_provider *pp;
543 LIST_FOREACH(gp, &mp->geom, geom) {
545 if (sc == NULL || sc->sc_stopping)
547 if (strcmp(gp->name, md->md_name) == 0) {
548 printf("GEOM_MULTIPATH: name %s already exists\n",
554 gp = g_new_geomf(mp, "%s", md->md_name);
555 sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
556 mtx_init(&sc->sc_mtx, "multipath", NULL, MTX_DEF);
557 memcpy(sc->sc_uuid, md->md_uuid, sizeof (sc->sc_uuid));
558 memcpy(sc->sc_name, md->md_name, sizeof (sc->sc_name));
559 sc->sc_active_active = md->md_active_active;
560 sc->sc_size = md->md_size;
562 gp->start = g_multipath_start;
563 gp->orphan = g_multipath_orphan;
564 gp->resize = g_multipath_resize;
565 gp->access = g_multipath_access;
566 gp->dumpconf = g_multipath_dumpconf;
568 pp = g_new_providerf(gp, "multipath/%s", md->md_name);
569 pp->flags |= G_PF_DIRECT_SEND | G_PF_DIRECT_RECEIVE;
570 if (md->md_size != 0) {
571 pp->mediasize = md->md_size -
572 ((md->md_uuid[0] != 0) ? md->md_sectorsize : 0);
573 pp->sectorsize = md->md_sectorsize;
576 g_error_provider(pp, 0);
577 printf("GEOM_MULTIPATH: %s created\n", gp->name);
582 g_multipath_add_disk(struct g_geom *gp, struct g_provider *pp)
584 struct g_multipath_softc *sc;
585 struct g_consumer *cp;
586 int error, acr, acw, ace;
591 KASSERT(sc, ("no softc"));
594 * Make sure that the passed provider isn't already attached
596 LIST_FOREACH(cp, &gp->consumer, consumer) {
597 if (cp->provider == pp)
601 printf("GEOM_MULTIPATH: provider %s already attached to %s\n",
605 cp = g_new_consumer(gp);
606 cp->flags |= G_CF_DIRECT_SEND | G_CF_DIRECT_RECEIVE;
609 error = g_attach(cp, pp);
611 printf("GEOM_MULTIPATH: cannot attach %s to %s",
612 pp->name, sc->sc_name);
613 g_destroy_consumer(cp);
618 * Set access permissions on new consumer to match other consumers
621 acr = sc->sc_pp->acr;
622 acw = sc->sc_pp->acw;
623 ace = sc->sc_pp->ace;
626 if (g_multipath_exclusive) {
631 error = g_access(cp, acr, acw, ace);
633 printf("GEOM_MULTIPATH: cannot set access in "
634 "attaching %s to %s (%d)\n",
635 pp->name, sc->sc_name, error);
637 g_destroy_consumer(cp);
640 if (sc->sc_size == 0) {
641 sc->sc_size = pp->mediasize -
642 ((sc->sc_uuid[0] != 0) ? pp->sectorsize : 0);
643 sc->sc_pp->mediasize = sc->sc_size;
644 sc->sc_pp->sectorsize = pp->sectorsize;
646 if (sc->sc_pp->stripesize == 0 && sc->sc_pp->stripeoffset == 0) {
647 sc->sc_pp->stripesize = pp->stripesize;
648 sc->sc_pp->stripeoffset = pp->stripeoffset;
650 sc->sc_pp->flags |= pp->flags & G_PF_ACCEPT_UNMAPPED;
651 mtx_lock(&sc->sc_mtx);
654 mtx_unlock(&sc->sc_mtx);
655 printf("GEOM_MULTIPATH: %s added to %s\n",
656 pp->name, sc->sc_name);
657 if (sc->sc_active == NULL) {
659 if (sc->sc_active_active != 1)
660 printf("GEOM_MULTIPATH: %s is now active path in %s\n",
661 pp->name, sc->sc_name);
667 g_multipath_destroy(struct g_geom *gp)
669 struct g_multipath_softc *sc;
670 struct g_consumer *cp, *cp1;
673 if (gp->softc == NULL)
676 if (!sc->sc_stopping) {
677 printf("GEOM_MULTIPATH: destroying %s\n", gp->name);
680 if (sc->sc_opened != 0) {
681 g_wither_provider(sc->sc_pp, ENXIO);
683 return (EINPROGRESS);
685 LIST_FOREACH_SAFE(cp, &gp->consumer, consumer, cp1) {
686 mtx_lock(&sc->sc_mtx);
687 if ((cp->index & MP_POSTED) == 0) {
688 cp->index |= MP_POSTED;
689 mtx_unlock(&sc->sc_mtx);
692 return(0); /* Recursion happened. */
694 mtx_unlock(&sc->sc_mtx);
696 if (!LIST_EMPTY(&gp->consumer))
697 return (EINPROGRESS);
698 mtx_destroy(&sc->sc_mtx);
701 printf("GEOM_MULTIPATH: %s destroyed\n", gp->name);
702 g_wither_geom(gp, ENXIO);
707 g_multipath_destroy_geom(struct gctl_req *req, struct g_class *mp,
711 return (g_multipath_destroy(gp));
715 g_multipath_rotate(struct g_geom *gp)
717 struct g_consumer *lcp, *first_good_cp = NULL;
718 struct g_multipath_softc *sc = gp->softc;
719 int active_cp_seen = 0;
724 LIST_FOREACH(lcp, &gp->consumer, consumer) {
725 if ((lcp->index & MP_BAD) == 0) {
726 if (first_good_cp == NULL)
731 if (sc->sc_active == lcp)
736 if (lcp && lcp != sc->sc_active) {
738 if (sc->sc_active_active != 1)
739 printf("GEOM_MULTIPATH: %s is now active path in %s\n",
740 lcp->provider->name, sc->sc_name);
746 g_multipath_init(struct g_class *mp)
749 mtx_init(&gmtbq_mtx, "gmtbq", NULL, MTX_DEF);
750 kproc_create(g_multipath_kt, mp, NULL, 0, 0, "g_mp_kt");
754 g_multipath_fini(struct g_class *mp)
756 if (g_multipath_kt_state == GKT_RUN) {
757 mtx_lock(&gmtbq_mtx);
758 g_multipath_kt_state = GKT_DIE;
759 wakeup(&g_multipath_kt_state);
760 msleep(&g_multipath_kt_state, &gmtbq_mtx, PRIBIO,
762 mtx_unlock(&gmtbq_mtx);
767 g_multipath_read_metadata(struct g_consumer *cp,
768 struct g_multipath_metadata *md)
770 struct g_provider *pp;
775 error = g_access(cp, 1, 0, 0);
780 buf = g_read_data(cp, pp->mediasize - pp->sectorsize,
781 pp->sectorsize, &error);
783 g_access(cp, -1, 0, 0);
786 multipath_metadata_decode(buf, md);
792 g_multipath_write_metadata(struct g_consumer *cp,
793 struct g_multipath_metadata *md)
795 struct g_provider *pp;
800 error = g_access(cp, 1, 1, 1);
805 buf = g_malloc(pp->sectorsize, M_WAITOK | M_ZERO);
806 multipath_metadata_encode(md, buf);
807 error = g_write_data(cp, pp->mediasize - pp->sectorsize,
808 buf, pp->sectorsize);
810 g_access(cp, -1, -1, -1);
815 static struct g_geom *
816 g_multipath_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
818 struct g_multipath_metadata md;
819 struct g_multipath_softc *sc;
820 struct g_consumer *cp;
821 struct g_geom *gp, *gp1;
826 gp = g_new_geomf(mp, "multipath:taste");
827 gp->start = g_multipath_start;
828 gp->access = g_multipath_access;
829 gp->orphan = g_multipath_orphan;
830 cp = g_new_consumer(gp);
831 error = g_attach(cp, pp);
833 error = g_multipath_read_metadata(cp, &md);
836 g_destroy_consumer(cp);
842 if (strcmp(md.md_magic, G_MULTIPATH_MAGIC) != 0) {
843 if (g_multipath_debug)
844 printf("%s is not MULTIPATH\n", pp->name);
847 if (md.md_version != G_MULTIPATH_VERSION) {
848 printf("%s has version %d multipath id- this module is version "
849 " %d: rejecting\n", pp->name, md.md_version,
850 G_MULTIPATH_VERSION);
853 if (md.md_size != 0 && md.md_size != pp->mediasize)
855 if (md.md_sectorsize != 0 && md.md_sectorsize != pp->sectorsize)
857 if (g_multipath_debug)
858 printf("MULTIPATH: %s/%s\n", md.md_name, md.md_uuid);
859 SDT_PROBE2(geom, multipath, config, taste, md.md_name, md.md_uuid);
862 * Let's check if such a device already is present. We check against
863 * uuid alone first because that's the true distinguishor. If that
864 * passes, then we check for name conflicts. If there are conflicts,
867 * The whole purpose of this is to solve the problem that people don't
868 * pick good unique names, but good unique names (like uuids) are a
869 * pain to use. So, we allow people to build GEOMs with friendly names
870 * and uuids, and modify the names in case there's a collision.
873 LIST_FOREACH(gp, &mp->geom, geom) {
875 if (sc == NULL || sc->sc_stopping)
877 if (strncmp(md.md_uuid, sc->sc_uuid, sizeof(md.md_uuid)) == 0)
881 LIST_FOREACH(gp1, &mp->geom, geom) {
885 if (sc == NULL || sc->sc_stopping)
887 if (strncmp(md.md_name, sc->sc_name, sizeof(md.md_name)) == 0)
892 * If gp is NULL, we had no extant MULTIPATH geom with this uuid.
894 * If gp1 is *not* NULL, that means we have a MULTIPATH geom extant
895 * with the same name (but a different UUID).
897 * If gp is NULL, then modify the name with a random number and
898 * complain, but allow the creation of the geom to continue.
900 * If gp is *not* NULL, just use the geom's name as we're attaching
901 * this disk to the (previously generated) name.
908 u_long rand = random();
910 snprintf(buf, sizeof (buf), "%s-%lu", md.md_name, rand);
911 printf("GEOM_MULTIPATH: geom %s/%s exists already\n",
912 sc->sc_name, sc->sc_uuid);
913 printf("GEOM_MULTIPATH: %s will be (temporarily) %s\n",
915 strlcpy(md.md_name, buf, sizeof(md.md_name));
917 strlcpy(md.md_name, sc->sc_name, sizeof(md.md_name));
922 gp = g_multipath_create(mp, &md);
924 printf("GEOM_MULTIPATH: cannot create geom %s/%s\n",
925 md.md_name, md.md_uuid);
934 KASSERT(sc != NULL, ("sc is NULL"));
935 error = g_multipath_add_disk(gp, pp);
938 g_multipath_destroy(gp);
945 g_multipath_ctl_add_name(struct gctl_req *req, struct g_class *mp,
948 struct g_multipath_softc *sc;
950 struct g_consumer *cp;
951 struct g_provider *pp;
953 static const char devpf[6] = _PATH_DEV;
958 mpname = gctl_get_asciiparam(req, "arg0");
959 if (mpname == NULL) {
960 gctl_error(req, "No 'arg0' argument");
963 gp = g_multipath_find_geom(mp, mpname);
965 gctl_error(req, "Device %s is invalid", mpname);
970 if (strncmp(name, devpf, 5) == 0)
972 pp = g_provider_by_name(name);
974 gctl_error(req, "Provider %s is invalid", name);
979 * Check to make sure parameters match.
981 LIST_FOREACH(cp, &gp->consumer, consumer) {
982 if (cp->provider == pp) {
983 gctl_error(req, "provider %s is already there",
988 if (sc->sc_pp->mediasize != 0 &&
989 sc->sc_pp->mediasize + (sc->sc_uuid[0] != 0 ? pp->sectorsize : 0)
991 gctl_error(req, "Providers size mismatch %jd != %jd",
992 (intmax_t) sc->sc_pp->mediasize +
993 (sc->sc_uuid[0] != 0 ? pp->sectorsize : 0),
994 (intmax_t) pp->mediasize);
997 if (sc->sc_pp->sectorsize != 0 &&
998 sc->sc_pp->sectorsize != pp->sectorsize) {
999 gctl_error(req, "Providers sectorsize mismatch %u != %u",
1000 sc->sc_pp->sectorsize, pp->sectorsize);
1004 error = g_multipath_add_disk(gp, pp);
1006 gctl_error(req, "Provider addition error: %d", error);
1010 g_multipath_ctl_prefer(struct gctl_req *req, struct g_class *mp)
1013 struct g_multipath_softc *sc;
1014 struct g_consumer *cp;
1015 const char *name, *mpname;
1016 static const char devpf[6] = _PATH_DEV;
1019 g_topology_assert();
1021 mpname = gctl_get_asciiparam(req, "arg0");
1022 if (mpname == NULL) {
1023 gctl_error(req, "No 'arg0' argument");
1026 gp = g_multipath_find_geom(mp, mpname);
1028 gctl_error(req, "Device %s is invalid", mpname);
1033 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
1034 if (nargs == NULL) {
1035 gctl_error(req, "No 'nargs' argument");
1039 gctl_error(req, "missing device");
1043 name = gctl_get_asciiparam(req, "arg1");
1045 gctl_error(req, "No 'arg1' argument");
1048 if (strncmp(name, devpf, 5) == 0) {
1052 LIST_FOREACH(cp, &gp->consumer, consumer) {
1053 if (cp->provider != NULL
1054 && strcmp(cp->provider->name, name) == 0)
1059 gctl_error(req, "Provider %s not found", name);
1063 mtx_lock(&sc->sc_mtx);
1065 if (cp->index & MP_BAD) {
1066 gctl_error(req, "Consumer %s is invalid", name);
1067 mtx_unlock(&sc->sc_mtx);
1071 /* Here when the consumer is present and in good shape */
1074 if (!sc->sc_active_active)
1075 printf("GEOM_MULTIPATH: %s now active path in %s\n",
1076 sc->sc_active->provider->name, sc->sc_name);
1078 mtx_unlock(&sc->sc_mtx);
1082 g_multipath_ctl_add(struct gctl_req *req, struct g_class *mp)
1085 const char *mpname, *name;
1087 mpname = gctl_get_asciiparam(req, "arg0");
1088 if (mpname == NULL) {
1089 gctl_error(req, "No 'arg0' argument");
1092 gp = g_multipath_find_geom(mp, mpname);
1094 gctl_error(req, "Device %s not found", mpname);
1098 name = gctl_get_asciiparam(req, "arg1");
1100 gctl_error(req, "No 'arg1' argument");
1103 g_multipath_ctl_add_name(req, mp, name);
1107 g_multipath_ctl_create(struct gctl_req *req, struct g_class *mp)
1109 struct g_multipath_metadata md;
1110 struct g_multipath_softc *sc;
1112 const char *mpname, *name;
1114 int *nargs, i, *val;
1116 g_topology_assert();
1118 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
1120 gctl_error(req, "wrong number of arguments.");
1124 mpname = gctl_get_asciiparam(req, "arg0");
1125 if (mpname == NULL) {
1126 gctl_error(req, "No 'arg0' argument");
1129 gp = g_multipath_find_geom(mp, mpname);
1131 gctl_error(req, "Device %s already exist", mpname);
1135 memset(&md, 0, sizeof(md));
1136 strlcpy(md.md_magic, G_MULTIPATH_MAGIC, sizeof(md.md_magic));
1137 md.md_version = G_MULTIPATH_VERSION;
1138 strlcpy(md.md_name, mpname, sizeof(md.md_name));
1140 md.md_sectorsize = 0;
1142 md.md_active_active = 0;
1143 val = gctl_get_paraml(req, "active_active", sizeof(*val));
1144 if (val != NULL && *val != 0)
1145 md.md_active_active = 1;
1146 val = gctl_get_paraml(req, "active_read", sizeof(*val));
1147 if (val != NULL && *val != 0)
1148 md.md_active_active = 2;
1149 gp = g_multipath_create(mp, &md);
1151 gctl_error(req, "GEOM_MULTIPATH: cannot create geom %s/%s\n",
1152 md.md_name, md.md_uuid);
1157 for (i = 1; i < *nargs; i++) {
1158 snprintf(param, sizeof(param), "arg%d", i);
1159 name = gctl_get_asciiparam(req, param);
1160 g_multipath_ctl_add_name(req, mp, name);
1163 if (sc->sc_ndisks != (*nargs - 1))
1164 g_multipath_destroy(gp);
1168 g_multipath_ctl_configure(struct gctl_req *req, struct g_class *mp)
1170 struct g_multipath_softc *sc;
1172 struct g_consumer *cp;
1173 struct g_provider *pp;
1174 struct g_multipath_metadata md;
1178 g_topology_assert();
1180 name = gctl_get_asciiparam(req, "arg0");
1182 gctl_error(req, "No 'arg0' argument");
1185 gp = g_multipath_find_geom(mp, name);
1187 gctl_error(req, "Device %s is invalid", name);
1191 val = gctl_get_paraml(req, "active_active", sizeof(*val));
1192 if (val != NULL && *val != 0)
1193 sc->sc_active_active = 1;
1194 val = gctl_get_paraml(req, "active_read", sizeof(*val));
1195 if (val != NULL && *val != 0)
1196 sc->sc_active_active = 2;
1197 val = gctl_get_paraml(req, "active_passive", sizeof(*val));
1198 if (val != NULL && *val != 0)
1199 sc->sc_active_active = 0;
1200 if (sc->sc_uuid[0] != 0 && sc->sc_active != NULL) {
1203 strlcpy(md.md_magic, G_MULTIPATH_MAGIC, sizeof(md.md_magic));
1204 memcpy(md.md_uuid, sc->sc_uuid, sizeof (sc->sc_uuid));
1205 strlcpy(md.md_name, name, sizeof(md.md_name));
1206 md.md_version = G_MULTIPATH_VERSION;
1207 md.md_size = pp->mediasize;
1208 md.md_sectorsize = pp->sectorsize;
1209 md.md_active_active = sc->sc_active_active;
1210 error = g_multipath_write_metadata(cp, &md);
1212 gctl_error(req, "Can't update metadata on %s (%d)",
1218 g_multipath_ctl_fail(struct gctl_req *req, struct g_class *mp, int fail)
1220 struct g_multipath_softc *sc;
1222 struct g_consumer *cp;
1223 const char *mpname, *name;
1226 mpname = gctl_get_asciiparam(req, "arg0");
1227 if (mpname == NULL) {
1228 gctl_error(req, "No 'arg0' argument");
1231 gp = g_multipath_find_geom(mp, mpname);
1233 gctl_error(req, "Device %s not found", mpname);
1238 name = gctl_get_asciiparam(req, "arg1");
1240 gctl_error(req, "No 'arg1' argument");
1245 mtx_lock(&sc->sc_mtx);
1246 LIST_FOREACH(cp, &gp->consumer, consumer) {
1247 if (cp->provider != NULL &&
1248 strcmp(cp->provider->name, name) == 0 &&
1249 (cp->index & MP_LOST) == 0) {
1251 if (!fail == !(cp->index & MP_FAIL))
1253 printf("GEOM_MULTIPATH: %s in %s is marked %s.\n",
1254 name, sc->sc_name, fail ? "FAIL" : "OK");
1256 g_multipath_fault(cp, MP_FAIL);
1257 SDT_PROBE3(geom, multipath, config, fail,
1258 sc->sc_name, cp->provider->name, 0);
1260 cp->index &= ~MP_FAIL;
1261 SDT_PROBE2(geom, multipath, config, restore,
1262 sc->sc_name, cp->provider->name);
1266 mtx_unlock(&sc->sc_mtx);
1268 gctl_error(req, "Provider %s not found", name);
1272 g_multipath_ctl_remove(struct gctl_req *req, struct g_class *mp)
1274 struct g_multipath_softc *sc;
1276 struct g_consumer *cp, *cp1;
1277 const char *mpname, *name;
1281 mpname = gctl_get_asciiparam(req, "arg0");
1282 if (mpname == NULL) {
1283 gctl_error(req, "No 'arg0' argument");
1286 gp = g_multipath_find_geom(mp, mpname);
1288 gctl_error(req, "Device %s not found", mpname);
1293 name = gctl_get_asciiparam(req, "arg1");
1295 gctl_error(req, "No 'arg1' argument");
1300 mtx_lock(&sc->sc_mtx);
1301 LIST_FOREACH_SAFE(cp, &gp->consumer, consumer, cp1) {
1302 if (cp->provider != NULL &&
1303 strcmp(cp->provider->name, name) == 0 &&
1304 (cp->index & MP_LOST) == 0) {
1306 printf("GEOM_MULTIPATH: removing %s from %s\n",
1307 cp->provider->name, cp->geom->name);
1308 SDT_PROBE2(geom, multipath, config, remove,
1309 cp->geom->name, cp->provider->name);
1311 g_multipath_fault(cp, MP_LOST);
1312 cnt = (uintptr_t *)&cp->private;
1313 if (*cnt == 0 && (cp->index & MP_POSTED) == 0) {
1314 cp->index |= MP_POSTED;
1315 mtx_unlock(&sc->sc_mtx);
1318 return; /* Recursion happened. */
1319 mtx_lock(&sc->sc_mtx);
1323 mtx_unlock(&sc->sc_mtx);
1325 gctl_error(req, "Provider %s not found", name);
1328 static struct g_geom *
1329 g_multipath_find_geom(struct g_class *mp, const char *name)
1332 struct g_multipath_softc *sc;
1334 LIST_FOREACH(gp, &mp->geom, geom) {
1336 if (sc == NULL || sc->sc_stopping)
1338 if (strcmp(gp->name, name) == 0)
1345 g_multipath_ctl_stop(struct gctl_req *req, struct g_class *mp)
1351 g_topology_assert();
1353 name = gctl_get_asciiparam(req, "arg0");
1355 gctl_error(req, "No 'arg0' argument");
1358 gp = g_multipath_find_geom(mp, name);
1360 gctl_error(req, "Device %s is invalid", name);
1363 error = g_multipath_destroy(gp);
1364 if (error != 0 && error != EINPROGRESS)
1365 gctl_error(req, "failed to stop %s (err=%d)", name, error);
1369 g_multipath_ctl_destroy(struct gctl_req *req, struct g_class *mp)
1372 struct g_multipath_softc *sc;
1373 struct g_consumer *cp;
1374 struct g_provider *pp;
1379 g_topology_assert();
1381 name = gctl_get_asciiparam(req, "arg0");
1383 gctl_error(req, "No 'arg0' argument");
1386 gp = g_multipath_find_geom(mp, name);
1388 gctl_error(req, "Device %s is invalid", name);
1393 if (sc->sc_uuid[0] != 0 && sc->sc_active != NULL) {
1396 error = g_access(cp, 1, 1, 1);
1398 gctl_error(req, "Can't open %s (%d)", pp->name, error);
1401 g_topology_unlock();
1402 buf = g_malloc(pp->sectorsize, M_WAITOK | M_ZERO);
1403 error = g_write_data(cp, pp->mediasize - pp->sectorsize,
1404 buf, pp->sectorsize);
1406 g_access(cp, -1, -1, -1);
1408 gctl_error(req, "Can't erase metadata on %s (%d)",
1413 error = g_multipath_destroy(gp);
1414 if (error != 0 && error != EINPROGRESS)
1415 gctl_error(req, "failed to destroy %s (err=%d)", name, error);
1419 g_multipath_ctl_rotate(struct gctl_req *req, struct g_class *mp)
1425 g_topology_assert();
1427 name = gctl_get_asciiparam(req, "arg0");
1429 gctl_error(req, "No 'arg0' argument");
1432 gp = g_multipath_find_geom(mp, name);
1434 gctl_error(req, "Device %s is invalid", name);
1437 error = g_multipath_rotate(gp);
1439 gctl_error(req, "failed to rotate %s (err=%d)", name, error);
1444 g_multipath_ctl_getactive(struct gctl_req *req, struct g_class *mp)
1448 struct g_multipath_softc *sc;
1449 struct g_consumer *cp;
1453 sb = sbuf_new_auto();
1455 g_topology_assert();
1456 name = gctl_get_asciiparam(req, "arg0");
1458 gctl_error(req, "No 'arg0' argument");
1461 gp = g_multipath_find_geom(mp, name);
1463 gctl_error(req, "Device %s is invalid", name);
1467 if (sc->sc_active_active == 1) {
1469 LIST_FOREACH(cp, &gp->consumer, consumer) {
1470 if (cp->index & MP_BAD)
1474 sbuf_cat(sb, cp->provider->name);
1478 sbuf_cat(sb, "none");
1480 } else if (sc->sc_active && sc->sc_active->provider) {
1481 sbuf_printf(sb, "%s\n", sc->sc_active->provider->name);
1483 sbuf_cat(sb, "none\n");
1486 gctl_set_param_err(req, "output", sbuf_data(sb), sbuf_len(sb) + 1);
1491 g_multipath_config(struct gctl_req *req, struct g_class *mp, const char *verb)
1494 g_topology_assert();
1495 version = gctl_get_paraml(req, "version", sizeof(*version));
1496 if (version == NULL) {
1497 gctl_error(req, "No 'version' argument");
1498 } else if (*version != G_MULTIPATH_VERSION) {
1499 gctl_error(req, "Userland and kernel parts are out of sync");
1500 } else if (strcmp(verb, "add") == 0) {
1501 g_multipath_ctl_add(req, mp);
1502 } else if (strcmp(verb, "prefer") == 0) {
1503 g_multipath_ctl_prefer(req, mp);
1504 } else if (strcmp(verb, "create") == 0) {
1505 g_multipath_ctl_create(req, mp);
1506 } else if (strcmp(verb, "configure") == 0) {
1507 g_multipath_ctl_configure(req, mp);
1508 } else if (strcmp(verb, "stop") == 0) {
1509 g_multipath_ctl_stop(req, mp);
1510 } else if (strcmp(verb, "destroy") == 0) {
1511 g_multipath_ctl_destroy(req, mp);
1512 } else if (strcmp(verb, "fail") == 0) {
1513 g_multipath_ctl_fail(req, mp, 1);
1514 } else if (strcmp(verb, "restore") == 0) {
1515 g_multipath_ctl_fail(req, mp, 0);
1516 } else if (strcmp(verb, "remove") == 0) {
1517 g_multipath_ctl_remove(req, mp);
1518 } else if (strcmp(verb, "rotate") == 0) {
1519 g_multipath_ctl_rotate(req, mp);
1520 } else if (strcmp(verb, "getactive") == 0) {
1521 g_multipath_ctl_getactive(req, mp);
1523 gctl_error(req, "Unknown verb %s", verb);
1528 g_multipath_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
1529 struct g_consumer *cp, struct g_provider *pp)
1531 struct g_multipath_softc *sc;
1534 g_topology_assert();
1540 sbuf_printf(sb, "%s<State>%s</State>\n", indent,
1541 (cp->index & MP_NEW) ? "NEW" :
1542 (cp->index & MP_LOST) ? "LOST" :
1543 (cp->index & MP_FAIL) ? "FAIL" :
1544 (sc->sc_active_active == 1 || sc->sc_active == cp) ?
1546 sc->sc_active_active == 2 ? "READ" : "PASSIVE");
1548 good = g_multipath_good(gp);
1549 sbuf_printf(sb, "%s<State>%s</State>\n", indent,
1550 good == 0 ? "BROKEN" :
1551 (good != sc->sc_ndisks || sc->sc_ndisks == 1) ?
1552 "DEGRADED" : "OPTIMAL");
1554 if (cp == NULL && pp == NULL) {
1555 sbuf_printf(sb, "%s<UUID>%s</UUID>\n", indent, sc->sc_uuid);
1556 sbuf_printf(sb, "%s<Mode>Active/%s</Mode>\n", indent,
1557 sc->sc_active_active == 2 ? "Read" :
1558 sc->sc_active_active == 1 ? "Active" : "Passive");
1559 sbuf_printf(sb, "%s<Type>%s</Type>\n", indent,
1560 sc->sc_uuid[0] == 0 ? "MANUAL" : "AUTOMATIC");
1564 DECLARE_GEOM_CLASS(g_multipath_class, g_multipath);
1565 MODULE_VERSION(geom_multipath, 0);