2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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
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
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/sysctl.h>
46 #include <sys/ctype.h>
47 #include <sys/fcntl.h>
48 #include <sys/malloc.h>
50 #include <sys/sysctl.h>
51 #include <sys/devicestat.h>
52 #include <machine/md_var.h>
55 #include <sys/mutex.h>
56 #include <geom/geom.h>
57 #include <geom/geom_disk.h>
58 #include <geom/geom_int.h>
60 #include <dev/led/led.h>
65 struct sysctl_ctx_list sysctl_ctx;
66 struct sysctl_oid *sysctl_tree;
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;
77 static struct g_class g_disk_class = {
78 .name = G_DISK_CLASS_NAME,
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,
87 SYSCTL_DECL(_kern_geom);
88 static SYSCTL_NODE(_kern_geom, OID_AUTO, disk, CTLFLAG_RW, 0,
91 DECLARE_GEOM_CLASS(g_disk_class, g_disk);
94 g_disk_lock_giant(struct disk *dp)
97 if (dp->d_flags & DISKFLAG_NEEDSGIANT)
102 g_disk_unlock_giant(struct disk *dp)
105 if (dp->d_flags & DISKFLAG_NEEDSGIANT)
110 g_disk_access(struct g_provider *pp, int r, int w, int e)
113 struct g_disk_softc *sc;
116 g_trace(G_T_ACCESS, "g_disk_access(%s, %d, %d, %d)",
120 if (sc == NULL || (dp = sc->dp) == NULL || dp->d_destroyed) {
122 * Allow decreasing access count even if disk is not
125 if (r <= 0 && w <= 0 && e <= 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",
140 g_disk_unlock_giant(dp);
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;
151 if (dp->d_flags & DISKFLAG_CANDELETE) {
152 if (bootverbose && dp->d_delmaxsize == 0) {
153 printf("WARNING: Disk drive %s%d has no d_delmaxsize\n",
154 dp->d_name, dp->d_unit);
155 dp->d_delmaxsize = dp->d_maxsize;
158 dp->d_delmaxsize = 0;
160 pp->stripeoffset = dp->d_stripeoffset;
161 pp->stripesize = dp->d_stripesize;
162 dp->d_flags |= DISKFLAG_OPEN;
163 } else if ((pp->acr + pp->acw + pp->ace) > 0 && (r + w + e) == 0) {
164 if (dp->d_close != NULL) {
165 g_disk_lock_giant(dp);
166 error = dp->d_close(dp);
168 printf("Closed disk %s -> %d\n",
170 g_disk_unlock_giant(dp);
172 sc->state = G_STATE_ACTIVE;
174 led_set(sc->led, "0");
175 dp->d_flags &= ~DISKFLAG_OPEN;
181 g_disk_kerneldump(struct bio *bp, struct disk *dp)
183 struct g_kerneldump *gkd;
186 gkd = (struct g_kerneldump*)bp->bio_data;
187 gp = bp->bio_to->geom;
188 g_trace(G_T_TOPOLOGY, "g_disk_kernedump(%s, %jd, %jd)",
189 gp->name, (intmax_t)gkd->offset, (intmax_t)gkd->length);
190 if (dp->d_dump == NULL) {
191 g_io_deliver(bp, ENODEV);
194 gkd->di.dumper = dp->d_dump;
196 gkd->di.blocksize = dp->d_sectorsize;
197 gkd->di.maxiosize = dp->d_maxsize;
198 gkd->di.mediaoffset = gkd->offset;
199 if ((gkd->offset + gkd->length) > dp->d_mediasize)
200 gkd->length = dp->d_mediasize - gkd->offset;
201 gkd->di.mediasize = gkd->length;
206 g_disk_setstate(struct bio *bp, struct g_disk_softc *sc)
210 memcpy(&sc->state, bp->bio_data, sizeof(sc->state));
211 if (sc->led[0] != 0) {
216 case G_STATE_REBUILD:
226 led_set(sc->led, cmd);
232 g_disk_done(struct bio *bp)
235 struct g_disk_softc *sc;
237 /* See "notes" for why we need a mutex here */
238 /* XXX: will witness accept a mix of Giant/unGiant drivers here ? */
239 bp2 = bp->bio_parent;
240 sc = bp2->bio_to->private;
241 bp->bio_completed = bp->bio_length - bp->bio_resid;
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(sc->dp->d_devstat, bp);
250 if (bp2->bio_children == bp2->bio_inbed) {
251 bp2->bio_resid = bp2->bio_bcount - bp2->bio_completed;
252 g_io_deliver(bp2, bp2->bio_error);
254 mtx_unlock(&sc->done_mtx);
258 g_disk_ioctl(struct g_provider *pp, u_long cmd, void * data, int fflag, struct thread *td)
261 struct g_disk_softc *sc;
267 if (dp->d_ioctl == NULL)
269 g_disk_lock_giant(dp);
270 error = dp->d_ioctl(dp, cmd, data, fflag, td);
271 g_disk_unlock_giant(dp);
276 g_disk_start(struct bio *bp)
278 struct bio *bp2, *bp3;
280 struct g_disk_softc *sc;
284 sc = bp->bio_to->private;
285 if (sc == NULL || (dp = sc->dp) == NULL || dp->d_destroyed) {
286 g_io_deliver(bp, ENXIO);
290 switch(bp->bio_cmd) {
292 if (!(dp->d_flags & DISKFLAG_CANDELETE)) {
301 bp2 = g_clone_bio(bp);
309 d_maxsize = (bp->bio_cmd == BIO_DELETE) ?
310 dp->d_delmaxsize : dp->d_maxsize;
311 bp2->bio_offset += off;
312 bp2->bio_length -= off;
313 if ((bp->bio_flags & BIO_UNMAPPED) == 0) {
314 bp2->bio_data += off;
316 KASSERT((dp->d_flags & DISKFLAG_UNMAPPED_BIO)
318 ("unmapped bio not supported by disk %s",
320 bp2->bio_ma += off / PAGE_SIZE;
321 bp2->bio_ma_offset += off;
322 bp2->bio_ma_offset %= PAGE_SIZE;
323 bp2->bio_ma_n -= off / PAGE_SIZE;
325 if (bp2->bio_length > d_maxsize) {
327 * XXX: If we have a stripesize we should really
328 * use it here. Care should be taken in the delete
329 * case if this is done as deletes can be very
330 * sensitive to size given how they are processed.
332 bp2->bio_length = d_maxsize;
333 if ((bp->bio_flags & BIO_UNMAPPED) != 0) {
334 bp2->bio_ma_n = howmany(
336 bp2->bio_length, PAGE_SIZE);
340 * To avoid a race, we need to grab the next bio
341 * before we schedule this one. See "notes".
343 bp3 = g_clone_bio(bp);
345 bp->bio_error = ENOMEM;
347 bp2->bio_done = g_disk_done;
348 bp2->bio_pblkno = bp2->bio_offset / dp->d_sectorsize;
349 bp2->bio_bcount = bp2->bio_length;
351 devstat_start_transaction_bio(dp->d_devstat, bp2);
352 g_disk_lock_giant(dp);
354 g_disk_unlock_giant(dp);
357 } while (bp2 != NULL);
360 /* Give the driver a chance to override */
361 if (dp->d_getattr != NULL) {
362 if (bp->bio_disk == NULL)
364 error = dp->d_getattr(bp);
369 if (g_handleattr_int(bp, "GEOM::candelete",
370 (dp->d_flags & DISKFLAG_CANDELETE) != 0))
372 else if (g_handleattr_int(bp, "GEOM::fwsectors",
375 else if (g_handleattr_int(bp, "GEOM::fwheads", dp->d_fwheads))
377 else if (g_handleattr_off_t(bp, "GEOM::frontstuff", 0))
379 else if (g_handleattr_str(bp, "GEOM::ident", dp->d_ident))
381 else if (g_handleattr(bp, "GEOM::hba_vendor",
382 &dp->d_hba_vendor, 2))
384 else if (g_handleattr(bp, "GEOM::hba_device",
385 &dp->d_hba_device, 2))
387 else if (g_handleattr(bp, "GEOM::hba_subvendor",
388 &dp->d_hba_subvendor, 2))
390 else if (g_handleattr(bp, "GEOM::hba_subdevice",
391 &dp->d_hba_subdevice, 2))
393 else if (!strcmp(bp->bio_attribute, "GEOM::kerneldump"))
394 g_disk_kerneldump(bp, dp);
395 else if (!strcmp(bp->bio_attribute, "GEOM::setstate"))
396 g_disk_setstate(bp, sc);
401 g_trace(G_T_BIO, "g_disk_flushcache(%s)",
403 if (!(dp->d_flags & DISKFLAG_CANFLUSHCACHE)) {
407 bp2 = g_clone_bio(bp);
409 g_io_deliver(bp, ENOMEM);
412 bp2->bio_done = g_disk_done;
414 g_disk_lock_giant(dp);
416 g_disk_unlock_giant(dp);
422 if (error != EJUSTRETURN)
423 g_io_deliver(bp, error);
428 g_disk_dumpconf(struct sbuf *sb, const char *indent, struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp)
432 struct g_disk_softc *sc;
437 if (sc == NULL || (dp = sc->dp) == NULL)
439 if (indent == NULL) {
440 sbuf_printf(sb, " hd %u", dp->d_fwheads);
441 sbuf_printf(sb, " sc %u", dp->d_fwsectors);
445 sbuf_printf(sb, "%s<fwheads>%u</fwheads>\n",
446 indent, dp->d_fwheads);
447 sbuf_printf(sb, "%s<fwsectors>%u</fwsectors>\n",
448 indent, dp->d_fwsectors);
449 if (dp->d_getattr != NULL) {
450 buf = g_malloc(DISK_IDENT_SIZE, M_WAITOK);
453 bp->bio_attribute = "GEOM::ident";
454 bp->bio_length = DISK_IDENT_SIZE;
456 res = dp->d_getattr(bp);
457 sbuf_printf(sb, "%s<ident>%s</ident>\n", indent,
458 res == 0 ? buf: dp->d_ident);
459 bp->bio_attribute = "GEOM::lunid";
460 bp->bio_length = DISK_IDENT_SIZE;
462 if (dp->d_getattr(bp) == 0)
463 sbuf_printf(sb, "%s<lunid>%s</lunid>\n",
468 sbuf_printf(sb, "%s<ident>%s</ident>\n", indent,
470 sbuf_printf(sb, "%s<descr>%s</descr>\n", indent, dp->d_descr);
475 g_disk_resize(void *ptr, int flag)
479 struct g_provider *pp;
481 if (flag == EV_CANCEL)
488 if (dp->d_destroyed || gp == NULL)
491 LIST_FOREACH(pp, &gp->provider, provider) {
492 if (pp->sectorsize != 0 &&
493 pp->sectorsize != dp->d_sectorsize)
494 g_wither_provider(pp, ENXIO);
496 g_resize_provider(pp, dp->d_mediasize);
501 g_disk_create(void *arg, int flag)
504 struct g_provider *pp;
506 struct g_disk_softc *sc;
509 if (flag == EV_CANCEL)
513 sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
514 mtx_init(&sc->done_mtx, "g_disk_done", NULL, MTX_DEF);
516 gp = g_new_geomf(&g_disk_class, "%s%d", dp->d_name, dp->d_unit);
518 pp = g_new_providerf(gp, "%s", gp->name);
519 pp->mediasize = dp->d_mediasize;
520 pp->sectorsize = dp->d_sectorsize;
521 pp->stripeoffset = dp->d_stripeoffset;
522 pp->stripesize = dp->d_stripesize;
523 if ((dp->d_flags & DISKFLAG_UNMAPPED_BIO) != 0)
524 pp->flags |= G_PF_ACCEPT_UNMAPPED;
526 printf("GEOM: new disk %s\n", gp->name);
527 sysctl_ctx_init(&sc->sysctl_ctx);
528 snprintf(tmpstr, sizeof(tmpstr), "GEOM disk %s", gp->name);
529 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
530 SYSCTL_STATIC_CHILDREN(_kern_geom_disk), OID_AUTO, gp->name,
531 CTLFLAG_RD, 0, tmpstr);
532 if (sc->sysctl_tree != NULL) {
533 snprintf(tmpstr, sizeof(tmpstr),
534 "kern.geom.disk.%s.led", gp->name);
535 TUNABLE_STR_FETCH(tmpstr, sc->led, sizeof(sc->led));
536 SYSCTL_ADD_STRING(&sc->sysctl_ctx,
537 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO, "led",
538 CTLFLAG_RW | CTLFLAG_TUN, sc->led, sizeof(sc->led),
543 g_error_provider(pp, 0);
547 * We get this callback after all of the consumers have gone away, and just
548 * before the provider is freed. If the disk driver provided a d_gone
549 * callback, let them know that it is okay to free resources -- they won't
550 * be getting any more accesses from GEOM.
553 g_disk_providergone(struct g_provider *pp)
556 struct g_disk_softc *sc;
558 sc = (struct g_disk_softc *)pp->private;
560 if (dp != NULL && dp->d_gone != NULL)
562 if (sc->sysctl_tree != NULL) {
563 sysctl_ctx_free(&sc->sysctl_ctx);
564 sc->sysctl_tree = NULL;
566 if (sc->led[0] != 0) {
567 led_set(sc->led, "0");
571 pp->geom->softc = NULL;
572 mtx_destroy(&sc->done_mtx);
577 g_disk_destroy(void *ptr, int flag)
581 struct g_disk_softc *sc;
591 g_wither_geom(gp, ENXIO);
597 * We only allow printable characters in disk ident,
598 * the rest is converted to 'x<HH>'.
601 g_disk_ident_adjust(char *ident, size_t size)
603 char *p, tmp[4], newid[DISK_IDENT_SIZE];
606 for (p = ident; *p != '\0'; p++) {
611 snprintf(tmp, sizeof(tmp), "x%02hhx",
612 *(unsigned char *)p);
614 if (strlcat(newid, tmp, sizeof(newid)) >= sizeof(newid))
618 strlcpy(ident, newid, size);
625 return (g_malloc(sizeof(struct disk), M_WAITOK | M_ZERO));
629 disk_create(struct disk *dp, int version)
632 if (version != DISK_VERSION_02) {
633 printf("WARNING: Attempt to add disk %s%d %s",
634 dp->d_name, dp->d_unit,
635 " using incompatible ABI version of disk(9)\n");
636 printf("WARNING: Ignoring disk %s%d\n",
637 dp->d_name, dp->d_unit);
640 KASSERT(dp->d_strategy != NULL, ("disk_create need d_strategy"));
641 KASSERT(dp->d_name != NULL, ("disk_create need d_name"));
642 KASSERT(*dp->d_name != 0, ("disk_create need d_name"));
643 KASSERT(strlen(dp->d_name) < SPECNAMELEN - 4, ("disk name too long"));
644 if (dp->d_devstat == NULL)
645 dp->d_devstat = devstat_new_entry(dp->d_name, dp->d_unit,
646 dp->d_sectorsize, DEVSTAT_ALL_SUPPORTED,
647 DEVSTAT_TYPE_DIRECT, DEVSTAT_PRIORITY_MAX);
649 g_disk_ident_adjust(dp->d_ident, sizeof(dp->d_ident));
650 g_post_event(g_disk_create, dp, M_WAITOK, dp, NULL);
654 disk_destroy(struct disk *dp)
659 if (dp->d_devstat != NULL)
660 devstat_remove_entry(dp->d_devstat);
661 g_post_event(g_disk_destroy, dp, M_WAITOK, NULL);
665 disk_gone(struct disk *dp)
668 struct g_provider *pp;
672 pp = LIST_FIRST(&gp->provider);
674 KASSERT(LIST_NEXT(pp, provider) == NULL,
675 ("geom %p has more than one provider", gp));
676 g_wither_provider(pp, ENXIO);
682 disk_attr_changed(struct disk *dp, const char *attr, int flag)
685 struct g_provider *pp;
689 LIST_FOREACH(pp, &gp->provider, provider)
690 (void)g_attr_changed(pp, attr, flag);
694 disk_media_changed(struct disk *dp, int flag)
697 struct g_provider *pp;
701 pp = LIST_FIRST(&gp->provider);
703 KASSERT(LIST_NEXT(pp, provider) == NULL,
704 ("geom %p has more than one provider", gp));
705 g_media_changed(pp, flag);
711 disk_media_gone(struct disk *dp, int flag)
714 struct g_provider *pp;
718 pp = LIST_FIRST(&gp->provider);
720 KASSERT(LIST_NEXT(pp, provider) == NULL,
721 ("geom %p has more than one provider", gp));
722 g_media_gone(pp, flag);
728 disk_resize(struct disk *dp, int flag)
731 if (dp->d_destroyed || dp->d_geom == NULL)
734 return (g_post_event(g_disk_resize, dp, flag, NULL));
738 g_kern_disks(void *p, int flag __unused)
747 LIST_FOREACH(gp, &g_disk_class.geom, geom) {
748 sbuf_printf(sb, "%s%s", sp, gp->name);
755 sysctl_disks(SYSCTL_HANDLER_ARGS)
760 sb = sbuf_new_auto();
761 g_waitfor_event(g_kern_disks, sb, M_WAITOK, NULL);
762 error = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb) + 1);
767 SYSCTL_PROC(_kern, OID_AUTO, disks,
768 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0,
769 sysctl_disks, "A", "names of available disks");