xref: /freebsd/sys/geom/shsec/g_shsec.c (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
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 		g_access(cp, -cp->acr, -cp->acw, -cp->ace);
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 (g_shsec_nvalid(sc) == 0)
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;
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 	if (sc == NULL) {
203 		/*
204 		 * It looks like geom is being withered.
205 		 * In that case we allow only negative requests.
206 		 */
207 		KASSERT(dr <= 0 && dw <= 0 && de <= 0,
208 		    ("Positive access request (device=%s).", pp->name));
209 		if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 &&
210 		    (pp->ace + de) == 0) {
211 			G_SHSEC_DEBUG(0, "Device %s definitely destroyed.",
212 			    gp->name);
213 		}
214 		return (0);
215 	}
216 
217 	/* On first open, grab an extra "exclusive" bit */
218 	if (pp->acr == 0 && pp->acw == 0 && pp->ace == 0)
219 		de++;
220 	/* ... and let go of it on last close */
221 	if ((pp->acr + dr) == 0 && (pp->acw + dw) == 0 && (pp->ace + de) == 0)
222 		de--;
223 
224 	error = ENXIO;
225 	LIST_FOREACH(cp1, &gp->consumer, consumer) {
226 		error = g_access(cp1, dr, dw, de);
227 		if (error == 0)
228 			continue;
229 		/*
230 		 * If we fail here, backout all previous changes.
231 		 */
232 		LIST_FOREACH(cp2, &gp->consumer, consumer) {
233 			if (cp1 == cp2)
234 				return (error);
235 			g_access(cp2, -dr, -dw, -de);
236 		}
237 		/* NOTREACHED */
238 	}
239 
240 	return (error);
241 }
242 
243 static void
244 g_shsec_xor1(uint32_t *src, uint32_t *dst, ssize_t len)
245 {
246 
247 	for (; len > 0; len -= sizeof(uint32_t), dst++)
248 		*dst = *dst ^ *src++;
249 	KASSERT(len == 0, ("len != 0 (len=%zd)", len));
250 }
251 
252 static void
253 g_shsec_done(struct bio *bp)
254 {
255 	struct g_shsec_softc *sc;
256 	struct bio *pbp;
257 
258 	pbp = bp->bio_parent;
259 	sc = pbp->bio_to->geom->softc;
260 	if (bp->bio_error == 0)
261 		G_SHSEC_LOGREQ(2, bp, "Request done.");
262 	else {
263 		G_SHSEC_LOGREQ(0, bp, "Request failed (error=%d).",
264 		    bp->bio_error);
265 		if (pbp->bio_error == 0)
266 			pbp->bio_error = bp->bio_error;
267 	}
268 	if (pbp->bio_cmd == BIO_READ) {
269 		if ((pbp->bio_pflags & G_SHSEC_BFLAG_FIRST) != 0) {
270 			bcopy(bp->bio_data, pbp->bio_data, pbp->bio_length);
271 			pbp->bio_pflags = 0;
272 		} else {
273 			g_shsec_xor1((uint32_t *)bp->bio_data,
274 			    (uint32_t *)pbp->bio_data,
275 			    (ssize_t)pbp->bio_length);
276 		}
277 	}
278 	bzero(bp->bio_data, bp->bio_length);
279 	uma_zfree(g_shsec_zone, bp->bio_data);
280 	g_destroy_bio(bp);
281 	pbp->bio_inbed++;
282 	if (pbp->bio_children == pbp->bio_inbed) {
283 		pbp->bio_completed = pbp->bio_length;
284 		g_io_deliver(pbp, pbp->bio_error);
285 	}
286 }
287 
288 static void
289 g_shsec_xor2(uint32_t *rand, uint32_t *dst, ssize_t len)
290 {
291 
292 	for (; len > 0; len -= sizeof(uint32_t), dst++) {
293 		*rand = arc4random();
294 		*dst = *dst ^ *rand++;
295 	}
296 	KASSERT(len == 0, ("len != 0 (len=%zd)", len));
297 }
298 
299 static void
300 g_shsec_start(struct bio *bp)
301 {
302 	TAILQ_HEAD(, bio) queue = TAILQ_HEAD_INITIALIZER(queue);
303 	struct g_shsec_softc *sc;
304 	struct bio *cbp;
305 	uint32_t *dst;
306 	ssize_t len;
307 	u_int no;
308 	int error;
309 
310 	sc = bp->bio_to->geom->softc;
311 	/*
312 	 * If sc == NULL, provider's error should be set and g_shsec_start()
313 	 * should not be called at all.
314 	 */
315 	KASSERT(sc != NULL,
316 	    ("Provider's error should be set (error=%d)(device=%s).",
317 	    bp->bio_to->error, bp->bio_to->name));
318 
319 	G_SHSEC_LOGREQ(2, bp, "Request received.");
320 
321 	switch (bp->bio_cmd) {
322 	case BIO_READ:
323 	case BIO_WRITE:
324 	case BIO_FLUSH:
325 		/*
326 		 * Only those requests are supported.
327 		 */
328 		break;
329 	case BIO_DELETE:
330 	case BIO_GETATTR:
331 		/* To which provider it should be delivered? */
332 	default:
333 		g_io_deliver(bp, EOPNOTSUPP);
334 		return;
335 	}
336 
337 	/*
338 	 * Allocate all bios first and calculate XOR.
339 	 */
340 	dst = NULL;
341 	len = bp->bio_length;
342 	if (bp->bio_cmd == BIO_READ)
343 		bp->bio_pflags = G_SHSEC_BFLAG_FIRST;
344 	for (no = 0; no < sc->sc_ndisks; no++) {
345 		cbp = g_clone_bio(bp);
346 		if (cbp == NULL) {
347 			error = ENOMEM;
348 			goto failure;
349 		}
350 		TAILQ_INSERT_TAIL(&queue, cbp, bio_queue);
351 
352 		/*
353 		 * Fill in the component buf structure.
354 		 */
355 		cbp->bio_done = g_shsec_done;
356 		cbp->bio_data = uma_zalloc(g_shsec_zone, M_NOWAIT);
357 		if (cbp->bio_data == NULL) {
358 			g_shsec_alloc_failed++;
359 			error = ENOMEM;
360 			goto failure;
361 		}
362 		cbp->bio_caller2 = sc->sc_disks[no];
363 		if (bp->bio_cmd == BIO_WRITE) {
364 			if (no == 0) {
365 				dst = (uint32_t *)cbp->bio_data;
366 				bcopy(bp->bio_data, dst, len);
367 			} else {
368 				g_shsec_xor2((uint32_t *)cbp->bio_data, dst,
369 				    len);
370 			}
371 		}
372 	}
373 	/*
374 	 * Fire off all allocated requests!
375 	 */
376 	while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
377 		struct g_consumer *cp;
378 
379 		TAILQ_REMOVE(&queue, cbp, bio_queue);
380 		cp = cbp->bio_caller2;
381 		cbp->bio_caller2 = NULL;
382 		cbp->bio_to = cp->provider;
383 		G_SHSEC_LOGREQ(2, cbp, "Sending request.");
384 		g_io_request(cbp, cp);
385 	}
386 	return;
387 failure:
388 	while ((cbp = TAILQ_FIRST(&queue)) != NULL) {
389 		TAILQ_REMOVE(&queue, cbp, bio_queue);
390 		bp->bio_children--;
391 		if (cbp->bio_data != NULL) {
392 			bzero(cbp->bio_data, cbp->bio_length);
393 			uma_zfree(g_shsec_zone, cbp->bio_data);
394 		}
395 		g_destroy_bio(cbp);
396 	}
397 	if (bp->bio_error == 0)
398 		bp->bio_error = error;
399 	g_io_deliver(bp, bp->bio_error);
400 }
401 
402 static void
403 g_shsec_check_and_run(struct g_shsec_softc *sc)
404 {
405 	off_t mediasize, ms;
406 	u_int no, sectorsize = 0;
407 
408 	if (g_shsec_nvalid(sc) != sc->sc_ndisks)
409 		return;
410 
411 	sc->sc_provider = g_new_providerf(sc->sc_geom, "shsec/%s", sc->sc_name);
412 	/*
413 	 * Find the smallest disk.
414 	 */
415 	mediasize = sc->sc_disks[0]->provider->mediasize;
416 	mediasize -= sc->sc_disks[0]->provider->sectorsize;
417 	sectorsize = sc->sc_disks[0]->provider->sectorsize;
418 	for (no = 1; no < sc->sc_ndisks; no++) {
419 		ms = sc->sc_disks[no]->provider->mediasize;
420 		ms -= sc->sc_disks[no]->provider->sectorsize;
421 		if (ms < mediasize)
422 			mediasize = ms;
423 		sectorsize = lcm(sectorsize,
424 		    sc->sc_disks[no]->provider->sectorsize);
425 	}
426 	sc->sc_provider->sectorsize = sectorsize;
427 	sc->sc_provider->mediasize = mediasize;
428 	g_error_provider(sc->sc_provider, 0);
429 
430 	G_SHSEC_DEBUG(0, "Device %s activated.", sc->sc_name);
431 }
432 
433 static int
434 g_shsec_read_metadata(struct g_consumer *cp, struct g_shsec_metadata *md)
435 {
436 	struct g_provider *pp;
437 	u_char *buf;
438 	int error;
439 
440 	g_topology_assert();
441 
442 	error = g_access(cp, 1, 0, 0);
443 	if (error != 0)
444 		return (error);
445 	pp = cp->provider;
446 	g_topology_unlock();
447 	buf = g_read_data(cp, pp->mediasize - pp->sectorsize, pp->sectorsize,
448 	    &error);
449 	g_topology_lock();
450 	g_access(cp, -1, 0, 0);
451 	if (buf == NULL)
452 		return (error);
453 
454 	/* Decode metadata. */
455 	shsec_metadata_decode(buf, md);
456 	g_free(buf);
457 
458 	return (0);
459 }
460 
461 /*
462  * Add disk to given device.
463  */
464 static int
465 g_shsec_add_disk(struct g_shsec_softc *sc, struct g_provider *pp, u_int no)
466 {
467 	struct g_consumer *cp, *fcp;
468 	struct g_geom *gp;
469 	struct g_shsec_metadata md;
470 	int error;
471 
472 	/* Metadata corrupted? */
473 	if (no >= sc->sc_ndisks)
474 		return (EINVAL);
475 
476 	/* Check if disk is not already attached. */
477 	if (sc->sc_disks[no] != NULL)
478 		return (EEXIST);
479 
480 	gp = sc->sc_geom;
481 	fcp = LIST_FIRST(&gp->consumer);
482 
483 	cp = g_new_consumer(gp);
484 	error = g_attach(cp, pp);
485 	if (error != 0) {
486 		g_destroy_consumer(cp);
487 		return (error);
488 	}
489 
490 	if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0)) {
491 		error = g_access(cp, fcp->acr, fcp->acw, fcp->ace);
492 		if (error != 0) {
493 			g_detach(cp);
494 			g_destroy_consumer(cp);
495 			return (error);
496 		}
497 	}
498 
499 	/* Reread metadata. */
500 	error = g_shsec_read_metadata(cp, &md);
501 	if (error != 0)
502 		goto fail;
503 
504 	if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0 ||
505 	    strcmp(md.md_name, sc->sc_name) != 0 || md.md_id != sc->sc_id) {
506 		G_SHSEC_DEBUG(0, "Metadata on %s changed.", pp->name);
507 		goto fail;
508 	}
509 
510 	cp->private = sc;
511 	cp->index = no;
512 	sc->sc_disks[no] = cp;
513 
514 	G_SHSEC_DEBUG(0, "Disk %s attached to %s.", pp->name, sc->sc_name);
515 
516 	g_shsec_check_and_run(sc);
517 
518 	return (0);
519 fail:
520 	if (fcp != NULL && (fcp->acr > 0 || fcp->acw > 0 || fcp->ace > 0))
521 		g_access(cp, -fcp->acr, -fcp->acw, -fcp->ace);
522 	g_detach(cp);
523 	g_destroy_consumer(cp);
524 	return (error);
525 }
526 
527 static struct g_geom *
528 g_shsec_create(struct g_class *mp, const struct g_shsec_metadata *md)
529 {
530 	struct g_shsec_softc *sc;
531 	struct g_geom *gp;
532 	u_int no;
533 
534 	G_SHSEC_DEBUG(1, "Creating device %s (id=%u).", md->md_name, md->md_id);
535 
536 	/* Two disks is minimum. */
537 	if (md->md_all < 2) {
538 		G_SHSEC_DEBUG(0, "Too few disks defined for %s.", md->md_name);
539 		return (NULL);
540 	}
541 
542 	/* Check for duplicate unit */
543 	LIST_FOREACH(gp, &mp->geom, geom) {
544 		sc = gp->softc;
545 		if (sc != NULL && strcmp(sc->sc_name, md->md_name) == 0) {
546 			G_SHSEC_DEBUG(0, "Device %s already configured.",
547 			    sc->sc_name);
548 			return (NULL);
549 		}
550 	}
551 	gp = g_new_geomf(mp, "%s", md->md_name);
552 	sc = malloc(sizeof(*sc), M_SHSEC, M_WAITOK | M_ZERO);
553 	gp->start = g_shsec_start;
554 	gp->spoiled = g_shsec_orphan;
555 	gp->orphan = g_shsec_orphan;
556 	gp->access = g_shsec_access;
557 	gp->dumpconf = g_shsec_dumpconf;
558 
559 	sc->sc_id = md->md_id;
560 	sc->sc_ndisks = md->md_all;
561 	sc->sc_disks = malloc(sizeof(struct g_consumer *) * sc->sc_ndisks,
562 	    M_SHSEC, M_WAITOK | M_ZERO);
563 	for (no = 0; no < sc->sc_ndisks; no++)
564 		sc->sc_disks[no] = NULL;
565 
566 	gp->softc = sc;
567 	sc->sc_geom = gp;
568 	sc->sc_provider = NULL;
569 
570 	G_SHSEC_DEBUG(0, "Device %s created (id=%u).", sc->sc_name, sc->sc_id);
571 
572 	return (gp);
573 }
574 
575 static int
576 g_shsec_destroy(struct g_shsec_softc *sc, boolean_t force)
577 {
578 	struct g_provider *pp;
579 	struct g_geom *gp;
580 	u_int no;
581 
582 	g_topology_assert();
583 
584 	if (sc == NULL)
585 		return (ENXIO);
586 
587 	pp = sc->sc_provider;
588 	if (pp != NULL && (pp->acr != 0 || pp->acw != 0 || pp->ace != 0)) {
589 		if (force) {
590 			G_SHSEC_DEBUG(0, "Device %s is still open, so it "
591 			    "can't be definitely removed.", pp->name);
592 		} else {
593 			G_SHSEC_DEBUG(1,
594 			    "Device %s is still open (r%dw%de%d).", pp->name,
595 			    pp->acr, pp->acw, pp->ace);
596 			return (EBUSY);
597 		}
598 	}
599 
600 	for (no = 0; no < sc->sc_ndisks; no++) {
601 		if (sc->sc_disks[no] != NULL)
602 			g_shsec_remove_disk(sc->sc_disks[no]);
603 	}
604 
605 	gp = sc->sc_geom;
606 	gp->softc = NULL;
607 	KASSERT(sc->sc_provider == NULL, ("Provider still exists? (device=%s)",
608 	    gp->name));
609 	free(sc->sc_disks, M_SHSEC);
610 	free(sc, M_SHSEC);
611 
612 	pp = LIST_FIRST(&gp->provider);
613 	if (pp == NULL || (pp->acr == 0 && pp->acw == 0 && pp->ace == 0))
614 		G_SHSEC_DEBUG(0, "Device %s destroyed.", gp->name);
615 
616 	g_wither_geom(gp, ENXIO);
617 
618 	return (0);
619 }
620 
621 static int
622 g_shsec_destroy_geom(struct gctl_req *req __unused, struct g_class *mp __unused,
623     struct g_geom *gp)
624 {
625 	struct g_shsec_softc *sc;
626 
627 	sc = gp->softc;
628 	return (g_shsec_destroy(sc, 0));
629 }
630 
631 static struct g_geom *
632 g_shsec_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
633 {
634 	struct g_shsec_metadata md;
635 	struct g_shsec_softc *sc;
636 	struct g_consumer *cp;
637 	struct g_geom *gp;
638 	int error;
639 
640 	g_trace(G_T_TOPOLOGY, "%s(%s, %s)", __func__, mp->name, pp->name);
641 	g_topology_assert();
642 
643 	/* Skip providers that are already open for writing. */
644 	if (pp->acw > 0)
645 		return (NULL);
646 
647 	G_SHSEC_DEBUG(3, "Tasting %s.", pp->name);
648 
649 	gp = g_new_geomf(mp, "shsec:taste");
650 	gp->start = g_shsec_start;
651 	gp->access = g_shsec_access;
652 	gp->orphan = g_shsec_orphan;
653 	cp = g_new_consumer(gp);
654 	g_attach(cp, pp);
655 	error = g_shsec_read_metadata(cp, &md);
656 	g_detach(cp);
657 	g_destroy_consumer(cp);
658 	g_destroy_geom(gp);
659 	if (error != 0)
660 		return (NULL);
661 	gp = NULL;
662 
663 	if (strcmp(md.md_magic, G_SHSEC_MAGIC) != 0)
664 		return (NULL);
665 	if (md.md_version > G_SHSEC_VERSION) {
666 		G_SHSEC_DEBUG(0, "Kernel module is too old to handle %s.\n",
667 		    pp->name);
668 		return (NULL);
669 	}
670 	/*
671 	 * Backward compatibility:
672 	 */
673 	/* There was no md_provsize field in earlier versions of metadata. */
674 	if (md.md_version < 1)
675 		md.md_provsize = pp->mediasize;
676 
677 	if (md.md_provider[0] != '\0' &&
678 	    !g_compare_names(md.md_provider, pp->name))
679 		return (NULL);
680 	if (md.md_provsize != pp->mediasize)
681 		return (NULL);
682 
683 	/*
684 	 * Let's check if device already exists.
685 	 */
686 	sc = NULL;
687 	LIST_FOREACH(gp, &mp->geom, geom) {
688 		sc = gp->softc;
689 		if (sc == NULL)
690 			continue;
691 		if (strcmp(md.md_name, sc->sc_name) != 0)
692 			continue;
693 		if (md.md_id != sc->sc_id)
694 			continue;
695 		break;
696 	}
697 	if (gp != NULL) {
698 		G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
699 		error = g_shsec_add_disk(sc, pp, md.md_no);
700 		if (error != 0) {
701 			G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
702 			    pp->name, gp->name, error);
703 			return (NULL);
704 		}
705 	} else {
706 		gp = g_shsec_create(mp, &md);
707 		if (gp == NULL) {
708 			G_SHSEC_DEBUG(0, "Cannot create device %s.", md.md_name);
709 			return (NULL);
710 		}
711 		sc = gp->softc;
712 		G_SHSEC_DEBUG(1, "Adding disk %s to %s.", pp->name, gp->name);
713 		error = g_shsec_add_disk(sc, pp, md.md_no);
714 		if (error != 0) {
715 			G_SHSEC_DEBUG(0, "Cannot add disk %s to %s (error=%d).",
716 			    pp->name, gp->name, error);
717 			g_shsec_destroy(sc, 1);
718 			return (NULL);
719 		}
720 	}
721 	return (gp);
722 }
723 
724 static struct g_shsec_softc *
725 g_shsec_find_device(struct g_class *mp, const char *name)
726 {
727 	struct g_shsec_softc *sc;
728 	struct g_geom *gp;
729 
730 	LIST_FOREACH(gp, &mp->geom, geom) {
731 		sc = gp->softc;
732 		if (sc == NULL)
733 			continue;
734 		if (strcmp(sc->sc_name, name) == 0)
735 			return (sc);
736 	}
737 	return (NULL);
738 }
739 
740 static void
741 g_shsec_ctl_destroy(struct gctl_req *req, struct g_class *mp)
742 {
743 	struct g_shsec_softc *sc;
744 	int *force, *nargs, error;
745 	const char *name;
746 	char param[16];
747 	u_int i;
748 
749 	g_topology_assert();
750 
751 	nargs = gctl_get_paraml(req, "nargs", sizeof(*nargs));
752 	if (nargs == NULL) {
753 		gctl_error(req, "No '%s' argument.", "nargs");
754 		return;
755 	}
756 	if (*nargs <= 0) {
757 		gctl_error(req, "Missing device(s).");
758 		return;
759 	}
760 	force = gctl_get_paraml(req, "force", sizeof(*force));
761 	if (force == NULL) {
762 		gctl_error(req, "No '%s' argument.", "force");
763 		return;
764 	}
765 
766 	for (i = 0; i < (u_int)*nargs; i++) {
767 		snprintf(param, sizeof(param), "arg%u", i);
768 		name = gctl_get_asciiparam(req, param);
769 		if (name == NULL) {
770 			gctl_error(req, "No 'arg%u' argument.", i);
771 			return;
772 		}
773 		sc = g_shsec_find_device(mp, name);
774 		if (sc == NULL) {
775 			gctl_error(req, "No such device: %s.", name);
776 			return;
777 		}
778 		error = g_shsec_destroy(sc, *force);
779 		if (error != 0) {
780 			gctl_error(req, "Cannot destroy device %s (error=%d).",
781 			    sc->sc_name, error);
782 			return;
783 		}
784 	}
785 }
786 
787 static void
788 g_shsec_config(struct gctl_req *req, struct g_class *mp, const char *verb)
789 {
790 	uint32_t *version;
791 
792 	g_topology_assert();
793 
794 	version = gctl_get_paraml(req, "version", sizeof(*version));
795 	if (version == NULL) {
796 		gctl_error(req, "No '%s' argument.", "version");
797 		return;
798 	}
799 	if (*version != G_SHSEC_VERSION) {
800 		gctl_error(req, "Userland and kernel parts are out of sync.");
801 		return;
802 	}
803 
804 	if (strcmp(verb, "stop") == 0) {
805 		g_shsec_ctl_destroy(req, mp);
806 		return;
807 	}
808 
809 	gctl_error(req, "Unknown verb.");
810 }
811 
812 static void
813 g_shsec_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp,
814     struct g_consumer *cp, struct g_provider *pp)
815 {
816 	struct g_shsec_softc *sc;
817 
818 	sc = gp->softc;
819 	if (sc == NULL)
820 		return;
821 	if (pp != NULL) {
822 		/* Nothing here. */
823 	} else if (cp != NULL) {
824 		sbuf_printf(sb, "%s<Number>%u</Number>\n", indent,
825 		    (u_int)cp->index);
826 	} else {
827 		sbuf_printf(sb, "%s<ID>%u</ID>\n", indent, (u_int)sc->sc_id);
828 		sbuf_printf(sb, "%s<Status>Total=%u, Online=%u</Status>\n",
829 		    indent, sc->sc_ndisks, g_shsec_nvalid(sc));
830 		sbuf_printf(sb, "%s<State>", indent);
831 		if (sc->sc_provider != NULL && sc->sc_provider->error == 0)
832 			sbuf_printf(sb, "UP");
833 		else
834 			sbuf_printf(sb, "DOWN");
835 		sbuf_printf(sb, "</State>\n");
836 	}
837 }
838 
839 DECLARE_GEOM_CLASS(g_shsec_class, g_shsec);
840 MODULE_VERSION(geom_shsec, 0);
841