xref: /freebsd/sys/geom/geom_disk.c (revision 6ab38b8e25f31df8140b99c09160d0207f912ef3)
1 /*-
2  * Copyright (c) 2002 Poul-Henning Kamp
3  * Copyright (c) 2002 Networks Associates Technology, Inc.
4  * All rights reserved.
5  *
6  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7  * and NAI Labs, the Security Research Division of Network Associates, Inc.
8  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9  * DARPA CHATS research program.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. The names of the authors may not be used to endorse or promote
20  *    products derived from this software without specific prior written
21  *    permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38 
39 #include "opt_geom.h"
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/sysctl.h>
45 #include <sys/bio.h>
46 #include <sys/ctype.h>
47 #include <sys/fcntl.h>
48 #include <sys/malloc.h>
49 #include <sys/sbuf.h>
50 #include <sys/sysctl.h>
51 #include <sys/devicestat.h>
52 #include <machine/md_var.h>
53 
54 #include <sys/lock.h>
55 #include <sys/mutex.h>
56 #include <geom/geom.h>
57 #include <geom/geom_disk.h>
58 #include <geom/geom_int.h>
59 
60 #include <dev/led/led.h>
61 
62 struct g_disk_softc {
63 	struct mtx		 done_mtx;
64 	struct disk		*dp;
65 	struct sysctl_ctx_list	sysctl_ctx;
66 	struct sysctl_oid	*sysctl_tree;
67 	char			led[64];
68 	uint32_t		state;
69 };
70 
71 static g_access_t g_disk_access;
72 static g_start_t g_disk_start;
73 static g_ioctl_t g_disk_ioctl;
74 static g_dumpconf_t g_disk_dumpconf;
75 static g_provgone_t g_disk_providergone;
76 
77 static struct g_class g_disk_class = {
78 	.name = G_DISK_CLASS_NAME,
79 	.version = G_VERSION,
80 	.start = g_disk_start,
81 	.access = g_disk_access,
82 	.ioctl = g_disk_ioctl,
83 	.providergone = g_disk_providergone,
84 	.dumpconf = g_disk_dumpconf,
85 };
86 
87 SYSCTL_DECL(_kern_geom);
88 static SYSCTL_NODE(_kern_geom, OID_AUTO, disk, CTLFLAG_RW, 0,
89     "GEOM_DISK stuff");
90 
91 DECLARE_GEOM_CLASS(g_disk_class, g_disk);
92 
93 static void __inline
94 g_disk_lock_giant(struct disk *dp)
95 {
96 
97 	if (dp->d_flags & DISKFLAG_NEEDSGIANT)
98 		mtx_lock(&Giant);
99 }
100 
101 static void __inline
102 g_disk_unlock_giant(struct disk *dp)
103 {
104 
105 	if (dp->d_flags & DISKFLAG_NEEDSGIANT)
106 		mtx_unlock(&Giant);
107 }
108 
109 static int
110 g_disk_access(struct g_provider *pp, int r, int w, int e)
111 {
112 	struct disk *dp;
113 	struct g_disk_softc *sc;
114 	int error;
115 
116 	g_trace(G_T_ACCESS, "g_disk_access(%s, %d, %d, %d)",
117 	    pp->name, r, w, e);
118 	g_topology_assert();
119 	sc = pp->private;
120 	if (sc == NULL || (dp = sc->dp) == NULL || dp->d_destroyed) {
121 		/*
122 		 * Allow decreasing access count even if disk is not
123 		 * avaliable anymore.
124 		 */
125 		if (r <= 0 && w <= 0 && e <= 0)
126 			return (0);
127 		return (ENXIO);
128 	}
129 	r += pp->acr;
130 	w += pp->acw;
131 	e += pp->ace;
132 	error = 0;
133 	if ((pp->acr + pp->acw + pp->ace) == 0 && (r + w + e) > 0) {
134 		if (dp->d_open != NULL) {
135 			g_disk_lock_giant(dp);
136 			error = dp->d_open(dp);
137 			if (bootverbose && error != 0)
138 				printf("Opened disk %s -> %d\n",
139 				    pp->name, error);
140 			g_disk_unlock_giant(dp);
141 			if (error != 0)
142 				return (error);
143 		}
144 		pp->mediasize = dp->d_mediasize;
145 		pp->sectorsize = dp->d_sectorsize;
146 		if (dp->d_maxsize == 0) {
147 			printf("WARNING: Disk drive %s%d has no d_maxsize\n",
148 			    dp->d_name, dp->d_unit);
149 			dp->d_maxsize = DFLTPHYS;
150 		}
151 		if (dp->d_delmaxsize == 0) {
152 			if (bootverbose && dp->d_flags & DISKFLAG_CANDELETE) {
153 				printf("WARNING: Disk drive %s%d has no "
154 				    "d_delmaxsize\n", dp->d_name, dp->d_unit);
155 			}
156 			dp->d_delmaxsize = dp->d_maxsize;
157 		}
158 		pp->stripeoffset = dp->d_stripeoffset;
159 		pp->stripesize = dp->d_stripesize;
160 		dp->d_flags |= DISKFLAG_OPEN;
161 	} else if ((pp->acr + pp->acw + pp->ace) > 0 && (r + w + e) == 0) {
162 		if (dp->d_close != NULL) {
163 			g_disk_lock_giant(dp);
164 			error = dp->d_close(dp);
165 			if (error != 0)
166 				printf("Closed disk %s -> %d\n",
167 				    pp->name, error);
168 			g_disk_unlock_giant(dp);
169 		}
170 		sc->state = G_STATE_ACTIVE;
171 		if (sc->led[0] != 0)
172 			led_set(sc->led, "0");
173 		dp->d_flags &= ~DISKFLAG_OPEN;
174 	}
175 	return (error);
176 }
177 
178 static void
179 g_disk_kerneldump(struct bio *bp, struct disk *dp)
180 {
181 	struct g_kerneldump *gkd;
182 	struct g_geom *gp;
183 
184 	gkd = (struct g_kerneldump*)bp->bio_data;
185 	gp = bp->bio_to->geom;
186 	g_trace(G_T_TOPOLOGY, "g_disk_kernedump(%s, %jd, %jd)",
187 		gp->name, (intmax_t)gkd->offset, (intmax_t)gkd->length);
188 	if (dp->d_dump == NULL) {
189 		g_io_deliver(bp, ENODEV);
190 		return;
191 	}
192 	gkd->di.dumper = dp->d_dump;
193 	gkd->di.priv = dp;
194 	gkd->di.blocksize = dp->d_sectorsize;
195 	gkd->di.maxiosize = dp->d_maxsize;
196 	gkd->di.mediaoffset = gkd->offset;
197 	if ((gkd->offset + gkd->length) > dp->d_mediasize)
198 		gkd->length = dp->d_mediasize - gkd->offset;
199 	gkd->di.mediasize = gkd->length;
200 	g_io_deliver(bp, 0);
201 }
202 
203 static void
204 g_disk_setstate(struct bio *bp, struct g_disk_softc *sc)
205 {
206 	const char *cmd;
207 
208 	memcpy(&sc->state, bp->bio_data, sizeof(sc->state));
209 	if (sc->led[0] != 0) {
210 		switch (sc->state) {
211 		case G_STATE_FAILED:
212 			cmd = "1";
213 			break;
214 		case G_STATE_REBUILD:
215 			cmd = "f5";
216 			break;
217 		case G_STATE_RESYNC:
218 			cmd = "f1";
219 			break;
220 		default:
221 			cmd = "0";
222 			break;
223 		}
224 		led_set(sc->led, cmd);
225 	}
226 	g_io_deliver(bp, 0);
227 }
228 
229 static void
230 g_disk_done(struct bio *bp)
231 {
232 	struct bintime now;
233 	struct bio *bp2;
234 	struct g_disk_softc *sc;
235 
236 	/* See "notes" for why we need a mutex here */
237 	/* XXX: will witness accept a mix of Giant/unGiant drivers here ? */
238 	bp2 = bp->bio_parent;
239 	sc = bp2->bio_to->private;
240 	bp->bio_completed = bp->bio_length - bp->bio_resid;
241 	binuptime(&now);
242 	mtx_lock(&sc->done_mtx);
243 	if (bp2->bio_error == 0)
244 		bp2->bio_error = bp->bio_error;
245 	bp2->bio_completed += bp->bio_completed;
246 	if ((bp->bio_cmd & (BIO_READ|BIO_WRITE|BIO_DELETE)) != 0)
247 		devstat_end_transaction_bio_bt(sc->dp->d_devstat, bp, &now);
248 	bp2->bio_inbed++;
249 	if (bp2->bio_children == bp2->bio_inbed) {
250 		mtx_unlock(&sc->done_mtx);
251 		bp2->bio_resid = bp2->bio_bcount - bp2->bio_completed;
252 		g_io_deliver(bp2, bp2->bio_error);
253 	} else
254 		mtx_unlock(&sc->done_mtx);
255 	g_destroy_bio(bp);
256 }
257 
258 static int
259 g_disk_ioctl(struct g_provider *pp, u_long cmd, void * data, int fflag, struct thread *td)
260 {
261 	struct disk *dp;
262 	struct g_disk_softc *sc;
263 	int error;
264 
265 	sc = pp->private;
266 	dp = sc->dp;
267 
268 	if (dp->d_ioctl == NULL)
269 		return (ENOIOCTL);
270 	g_disk_lock_giant(dp);
271 	error = dp->d_ioctl(dp, cmd, data, fflag, td);
272 	g_disk_unlock_giant(dp);
273 	return (error);
274 }
275 
276 static void
277 g_disk_start(struct bio *bp)
278 {
279 	struct bio *bp2, *bp3;
280 	struct disk *dp;
281 	struct g_disk_softc *sc;
282 	int error;
283 	off_t off;
284 
285 	sc = bp->bio_to->private;
286 	if (sc == NULL || (dp = sc->dp) == NULL || dp->d_destroyed) {
287 		g_io_deliver(bp, ENXIO);
288 		return;
289 	}
290 	error = EJUSTRETURN;
291 	switch(bp->bio_cmd) {
292 	case BIO_DELETE:
293 		if (!(dp->d_flags & DISKFLAG_CANDELETE)) {
294 			error = EOPNOTSUPP;
295 			break;
296 		}
297 		/* fall-through */
298 	case BIO_READ:
299 	case BIO_WRITE:
300 		off = 0;
301 		bp3 = NULL;
302 		bp2 = g_clone_bio(bp);
303 		if (bp2 == NULL) {
304 			error = ENOMEM;
305 			break;
306 		}
307 		do {
308 			off_t d_maxsize;
309 
310 			d_maxsize = (bp->bio_cmd == BIO_DELETE) ?
311 			    dp->d_delmaxsize : dp->d_maxsize;
312 			bp2->bio_offset += off;
313 			bp2->bio_length -= off;
314 			if ((bp->bio_flags & BIO_UNMAPPED) == 0) {
315 				bp2->bio_data += off;
316 			} else {
317 				KASSERT((dp->d_flags & DISKFLAG_UNMAPPED_BIO)
318 				    != 0,
319 				    ("unmapped bio not supported by disk %s",
320 				    dp->d_name));
321 				bp2->bio_ma += off / PAGE_SIZE;
322 				bp2->bio_ma_offset += off;
323 				bp2->bio_ma_offset %= PAGE_SIZE;
324 				bp2->bio_ma_n -= off / PAGE_SIZE;
325 			}
326 			if (bp2->bio_length > d_maxsize) {
327 				/*
328 				 * XXX: If we have a stripesize we should really
329 				 * use it here. Care should be taken in the delete
330 				 * case if this is done as deletes can be very
331 				 * sensitive to size given how they are processed.
332 				 */
333 				bp2->bio_length = d_maxsize;
334 				if ((bp->bio_flags & BIO_UNMAPPED) != 0) {
335 					bp2->bio_ma_n = howmany(
336 					    bp2->bio_ma_offset +
337 					    bp2->bio_length, PAGE_SIZE);
338 				}
339 				off += d_maxsize;
340 				/*
341 				 * To avoid a race, we need to grab the next bio
342 				 * before we schedule this one.  See "notes".
343 				 */
344 				bp3 = g_clone_bio(bp);
345 				if (bp3 == NULL)
346 					bp->bio_error = ENOMEM;
347 			}
348 			bp2->bio_done = g_disk_done;
349 			bp2->bio_pblkno = bp2->bio_offset / dp->d_sectorsize;
350 			bp2->bio_bcount = bp2->bio_length;
351 			bp2->bio_disk = dp;
352 			devstat_start_transaction_bio(dp->d_devstat, bp2);
353 			g_disk_lock_giant(dp);
354 			dp->d_strategy(bp2);
355 			g_disk_unlock_giant(dp);
356 			bp2 = bp3;
357 			bp3 = NULL;
358 		} while (bp2 != NULL);
359 		break;
360 	case BIO_GETATTR:
361 		/* Give the driver a chance to override */
362 		if (dp->d_getattr != NULL) {
363 			if (bp->bio_disk == NULL)
364 				bp->bio_disk = dp;
365 			error = dp->d_getattr(bp);
366 			if (error != -1)
367 				break;
368 			error = EJUSTRETURN;
369 		}
370 		if (g_handleattr_int(bp, "GEOM::candelete",
371 		    (dp->d_flags & DISKFLAG_CANDELETE) != 0))
372 			break;
373 		else if (g_handleattr_int(bp, "GEOM::fwsectors",
374 		    dp->d_fwsectors))
375 			break;
376 		else if (g_handleattr_int(bp, "GEOM::fwheads", dp->d_fwheads))
377 			break;
378 		else if (g_handleattr_off_t(bp, "GEOM::frontstuff", 0))
379 			break;
380 		else if (g_handleattr_str(bp, "GEOM::ident", dp->d_ident))
381 			break;
382 		else if (g_handleattr(bp, "GEOM::hba_vendor",
383 		    &dp->d_hba_vendor, 2))
384 			break;
385 		else if (g_handleattr(bp, "GEOM::hba_device",
386 		    &dp->d_hba_device, 2))
387 			break;
388 		else if (g_handleattr(bp, "GEOM::hba_subvendor",
389 		    &dp->d_hba_subvendor, 2))
390 			break;
391 		else if (g_handleattr(bp, "GEOM::hba_subdevice",
392 		    &dp->d_hba_subdevice, 2))
393 			break;
394 		else if (!strcmp(bp->bio_attribute, "GEOM::kerneldump"))
395 			g_disk_kerneldump(bp, dp);
396 		else if (!strcmp(bp->bio_attribute, "GEOM::setstate"))
397 			g_disk_setstate(bp, sc);
398 		else
399 			error = ENOIOCTL;
400 		break;
401 	case BIO_FLUSH:
402 		g_trace(G_T_BIO, "g_disk_flushcache(%s)",
403 		    bp->bio_to->name);
404 		if (!(dp->d_flags & DISKFLAG_CANFLUSHCACHE)) {
405 			error = EOPNOTSUPP;
406 			break;
407 		}
408 		bp2 = g_clone_bio(bp);
409 		if (bp2 == NULL) {
410 			g_io_deliver(bp, ENOMEM);
411 			return;
412 		}
413 		bp2->bio_done = g_disk_done;
414 		bp2->bio_disk = dp;
415 		g_disk_lock_giant(dp);
416 		dp->d_strategy(bp2);
417 		g_disk_unlock_giant(dp);
418 		break;
419 	default:
420 		error = EOPNOTSUPP;
421 		break;
422 	}
423 	if (error != EJUSTRETURN)
424 		g_io_deliver(bp, error);
425 	return;
426 }
427 
428 static void
429 g_disk_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp)
430 {
431 	struct bio *bp;
432 	struct disk *dp;
433 	struct g_disk_softc *sc;
434 	char *buf;
435 	int res = 0;
436 
437 	sc = gp->softc;
438 	if (sc == NULL || (dp = sc->dp) == NULL)
439 		return;
440 	if (indent == NULL) {
441 		sbuf_printf(sb, " hd %u", dp->d_fwheads);
442 		sbuf_printf(sb, " sc %u", dp->d_fwsectors);
443 		return;
444 	}
445 	if (pp != NULL) {
446 		sbuf_printf(sb, "%s<fwheads>%u</fwheads>\n",
447 		    indent, dp->d_fwheads);
448 		sbuf_printf(sb, "%s<fwsectors>%u</fwsectors>\n",
449 		    indent, dp->d_fwsectors);
450 		if (dp->d_getattr != NULL) {
451 			buf = g_malloc(DISK_IDENT_SIZE, M_WAITOK);
452 			bp = g_alloc_bio();
453 			bp->bio_disk = dp;
454 			bp->bio_attribute = "GEOM::ident";
455 			bp->bio_length = DISK_IDENT_SIZE;
456 			bp->bio_data = buf;
457 			res = dp->d_getattr(bp);
458 			sbuf_printf(sb, "%s<ident>%s</ident>\n", indent,
459 			    res == 0 ? buf: dp->d_ident);
460 			bp->bio_attribute = "GEOM::lunid";
461 			bp->bio_length = DISK_IDENT_SIZE;
462 			bp->bio_data = buf;
463 			if (dp->d_getattr(bp) == 0)
464 				sbuf_printf(sb, "%s<lunid>%s</lunid>\n",
465 				    indent, buf);
466 			bp->bio_attribute = "GEOM::lunname";
467 			bp->bio_length = DISK_IDENT_SIZE;
468 			bp->bio_data = buf;
469 			if (dp->d_getattr(bp) == 0)
470 				sbuf_printf(sb, "%s<lunname>%s</lunname>\n",
471 				    indent, buf);
472 			g_destroy_bio(bp);
473 			g_free(buf);
474 		} else
475 			sbuf_printf(sb, "%s<ident>%s</ident>\n", indent,
476 			    dp->d_ident);
477 		sbuf_printf(sb, "%s<descr>%s</descr>\n", indent, dp->d_descr);
478 	}
479 }
480 
481 static void
482 g_disk_resize(void *ptr, int flag)
483 {
484 	struct disk *dp;
485 	struct g_geom *gp;
486 	struct g_provider *pp;
487 
488 	if (flag == EV_CANCEL)
489 		return;
490 	g_topology_assert();
491 
492 	dp = ptr;
493 	gp = dp->d_geom;
494 
495 	if (dp->d_destroyed || gp == NULL)
496 		return;
497 
498 	LIST_FOREACH(pp, &gp->provider, provider) {
499 		if (pp->sectorsize != 0 &&
500 		    pp->sectorsize != dp->d_sectorsize)
501 			g_wither_provider(pp, ENXIO);
502 		else
503 			g_resize_provider(pp, dp->d_mediasize);
504 	}
505 }
506 
507 static void
508 g_disk_create(void *arg, int flag)
509 {
510 	struct g_geom *gp;
511 	struct g_provider *pp;
512 	struct disk *dp;
513 	struct g_disk_softc *sc;
514 	char tmpstr[80];
515 
516 	if (flag == EV_CANCEL)
517 		return;
518 	g_topology_assert();
519 	dp = arg;
520 	sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
521 	mtx_init(&sc->done_mtx, "g_disk_done", NULL, MTX_DEF);
522 	sc->dp = dp;
523 	gp = g_new_geomf(&g_disk_class, "%s%d", dp->d_name, dp->d_unit);
524 	gp->softc = sc;
525 	pp = g_new_providerf(gp, "%s", gp->name);
526 	pp->mediasize = dp->d_mediasize;
527 	pp->sectorsize = dp->d_sectorsize;
528 	pp->stripeoffset = dp->d_stripeoffset;
529 	pp->stripesize = dp->d_stripesize;
530 	if ((dp->d_flags & DISKFLAG_UNMAPPED_BIO) != 0)
531 		pp->flags |= G_PF_ACCEPT_UNMAPPED;
532 	if (bootverbose)
533 		printf("GEOM: new disk %s\n", gp->name);
534 	sysctl_ctx_init(&sc->sysctl_ctx);
535 	snprintf(tmpstr, sizeof(tmpstr), "GEOM disk %s", gp->name);
536 	sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
537 		SYSCTL_STATIC_CHILDREN(_kern_geom_disk), OID_AUTO, gp->name,
538 		CTLFLAG_RD, 0, tmpstr);
539 	if (sc->sysctl_tree != NULL) {
540 		snprintf(tmpstr, sizeof(tmpstr),
541 		    "kern.geom.disk.%s.led", gp->name);
542 		TUNABLE_STR_FETCH(tmpstr, sc->led, sizeof(sc->led));
543 		SYSCTL_ADD_STRING(&sc->sysctl_ctx,
544 		    SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO, "led",
545 		    CTLFLAG_RW | CTLFLAG_TUN, sc->led, sizeof(sc->led),
546 		    "LED name");
547 	}
548 	pp->private = sc;
549 	dp->d_geom = gp;
550 	g_error_provider(pp, 0);
551 }
552 
553 /*
554  * We get this callback after all of the consumers have gone away, and just
555  * before the provider is freed.  If the disk driver provided a d_gone
556  * callback, let them know that it is okay to free resources -- they won't
557  * be getting any more accesses from GEOM.
558  */
559 static void
560 g_disk_providergone(struct g_provider *pp)
561 {
562 	struct disk *dp;
563 	struct g_disk_softc *sc;
564 
565 	sc = (struct g_disk_softc *)pp->private;
566 	dp = sc->dp;
567 	if (dp != NULL && dp->d_gone != NULL)
568 		dp->d_gone(dp);
569 	if (sc->sysctl_tree != NULL) {
570 		sysctl_ctx_free(&sc->sysctl_ctx);
571 		sc->sysctl_tree = NULL;
572 	}
573 	if (sc->led[0] != 0) {
574 		led_set(sc->led, "0");
575 		sc->led[0] = 0;
576 	}
577 	pp->private = NULL;
578 	pp->geom->softc = NULL;
579 	mtx_destroy(&sc->done_mtx);
580 	g_free(sc);
581 }
582 
583 static void
584 g_disk_destroy(void *ptr, int flag)
585 {
586 	struct disk *dp;
587 	struct g_geom *gp;
588 	struct g_disk_softc *sc;
589 
590 	g_topology_assert();
591 	dp = ptr;
592 	gp = dp->d_geom;
593 	if (gp != NULL) {
594 		sc = gp->softc;
595 		if (sc != NULL)
596 			sc->dp = NULL;
597 		dp->d_geom = NULL;
598 		g_wither_geom(gp, ENXIO);
599 	}
600 	g_free(dp);
601 }
602 
603 /*
604  * We only allow printable characters in disk ident,
605  * the rest is converted to 'x<HH>'.
606  */
607 static void
608 g_disk_ident_adjust(char *ident, size_t size)
609 {
610 	char *p, tmp[4], newid[DISK_IDENT_SIZE];
611 
612 	newid[0] = '\0';
613 	for (p = ident; *p != '\0'; p++) {
614 		if (isprint(*p)) {
615 			tmp[0] = *p;
616 			tmp[1] = '\0';
617 		} else {
618 			snprintf(tmp, sizeof(tmp), "x%02hhx",
619 			    *(unsigned char *)p);
620 		}
621 		if (strlcat(newid, tmp, sizeof(newid)) >= sizeof(newid))
622 			break;
623 	}
624 	bzero(ident, size);
625 	strlcpy(ident, newid, size);
626 }
627 
628 struct disk *
629 disk_alloc(void)
630 {
631 
632 	return (g_malloc(sizeof(struct disk), M_WAITOK | M_ZERO));
633 }
634 
635 void
636 disk_create(struct disk *dp, int version)
637 {
638 
639 	if (version != DISK_VERSION) {
640 		printf("WARNING: Attempt to add disk %s%d %s",
641 		    dp->d_name, dp->d_unit,
642 		    " using incompatible ABI version of disk(9)\n");
643 		printf("WARNING: Ignoring disk %s%d\n",
644 		    dp->d_name, dp->d_unit);
645 		return;
646 	}
647 	KASSERT(dp->d_strategy != NULL, ("disk_create need d_strategy"));
648 	KASSERT(dp->d_name != NULL, ("disk_create need d_name"));
649 	KASSERT(*dp->d_name != 0, ("disk_create need d_name"));
650 	KASSERT(strlen(dp->d_name) < SPECNAMELEN - 4, ("disk name too long"));
651 	if (dp->d_devstat == NULL)
652 		dp->d_devstat = devstat_new_entry(dp->d_name, dp->d_unit,
653 		    dp->d_sectorsize, DEVSTAT_ALL_SUPPORTED,
654 		    DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
655 	dp->d_geom = NULL;
656 	g_disk_ident_adjust(dp->d_ident, sizeof(dp->d_ident));
657 	g_post_event(g_disk_create, dp, M_WAITOK, dp, NULL);
658 }
659 
660 void
661 disk_destroy(struct disk *dp)
662 {
663 
664 	g_cancel_event(dp);
665 	dp->d_destroyed = 1;
666 	if (dp->d_devstat != NULL)
667 		devstat_remove_entry(dp->d_devstat);
668 	g_post_event(g_disk_destroy, dp, M_WAITOK, NULL);
669 }
670 
671 void
672 disk_gone(struct disk *dp)
673 {
674 	struct g_geom *gp;
675 	struct g_provider *pp;
676 
677 	gp = dp->d_geom;
678 	if (gp != NULL) {
679 		pp = LIST_FIRST(&gp->provider);
680 		if (pp != NULL) {
681 			KASSERT(LIST_NEXT(pp, provider) == NULL,
682 			    ("geom %p has more than one provider", gp));
683 			g_wither_provider(pp, ENXIO);
684 		}
685 	}
686 }
687 
688 void
689 disk_attr_changed(struct disk *dp, const char *attr, int flag)
690 {
691 	struct g_geom *gp;
692 	struct g_provider *pp;
693 
694 	gp = dp->d_geom;
695 	if (gp != NULL)
696 		LIST_FOREACH(pp, &gp->provider, provider)
697 			(void)g_attr_changed(pp, attr, flag);
698 }
699 
700 void
701 disk_media_changed(struct disk *dp, int flag)
702 {
703 	struct g_geom *gp;
704 	struct g_provider *pp;
705 
706 	gp = dp->d_geom;
707 	if (gp != NULL) {
708 		pp = LIST_FIRST(&gp->provider);
709 		if (pp != NULL) {
710 			KASSERT(LIST_NEXT(pp, provider) == NULL,
711 			    ("geom %p has more than one provider", gp));
712 			g_media_changed(pp, flag);
713 		}
714 	}
715 }
716 
717 void
718 disk_media_gone(struct disk *dp, int flag)
719 {
720 	struct g_geom *gp;
721 	struct g_provider *pp;
722 
723 	gp = dp->d_geom;
724 	if (gp != NULL) {
725 		pp = LIST_FIRST(&gp->provider);
726 		if (pp != NULL) {
727 			KASSERT(LIST_NEXT(pp, provider) == NULL,
728 			    ("geom %p has more than one provider", gp));
729 			g_media_gone(pp, flag);
730 		}
731 	}
732 }
733 
734 int
735 disk_resize(struct disk *dp, int flag)
736 {
737 
738 	if (dp->d_destroyed || dp->d_geom == NULL)
739 		return (0);
740 
741 	return (g_post_event(g_disk_resize, dp, flag, NULL));
742 }
743 
744 static void
745 g_kern_disks(void *p, int flag __unused)
746 {
747 	struct sbuf *sb;
748 	struct g_geom *gp;
749 	char *sp;
750 
751 	sb = p;
752 	sp = "";
753 	g_topology_assert();
754 	LIST_FOREACH(gp, &g_disk_class.geom, geom) {
755 		sbuf_printf(sb, "%s%s", sp, gp->name);
756 		sp = " ";
757 	}
758 	sbuf_finish(sb);
759 }
760 
761 static int
762 sysctl_disks(SYSCTL_HANDLER_ARGS)
763 {
764 	int error;
765 	struct sbuf *sb;
766 
767 	sb = sbuf_new_auto();
768 	g_waitfor_event(g_kern_disks, sb, M_WAITOK, NULL);
769 	error = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb) + 1);
770 	sbuf_delete(sb);
771 	return error;
772 }
773 
774 SYSCTL_PROC(_kern, OID_AUTO, disks,
775     CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
776     sysctl_disks, "A", "names of available disks");
777