2 * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
35 #include <sys/mutex.h>
37 #include <sys/sysctl.h>
38 #include <sys/malloc.h>
39 #include <geom/geom.h>
40 #include <geom/concat/g_concat.h>
43 static MALLOC_DEFINE(M_CONCAT, "concat_data", "GEOM_CONCAT Data");
45 SYSCTL_DECL(_kern_geom);
46 SYSCTL_NODE(_kern_geom, OID_AUTO, concat, CTLFLAG_RW, 0, "GEOM_CONCAT stuff");
47 static u_int g_concat_debug = 0;
48 TUNABLE_INT("kern.geom.concat.debug", &g_concat_debug);
49 SYSCTL_UINT(_kern_geom_concat, OID_AUTO, debug, CTLFLAG_RW, &g_concat_debug, 0,
52 static int g_concat_destroy(struct g_concat_softc *sc, boolean_t force);
53 static int g_concat_destroy_geom(struct gctl_req *req, struct g_class *mp,
56 static g_taste_t g_concat_taste;
57 static g_ctl_req_t g_concat_config;
58 static g_dumpconf_t g_concat_dumpconf;
60 struct g_class g_concat_class = {
61 .name = G_CONCAT_CLASS_NAME,
63 .ctlreq = g_concat_config,
64 .taste = g_concat_taste,
65 .destroy_geom = g_concat_destroy_geom
70 * Greatest Common Divisor.
86 * Least Common Multiple.
92 return ((a * b) / gcd(a, b));
96 * Return the number of valid disks.
99 g_concat_nvalid(struct g_concat_softc *sc)
104 for (i = 0; i < sc->sc_ndisks; i++) {
105 if (sc->sc_disks[i].d_consumer != NULL)
113 g_concat_remove_disk(struct g_concat_disk *disk)
115 struct g_consumer *cp;
116 struct g_concat_softc *sc;
118 KASSERT(disk->d_consumer != NULL, ("Non-valid disk in %s.", __func__));
120 cp = disk->d_consumer;
122 G_CONCAT_DEBUG(0, "Disk %s removed from %s.", cp->provider->name,
125 disk->d_consumer = NULL;
126 if (sc->sc_provider != NULL) {
127 sc->sc_provider->flags |= G_PF_WITHER;
128 g_orphan_provider(sc->sc_provider, ENXIO);
129 sc->sc_provider = NULL;
130 G_CONCAT_DEBUG(0, "Device %s removed.", sc->sc_name);
133 if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0)
134 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
136 g_destroy_consumer(cp);
140 g_concat_orphan(struct g_consumer *cp)
142 struct g_concat_softc *sc;
143 struct g_concat_disk *disk;
153 if (disk == NULL) /* Possible? */
155 g_concat_remove_disk(disk);
157 /* If there are no valid disks anymore, remove device. */
158 if (g_concat_nvalid(sc) == 0)
159 g_concat_destroy(sc, 1);
163 g_concat_access(struct g_provider *pp, int dr, int dw, int de)
165 struct g_consumer *cp1, *cp2;
166 struct g_concat_softc *sc;
175 * It looks like geom is being withered.
176 * In that case we allow only negative requests.
178 KASSERT(dr <= 0 && dw <= 0 && de <= 0,
179 ("Positive access request (device=%s).", pp->name));
180 if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 &&
181 (pp->ace + de) == 0) {
182 G_CONCAT_DEBUG(0, "Device %s definitely destroyed.",
188 /* On first open, grab an extra "exclusive" bit */
189 if (pp->acr == 0 && pp->acw == 0 && pp->ace == 0)
191 /* ... and let go of it on last close */
192 if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 && (pp->ace + de) == 0)
196 LIST_FOREACH(cp1, &gp->consumer, consumer) {
197 error = g_access(cp1, dr, dw, de);
201 * If we fail here, backout all previous changes.
203 LIST_FOREACH(cp2, &gp->consumer, consumer) {
206 g_access(cp2, -dr, -dw, -de);
215 g_concat_flush(struct g_concat_softc *sc, struct bio *bp)
217 struct bio_queue_head queue;
218 struct g_consumer *cp;
223 for (no = 0; no < sc->sc_ndisks; no++) {
224 cbp = g_clone_bio(bp);
226 for (cbp = bioq_first(&queue); cbp != NULL;
227 cbp = bioq_first(&queue)) {
228 bioq_remove(&queue, cbp);
231 if (bp->bio_error == 0)
232 bp->bio_error = ENOMEM;
233 g_io_deliver(bp, bp->bio_error);
236 bioq_insert_tail(&queue, cbp);
237 cbp->bio_done = g_std_done;
238 cbp->bio_caller1 = sc->sc_disks[no].d_consumer;
239 cbp->bio_to = sc->sc_disks[no].d_consumer->provider;
241 for (cbp = bioq_first(&queue); cbp != NULL; cbp = bioq_first(&queue)) {
242 bioq_remove(&queue, cbp);
243 G_CONCAT_LOGREQ(cbp, "Sending request.");
244 cp = cbp->bio_caller1;
245 cbp->bio_caller1 = NULL;
246 g_io_request(cbp, cp);
251 g_concat_start(struct bio *bp)
253 struct bio_queue_head queue;
254 struct g_concat_softc *sc;
255 struct g_concat_disk *disk;
256 struct g_provider *pp;
257 off_t offset, end, length, off, len;
263 sc = pp->geom->softc;
265 * If sc == NULL, provider's error should be set and g_concat_start()
266 * should not be called at all.
269 ("Provider's error should be set (error=%d)(device=%s).",
270 bp->bio_to->error, bp->bio_to->name));
272 G_CONCAT_LOGREQ(bp, "Request received.");
274 switch (bp->bio_cmd) {
280 g_concat_flush(sc, bp);
283 /* To which provider it should be delivered? */
285 g_io_deliver(bp, EOPNOTSUPP);
289 offset = bp->bio_offset;
290 length = bp->bio_length;
292 end = offset + length;
295 for (no = 0; no < sc->sc_ndisks; no++) {
296 disk = &sc->sc_disks[no];
297 if (disk->d_end <= offset)
299 if (disk->d_start >= end)
302 off = offset - disk->d_start;
303 len = MIN(length, disk->d_end - offset);
307 cbp = g_clone_bio(bp);
309 for (cbp = bioq_first(&queue); cbp != NULL;
310 cbp = bioq_first(&queue)) {
311 bioq_remove(&queue, cbp);
314 if (bp->bio_error == 0)
315 bp->bio_error = ENOMEM;
316 g_io_deliver(bp, bp->bio_error);
319 bioq_insert_tail(&queue, cbp);
321 * Fill in the component buf structure.
323 cbp->bio_done = g_std_done;
324 cbp->bio_offset = off;
325 cbp->bio_data = addr;
327 cbp->bio_length = len;
328 cbp->bio_to = disk->d_consumer->provider;
329 cbp->bio_caller1 = disk;
335 ("Length is still greater than 0 (class=%s, name=%s).",
336 bp->bio_to->geom->class->name, bp->bio_to->geom->name));
337 for (cbp = bioq_first(&queue); cbp != NULL; cbp = bioq_first(&queue)) {
338 bioq_remove(&queue, cbp);
339 G_CONCAT_LOGREQ(cbp, "Sending request.");
340 disk = cbp->bio_caller1;
341 cbp->bio_caller1 = NULL;
342 g_io_request(cbp, disk->d_consumer);
347 g_concat_check_and_run(struct g_concat_softc *sc)
349 struct g_concat_disk *disk;
350 u_int no, sectorsize = 0;
353 if (g_concat_nvalid(sc) != sc->sc_ndisks)
356 sc->sc_provider = g_new_providerf(sc->sc_geom, "concat/%s",
359 for (no = 0; no < sc->sc_ndisks; no++) {
360 disk = &sc->sc_disks[no];
361 disk->d_start = start;
362 disk->d_end = disk->d_start +
363 disk->d_consumer->provider->mediasize;
364 if (sc->sc_type == G_CONCAT_TYPE_AUTOMATIC)
365 disk->d_end -= disk->d_consumer->provider->sectorsize;
368 sectorsize = disk->d_consumer->provider->sectorsize;
370 sectorsize = lcm(sectorsize,
371 disk->d_consumer->provider->sectorsize);
374 sc->sc_provider->sectorsize = sectorsize;
375 /* We have sc->sc_disks[sc->sc_ndisks - 1].d_end in 'start'. */
376 sc->sc_provider->mediasize = start;
377 g_error_provider(sc->sc_provider, 0);
379 G_CONCAT_DEBUG(0, "Device %s activated.", sc->sc_name);
383 g_concat_read_metadata(struct g_consumer *cp, struct g_concat_metadata *md)
385 struct g_provider *pp;
391 error = g_access(cp, 1, 0, 0);
396 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
399 g_access(cp, -1, 0, 0);
403 /* Decode metadata. */
404 concat_metadata_decode(buf, md);
411 * Add disk to given device.
414 g_concat_add_disk(struct g_concat_softc *sc, struct g_provider *pp, u_int no)
416 struct g_concat_disk *disk;
417 struct g_consumer *cp, *fcp;
421 /* Metadata corrupted? */
422 if (no >= sc->sc_ndisks)
425 disk = &sc->sc_disks[no];
426 /* Check if disk is not already attached. */
427 if (disk->d_consumer != NULL)
431 fcp = LIST_FIRST(&gp->consumer);
433 cp = g_new_consumer(gp);
434 error = g_attach(cp, pp);
436 g_destroy_consumer(cp);
440 if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0)) {
441 error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
444 g_destroy_consumer(cp);
448 if (sc->sc_type == G_CONCAT_TYPE_AUTOMATIC) {
449 struct g_concat_metadata md;
451 /* Re-read metadata. */
452 error = g_concat_read_metadata(cp, &md);
456 if (strcmp(md.md_magic, G_CONCAT_MAGIC) != 0 ||
457 strcmp(md.md_name, sc->sc_name) != 0 ||
458 md.md_id != sc->sc_id) {
459 G_CONCAT_DEBUG(0, "Metadata on %s changed.", pp->name);
465 disk->d_consumer = cp;
467 disk->d_start = 0; /* not yet */
468 disk->d_end = 0; /* not yet */
470 G_CONCAT_DEBUG(0, "Disk %s attached to %s.", pp->name, sc->sc_name);
472 g_concat_check_and_run(sc);
476 if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0))
477 g_access(cp, -fcp->acr, -fcp->acw, -fcp->ace);
479 g_destroy_consumer(cp);
483 static struct g_geom *
484 g_concat_create(struct g_class *mp, const struct g_concat_metadata *md,
487 struct g_concat_softc *sc;
491 G_CONCAT_DEBUG(1, "Creating device %s (id=%u).", md->md_name,
494 /* One disks is minimum. */
498 /* Check for duplicate unit */
499 LIST_FOREACH(gp, &mp->geom, geom) {
501 if (sc != NULL && strcmp(sc->sc_name, md->md_name) == 0) {
502 G_CONCAT_DEBUG(0, "Device %s already configured.",
507 gp = g_new_geomf(mp, "%s", md->md_name);
508 gp->softc = NULL; /* for a moment */
510 sc = malloc(sizeof(*sc), M_CONCAT, M_WAITOK | M_ZERO);
511 gp->start = g_concat_start;
512 gp->spoiled = g_concat_orphan;
513 gp->orphan = g_concat_orphan;
514 gp->access = g_concat_access;
515 gp->dumpconf = g_concat_dumpconf;
517 sc->sc_id = md->md_id;
518 sc->sc_ndisks = md->md_all;
519 sc->sc_disks = malloc(sizeof(struct g_concat_disk) * sc->sc_ndisks,
520 M_CONCAT, M_WAITOK | M_ZERO);
521 for (no = 0; no < sc->sc_ndisks; no++)
522 sc->sc_disks[no].d_consumer = NULL;
527 sc->sc_provider = NULL;
529 G_CONCAT_DEBUG(0, "Device %s created (id=%u).", sc->sc_name, sc->sc_id);
535 g_concat_destroy(struct g_concat_softc *sc, boolean_t force)
537 struct g_provider *pp;
546 pp = sc->sc_provider;
547 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
549 G_CONCAT_DEBUG(0, "Device %s is still open, so it "
550 "can't be definitely removed.", pp->name);
553 "Device %s is still open (r%dw%de%d).", pp->name,
554 pp->acr, pp->acw, pp->ace);
559 for (no = 0; no < sc->sc_ndisks; no++) {
560 if (sc->sc_disks[no].d_consumer != NULL)
561 g_concat_remove_disk(&sc->sc_disks[no]);
566 KASSERT(sc->sc_provider == NULL, ("Provider still exists? (device=%s)",
568 free(sc->sc_disks, M_CONCAT);
571 pp = LIST_FIRST(&gp->provider);
572 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
573 G_CONCAT_DEBUG(0, "Device %s destroyed.", gp->name);
575 g_wither_geom(gp, ENXIO);
581 g_concat_destroy_geom(struct gctl_req *req __unused,
582 struct g_class *mp __unused, struct g_geom *gp)
584 struct g_concat_softc *sc;
587 return (g_concat_destroy(sc, 0));
590 static struct g_geom *
591 g_concat_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
593 struct g_concat_metadata md;
594 struct g_concat_softc *sc;
595 struct g_consumer *cp;
599 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
602 G_CONCAT_DEBUG(3, "Tasting %s.", pp->name);
604 gp = g_new_geomf(mp, "concat:taste");
605 gp->start = g_concat_start;
606 gp->access = g_concat_access;
607 gp->orphan = g_concat_orphan;
608 cp = g_new_consumer(gp);
610 error = g_concat_read_metadata(cp, &md);
612 g_destroy_consumer(cp);
618 if (strcmp(md.md_magic, G_CONCAT_MAGIC) != 0)
620 if (md.md_version > G_CONCAT_VERSION) {
621 printf("geom_concat.ko module is too old to handle %s.\n",
626 * Backward compatibility:
628 /* There was no md_provider field in earlier versions of metadata. */
629 if (md.md_version < 3)
630 bzero(md.md_provider, sizeof(md.md_provider));
631 /* There was no md_provsize field in earlier versions of metadata. */
632 if (md.md_version < 4)
633 md.md_provsize = pp->mediasize;
635 if (md.md_provider[0] != '\0' && strcmp(md.md_provider, pp->name) != 0)
637 if (md.md_provsize != pp->mediasize)
641 * Let's check if device already exists.
644 LIST_FOREACH(gp, &mp->geom, geom) {
648 if (sc->sc_type != G_CONCAT_TYPE_AUTOMATIC)
650 if (strcmp(md.md_name, sc->sc_name) != 0)
652 if (md.md_id != sc->sc_id)
657 G_CONCAT_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
658 error = g_concat_add_disk(sc, pp, md.md_no);
661 "Cannot add disk %s to %s (error=%d).", pp->name,
666 gp = g_concat_create(mp, &md, G_CONCAT_TYPE_AUTOMATIC);
668 G_CONCAT_DEBUG(0, "Cannot create device %s.",
673 G_CONCAT_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
674 error = g_concat_add_disk(sc, pp, md.md_no);
677 "Cannot add disk %s to %s (error=%d).", pp->name,
679 g_concat_destroy(sc, 1);
688 g_concat_ctl_create(struct gctl_req *req, struct g_class *mp)
691 struct g_concat_metadata md;
692 struct g_provider *pp;
693 struct g_concat_softc *sc;
701 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
703 gctl_error(req, "No '%s' argument.", "nargs");
707 gctl_error(req, "Too few arguments.");
711 strlcpy(md.md_magic, G_CONCAT_MAGIC, sizeof(md.md_magic));
712 md.md_version = G_CONCAT_VERSION;
713 name = gctl_get_asciiparam(req, "arg0");
715 gctl_error(req, "No 'arg%u' argument.", 0);
718 strlcpy(md.md_name, name, sizeof(md.md_name));
719 md.md_id = arc4random();
721 md.md_all = *nargs - 1;
722 bzero(md.md_provider, sizeof(md.md_provider));
723 /* This field is not important here. */
726 /* Check all providers are valid */
727 for (no = 1; no < *nargs; no++) {
728 snprintf(param, sizeof(param), "arg%u", no);
729 name = gctl_get_asciiparam(req, param);
731 gctl_error(req, "No 'arg%u' argument.", no);
734 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
735 name += strlen("/dev/");
736 pp = g_provider_by_name(name);
738 G_CONCAT_DEBUG(1, "Disk %s is invalid.", name);
739 gctl_error(req, "Disk %s is invalid.", name);
744 gp = g_concat_create(mp, &md, G_CONCAT_TYPE_MANUAL);
746 gctl_error(req, "Can't configure %s.", md.md_name);
751 sb = sbuf_new_auto();
752 sbuf_printf(sb, "Can't attach disk(s) to %s:", gp->name);
753 for (attached = 0, no = 1; no < *nargs; no++) {
754 snprintf(param, sizeof(param), "arg%u", no);
755 name = gctl_get_asciiparam(req, param);
756 if (strncmp(name, "/dev/", strlen("/dev/")) == 0)
757 name += strlen("/dev/");
758 pp = g_provider_by_name(name);
759 KASSERT(pp != NULL, ("Provider %s disappear?!", name));
760 if (g_concat_add_disk(sc, pp, no - 1) != 0) {
761 G_CONCAT_DEBUG(1, "Disk %u (%s) not attached to %s.",
762 no, pp->name, gp->name);
763 sbuf_printf(sb, " %s", pp->name);
769 if (md.md_all != attached) {
770 g_concat_destroy(gp->softc, 1);
771 gctl_error(req, "%s", sbuf_data(sb));
776 static struct g_concat_softc *
777 g_concat_find_device(struct g_class *mp, const char *name)
779 struct g_concat_softc *sc;
782 LIST_FOREACH(gp, &mp->geom, geom) {
786 if (strcmp(sc->sc_name, name) == 0)
793 g_concat_ctl_destroy(struct gctl_req *req, struct g_class *mp)
795 struct g_concat_softc *sc;
796 int *force, *nargs, error;
803 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
805 gctl_error(req, "No '%s' argument.", "nargs");
809 gctl_error(req, "Missing device(s).");
812 force = gctl_get_paraml(req, "force", sizeof(*force));
814 gctl_error(req, "No '%s' argument.", "force");
818 for (i = 0; i < (u_int)*nargs; i++) {
819 snprintf(param, sizeof(param), "arg%u", i);
820 name = gctl_get_asciiparam(req, param);
822 gctl_error(req, "No 'arg%u' argument.", i);
825 sc = g_concat_find_device(mp, name);
827 gctl_error(req, "No such device: %s.", name);
830 error = g_concat_destroy(sc, *force);
832 gctl_error(req, "Cannot destroy device %s (error=%d).",
840 g_concat_config(struct gctl_req *req, struct g_class *mp, const char *verb)
846 version = gctl_get_paraml(req, "version", sizeof(*version));
847 if (version == NULL) {
848 gctl_error(req, "No '%s' argument.", "version");
851 if (*version != G_CONCAT_VERSION) {
852 gctl_error(req, "Userland and kernel parts are out of sync.");
856 if (strcmp(verb, "create") == 0) {
857 g_concat_ctl_create(req, mp);
859 } else if (strcmp(verb, "destroy") == 0 ||
860 strcmp(verb, "stop") == 0) {
861 g_concat_ctl_destroy(req, mp);
864 gctl_error(req, "Unknown verb.");
868 g_concat_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
869 struct g_consumer *cp, struct g_provider *pp)
871 struct g_concat_softc *sc;
879 } else if (cp != NULL) {
880 struct g_concat_disk *disk;
885 sbuf_printf(sb, "%s<End>%jd</End>\n", indent,
886 (intmax_t)disk->d_end);
887 sbuf_printf(sb, "%s<Start>%jd</Start>\n", indent,
888 (intmax_t)disk->d_start);
890 sbuf_printf(sb, "%s<ID>%u</ID>\n", indent, (u_int)sc->sc_id);
891 sbuf_printf(sb, "%s<Type>", indent);
892 switch (sc->sc_type) {
893 case G_CONCAT_TYPE_AUTOMATIC:
894 sbuf_printf(sb, "AUTOMATIC");
896 case G_CONCAT_TYPE_MANUAL:
897 sbuf_printf(sb, "MANUAL");
900 sbuf_printf(sb, "UNKNOWN");
903 sbuf_printf(sb, "</Type>\n");
904 sbuf_printf(sb, "%s<Status>Total=%u, Online=%u</Status>\n",
905 indent, sc->sc_ndisks, g_concat_nvalid(sc));
906 sbuf_printf(sb, "%s<State>", indent);
907 if (sc->sc_provider != NULL && sc->sc_provider->error == 0)
908 sbuf_printf(sb, "UP");
910 sbuf_printf(sb, "DOWN");
911 sbuf_printf(sb, "</State>\n");
915 DECLARE_GEOM_CLASS(g_concat_class, g_concat);