xref: /freebsd/sys/geom/shsec/g_shsec.c (revision a7dea1671b87c07d2d266f836bfa8b58efc7c134)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/lock.h>
37 #include <sys/mutex.h>
38 #include <sys/bio.h>
39 #include <sys/sbuf.h>
40 #include <sys/sysctl.h>
41 #include <sys/malloc.h>
42 #include <vm/uma.h>
43 #include <geom/geom.h>
44 #include <geom/geom_dbg.h>
45 #include <geom/shsec/g_shsec.h>
46 
47 FEATURE(geom_shsec, "GEOM shared secret device support");
48 
49 static MALLOC_DEFINE(M_SHSEC, "shsec_data", "GEOM_SHSEC Data");
50 
51 static uma_zone_t g_shsec_zone;
52 
53 static int g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force);
54 static int g_shsec_destroy_geom(struct gctl_req *req, struct g_class *mp,
55     struct g_geom *gp);
56 
57 static g_taste_t g_shsec_taste;
58 static g_ctl_req_t g_shsec_config;
59 static g_dumpconf_t g_shsec_dumpconf;
60 static g_init_t g_shsec_init;
61 static g_fini_t g_shsec_fini;
62 
63 struct g_class g_shsec_class = {
64 	.name = G_SHSEC_CLASS_NAME,
65 	.version = G_VERSION,
66 	.ctlreq = g_shsec_config,
67 	.taste = g_shsec_taste,
68 	.destroy_geom = g_shsec_destroy_geom,
69 	.init = g_shsec_init,
70 	.fini = g_shsec_fini
71 };
72 
73 SYSCTL_DECL(_kern_geom);
74 static SYSCTL_NODE(_kern_geom, OID_AUTO, shsec, CTLFLAG_RW, 0,
75     "GEOM_SHSEC stuff");
76 static u_int g_shsec_debug = 0;
77 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, debug, CTLFLAG_RWTUN, &g_shsec_debug, 0,
78     "Debug level");
79 static u_int g_shsec_maxmem = MAXPHYS * 100;
80 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, maxmem, CTLFLAG_RDTUN, &g_shsec_maxmem,
81     0, "Maximum memory that can be allocated for I/O (in bytes)");
82 static u_int g_shsec_alloc_failed = 0;
83 SYSCTL_UINT(_kern_geom_shsec, OID_AUTO, alloc_failed, CTLFLAG_RD,
84     &g_shsec_alloc_failed, 0, "How many times I/O allocation failed");
85 
86 /*
87  * Greatest Common Divisor.
88  */
89 static u_int
90 gcd(u_int a, u_int b)
91 {
92 	u_int c;
93 
94 	while (b != 0) {
95 		c = a;
96 		a = b;
97 		b = (c % b);
98 	}
99 	return (a);
100 }
101 
102 /*
103  * Least Common Multiple.
104  */
105 static u_int
106 lcm(u_int a, u_int b)
107 {
108 
109 	return ((a * b) / gcd(a, b));
110 }
111 
112 static void
113 g_shsec_init(struct g_class *mp __unused)
114 {
115 
116 	g_shsec_zone = uma_zcreate("g_shsec_zone", MAXPHYS, NULL, NULL, NULL,
117 	    NULL, 0, 0);
118 	g_shsec_maxmem -= g_shsec_maxmem % MAXPHYS;
119 	uma_zone_set_max(g_shsec_zone, g_shsec_maxmem / MAXPHYS);
120 }
121 
122 static void
123 g_shsec_fini(struct g_class *mp __unused)
124 {
125 
126 	uma_zdestroy(g_shsec_zone);
127 }
128 
129 /*
130  * Return the number of valid disks.
131  */
132 static u_int
133 g_shsec_nvalid(struct g_shsec_softc *sc)
134 {
135 	u_int i, no;
136 
137 	no = 0;
138 	for (i = 0; i < sc->sc_ndisks; i++) {
139 		if (sc->sc_disks[i] != NULL)
140 			no++;
141 	}
142 
143 	return (no);
144 }
145 
146 static void
147 g_shsec_remove_disk(struct g_consumer *cp)
148 {
149 	struct g_shsec_softc *sc;
150 	u_int no;
151 
152 	KASSERT(cp != NULL, ("Non-valid disk in %s.", __func__));
153 	sc = (struct g_shsec_softc *)cp->private;
154 	KASSERT(sc != NULL, ("NULL sc in %s.", __func__));
155 	no = cp->index;
156 
157 	G_SHSEC_DEBUG(0, "Disk %s removed from %s.", cp->provider->name,
158 	    sc->sc_name);
159 
160 	sc->sc_disks[no] = NULL;
161 	if (sc->sc_provider != NULL) {
162 		g_wither_provider(sc->sc_provider, ENXIO);
163 		sc->sc_provider = NULL;
164 		G_SHSEC_DEBUG(0, "Device %s removed.", sc->sc_name);
165 	}
166 
167 	if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0)
168 		return;
169 	g_detach(cp);
170 	g_destroy_consumer(cp);
171 }
172 
173 static void
174 g_shsec_orphan(struct g_consumer *cp)
175 {
176 	struct g_shsec_softc *sc;
177 	struct g_geom *gp;
178 
179 	g_topology_assert();
180 	gp = cp->geom;
181 	sc = gp->softc;
182 	if (sc == NULL)
183 		return;
184 
185 	g_shsec_remove_disk(cp);
186 	/* If there are no valid disks anymore, remove device. */
187 	if (LIST_EMPTY(&gp->consumer))
188 		g_shsec_destroy(sc, 1);
189 }
190 
191 static int
192 g_shsec_access(struct g_provider *pp, int dr, int dw, int de)
193 {
194 	struct g_consumer *cp1, *cp2, *tmp;
195 	struct g_shsec_softc *sc;
196 	struct g_geom *gp;
197 	int error;
198 
199 	gp = pp->geom;
200 	sc = gp->softc;
201 
202 	/* On first open, grab an extra "exclusive" bit */
203 	if (pp->acr == 0 && pp->acw == 0 && pp->ace == 0)
204 		de++;
205 	/* ... and let go of it on last close */
206 	if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 && (pp->ace + de) == 0)
207 		de--;
208 
209 	error = ENXIO;
210 	LIST_FOREACH_SAFE(cp1, &gp->consumer, consumer, tmp) {
211 		error = g_access(cp1, dr, dw, de);
212 		if (error != 0)
213 			goto fail;
214 		if (cp1->acr == 0 && cp1->acw == 0 && cp1->ace == 0 &&
215 		    cp1->flags & G_CF_ORPHAN) {
216 			g_detach(cp1);
217 			g_destroy_consumer(cp1);
218 		}
219 	}
220 
221 	/* If there are no valid disks anymore, remove device. */
222 	if (LIST_EMPTY(&gp->consumer))
223 		g_shsec_destroy(sc, 1);
224 
225 	return (error);
226 
227 fail:
228 	/* If we fail here, backout all previous changes. */
229 	LIST_FOREACH(cp2, &gp->consumer, consumer) {
230 		if (cp1 == cp2)
231 			break;
232 		g_access(cp2, -dr, -dw, -de);
233 	}
234 	return (error);
235 }
236 
237 static void
238 g_shsec_xor1(uint32_t *src, uint32_t *dst, ssize_t len)
239 {
240 
241 	for (; len > 0; len -= sizeof(uint32_t), dst++)
242 		*dst = *dst ^ *src++;
243 	KASSERT(len == 0, ("len != 0 (len=%zd)", len));
244 }
245 
246 static void
247 g_shsec_done(struct bio *bp)
248 {
249 	struct g_shsec_softc *sc;
250 	struct bio *pbp;
251 
252 	pbp = bp->bio_parent;
253 	sc = pbp->bio_to->geom->softc;
254 	if (bp->bio_error == 0)
255 		G_SHSEC_LOGREQ(2, bp, "Request done.");
256 	else {
257 		G_SHSEC_LOGREQ(0, bp, "Request failed (error=%d).",
258 		    bp->bio_error);
259 		if (pbp->bio_error == 0)
260 			pbp->bio_error = bp->bio_error;
261 	}
262 	if (pbp->bio_cmd == BIO_READ) {
263 		if ((pbp->bio_pflags & G_SHSEC_BFLAG_FIRST) != 0) {
264 			bcopy(bp->bio_data, pbp->bio_data, pbp->bio_length);
265 			pbp->bio_pflags = 0;
266 		} else {
267 			g_shsec_xor1((uint32_t *)bp->bio_data,
268 			    (uint32_t *)pbp->bio_data,
269 			    (ssize_t)pbp->bio_length);
270 		}
271 	}
272 	bzero(bp->bio_data, bp->bio_length);
273 	uma_zfree(g_shsec_zone, bp->bio_data);
274 	g_destroy_bio(bp);
275 	pbp->bio_inbed++;
276 	if (pbp->bio_children == pbp->bio_inbed) {
277 		pbp->bio_completed = pbp->bio_length;
278 		g_io_deliver(pbp, pbp->bio_error);
279 	}
280 }
281 
282 static void
283 g_shsec_xor2(uint32_t *rand, uint32_t *dst, ssize_t len)
284 {
285 
286 	for (; len > 0; len -= sizeof(uint32_t), dst++) {
287 		*rand = arc4random();
288 		*dst = *dst ^ *rand++;
289 	}
290 	KASSERT(len == 0, ("len != 0 (len=%zd)", len));
291 }
292 
293 static void
294 g_shsec_start(struct bio *bp)
295 {
296 	TAILQ_HEAD(, bio) queue = TAILQ_HEAD_INITIALIZER(queue);
297 	struct g_shsec_softc *sc;
298 	struct bio *cbp;
299 	uint32_t *dst;
300 	ssize_t len;
301 	u_int no;
302 	int error;
303 
304 	sc = bp->bio_to->geom->softc;
305 	/*
306 	 * If sc == NULL, provider's error should be set and g_shsec_start()
307 	 * should not be called at all.
308 	 */
309 	KASSERT(sc != NULL,
310 	    ("Provider's error should be set (error=%d)(device=%s).",
311 	    bp->bio_to->error, bp->bio_to->name));
312 
313 	G_SHSEC_LOGREQ(2, bp, "Request received.");
314 
315 	switch (bp->bio_cmd) {
316 	case BIO_READ:
317 	case BIO_WRITE:
318 	case BIO_FLUSH:
319 	case BIO_SPEEDUP:
320 		/*
321 		 * Only those requests are supported.
322 		 */
323 		break;
324 	case BIO_DELETE:
325 	case BIO_GETATTR:
326 		/* To which provider it should be delivered? */
327 	default:
328 		g_io_deliver(bp, EOPNOTSUPP);
329 		return;
330 	}
331 
332 	/*
333 	 * Allocate all bios first and calculate XOR.
334 	 */
335 	dst = NULL;
336 	len = bp->bio_length;
337 	if (bp->bio_cmd == BIO_READ)
338 		bp->bio_pflags = G_SHSEC_BFLAG_FIRST;
339 	for (no = 0; no < sc->sc_ndisks; no++) {
340 		cbp = g_clone_bio(bp);
341 		if (cbp == NULL) {
342 			error = ENOMEM;
343 			goto failure;
344 		}
345 		TAILQ_INSERT_TAIL(&queue, cbp, bio_queue);
346 
347 		/*
348 		 * Fill in the component buf structure.
349 		 */
350 		cbp->bio_done = g_shsec_done;
351 		cbp->bio_data = uma_zalloc(g_shsec_zone, M_NOWAIT);
352 		if (cbp->bio_data == NULL) {
353 			g_shsec_alloc_failed++;
354 			error = ENOMEM;
355 			goto failure;
356 		}
357 		cbp->bio_caller2 = sc->sc_disks[no];
358 		if (bp->bio_cmd == BIO_WRITE) {
359 			if (no == 0) {
360 				dst = (uint32_t *)cbp->bio_data;
361 				bcopy(bp->bio_data, dst, len);
362 			} else {
363 				g_shsec_xor2((uint32_t *)cbp->bio_data, dst,
364 				    len);
365 			}
366 		}
367 	}
368 	/*
369 	 * Fire off all allocated requests!
370 	 */
371 	while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
372 		struct g_consumer *cp;
373 
374 		TAILQ_REMOVE(&queue, cbp, bio_queue);
375 		cp = cbp->bio_caller2;
376 		cbp->bio_caller2 = NULL;
377 		cbp->bio_to = cp->provider;
378 		G_SHSEC_LOGREQ(2, cbp, "Sending request.");
379 		g_io_request(cbp, cp);
380 	}
381 	return;
382 failure:
383 	while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
384 		TAILQ_REMOVE(&queue, cbp, bio_queue);
385 		bp->bio_children--;
386 		if (cbp->bio_data != NULL) {
387 			bzero(cbp->bio_data, cbp->bio_length);
388 			uma_zfree(g_shsec_zone, cbp->bio_data);
389 		}
390 		g_destroy_bio(cbp);
391 	}
392 	if (bp->bio_error == 0)
393 		bp->bio_error = error;
394 	g_io_deliver(bp, bp->bio_error);
395 }
396 
397 static void
398 g_shsec_check_and_run(struct g_shsec_softc *sc)
399 {
400 	off_t mediasize, ms;
401 	u_int no, sectorsize = 0;
402 
403 	if (g_shsec_nvalid(sc) != sc->sc_ndisks)
404 		return;
405 
406 	sc->sc_provider = g_new_providerf(sc->sc_geom, "shsec/%s", sc->sc_name);
407 	/*
408 	 * Find the smallest disk.
409 	 */
410 	mediasize = sc->sc_disks[0]->provider->mediasize;
411 	mediasize -= sc->sc_disks[0]->provider->sectorsize;
412 	sectorsize = sc->sc_disks[0]->provider->sectorsize;
413 	for (no = 1; no < sc->sc_ndisks; no++) {
414 		ms = sc->sc_disks[no]->provider->mediasize;
415 		ms -= sc->sc_disks[no]->provider->sectorsize;
416 		if (ms < mediasize)
417 			mediasize = ms;
418 		sectorsize = lcm(sectorsize,
419 		    sc->sc_disks[no]->provider->sectorsize);
420 	}
421 	sc->sc_provider->sectorsize = sectorsize;
422 	sc->sc_provider->mediasize = mediasize;
423 	g_error_provider(sc->sc_provider, 0);
424 
425 	G_SHSEC_DEBUG(0, "Device %s activated.", sc->sc_name);
426 }
427 
428 static int
429 g_shsec_read_metadata(struct g_consumer *cp, struct g_shsec_metadata *md)
430 {
431 	struct g_provider *pp;
432 	u_char *buf;
433 	int error;
434 
435 	g_topology_assert();
436 
437 	error = g_access(cp, 1, 0, 0);
438 	if (error != 0)
439 		return (error);
440 	pp = cp->provider;
441 	g_topology_unlock();
442 	buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
443 	    &error);
444 	g_topology_lock();
445 	g_access(cp, -1, 0, 0);
446 	if (buf == NULL)
447 		return (error);
448 
449 	/* Decode metadata. */
450 	shsec_metadata_decode(buf, md);
451 	g_free(buf);
452 
453 	return (0);
454 }
455 
456 /*
457  * Add disk to given device.
458  */
459 static int
460 g_shsec_add_disk(struct g_shsec_softc *sc, struct g_provider *pp, u_int no)
461 {
462 	struct g_consumer *cp, *fcp;
463 	struct g_geom *gp;
464 	struct g_shsec_metadata md;
465 	int error;
466 
467 	/* Metadata corrupted? */
468 	if (no >= sc->sc_ndisks)
469 		return (EINVAL);
470 
471 	/* Check if disk is not already attached. */
472 	if (sc->sc_disks[no] != NULL)
473 		return (EEXIST);
474 
475 	gp = sc->sc_geom;
476 	fcp = LIST_FIRST(&gp->consumer);
477 
478 	cp = g_new_consumer(gp);
479 	error = g_attach(cp, pp);
480 	if (error != 0) {
481 		g_destroy_consumer(cp);
482 		return (error);
483 	}
484 
485 	if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0)) {
486 		error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
487 		if (error != 0) {
488 			g_detach(cp);
489 			g_destroy_consumer(cp);
490 			return (error);
491 		}
492 	}
493 
494 	/* Reread metadata. */
495 	error = g_shsec_read_metadata(cp, &md);
496 	if (error != 0)
497 		goto fail;
498 
499 	if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0 ||
500 	    strcmp(md.md_name, sc->sc_name) != 0 || md.md_id != sc->sc_id) {
501 		G_SHSEC_DEBUG(0, "Metadata on %s changed.", pp->name);
502 		goto fail;
503 	}
504 
505 	cp->private = sc;
506 	cp->index = no;
507 	sc->sc_disks[no] = cp;
508 
509 	G_SHSEC_DEBUG(0, "Disk %s attached to %s.", pp->name, sc->sc_name);
510 
511 	g_shsec_check_and_run(sc);
512 
513 	return (0);
514 fail:
515 	if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0))
516 		g_access(cp, -fcp->acr, -fcp->acw, -fcp->ace);
517 	g_detach(cp);
518 	g_destroy_consumer(cp);
519 	return (error);
520 }
521 
522 static struct g_geom *
523 g_shsec_create(struct g_class *mp, const struct g_shsec_metadata *md)
524 {
525 	struct g_shsec_softc *sc;
526 	struct g_geom *gp;
527 	u_int no;
528 
529 	G_SHSEC_DEBUG(1, "Creating device %s (id=%u).", md->md_name, md->md_id);
530 
531 	/* Two disks is minimum. */
532 	if (md->md_all < 2) {
533 		G_SHSEC_DEBUG(0, "Too few disks defined for %s.", md->md_name);
534 		return (NULL);
535 	}
536 
537 	/* Check for duplicate unit */
538 	LIST_FOREACH(gp, &mp->geom, geom) {
539 		sc = gp->softc;
540 		if (sc != NULL && strcmp(sc->sc_name, md->md_name) == 0) {
541 			G_SHSEC_DEBUG(0, "Device %s already configured.",
542 			    sc->sc_name);
543 			return (NULL);
544 		}
545 	}
546 	gp = g_new_geomf(mp, "%s", md->md_name);
547 	sc = malloc(sizeof(*sc), M_SHSEC, M_WAITOK | M_ZERO);
548 	gp->start = g_shsec_start;
549 	gp->spoiled = g_shsec_orphan;
550 	gp->orphan = g_shsec_orphan;
551 	gp->access = g_shsec_access;
552 	gp->dumpconf = g_shsec_dumpconf;
553 
554 	sc->sc_id = md->md_id;
555 	sc->sc_ndisks = md->md_all;
556 	sc->sc_disks = malloc(sizeof(struct g_consumer *) * sc->sc_ndisks,
557 	    M_SHSEC, M_WAITOK | M_ZERO);
558 	for (no = 0; no < sc->sc_ndisks; no++)
559 		sc->sc_disks[no] = NULL;
560 
561 	gp->softc = sc;
562 	sc->sc_geom = gp;
563 	sc->sc_provider = NULL;
564 
565 	G_SHSEC_DEBUG(0, "Device %s created (id=%u).", sc->sc_name, sc->sc_id);
566 
567 	return (gp);
568 }
569 
570 static int
571 g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force)
572 {
573 	struct g_provider *pp;
574 	struct g_geom *gp;
575 	u_int no;
576 
577 	g_topology_assert();
578 
579 	if (sc == NULL)
580 		return (ENXIO);
581 
582 	pp = sc->sc_provider;
583 	if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
584 		if (force) {
585 			G_SHSEC_DEBUG(0, "Device %s is still open, so it "
586 			    "can't be definitely removed.", pp->name);
587 		} else {
588 			G_SHSEC_DEBUG(1,
589 			    "Device %s is still open (r%dw%de%d).", pp->name,
590 			    pp->acr, pp->acw, pp->ace);
591 			return (EBUSY);
592 		}
593 	}
594 
595 	for (no = 0; no < sc->sc_ndisks; no++) {
596 		if (sc->sc_disks[no] != NULL)
597 			g_shsec_remove_disk(sc->sc_disks[no]);
598 	}
599 
600 	gp = sc->sc_geom;
601 	gp->softc = NULL;
602 	KASSERT(sc->sc_provider == NULL, ("Provider still exists? (device=%s)",
603 	    gp->name));
604 	free(sc->sc_disks, M_SHSEC);
605 	free(sc, M_SHSEC);
606 
607 	pp = LIST_FIRST(&gp->provider);
608 	if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
609 		G_SHSEC_DEBUG(0, "Device %s destroyed.", gp->name);
610 
611 	g_wither_geom(gp, ENXIO);
612 
613 	return (0);
614 }
615 
616 static int
617 g_shsec_destroy_geom(struct gctl_req *req __unused, struct g_class *mp __unused,
618     struct g_geom *gp)
619 {
620 	struct g_shsec_softc *sc;
621 
622 	sc = gp->softc;
623 	return (g_shsec_destroy(sc, 0));
624 }
625 
626 static struct g_geom *
627 g_shsec_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
628 {
629 	struct g_shsec_metadata md;
630 	struct g_shsec_softc *sc;
631 	struct g_consumer *cp;
632 	struct g_geom *gp;
633 	int error;
634 
635 	g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
636 	g_topology_assert();
637 
638 	/* Skip providers that are already open for writing. */
639 	if (pp->acw > 0)
640 		return (NULL);
641 
642 	G_SHSEC_DEBUG(3, "Tasting %s.", pp->name);
643 
644 	gp = g_new_geomf(mp, "shsec:taste");
645 	gp->start = g_shsec_start;
646 	gp->access = g_shsec_access;
647 	gp->orphan = g_shsec_orphan;
648 	cp = g_new_consumer(gp);
649 	g_attach(cp, pp);
650 	error = g_shsec_read_metadata(cp, &md);
651 	g_detach(cp);
652 	g_destroy_consumer(cp);
653 	g_destroy_geom(gp);
654 	if (error != 0)
655 		return (NULL);
656 	gp = NULL;
657 
658 	if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0)
659 		return (NULL);
660 	if (md.md_version > G_SHSEC_VERSION) {
661 		G_SHSEC_DEBUG(0, "Kernel module is too old to handle %s.\n",
662 		    pp->name);
663 		return (NULL);
664 	}
665 	/*
666 	 * Backward compatibility:
667 	 */
668 	/* There was no md_provsize field in earlier versions of metadata. */
669 	if (md.md_version < 1)
670 		md.md_provsize = pp->mediasize;
671 
672 	if (md.md_provider[0] != '\0' &&
673 	    !g_compare_names(md.md_provider, pp->name))
674 		return (NULL);
675 	if (md.md_provsize != pp->mediasize)
676 		return (NULL);
677 
678 	/*
679 	 * Let's check if device already exists.
680 	 */
681 	sc = NULL;
682 	LIST_FOREACH(gp, &mp->geom, geom) {
683 		sc = gp->softc;
684 		if (sc == NULL)
685 			continue;
686 		if (strcmp(md.md_name, sc->sc_name) != 0)
687 			continue;
688 		if (md.md_id != sc->sc_id)
689 			continue;
690 		break;
691 	}
692 	if (gp != NULL) {
693 		G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
694 		error = g_shsec_add_disk(sc, pp, md.md_no);
695 		if (error != 0) {
696 			G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
697 			    pp->name, gp->name, error);
698 			return (NULL);
699 		}
700 	} else {
701 		gp = g_shsec_create(mp, &md);
702 		if (gp == NULL) {
703 			G_SHSEC_DEBUG(0, "Cannot create device %s.", md.md_name);
704 			return (NULL);
705 		}
706 		sc = gp->softc;
707 		G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
708 		error = g_shsec_add_disk(sc, pp, md.md_no);
709 		if (error != 0) {
710 			G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
711 			    pp->name, gp->name, error);
712 			g_shsec_destroy(sc, 1);
713 			return (NULL);
714 		}
715 	}
716 	return (gp);
717 }
718 
719 static struct g_shsec_softc *
720 g_shsec_find_device(struct g_class *mp, const char *name)
721 {
722 	struct g_shsec_softc *sc;
723 	struct g_geom *gp;
724 
725 	LIST_FOREACH(gp, &mp->geom, geom) {
726 		sc = gp->softc;
727 		if (sc == NULL)
728 			continue;
729 		if (strcmp(sc->sc_name, name) == 0)
730 			return (sc);
731 	}
732 	return (NULL);
733 }
734 
735 static void
736 g_shsec_ctl_destroy(struct gctl_req *req, struct g_class *mp)
737 {
738 	struct g_shsec_softc *sc;
739 	int *force, *nargs, error;
740 	const char *name;
741 	char param[16];
742 	u_int i;
743 
744 	g_topology_assert();
745 
746 	nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
747 	if (nargs == NULL) {
748 		gctl_error(req, "No '%s' argument.", "nargs");
749 		return;
750 	}
751 	if (*nargs <= 0) {
752 		gctl_error(req, "Missing device(s).");
753 		return;
754 	}
755 	force = gctl_get_paraml(req, "force", sizeof(*force));
756 	if (force == NULL) {
757 		gctl_error(req, "No '%s' argument.", "force");
758 		return;
759 	}
760 
761 	for (i = 0; i < (u_int)*nargs; i++) {
762 		snprintf(param, sizeof(param), "arg%u", i);
763 		name = gctl_get_asciiparam(req, param);
764 		if (name == NULL) {
765 			gctl_error(req, "No 'arg%u' argument.", i);
766 			return;
767 		}
768 		sc = g_shsec_find_device(mp, name);
769 		if (sc == NULL) {
770 			gctl_error(req, "No such device: %s.", name);
771 			return;
772 		}
773 		error = g_shsec_destroy(sc, *force);
774 		if (error != 0) {
775 			gctl_error(req, "Cannot destroy device %s (error=%d).",
776 			    sc->sc_name, error);
777 			return;
778 		}
779 	}
780 }
781 
782 static void
783 g_shsec_config(struct gctl_req *req, struct g_class *mp, const char *verb)
784 {
785 	uint32_t *version;
786 
787 	g_topology_assert();
788 
789 	version = gctl_get_paraml(req, "version", sizeof(*version));
790 	if (version == NULL) {
791 		gctl_error(req, "No '%s' argument.", "version");
792 		return;
793 	}
794 	if (*version != G_SHSEC_VERSION) {
795 		gctl_error(req, "Userland and kernel parts are out of sync.");
796 		return;
797 	}
798 
799 	if (strcmp(verb, "stop") == 0) {
800 		g_shsec_ctl_destroy(req, mp);
801 		return;
802 	}
803 
804 	gctl_error(req, "Unknown verb.");
805 }
806 
807 static void
808 g_shsec_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
809     struct g_consumer *cp, struct g_provider *pp)
810 {
811 	struct g_shsec_softc *sc;
812 
813 	sc = gp->softc;
814 	if (sc == NULL)
815 		return;
816 	if (pp != NULL) {
817 		/* Nothing here. */
818 	} else if (cp != NULL) {
819 		sbuf_printf(sb, "%s<Number>%u</Number>\n", indent,
820 		    (u_int)cp->index);
821 	} else {
822 		sbuf_printf(sb, "%s<ID>%u</ID>\n", indent, (u_int)sc->sc_id);
823 		sbuf_printf(sb, "%s<Status>Total=%u, Online=%u</Status>\n",
824 		    indent, sc->sc_ndisks, g_shsec_nvalid(sc));
825 		sbuf_printf(sb, "%s<State>", indent);
826 		if (sc->sc_provider != NULL && sc->sc_provider->error == 0)
827 			sbuf_printf(sb, "UP");
828 		else
829 			sbuf_printf(sb, "DOWN");
830 		sbuf_printf(sb, "</State>\n");
831 	}
832 }
833 
834 DECLARE_GEOM_CLASS(g_shsec_class, g_shsec);
835 MODULE_VERSION(geom_shsec, 0);
836