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>
37 #include <sys/sysctl.h>
38 #include <sys/malloc.h>
40 #include <geom/geom.h>
41 #include <geom/shsec/g_shsec.h>
44 static MALLOC_DEFINE(M_SHSEC, "shsec_data", "GEOM_SHSEC Data");
46 static uma_zone_t g_shsec_zone;
48 static int g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force);
49 static int g_shsec_destroy_geom(struct gctl_req *req, struct g_class *mp,
52 static g_taste_t g_shsec_taste;
53 static g_ctl_req_t g_shsec_config;
54 static g_dumpconf_t g_shsec_dumpconf;
55 static g_init_t g_shsec_init;
56 static g_fini_t g_shsec_fini;
58 struct g_class g_shsec_class = {
59 .name = G_SHSEC_CLASS_NAME,
61 .ctlreq = g_shsec_config,
62 .taste = g_shsec_taste,
63 .destroy_geom = g_shsec_destroy_geom,
68 SYSCTL_DECL(_kern_geom);
69 SYSCTL_NODE(_kern_geom, OID_AUTO, shsec, CTLFLAG_RW, 0, "GEOM_SHSEC stuff");
70 static u_int g_shsec_debug = 0;
71 TUNABLE_INT("kern.geom.shsec.debug", &g_shsec_debug);
72 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, debug, CTLFLAG_RW, &g_shsec_debug, 0,
74 static u_int g_shsec_maxmem = MAXPHYS * 100;
75 TUNABLE_INT("kern.geom.shsec.maxmem", &g_shsec_maxmem);
76 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, maxmem, CTLFLAG_RD, &g_shsec_maxmem,
77 0, "Maximum memory that can be allocated for I/O (in bytes)");
78 static u_int g_shsec_alloc_failed = 0;
79 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, alloc_failed, CTLFLAG_RD,
80 &g_shsec_alloc_failed, 0, "How many times I/O allocation failed");
83 * Greatest Common Divisor.
99 * Least Common Multiple.
102 lcm(u_int a, u_int b)
105 return ((a * b) / gcd(a, b));
109 g_shsec_init(struct g_class *mp __unused)
112 g_shsec_zone = uma_zcreate("g_shsec_zone", MAXPHYS, NULL, NULL, NULL,
114 g_shsec_maxmem -= g_shsec_maxmem % MAXPHYS;
115 uma_zone_set_max(g_shsec_zone, g_shsec_maxmem / MAXPHYS);
119 g_shsec_fini(struct g_class *mp __unused)
122 uma_zdestroy(g_shsec_zone);
126 * Return the number of valid disks.
129 g_shsec_nvalid(struct g_shsec_softc *sc)
134 for (i = 0; i < sc->sc_ndisks; i++) {
135 if (sc->sc_disks[i] != NULL)
143 g_shsec_remove_disk(struct g_consumer *cp)
145 struct g_shsec_softc *sc;
148 KASSERT(cp != NULL, ("Non-valid disk in %s.", __func__));
149 sc = (struct g_shsec_softc *)cp->private;
150 KASSERT(sc != NULL, ("NULL sc in %s.", __func__));
153 G_SHSEC_DEBUG(0, "Disk %s removed from %s.", cp->provider->name,
156 sc->sc_disks[no] = NULL;
157 if (sc->sc_provider != NULL) {
158 g_orphan_provider(sc->sc_provider, ENXIO);
159 sc->sc_provider = NULL;
160 G_SHSEC_DEBUG(0, "Device %s removed.", sc->sc_name);
163 if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0)
164 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
166 g_destroy_consumer(cp);
170 g_shsec_orphan(struct g_consumer *cp)
172 struct g_shsec_softc *sc;
181 g_shsec_remove_disk(cp);
182 /* If there are no valid disks anymore, remove device. */
183 if (g_shsec_nvalid(sc) == 0)
184 g_shsec_destroy(sc, 1);
188 g_shsec_access(struct g_provider *pp, int dr, int dw, int de)
190 struct g_consumer *cp1, *cp2;
191 struct g_shsec_softc *sc;
200 * It looks like geom is being withered.
201 * In that case we allow only negative requests.
203 KASSERT(dr <= 0 && dw <= 0 && de <= 0,
204 ("Positive access request (device=%s).", pp->name));
205 if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 &&
206 (pp->ace + de) == 0) {
207 G_SHSEC_DEBUG(0, "Device %s definitely destroyed.",
213 /* On first open, grab an extra "exclusive" bit */
214 if (pp->acr == 0 && pp->acw == 0 && pp->ace == 0)
216 /* ... and let go of it on last close */
217 if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 && (pp->ace + de) == 0)
221 LIST_FOREACH(cp1, &gp->consumer, consumer) {
222 error = g_access(cp1, dr, dw, de);
226 * If we fail here, backout all previous changes.
228 LIST_FOREACH(cp2, &gp->consumer, consumer) {
231 g_access(cp2, -dr, -dw, -de);
240 g_shsec_xor1(uint32_t *src, uint32_t *dst, ssize_t len)
243 for (; len > 0; len -= sizeof(uint32_t), dst++)
244 *dst = *dst ^ *src++;
245 KASSERT(len == 0, ("len != 0 (len=%zd)", len));
249 g_shsec_done(struct bio *bp)
251 struct g_shsec_softc *sc;
254 pbp = bp->bio_parent;
255 sc = pbp->bio_to->geom->softc;
256 if (bp->bio_error == 0)
257 G_SHSEC_LOGREQ(2, bp, "Request done.");
259 G_SHSEC_LOGREQ(0, bp, "Request failed (error=%d).",
261 if (pbp->bio_error == 0)
262 pbp->bio_error = bp->bio_error;
264 if (pbp->bio_cmd == BIO_READ) {
265 if ((pbp->bio_pflags & G_SHSEC_BFLAG_FIRST) != 0) {
266 bcopy(bp->bio_data, pbp->bio_data, pbp->bio_length);
269 g_shsec_xor1((uint32_t *)bp->bio_data,
270 (uint32_t *)pbp->bio_data,
271 (ssize_t)pbp->bio_length);
274 bzero(bp->bio_data, bp->bio_length);
275 uma_zfree(g_shsec_zone, bp->bio_data);
278 if (pbp->bio_children == pbp->bio_inbed) {
279 pbp->bio_completed = pbp->bio_length;
280 g_io_deliver(pbp, pbp->bio_error);
285 g_shsec_xor2(uint32_t *rand, uint32_t *dst, ssize_t len)
288 for (; len > 0; len -= sizeof(uint32_t), dst++) {
289 *rand = arc4random();
290 *dst = *dst ^ *rand++;
292 KASSERT(len == 0, ("len != 0 (len=%zd)", len));
296 g_shsec_start(struct bio *bp)
298 TAILQ_HEAD(, bio) queue = TAILQ_HEAD_INITIALIZER(queue);
299 struct g_shsec_softc *sc;
306 sc = bp->bio_to->geom->softc;
308 * If sc == NULL, provider's error should be set and g_shsec_start()
309 * should not be called at all.
312 ("Provider's error should be set (error=%d)(device=%s).",
313 bp->bio_to->error, bp->bio_to->name));
315 G_SHSEC_LOGREQ(2, bp, "Request received.");
317 switch (bp->bio_cmd) {
322 * Only those requests are supported.
327 /* To which provider it should be delivered? */
329 g_io_deliver(bp, EOPNOTSUPP);
334 * Allocate all bios first and calculate XOR.
337 len = bp->bio_length;
338 if (bp->bio_cmd == BIO_READ)
339 bp->bio_pflags = G_SHSEC_BFLAG_FIRST;
340 for (no = 0; no < sc->sc_ndisks; no++) {
341 cbp = g_clone_bio(bp);
346 TAILQ_INSERT_TAIL(&queue, cbp, bio_queue);
349 * Fill in the component buf structure.
351 cbp->bio_done = g_shsec_done;
352 cbp->bio_data = uma_zalloc(g_shsec_zone, M_NOWAIT);
353 if (cbp->bio_data == NULL) {
354 g_shsec_alloc_failed++;
358 cbp->bio_caller2 = sc->sc_disks[no];
359 if (bp->bio_cmd == BIO_WRITE) {
361 dst = (uint32_t *)cbp->bio_data;
362 bcopy(bp->bio_data, dst, len);
364 g_shsec_xor2((uint32_t *)cbp->bio_data, dst,
370 * Fire off all allocated requests!
372 while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
373 struct g_consumer *cp;
375 TAILQ_REMOVE(&queue, cbp, bio_queue);
376 cp = cbp->bio_caller2;
377 cbp->bio_caller2 = NULL;
378 cbp->bio_to = cp->provider;
379 G_SHSEC_LOGREQ(2, cbp, "Sending request.");
380 g_io_request(cbp, cp);
384 while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
385 TAILQ_REMOVE(&queue, cbp, bio_queue);
387 if (cbp->bio_data != NULL) {
388 bzero(cbp->bio_data, cbp->bio_length);
389 uma_zfree(g_shsec_zone, cbp->bio_data);
393 if (bp->bio_error == 0)
394 bp->bio_error = error;
395 g_io_deliver(bp, bp->bio_error);
399 g_shsec_check_and_run(struct g_shsec_softc *sc)
402 u_int no, sectorsize = 0;
404 if (g_shsec_nvalid(sc) != sc->sc_ndisks)
407 sc->sc_provider = g_new_providerf(sc->sc_geom, "shsec/%s", sc->sc_name);
409 * Find the smallest disk.
411 mediasize = sc->sc_disks[0]->provider->mediasize;
412 mediasize -= sc->sc_disks[0]->provider->sectorsize;
413 sectorsize = sc->sc_disks[0]->provider->sectorsize;
414 for (no = 1; no < sc->sc_ndisks; no++) {
415 ms = sc->sc_disks[no]->provider->mediasize;
416 ms -= sc->sc_disks[no]->provider->sectorsize;
419 sectorsize = lcm(sectorsize,
420 sc->sc_disks[no]->provider->sectorsize);
422 sc->sc_provider->sectorsize = sectorsize;
423 sc->sc_provider->mediasize = mediasize;
424 g_error_provider(sc->sc_provider, 0);
426 G_SHSEC_DEBUG(0, "Device %s activated.", sc->sc_name);
430 g_shsec_read_metadata(struct g_consumer *cp, struct g_shsec_metadata *md)
432 struct g_provider *pp;
438 error = g_access(cp, 1, 0, 0);
443 buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
446 g_access(cp, -1, 0, 0);
450 /* Decode metadata. */
451 shsec_metadata_decode(buf, md);
458 * Add disk to given device.
461 g_shsec_add_disk(struct g_shsec_softc *sc, struct g_provider *pp, u_int no)
463 struct g_consumer *cp, *fcp;
465 struct g_shsec_metadata md;
468 /* Metadata corrupted? */
469 if (no >= sc->sc_ndisks)
472 /* Check if disk is not already attached. */
473 if (sc->sc_disks[no] != NULL)
477 fcp = LIST_FIRST(&gp->consumer);
479 cp = g_new_consumer(gp);
480 error = g_attach(cp, pp);
482 g_destroy_consumer(cp);
486 if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0)) {
487 error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
490 g_destroy_consumer(cp);
495 /* Reread metadata. */
496 error = g_shsec_read_metadata(cp, &md);
500 if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0 ||
501 strcmp(md.md_name, sc->sc_name) != 0 || md.md_id != sc->sc_id) {
502 G_SHSEC_DEBUG(0, "Metadata on %s changed.", pp->name);
508 sc->sc_disks[no] = cp;
510 G_SHSEC_DEBUG(0, "Disk %s attached to %s.", pp->name, sc->sc_name);
512 g_shsec_check_and_run(sc);
516 if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0))
517 g_access(cp, -fcp->acr, -fcp->acw, -fcp->ace);
519 g_destroy_consumer(cp);
523 static struct g_geom *
524 g_shsec_create(struct g_class *mp, const struct g_shsec_metadata *md)
526 struct g_shsec_softc *sc;
530 G_SHSEC_DEBUG(1, "Creating device %s (id=%u).", md->md_name, md->md_id);
532 /* Two disks is minimum. */
533 if (md->md_all < 2) {
534 G_SHSEC_DEBUG(0, "Too few disks defined for %s.", md->md_name);
538 /* Check for duplicate unit */
539 LIST_FOREACH(gp, &mp->geom, geom) {
541 if (sc != NULL && strcmp(sc->sc_name, md->md_name) == 0) {
542 G_SHSEC_DEBUG(0, "Device %s already configured.",
547 gp = g_new_geomf(mp, "%s", md->md_name);
548 gp->softc = NULL; /* for a moment */
550 sc = malloc(sizeof(*sc), M_SHSEC, M_WAITOK | M_ZERO);
551 gp->start = g_shsec_start;
552 gp->spoiled = g_shsec_orphan;
553 gp->orphan = g_shsec_orphan;
554 gp->access = g_shsec_access;
555 gp->dumpconf = g_shsec_dumpconf;
557 sc->sc_id = md->md_id;
558 sc->sc_ndisks = md->md_all;
559 sc->sc_disks = malloc(sizeof(struct g_consumer *) * sc->sc_ndisks,
560 M_SHSEC, M_WAITOK | M_ZERO);
561 for (no = 0; no < sc->sc_ndisks; no++)
562 sc->sc_disks[no] = NULL;
566 sc->sc_provider = NULL;
568 G_SHSEC_DEBUG(0, "Device %s created (id=%u).", sc->sc_name, sc->sc_id);
574 g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force)
576 struct g_provider *pp;
585 pp = sc->sc_provider;
586 if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
588 G_SHSEC_DEBUG(0, "Device %s is still open, so it "
589 "can't be definitely removed.", pp->name);
592 "Device %s is still open (r%dw%de%d).", pp->name,
593 pp->acr, pp->acw, pp->ace);
598 for (no = 0; no < sc->sc_ndisks; no++) {
599 if (sc->sc_disks[no] != NULL)
600 g_shsec_remove_disk(sc->sc_disks[no]);
605 KASSERT(sc->sc_provider == NULL, ("Provider still exists? (device=%s)",
607 free(sc->sc_disks, M_SHSEC);
610 pp = LIST_FIRST(&gp->provider);
611 if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
612 G_SHSEC_DEBUG(0, "Device %s destroyed.", gp->name);
614 g_wither_geom(gp, ENXIO);
620 g_shsec_destroy_geom(struct gctl_req *req __unused, struct g_class *mp __unused,
623 struct g_shsec_softc *sc;
626 return (g_shsec_destroy(sc, 0));
629 static struct g_geom *
630 g_shsec_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
632 struct g_shsec_metadata md;
633 struct g_shsec_softc *sc;
634 struct g_consumer *cp;
638 g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
641 G_SHSEC_DEBUG(3, "Tasting %s.", pp->name);
643 gp = g_new_geomf(mp, "shsec:taste");
644 gp->start = g_shsec_start;
645 gp->access = g_shsec_access;
646 gp->orphan = g_shsec_orphan;
647 cp = g_new_consumer(gp);
649 error = g_shsec_read_metadata(cp, &md);
651 g_destroy_consumer(cp);
657 if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0)
659 if (md.md_version > G_SHSEC_VERSION) {
660 G_SHSEC_DEBUG(0, "Kernel module is too old to handle %s.\n",
665 * Backward compatibility:
667 /* There was no md_provsize field in earlier versions of metadata. */
668 if (md.md_version < 1)
669 md.md_provsize = pp->mediasize;
671 if (md.md_provider[0] != '\0' && strcmp(md.md_provider, pp->name) != 0)
673 if (md.md_provsize != pp->mediasize)
677 * Let's check if device already exists.
680 LIST_FOREACH(gp, &mp->geom, geom) {
684 if (strcmp(md.md_name, sc->sc_name) != 0)
686 if (md.md_id != sc->sc_id)
691 G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
692 error = g_shsec_add_disk(sc, pp, md.md_no);
694 G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
695 pp->name, gp->name, error);
699 gp = g_shsec_create(mp, &md);
701 G_SHSEC_DEBUG(0, "Cannot create device %s.", md.md_name);
705 G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
706 error = g_shsec_add_disk(sc, pp, md.md_no);
708 G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
709 pp->name, gp->name, error);
710 g_shsec_destroy(sc, 1);
717 static struct g_shsec_softc *
718 g_shsec_find_device(struct g_class *mp, const char *name)
720 struct g_shsec_softc *sc;
723 LIST_FOREACH(gp, &mp->geom, geom) {
727 if (strcmp(sc->sc_name, name) == 0)
734 g_shsec_ctl_destroy(struct gctl_req *req, struct g_class *mp)
736 struct g_shsec_softc *sc;
737 int *force, *nargs, error;
744 nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
746 gctl_error(req, "No '%s' argument.", "nargs");
750 gctl_error(req, "Missing device(s).");
753 force = gctl_get_paraml(req, "force", sizeof(*force));
755 gctl_error(req, "No '%s' argument.", "force");
759 for (i = 0; i < (u_int)*nargs; i++) {
760 snprintf(param, sizeof(param), "arg%u", i);
761 name = gctl_get_asciiparam(req, param);
763 gctl_error(req, "No 'arg%u' argument.", i);
766 sc = g_shsec_find_device(mp, name);
768 gctl_error(req, "No such device: %s.", name);
771 error = g_shsec_destroy(sc, *force);
773 gctl_error(req, "Cannot destroy device %s (error=%d).",
781 g_shsec_config(struct gctl_req *req, struct g_class *mp, const char *verb)
787 version = gctl_get_paraml(req, "version", sizeof(*version));
788 if (version == NULL) {
789 gctl_error(req, "No '%s' argument.", "version");
792 if (*version != G_SHSEC_VERSION) {
793 gctl_error(req, "Userland and kernel parts are out of sync.");
797 if (strcmp(verb, "stop") == 0) {
798 g_shsec_ctl_destroy(req, mp);
802 gctl_error(req, "Unknown verb.");
806 g_shsec_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
807 struct g_consumer *cp, struct g_provider *pp)
809 struct g_shsec_softc *sc;
816 } else if (cp != NULL) {
817 sbuf_printf(sb, "%s<Number>%u</Number>\n", indent,
820 sbuf_printf(sb, "%s<ID>%u</ID>\n", indent, (u_int)sc->sc_id);
821 sbuf_printf(sb, "%s<Status>Total=%u, Online=%u</Status>\n",
822 indent, sc->sc_ndisks, g_shsec_nvalid(sc));
823 sbuf_printf(sb, "%s<State>", indent);
824 if (sc->sc_provider != NULL && sc->sc_provider->error == 0)
825 sbuf_printf(sb, "UP");
827 sbuf_printf(sb, "DOWN");
828 sbuf_printf(sb, "</State>\n");
832 DECLARE_GEOM_CLASS(g_shsec_class, g_shsec);