2 * Copyright (c) 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>
38 #include <sys/sysctl.h>
39 #include <sys/malloc.h>
41 #include <geom/geom.h>
42 #include <geom/shsec/g_shsec.h>
44 FEATURE(geom_shsec, "GEOM shared secret device support");
46 static MALLOC_DEFINE(M_SHSEC, "shsec_data", "GEOM_SHSEC Data");
48 static uma_zone_t g_shsec_zone;
50 static int g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force);
51 static int g_shsec_destroy_geom(struct gctl_req *req, struct g_class *mp,
54 static g_taste_t g_shsec_taste;
55 static g_ctl_req_t g_shsec_config;
56 static g_dumpconf_t g_shsec_dumpconf;
57 static g_init_t g_shsec_init;
58 static g_fini_t g_shsec_fini;
60 struct g_class g_shsec_class = {
61 .name = G_SHSEC_CLASS_NAME,
63 .ctlreq = g_shsec_config,
64 .taste = g_shsec_taste,
65 .destroy_geom = g_shsec_destroy_geom,
70 SYSCTL_DECL(_kern_geom);
71 static SYSCTL_NODE(_kern_geom, OID_AUTO, shsec, CTLFLAG_RW, 0,
73 static u_int g_shsec_debug = 0;
74 TUNABLE_INT("kern.geom.shsec.debug", &g_shsec_debug);
75 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, debug, CTLFLAG_RW, &g_shsec_debug, 0,
77 static u_int g_shsec_maxmem = MAXPHYS * 100;
78 TUNABLE_INT("kern.geom.shsec.maxmem", &g_shsec_maxmem);
79 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, maxmem, CTLFLAG_RD, &g_shsec_maxmem,
80 0, "Maximum memory that can be allocated for I/O (in bytes)");
81 static u_int g_shsec_alloc_failed = 0;
82 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, alloc_failed, CTLFLAG_RD,
83 &g_shsec_alloc_failed, 0, "How many times I/O allocation failed");
86 * Greatest Common Divisor.
102 * Least Common Multiple.
105 lcm(u_int a, u_int b)
108 return ((a * b) / gcd(a, b));
112 g_shsec_init(struct g_class *mp __unused)
115 g_shsec_zone = uma_zcreate("g_shsec_zone", MAXPHYS, NULL, NULL, NULL,
117 g_shsec_maxmem -= g_shsec_maxmem % MAXPHYS;
118 uma_zone_set_max(g_shsec_zone, g_shsec_maxmem / MAXPHYS);
122 g_shsec_fini(struct g_class *mp __unused)
125 uma_zdestroy(g_shsec_zone);
129 * Return the number of valid disks.
132 g_shsec_nvalid(struct g_shsec_softc *sc)
137 for (i = 0; i < sc->sc_ndisks; i++) {
138 if (sc->sc_disks[i] != NULL)
146 g_shsec_remove_disk(struct g_consumer *cp)
148 struct g_shsec_softc *sc;
151 KASSERT(cp != NULL, ("Non-valid disk in %s.", __func__));
152 sc = (struct g_shsec_softc *)cp->private;
153 KASSERT(sc != NULL, ("NULL sc in %s.", __func__));
156 G_SHSEC_DEBUG(0, "Disk %s removed from %s.", cp->provider->name,
159 sc->sc_disks[no] = NULL;
160 if (sc->sc_provider != NULL) {
161 g_orphan_provider(sc->sc_provider, ENXIO);
162 sc->sc_provider = NULL;
163 G_SHSEC_DEBUG(0, "Device %s removed.", sc->sc_name);
166 if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0)
167 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
169 g_destroy_consumer(cp);
173 g_shsec_orphan(struct g_consumer *cp)
175 struct g_shsec_softc *sc;
184 g_shsec_remove_disk(cp);
185 /* If there are no valid disks anymore, remove device. */
186 if (g_shsec_nvalid(sc) == 0)
187 g_shsec_destroy(sc, 1);
191 g_shsec_access(struct g_provider *pp, int dr, int dw, int de)
193 struct g_consumer *cp1, *cp2;
194 struct g_shsec_softc *sc;
203 * It looks like geom is being withered.
204 * In that case we allow only negative requests.
206 KASSERT(dr <= 0 && dw <= 0 && de <= 0,
207 ("Positive access request (device=%s).", pp->name));
208 if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 &&
209 (pp->ace + de) == 0) {
210 G_SHSEC_DEBUG(0, "Device %s definitely destroyed.",
216 /* On first open, grab an extra "exclusive" bit */
217 if (pp->acr == 0 && pp->acw == 0 && pp->ace == 0)
219 /* ... and let go of it on last close */
220 if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 && (pp->ace + de) == 0)
224 LIST_FOREACH(cp1, &gp->consumer, consumer) {
225 error = g_access(cp1, dr, dw, de);
229 * If we fail here, backout all previous changes.
231 LIST_FOREACH(cp2, &gp->consumer, consumer) {
234 g_access(cp2, -dr, -dw, -de);
243 g_shsec_xor1(uint32_t *src, uint32_t *dst, ssize_t len)
246 for (; len > 0; len -= sizeof(uint32_t), dst++)
247 *dst = *dst ^ *src++;
248 KASSERT(len == 0, ("len != 0 (len=%zd)", len));
252 g_shsec_done(struct bio *bp)
254 struct g_shsec_softc *sc;
257 pbp = bp->bio_parent;
258 sc = pbp->bio_to->geom->softc;
259 if (bp->bio_error == 0)
260 G_SHSEC_LOGREQ(2, bp, "Request done.");
262 G_SHSEC_LOGREQ(0, bp, "Request failed (error=%d).",
264 if (pbp->bio_error == 0)
265 pbp->bio_error = bp->bio_error;
267 if (pbp->bio_cmd == BIO_READ) {
268 if ((pbp->bio_pflags & G_SHSEC_BFLAG_FIRST) != 0) {
269 bcopy(bp->bio_data, pbp->bio_data, pbp->bio_length);
272 g_shsec_xor1((uint32_t *)bp->bio_data,
273 (uint32_t *)pbp->bio_data,
274 (ssize_t)pbp->bio_length);
277 bzero(bp->bio_data, bp->bio_length);
278 uma_zfree(g_shsec_zone, bp->bio_data);
281 if (pbp->bio_children == pbp->bio_inbed) {
282 pbp->bio_completed = pbp->bio_length;
283 g_io_deliver(pbp, pbp->bio_error);
288 g_shsec_xor2(uint32_t *rand, uint32_t *dst, ssize_t len)
291 for (; len > 0; len -= sizeof(uint32_t), dst++) {
292 *rand = arc4random();
293 *dst = *dst ^ *rand++;
295 KASSERT(len == 0, ("len != 0 (len=%zd)", len));
299 g_shsec_start(struct bio *bp)
301 TAILQ_HEAD(, bio) queue = TAILQ_HEAD_INITIALIZER(queue);
302 struct g_shsec_softc *sc;
309 sc = bp->bio_to->geom->softc;
311 * If sc == NULL, provider's error should be set and g_shsec_start()
312 * should not be called at all.
315 ("Provider's error should be set (error=%d)(device=%s).",
316 bp->bio_to->error, bp->bio_to->name));
318 G_SHSEC_LOGREQ(2, bp, "Request received.");
320 switch (bp->bio_cmd) {
325 * Only those requests are supported.
330 /* To which provider it should be delivered? */
332 g_io_deliver(bp, EOPNOTSUPP);
337 * Allocate all bios first and calculate XOR.
340 len = bp->bio_length;
341 if (bp->bio_cmd == BIO_READ)
342 bp->bio_pflags = G_SHSEC_BFLAG_FIRST;
343 for (no = 0; no < sc->sc_ndisks; no++) {
344 cbp = g_clone_bio(bp);
349 TAILQ_INSERT_TAIL(&queue, cbp, bio_queue);
352 * Fill in the component buf structure.
354 cbp->bio_done = g_shsec_done;
355 cbp->bio_data = uma_zalloc(g_shsec_zone, M_NOWAIT);
356 if (cbp->bio_data == NULL) {
357 g_shsec_alloc_failed++;
361 cbp->bio_caller2 = sc->sc_disks[no];
362 if (bp->bio_cmd == BIO_WRITE) {
364 dst = (uint32_t *)cbp->bio_data;
365 bcopy(bp->bio_data, dst, len);
367 g_shsec_xor2((uint32_t *)cbp->bio_data, dst,
373 * Fire off all allocated requests!
375 while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
376 struct g_consumer *cp;
378 TAILQ_REMOVE(&queue, cbp, bio_queue);
379 cp = cbp->bio_caller2;
380 cbp->bio_caller2 = NULL;
381 cbp->bio_to = cp->provider;
382 G_SHSEC_LOGREQ(2, cbp, "Sending request.");
383 g_io_request(cbp, cp);
387 while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
388 TAILQ_REMOVE(&queue, cbp, bio_queue);
390 if (cbp->bio_data != NULL) {
391 bzero(cbp->bio_data, cbp->bio_length);
392 uma_zfree(g_shsec_zone, cbp->bio_data);
396 if (bp->bio_error == 0)
397 bp->bio_error = error;
398 g_io_deliver(bp, bp->bio_error);
402 g_shsec_check_and_run(struct g_shsec_softc *sc)
405 u_int no, sectorsize = 0;
407 if (g_shsec_nvalid(sc) != sc->sc_ndisks)
410 sc->sc_provider = g_new_providerf(sc->sc_geom, "shsec/%s", sc->sc_name);
412 * Find the smallest disk.
414 mediasize = sc->sc_disks[0]->provider->mediasize;
415 mediasize -= sc->sc_disks[0]->provider->sectorsize;
416 sectorsize = sc->sc_disks[0]->provider->sectorsize;
417 for (no = 1; no < sc->sc_ndisks; no++) {
418 ms = sc->sc_disks[no]->provider->mediasize;
419 ms -= sc->sc_disks[no]->provider->sectorsize;
422 sectorsize = lcm(sectorsize,
423 sc->sc_disks[no]->provider->sectorsize);
425 sc->sc_provider->sectorsize = sectorsize;
426 sc->sc_provider->mediasize = mediasize;
427 g_error_provider(sc->sc_provider, 0);
429 G_SHSEC_DEBUG(0, "Device %s activated.", sc->sc_name);
433 g_shsec_read_metadata(struct g_consumer *cp, struct g_shsec_metadata *md)
435 struct g_provider *pp;
441 error = g_access(cp, 1, 0, 0);
446 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
449 g_access(cp, -1, 0, 0);
453 /* Decode metadata. */
454 shsec_metadata_decode(buf, md);
461 * Add disk to given device.
464 g_shsec_add_disk(struct g_shsec_softc *sc, struct g_provider *pp, u_int no)
466 struct g_consumer *cp, *fcp;
468 struct g_shsec_metadata md;
471 /* Metadata corrupted? */
472 if (no >= sc->sc_ndisks)
475 /* Check if disk is not already attached. */
476 if (sc->sc_disks[no] != NULL)
480 fcp = LIST_FIRST(&gp->consumer);
482 cp = g_new_consumer(gp);
483 error = g_attach(cp, pp);
485 g_destroy_consumer(cp);
489 if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0)) {
490 error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
493 g_destroy_consumer(cp);
498 /* Reread metadata. */
499 error = g_shsec_read_metadata(cp, &md);
503 if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0 ||
504 strcmp(md.md_name, sc->sc_name) != 0 || md.md_id != sc->sc_id) {
505 G_SHSEC_DEBUG(0, "Metadata on %s changed.", pp->name);
511 sc->sc_disks[no] = cp;
513 G_SHSEC_DEBUG(0, "Disk %s attached to %s.", pp->name, sc->sc_name);
515 g_shsec_check_and_run(sc);
519 if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0))
520 g_access(cp, -fcp->acr, -fcp->acw, -fcp->ace);
522 g_destroy_consumer(cp);
526 static struct g_geom *
527 g_shsec_create(struct g_class *mp, const struct g_shsec_metadata *md)
529 struct g_shsec_softc *sc;
533 G_SHSEC_DEBUG(1, "Creating device %s (id=%u).", md->md_name, md->md_id);
535 /* Two disks is minimum. */
536 if (md->md_all < 2) {
537 G_SHSEC_DEBUG(0, "Too few disks defined for %s.", md->md_name);
541 /* Check for duplicate unit */
542 LIST_FOREACH(gp, &mp->geom, geom) {
544 if (sc != NULL && strcmp(sc->sc_name, md->md_name) == 0) {
545 G_SHSEC_DEBUG(0, "Device %s already configured.",
550 gp = g_new_geomf(mp, "%s", md->md_name);
551 sc = malloc(sizeof(*sc), M_SHSEC, M_WAITOK | M_ZERO);
552 gp->start = g_shsec_start;
553 gp->spoiled = g_shsec_orphan;
554 gp->orphan = g_shsec_orphan;
555 gp->access = g_shsec_access;
556 gp->dumpconf = g_shsec_dumpconf;
558 sc->sc_id = md->md_id;
559 sc->sc_ndisks = md->md_all;
560 sc->sc_disks = malloc(sizeof(struct g_consumer *) * sc->sc_ndisks,
561 M_SHSEC, M_WAITOK | M_ZERO);
562 for (no = 0; no < sc->sc_ndisks; no++)
563 sc->sc_disks[no] = NULL;
567 sc->sc_provider = NULL;
569 G_SHSEC_DEBUG(0, "Device %s created (id=%u).", sc->sc_name, sc->sc_id);
575 g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force)
577 struct g_provider *pp;
586 pp = sc->sc_provider;
587 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
589 G_SHSEC_DEBUG(0, "Device %s is still open, so it "
590 "can't be definitely removed.", pp->name);
593 "Device %s is still open (r%dw%de%d).", pp->name,
594 pp->acr, pp->acw, pp->ace);
599 for (no = 0; no < sc->sc_ndisks; no++) {
600 if (sc->sc_disks[no] != NULL)
601 g_shsec_remove_disk(sc->sc_disks[no]);
606 KASSERT(sc->sc_provider == NULL, ("Provider still exists? (device=%s)",
608 free(sc->sc_disks, M_SHSEC);
611 pp = LIST_FIRST(&gp->provider);
612 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
613 G_SHSEC_DEBUG(0, "Device %s destroyed.", gp->name);
615 g_wither_geom(gp, ENXIO);
621 g_shsec_destroy_geom(struct gctl_req *req __unused, struct g_class *mp __unused,
624 struct g_shsec_softc *sc;
627 return (g_shsec_destroy(sc, 0));
630 static struct g_geom *
631 g_shsec_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
633 struct g_shsec_metadata md;
634 struct g_shsec_softc *sc;
635 struct g_consumer *cp;
639 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
642 /* Skip providers that are already open for writing. */
646 G_SHSEC_DEBUG(3, "Tasting %s.", pp->name);
648 gp = g_new_geomf(mp, "shsec:taste");
649 gp->start = g_shsec_start;
650 gp->access = g_shsec_access;
651 gp->orphan = g_shsec_orphan;
652 cp = g_new_consumer(gp);
654 error = g_shsec_read_metadata(cp, &md);
656 g_destroy_consumer(cp);
662 if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0)
664 if (md.md_version > G_SHSEC_VERSION) {
665 G_SHSEC_DEBUG(0, "Kernel module is too old to handle %s.\n",
670 * Backward compatibility:
672 /* There was no md_provsize field in earlier versions of metadata. */
673 if (md.md_version < 1)
674 md.md_provsize = pp->mediasize;
676 if (md.md_provider[0] != '\0' &&
677 !g_compare_names(md.md_provider, pp->name))
679 if (md.md_provsize != pp->mediasize)
683 * Let's check if device already exists.
686 LIST_FOREACH(gp, &mp->geom, geom) {
690 if (strcmp(md.md_name, sc->sc_name) != 0)
692 if (md.md_id != sc->sc_id)
697 G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
698 error = g_shsec_add_disk(sc, pp, md.md_no);
700 G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
701 pp->name, gp->name, error);
705 gp = g_shsec_create(mp, &md);
707 G_SHSEC_DEBUG(0, "Cannot create device %s.", md.md_name);
711 G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
712 error = g_shsec_add_disk(sc, pp, md.md_no);
714 G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
715 pp->name, gp->name, error);
716 g_shsec_destroy(sc, 1);
723 static struct g_shsec_softc *
724 g_shsec_find_device(struct g_class *mp, const char *name)
726 struct g_shsec_softc *sc;
729 LIST_FOREACH(gp, &mp->geom, geom) {
733 if (strcmp(sc->sc_name, name) == 0)
740 g_shsec_ctl_destroy(struct gctl_req *req, struct g_class *mp)
742 struct g_shsec_softc *sc;
743 int *force, *nargs, error;
750 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
752 gctl_error(req, "No '%s' argument.", "nargs");
756 gctl_error(req, "Missing device(s).");
759 force = gctl_get_paraml(req, "force", sizeof(*force));
761 gctl_error(req, "No '%s' argument.", "force");
765 for (i = 0; i < (u_int)*nargs; i++) {
766 snprintf(param, sizeof(param), "arg%u", i);
767 name = gctl_get_asciiparam(req, param);
769 gctl_error(req, "No 'arg%u' argument.", i);
772 sc = g_shsec_find_device(mp, name);
774 gctl_error(req, "No such device: %s.", name);
777 error = g_shsec_destroy(sc, *force);
779 gctl_error(req, "Cannot destroy device %s (error=%d).",
787 g_shsec_config(struct gctl_req *req, struct g_class *mp, const char *verb)
793 version = gctl_get_paraml(req, "version", sizeof(*version));
794 if (version == NULL) {
795 gctl_error(req, "No '%s' argument.", "version");
798 if (*version != G_SHSEC_VERSION) {
799 gctl_error(req, "Userland and kernel parts are out of sync.");
803 if (strcmp(verb, "stop") == 0) {
804 g_shsec_ctl_destroy(req, mp);
808 gctl_error(req, "Unknown verb.");
812 g_shsec_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
813 struct g_consumer *cp, struct g_provider *pp)
815 struct g_shsec_softc *sc;
822 } else if (cp != NULL) {
823 sbuf_printf(sb, "%s<Number>%u</Number>\n", indent,
826 sbuf_printf(sb, "%s<ID>%u</ID>\n", indent, (u_int)sc->sc_id);
827 sbuf_printf(sb, "%s<Status>Total=%u, Online=%u</Status>\n",
828 indent, sc->sc_ndisks, g_shsec_nvalid(sc));
829 sbuf_printf(sb, "%s<State>", indent);
830 if (sc->sc_provider != NULL && sc->sc_provider->error == 0)
831 sbuf_printf(sb, "UP");
833 sbuf_printf(sb, "DOWN");
834 sbuf_printf(sb, "</State>\n");
838 DECLARE_GEOM_CLASS(g_shsec_class, g_shsec);