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$");
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/malloc.h>
42 #include <sys/kernel.h>
44 #include <sys/ctype.h>
48 #include <sys/mutex.h>
50 #include <sys/errno.h>
53 #include <sys/fcntl.h>
54 #include <sys/limits.h>
55 #include <sys/sysctl.h>
56 #include <geom/geom.h>
57 #include <geom/geom_int.h>
58 #include <machine/stdarg.h>
63 struct cdev *sc_alias;
68 static d_open_t g_dev_open;
69 static d_close_t g_dev_close;
70 static d_strategy_t g_dev_strategy;
71 static d_ioctl_t g_dev_ioctl;
73 static struct cdevsw g_dev_cdevsw = {
74 .d_version = D_VERSION,
76 .d_close = g_dev_close,
79 .d_ioctl = g_dev_ioctl,
80 .d_strategy = g_dev_strategy,
82 .d_flags = D_DISK | D_TRACKCLOSE,
85 static g_init_t g_dev_init;
86 static g_fini_t g_dev_fini;
87 static g_taste_t g_dev_taste;
88 static g_orphan_t g_dev_orphan;
89 static g_attrchanged_t g_dev_attrchanged;
91 static struct g_class g_dev_class = {
97 .orphan = g_dev_orphan,
98 .attrchanged = g_dev_attrchanged
102 * We target 262144 (8 x 32768) sectors by default as this significantly
103 * increases the throughput on commonly used SSD's with a marginal
104 * increase in non-interruptible request latency.
106 static uint64_t g_dev_del_max_sectors = 262144;
107 SYSCTL_DECL(_kern_geom);
108 SYSCTL_NODE(_kern_geom, OID_AUTO, dev, CTLFLAG_RW, 0, "GEOM_DEV stuff");
109 SYSCTL_QUAD(_kern_geom_dev, OID_AUTO, delete_max_sectors, CTLFLAG_RW,
110 &g_dev_del_max_sectors, 0, "Maximum number of sectors in a single "
111 "delete request sent to the provider. Larger requests are chunked "
112 "so they can be interrupted. (0 = disable chunking)");
114 static char *dumpdev = NULL;
116 g_dev_init(struct g_class *mp)
119 dumpdev = getenv("dumpdev");
123 g_dev_fini(struct g_class *mp)
131 g_dev_setdumpdev(struct cdev *dev, struct thread *td)
133 struct g_kerneldump kd;
134 struct g_consumer *cp;
138 return (set_dumper(NULL, NULL, td));
144 error = g_io_getattr("GEOM::kerneldump", cp, &len, &kd);
146 error = set_dumper(&kd.di, devtoname(dev), td);
148 dev->si_flags |= SI_DUMPDEV;
154 init_dumpdev(struct cdev *dev)
156 struct g_consumer *cp;
157 const char *devprefix = "/dev/", *devname;
164 len = strlen(devprefix);
165 devname = devtoname(dev);
166 if (strcmp(devname, dumpdev) != 0 &&
167 (strncmp(dumpdev, devprefix, len) != 0 ||
168 strcmp(devname, dumpdev + len) != 0))
171 cp = (struct g_consumer *)dev->si_drv2;
172 error = g_access(cp, 1, 0, 0);
176 error = g_dev_setdumpdev(dev, curthread);
182 (void)g_access(cp, -1, 0, 0);
188 g_dev_destroy(void *arg, int flags __unused)
190 struct g_consumer *cp;
192 struct g_dev_softc *sc;
193 char buf[SPECNAMELEN + 6];
199 g_trace(G_T_TOPOLOGY, "g_dev_destroy(%p(%s))", cp, gp->name);
200 snprintf(buf, sizeof(buf), "cdev=%s", gp->name);
201 devctl_notify_f("GEOM", "DEV", "DESTROY", buf, M_WAITOK);
202 if (cp->acr > 0 || cp->acw > 0 || cp->ace > 0)
203 g_access(cp, -cp->acr, -cp->acw, -cp->ace);
205 g_destroy_consumer(cp);
207 mtx_destroy(&sc->sc_mtx);
217 LIST_FOREACH(gp, &g_dev_class.geom, geom) {
218 printf("%s%s", p, gp->name);
225 g_dev_attrchanged(struct g_consumer *cp, const char *attr)
227 struct g_dev_softc *sc;
229 char buf[SPECNAMELEN + 6];
232 if (strcmp(attr, "GEOM::media") == 0) {
234 snprintf(buf, sizeof(buf), "cdev=%s", dev->si_name);
235 devctl_notify_f("DEVFS", "CDEV", "MEDIACHANGE", buf, M_WAITOK);
236 devctl_notify_f("GEOM", "DEV", "MEDIACHANGE", buf, M_WAITOK);
239 snprintf(buf, sizeof(buf), "cdev=%s", dev->si_name);
240 devctl_notify_f("DEVFS", "CDEV", "MEDIACHANGE", buf,
242 devctl_notify_f("GEOM", "DEV", "MEDIACHANGE", buf,
248 if (strcmp(attr, "GEOM::physpath") != 0)
251 if (g_access(cp, 1, 0, 0) == 0) {
253 int error, physpath_len;
255 physpath_len = MAXPATHLEN;
256 physpath = g_malloc(physpath_len, M_WAITOK|M_ZERO);
258 g_io_getattr("GEOM::physpath", cp, &physpath_len, physpath);
259 g_access(cp, -1, 0, 0);
260 if (error == 0 && strlen(physpath) != 0) {
261 struct cdev *old_alias_dev;
262 struct cdev **alias_devp;
265 old_alias_dev = sc->sc_alias;
266 alias_devp = (struct cdev **)&sc->sc_alias;
267 make_dev_physpath_alias(MAKEDEV_WAITOK, alias_devp,
268 dev, old_alias_dev, physpath);
269 } else if (sc->sc_alias) {
270 destroy_dev((struct cdev *)sc->sc_alias);
278 g_dev_getprovider(struct cdev *dev)
280 struct g_consumer *cp;
285 if (dev->si_devsw != &g_dev_cdevsw)
288 return (cp->provider);
291 static struct g_geom *
292 g_dev_taste(struct g_class *mp, struct g_provider *pp, int insist __unused)
295 struct g_consumer *cp;
296 struct g_dev_softc *sc;
298 struct cdev *dev, *adev;
299 char buf[SPECNAMELEN + 6], *val;
301 g_trace(G_T_TOPOLOGY, "dev_taste(%s,%s)", mp->name, pp->name);
303 gp = g_new_geomf(mp, "%s", pp->name);
304 sc = g_malloc(sizeof(*sc), M_WAITOK | M_ZERO);
305 mtx_init(&sc->sc_mtx, "g_dev", NULL, MTX_DEF);
306 cp = g_new_consumer(gp);
308 cp->flags |= G_CF_DIRECT_SEND | G_CF_DIRECT_RECEIVE;
309 error = g_attach(cp, pp);
311 ("g_dev_taste(%s) failed to g_attach, err=%d", pp->name, error));
312 error = make_dev_p(MAKEDEV_CHECKNAME | MAKEDEV_WAITOK, &dev,
313 &g_dev_cdevsw, NULL, UID_ROOT, GID_OPERATOR, 0640, "%s", gp->name);
315 printf("%s: make_dev_p() failed (gp->name=%s, error=%d)\n",
316 __func__, gp->name, error);
318 g_destroy_consumer(cp);
320 mtx_destroy(&sc->sc_mtx);
324 dev->si_flags |= SI_UNMAPPED;
327 /* Search for device alias name and create it if found. */
329 for (len = MIN(strlen(gp->name), sizeof(buf) - 15); len > 0; len--) {
330 snprintf(buf, sizeof(buf), "kern.devalias.%s", gp->name);
334 snprintf(buf, sizeof(buf), "%s%s",
335 val, gp->name + len);
337 make_dev_alias_p(MAKEDEV_CHECKNAME | MAKEDEV_WAITOK,
338 &adev, dev, "%s", buf);
339 adev->si_flags |= SI_UNMAPPED;
344 dev->si_iosize_max = MAXPHYS;
346 error = init_dumpdev(dev);
348 printf("%s: init_dumpdev() failed (gp->name=%s, error=%d)\n",
349 __func__, gp->name, error);
351 adev->si_iosize_max = MAXPHYS;
356 g_dev_attrchanged(cp, "GEOM::physpath");
357 snprintf(buf, sizeof(buf), "cdev=%s", gp->name);
358 devctl_notify_f("GEOM", "DEV", "CREATE", buf, M_WAITOK);
364 g_dev_open(struct cdev *dev, int flags, int fmt, struct thread *td)
366 struct g_consumer *cp;
367 struct g_dev_softc *sc;
372 return(ENXIO); /* g_dev_taste() not done yet */
373 g_trace(G_T_ACCESS, "g_dev_open(%s, %d, %d, %p)",
374 cp->geom->name, flags, fmt, td);
376 r = flags & FREAD ? 1 : 0;
377 w = flags & FWRITE ? 1 : 0;
379 e = flags & O_EXCL ? 1 : 0;
385 * This happens on attempt to open a device node with O_EXEC.
392 * When running in very secure mode, do not allow
393 * opens for writing of any disks.
395 error = securelevel_ge(td->td_ucred, 2);
400 error = g_access(cp, r, w, e);
404 mtx_lock(&sc->sc_mtx);
405 if (sc->sc_open == 0 && sc->sc_active != 0)
406 wakeup(&sc->sc_active);
407 sc->sc_open += r + w + e;
408 mtx_unlock(&sc->sc_mtx);
414 g_dev_close(struct cdev *dev, int flags, int fmt, struct thread *td)
416 struct g_consumer *cp;
417 struct g_dev_softc *sc;
423 g_trace(G_T_ACCESS, "g_dev_close(%s, %d, %d, %p)",
424 cp->geom->name, flags, fmt, td);
426 r = flags & FREAD ? -1 : 0;
427 w = flags & FWRITE ? -1 : 0;
429 e = flags & O_EXCL ? -1 : 0;
435 * The vgonel(9) - caused by eg. forced unmount of devfs - calls
436 * VOP_CLOSE(9) on devfs vnode without any FREAD or FWRITE flags,
437 * which would result in zero deltas, which in turn would cause
438 * panic in g_access(9).
440 * Note that we cannot zero the counters (ie. do "r = cp->acr"
441 * etc) instead, because the consumer might be opened in another
448 mtx_lock(&sc->sc_mtx);
449 sc->sc_open += r + w + e;
450 while (sc->sc_open == 0 && sc->sc_active != 0)
451 msleep(&sc->sc_active, &sc->sc_mtx, 0, "PRIBIO", 0);
452 mtx_unlock(&sc->sc_mtx);
454 error = g_access(cp, r, w, e);
460 * XXX: Until we have unmessed the ioctl situation, there is a race against
461 * XXX: a concurrent orphanization. We cannot close it by holding topology
462 * XXX: since that would prevent us from doing our job, and stalling events
463 * XXX: will break (actually: stall) the BSD disklabel hacks.
466 g_dev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
468 struct g_consumer *cp;
469 struct g_provider *pp;
470 off_t offset, length, chunk;
477 KASSERT(cp->acr || cp->acw,
478 ("Consumer with zero access count in g_dev_ioctl"));
480 i = IOCPARM_LEN(cmd);
482 case DIOCGSECTORSIZE:
483 *(u_int *)data = cp->provider->sectorsize;
484 if (*(u_int *)data == 0)
488 *(off_t *)data = cp->provider->mediasize;
489 if (*(off_t *)data == 0)
493 error = g_io_getattr("GEOM::fwsectors", cp, &i, data);
494 if (error == 0 && *(u_int *)data == 0)
498 error = g_io_getattr("GEOM::fwheads", cp, &i, data);
499 if (error == 0 && *(u_int *)data == 0)
502 case DIOCGFRONTSTUFF:
503 error = g_io_getattr("GEOM::frontstuff", cp, &i, data);
505 case DIOCSKERNELDUMP:
506 if (*(u_int *)data == 0)
507 error = g_dev_setdumpdev(NULL, td);
509 error = g_dev_setdumpdev(dev, td);
512 error = g_io_flush(cp);
515 offset = ((off_t *)data)[0];
516 length = ((off_t *)data)[1];
517 if ((offset % cp->provider->sectorsize) != 0 ||
518 (length % cp->provider->sectorsize) != 0 || length <= 0) {
519 printf("%s: offset=%jd length=%jd\n", __func__, offset,
526 if (g_dev_del_max_sectors != 0 && chunk >
527 g_dev_del_max_sectors * cp->provider->sectorsize) {
528 chunk = g_dev_del_max_sectors *
529 cp->provider->sectorsize;
531 error = g_delete_data(cp, offset, chunk);
537 * Since the request size can be large, the service
538 * time can be is likewise. We make this ioctl
539 * interruptible by checking for signals for each bio.
546 error = g_io_getattr("GEOM::ident", cp, &i, data);
548 case DIOCGPROVIDERNAME:
551 strlcpy(data, pp->name, i);
553 case DIOCGSTRIPESIZE:
554 *(off_t *)data = cp->provider->stripesize;
556 case DIOCGSTRIPEOFFSET:
557 *(off_t *)data = cp->provider->stripeoffset;
560 error = g_io_getattr("GEOM::physpath", cp, &i, data);
561 if (error == 0 && *(char *)data == '\0')
565 struct diocgattr_arg *arg = (struct diocgattr_arg *)data;
567 if (arg->len > sizeof(arg->value)) {
571 error = g_io_getattr(arg->name, cp, &arg->len, &arg->value);
575 if (cp->provider->geom->ioctl != NULL) {
576 error = cp->provider->geom->ioctl(cp->provider, cmd, data, fflag, td);
586 g_dev_done(struct bio *bp2)
588 struct g_consumer *cp;
589 struct g_dev_softc *sc;
595 bp = bp2->bio_parent;
596 bp->bio_error = bp2->bio_error;
597 bp->bio_completed = bp2->bio_completed;
598 bp->bio_resid = bp->bio_length - bp2->bio_completed;
599 if (bp2->bio_error != 0) {
600 g_trace(G_T_BIO, "g_dev_done(%p) had error %d",
601 bp2, bp2->bio_error);
602 bp->bio_flags |= BIO_ERROR;
604 g_trace(G_T_BIO, "g_dev_done(%p/%p) resid %ld completed %jd",
605 bp2, bp, bp2->bio_resid, (intmax_t)bp2->bio_completed);
609 mtx_lock(&sc->sc_mtx);
610 if ((--sc->sc_active) == 0) {
611 if (sc->sc_open == 0)
612 wakeup(&sc->sc_active);
613 if (sc->sc_dev == NULL)
616 mtx_unlock(&sc->sc_mtx);
618 g_post_event(g_dev_destroy, cp, M_NOWAIT, NULL);
623 g_dev_strategy(struct bio *bp)
625 struct g_consumer *cp;
628 struct g_dev_softc *sc;
630 KASSERT(bp->bio_cmd == BIO_READ ||
631 bp->bio_cmd == BIO_WRITE ||
632 bp->bio_cmd == BIO_DELETE ||
633 bp->bio_cmd == BIO_FLUSH,
634 ("Wrong bio_cmd bio=%p cmd=%d", bp, bp->bio_cmd));
638 KASSERT(cp->acr || cp->acw,
639 ("Consumer with zero access count in g_dev_strategy"));
641 if ((bp->bio_offset % cp->provider->sectorsize) != 0 ||
642 (bp->bio_bcount % cp->provider->sectorsize) != 0) {
643 bp->bio_resid = bp->bio_bcount;
644 biofinish(bp, NULL, EINVAL);
648 mtx_lock(&sc->sc_mtx);
649 KASSERT(sc->sc_open > 0, ("Closed device in g_dev_strategy"));
651 mtx_unlock(&sc->sc_mtx);
655 * XXX: This is not an ideal solution, but I belive it to
656 * XXX: deadlock safe, all things considered.
658 bp2 = g_clone_bio(bp);
661 pause("gdstrat", hz / 10);
663 KASSERT(bp2 != NULL, ("XXX: ENOMEM in a bad place"));
664 bp2->bio_done = g_dev_done;
666 "g_dev_strategy(%p/%p) offset %jd length %jd data %p cmd %d",
667 bp, bp2, (intmax_t)bp->bio_offset, (intmax_t)bp2->bio_length,
668 bp2->bio_data, bp2->bio_cmd);
669 g_io_request(bp2, cp);
670 KASSERT(cp->acr || cp->acw,
671 ("g_dev_strategy raced with g_dev_close and lost"));
678 * Called by devfs when asynchronous device destruction is completed.
679 * - Mark that we have no attached device any more.
680 * - If there are no outstanding requests, schedule geom destruction.
681 * Otherwise destruction will be scheduled later by g_dev_done().
685 g_dev_callback(void *arg)
687 struct g_consumer *cp;
688 struct g_dev_softc *sc;
693 g_trace(G_T_TOPOLOGY, "g_dev_callback(%p(%s))", cp, cp->geom->name);
695 mtx_lock(&sc->sc_mtx);
698 destroy = (sc->sc_active == 0);
699 mtx_unlock(&sc->sc_mtx);
701 g_post_event(g_dev_destroy, cp, M_WAITOK, NULL);
707 * Called from below when the provider orphaned us.
708 * - Clear any dump settings.
709 * - Request asynchronous device destruction to prevent any more requests
710 * from coming in. The provider is already marked with an error, so
711 * anything which comes in in the interrim will be returned immediately.
715 g_dev_orphan(struct g_consumer *cp)
718 struct g_dev_softc *sc;
723 g_trace(G_T_TOPOLOGY, "g_dev_orphan(%p(%s))", cp, cp->geom->name);
725 /* Reset any dump-area set on this device */
726 if (dev->si_flags & SI_DUMPDEV)
727 (void)set_dumper(NULL, NULL, curthread);
729 /* Destroy the struct cdev *so we get no more requests */
730 destroy_dev_sched_cb(dev, g_dev_callback, cp);
733 DECLARE_GEOM_CLASS(g_dev_class, g_dev);