2 * Copyright (c) 1999-2002 Poul-Henning Kamp
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/systm.h>
36 #include <sys/mutex.h>
37 #include <sys/module.h>
38 #include <sys/malloc.h>
40 #include <sys/vnode.h>
41 #include <sys/queue.h>
44 #include <sys/ctype.h>
45 #include <sys/ucred.h>
46 #include <sys/taskqueue.h>
47 #include <machine/stdarg.h>
49 #include <fs/devfs/devfs_int.h>
52 static MALLOC_DEFINE(M_DEVT, "cdev", "cdev storage");
55 static void destroy_devl(struct cdev *dev);
56 static int destroy_dev_sched_cbl(struct cdev *dev,
57 void (*cb)(void *), void *arg);
58 static void destroy_dev_tq(void *ctx, int pending);
59 static int make_dev_credv(int flags, struct cdev **dres, struct cdevsw *devsw,
60 int unit, struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
63 static struct cdev_priv_list cdevp_free_list =
64 TAILQ_HEAD_INITIALIZER(cdevp_free_list);
65 static SLIST_HEAD(free_cdevsw, cdevsw) cdevsw_gt_post_list =
66 SLIST_HEAD_INITIALIZER(cdevsw_gt_post_list);
76 * Free all the memory collected while the cdev mutex was
77 * locked. Since devmtx is after the system map mutex, free() cannot
78 * be called immediately and is postponed until cdev mutex can be
82 dev_unlock_and_free(void)
84 struct cdev_priv_list cdp_free;
85 struct free_cdevsw csw_free;
86 struct cdev_priv *cdp;
89 mtx_assert(&devmtx, MA_OWNED);
92 * Make the local copy of the list heads while the dev_mtx is
93 * held. Free it later.
95 TAILQ_INIT(&cdp_free);
96 TAILQ_CONCAT(&cdp_free, &cdevp_free_list, cdp_list);
97 csw_free = cdevsw_gt_post_list;
98 SLIST_INIT(&cdevsw_gt_post_list);
102 while ((cdp = TAILQ_FIRST(&cdp_free)) != NULL) {
103 TAILQ_REMOVE(&cdp_free, cdp, cdp_list);
104 devfs_free(&cdp->cdp_c);
106 while ((csw = SLIST_FIRST(&csw_free)) != NULL) {
107 SLIST_REMOVE_HEAD(&csw_free, d_postfree_list);
113 dev_free_devlocked(struct cdev *cdev)
115 struct cdev_priv *cdp;
117 mtx_assert(&devmtx, MA_OWNED);
118 cdp = cdev2priv(cdev);
119 KASSERT((cdp->cdp_flags & CDP_UNREF_DTR) == 0,
120 ("destroy_dev() was not called after delist_dev(%p)", cdev));
121 TAILQ_INSERT_HEAD(&cdevp_free_list, cdp, cdp_list);
125 cdevsw_free_devlocked(struct cdevsw *csw)
128 mtx_assert(&devmtx, MA_OWNED);
129 SLIST_INSERT_HEAD(&cdevsw_gt_post_list, csw, d_postfree_list);
140 dev_ref(struct cdev *dev)
143 mtx_assert(&devmtx, MA_NOTOWNED);
150 dev_refl(struct cdev *dev)
153 mtx_assert(&devmtx, MA_OWNED);
158 dev_rel(struct cdev *dev)
162 mtx_assert(&devmtx, MA_NOTOWNED);
165 KASSERT(dev->si_refcount >= 0,
166 ("dev_rel(%s) gave negative count", devtoname(dev)));
168 if (dev->si_usecount == 0 &&
169 (dev->si_flags & SI_CHEAPCLONE) && (dev->si_flags & SI_NAMED))
173 if (dev->si_devsw == NULL && dev->si_refcount == 0) {
174 LIST_REMOVE(dev, si_list);
183 dev_refthread(struct cdev *dev, int *ref)
186 struct cdev_priv *cdp;
188 mtx_assert(&devmtx, MA_NOTOWNED);
189 if ((dev->si_flags & SI_ETERNAL) != 0) {
191 return (dev->si_devsw);
196 cdp = cdev2priv(dev);
197 if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0)
198 atomic_add_long(&dev->si_threadcount, 1);
208 devvn_refthread(struct vnode *vp, struct cdev **devp, int *ref)
211 struct cdev_priv *cdp;
214 mtx_assert(&devmtx, MA_NOTOWNED);
215 if ((vp->v_vflag & VV_ETERNALDEV) != 0) {
219 KASSERT((dev->si_flags & SI_ETERNAL) != 0,
220 ("Not eternal cdev"));
223 KASSERT(csw != NULL, ("Eternal cdev is destroyed"));
235 cdp = cdev2priv(dev);
236 if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0) {
239 atomic_add_long(&dev->si_threadcount, 1);
250 dev_relthread(struct cdev *dev, int ref)
253 mtx_assert(&devmtx, MA_NOTOWNED);
256 KASSERT(dev->si_threadcount > 0,
257 ("%s threadcount is wrong", dev->si_name));
258 atomic_subtract_rel_long(&dev->si_threadcount, 1);
287 /* Define a dead_cdevsw for use when devices leave unexpectedly. */
289 #define dead_open (d_open_t *)enxio
290 #define dead_close (d_close_t *)enxio
291 #define dead_read (d_read_t *)enxio
292 #define dead_write (d_write_t *)enxio
293 #define dead_ioctl (d_ioctl_t *)enxio
294 #define dead_poll (d_poll_t *)enodev
295 #define dead_mmap (d_mmap_t *)enodev
298 dead_strategy(struct bio *bp)
301 biofinish(bp, NULL, ENXIO);
304 #define dead_dump (dumper_t *)enxio
305 #define dead_kqfilter (d_kqfilter_t *)enxio
306 #define dead_mmap_single (d_mmap_single_t *)enodev
308 static struct cdevsw dead_cdevsw = {
309 .d_version = D_VERSION,
311 .d_close = dead_close,
313 .d_write = dead_write,
314 .d_ioctl = dead_ioctl,
317 .d_strategy = dead_strategy,
320 .d_kqfilter = dead_kqfilter,
321 .d_mmap_single = dead_mmap_single
324 /* Default methods if driver does not specify method */
326 #define null_open (d_open_t *)nullop
327 #define null_close (d_close_t *)nullop
328 #define no_read (d_read_t *)enodev
329 #define no_write (d_write_t *)enodev
330 #define no_ioctl (d_ioctl_t *)enodev
331 #define no_mmap (d_mmap_t *)enodev
332 #define no_kqfilter (d_kqfilter_t *)enodev
333 #define no_mmap_single (d_mmap_single_t *)enodev
336 no_strategy(struct bio *bp)
339 biofinish(bp, NULL, ENODEV);
343 no_poll(struct cdev *dev __unused, int events, struct thread *td __unused)
346 return (poll_no_poll(events));
349 #define no_dump (dumper_t *)enodev
352 giant_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
357 dsw = dev_refthread(dev, &ref);
361 retval = dsw->d_gianttrick->d_open(dev, oflags, devtype, td);
363 dev_relthread(dev, ref);
368 giant_fdopen(struct cdev *dev, int oflags, struct thread *td, struct file *fp)
373 dsw = dev_refthread(dev, &ref);
377 retval = dsw->d_gianttrick->d_fdopen(dev, oflags, td, fp);
379 dev_relthread(dev, ref);
384 giant_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
389 dsw = dev_refthread(dev, &ref);
393 retval = dsw->d_gianttrick->d_close(dev, fflag, devtype, td);
395 dev_relthread(dev, ref);
400 giant_strategy(struct bio *bp)
407 dsw = dev_refthread(dev, &ref);
409 biofinish(bp, NULL, ENXIO);
413 dsw->d_gianttrick->d_strategy(bp);
415 dev_relthread(dev, ref);
419 giant_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
424 dsw = dev_refthread(dev, &ref);
428 retval = dsw->d_gianttrick->d_ioctl(dev, cmd, data, fflag, td);
430 dev_relthread(dev, ref);
435 giant_read(struct cdev *dev, struct uio *uio, int ioflag)
440 dsw = dev_refthread(dev, &ref);
444 retval = dsw->d_gianttrick->d_read(dev, uio, ioflag);
446 dev_relthread(dev, ref);
451 giant_write(struct cdev *dev, struct uio *uio, int ioflag)
456 dsw = dev_refthread(dev, &ref);
460 retval = dsw->d_gianttrick->d_write(dev, uio, ioflag);
462 dev_relthread(dev, ref);
467 giant_poll(struct cdev *dev, int events, struct thread *td)
472 dsw = dev_refthread(dev, &ref);
476 retval = dsw->d_gianttrick->d_poll(dev, events, td);
478 dev_relthread(dev, ref);
483 giant_kqfilter(struct cdev *dev, struct knote *kn)
488 dsw = dev_refthread(dev, &ref);
492 retval = dsw->d_gianttrick->d_kqfilter(dev, kn);
494 dev_relthread(dev, ref);
499 giant_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, int nprot,
500 vm_memattr_t *memattr)
505 dsw = dev_refthread(dev, &ref);
509 retval = dsw->d_gianttrick->d_mmap(dev, offset, paddr, nprot,
512 dev_relthread(dev, ref);
517 giant_mmap_single(struct cdev *dev, vm_ooffset_t *offset, vm_size_t size,
518 vm_object_t *object, int nprot)
523 dsw = dev_refthread(dev, &ref);
527 retval = dsw->d_gianttrick->d_mmap_single(dev, offset, size, object,
530 dev_relthread(dev, ref);
535 notify(struct cdev *dev, const char *ev, int flags)
537 static const char prefix[] = "cdev=";
543 mflags = (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK;
544 namelen = strlen(dev->si_name);
545 data = malloc(namelen + sizeof(prefix), M_TEMP, mflags);
548 memcpy(data, prefix, sizeof(prefix) - 1);
549 memcpy(data + sizeof(prefix) - 1, dev->si_name, namelen + 1);
550 devctl_notify_f("DEVFS", "CDEV", ev, data, mflags);
555 notify_create(struct cdev *dev, int flags)
558 notify(dev, "CREATE", flags);
562 notify_destroy(struct cdev *dev)
565 notify(dev, "DESTROY", MAKEDEV_WAITOK);
569 newdev(struct make_dev_args *args, struct cdev *si)
574 mtx_assert(&devmtx, MA_OWNED);
575 csw = args->mda_devsw;
576 if (csw->d_flags & D_NEEDMINOR) {
577 /* We may want to return an existing device */
578 LIST_FOREACH(si2, &csw->d_devs, si_list) {
579 if (dev2unit(si2) == args->mda_unit) {
580 dev_free_devlocked(si);
585 si->si_drv0 = args->mda_unit;
587 si->si_drv1 = args->mda_si_drv1;
588 si->si_drv2 = args->mda_si_drv2;
589 LIST_INSERT_HEAD(&csw->d_devs, si, si_list);
594 fini_cdevsw(struct cdevsw *devsw)
598 if (devsw->d_gianttrick != NULL) {
599 gt = devsw->d_gianttrick;
600 memcpy(devsw, gt, sizeof *devsw);
601 cdevsw_free_devlocked(gt);
602 devsw->d_gianttrick = NULL;
604 devsw->d_flags &= ~D_INIT;
608 prep_cdevsw(struct cdevsw *devsw, int flags)
612 mtx_assert(&devmtx, MA_OWNED);
613 if (devsw->d_flags & D_INIT)
615 if (devsw->d_flags & D_NEEDGIANT) {
617 dsw2 = malloc(sizeof *dsw2, M_DEVT,
618 (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK);
620 if (dsw2 == NULL && !(devsw->d_flags & D_INIT))
624 if (devsw->d_flags & D_INIT) {
626 cdevsw_free_devlocked(dsw2);
630 if (devsw->d_version != D_VERSION_03) {
632 "WARNING: Device driver \"%s\" has wrong version %s\n",
633 devsw->d_name == NULL ? "???" : devsw->d_name,
634 "and is disabled. Recompile KLD module.");
635 devsw->d_open = dead_open;
636 devsw->d_close = dead_close;
637 devsw->d_read = dead_read;
638 devsw->d_write = dead_write;
639 devsw->d_ioctl = dead_ioctl;
640 devsw->d_poll = dead_poll;
641 devsw->d_mmap = dead_mmap;
642 devsw->d_mmap_single = dead_mmap_single;
643 devsw->d_strategy = dead_strategy;
644 devsw->d_dump = dead_dump;
645 devsw->d_kqfilter = dead_kqfilter;
648 if (devsw->d_flags & D_NEEDGIANT) {
649 if (devsw->d_gianttrick == NULL) {
650 memcpy(dsw2, devsw, sizeof *dsw2);
651 devsw->d_gianttrick = dsw2;
656 #define FIXUP(member, noop, giant) \
658 if (devsw->member == NULL) { \
659 devsw->member = noop; \
660 } else if (devsw->d_flags & D_NEEDGIANT) \
661 devsw->member = giant; \
665 FIXUP(d_open, null_open, giant_open);
666 FIXUP(d_fdopen, NULL, giant_fdopen);
667 FIXUP(d_close, null_close, giant_close);
668 FIXUP(d_read, no_read, giant_read);
669 FIXUP(d_write, no_write, giant_write);
670 FIXUP(d_ioctl, no_ioctl, giant_ioctl);
671 FIXUP(d_poll, no_poll, giant_poll);
672 FIXUP(d_mmap, no_mmap, giant_mmap);
673 FIXUP(d_strategy, no_strategy, giant_strategy);
674 FIXUP(d_kqfilter, no_kqfilter, giant_kqfilter);
675 FIXUP(d_mmap_single, no_mmap_single, giant_mmap_single);
677 if (devsw->d_dump == NULL) devsw->d_dump = no_dump;
679 LIST_INIT(&devsw->d_devs);
681 devsw->d_flags |= D_INIT;
684 cdevsw_free_devlocked(dsw2);
689 prep_devname(struct cdev *dev, const char *fmt, va_list ap)
692 char *from, *q, *s, *to;
694 mtx_assert(&devmtx, MA_OWNED);
696 len = vsnrprintf(dev->si_name, sizeof(dev->si_name), 32, fmt, ap);
697 if (len > sizeof(dev->si_name) - 1)
698 return (ENAMETOOLONG);
700 /* Strip leading slashes. */
701 for (from = dev->si_name; *from == '/'; from++)
704 for (to = dev->si_name; *from != '\0'; from++, to++) {
706 * Spaces and double quotation marks cause
707 * problems for the devctl(4) protocol.
708 * Reject names containing those characters.
710 if (isspace(*from) || *from == '"')
712 /* Treat multiple sequential slashes as single. */
713 while (from[0] == '/' && from[1] == '/')
715 /* Trailing slash is considered invalid. */
716 if (from[0] == '/' && from[1] == '\0')
722 if (dev->si_name[0] == '\0')
725 /* Disallow "." and ".." components. */
726 for (s = dev->si_name;;) {
727 for (q = s; *q != '/' && *q != '\0'; q++)
729 if (q - s == 1 && s[0] == '.')
731 if (q - s == 2 && s[0] == '.' && s[1] == '.')
738 if (devfs_dev_exists(dev->si_name) != 0)
745 make_dev_args_init_impl(struct make_dev_args *args, size_t sz)
753 make_dev_sv(struct make_dev_args *args1, struct cdev **dres,
754 const char *fmt, va_list ap)
756 struct cdev *dev, *dev_new;
757 struct make_dev_args args;
760 bzero(&args, sizeof(args));
761 if (sizeof(args) < args1->mda_size)
763 bcopy(args1, &args, args1->mda_size);
764 KASSERT((args.mda_flags & MAKEDEV_WAITOK) == 0 ||
765 (args.mda_flags & MAKEDEV_NOWAIT) == 0,
766 ("make_dev_sv: both WAITOK and NOWAIT specified"));
767 dev_new = devfs_alloc(args.mda_flags);
771 res = prep_cdevsw(args.mda_devsw, args.mda_flags);
777 dev = newdev(&args, dev_new);
778 if ((dev->si_flags & SI_NAMED) == 0) {
779 res = prep_devname(dev, fmt, ap);
781 if ((args.mda_flags & MAKEDEV_CHECKNAME) == 0) {
783 "make_dev_sv: bad si_name (error=%d, si_name=%s)",
786 if (dev == dev_new) {
787 LIST_REMOVE(dev, si_list);
795 if ((args.mda_flags & MAKEDEV_REF) != 0)
797 if ((args.mda_flags & MAKEDEV_ETERNAL) != 0)
798 dev->si_flags |= SI_ETERNAL;
799 if (dev->si_flags & SI_CHEAPCLONE &&
800 dev->si_flags & SI_NAMED) {
802 * This is allowed as it removes races and generally
803 * simplifies cloning devices.
806 dev_unlock_and_free();
810 KASSERT(!(dev->si_flags & SI_NAMED),
811 ("make_dev() by driver %s on pre-existing device (min=%x, name=%s)",
812 args.mda_devsw->d_name, dev2unit(dev), devtoname(dev)));
813 dev->si_flags |= SI_NAMED;
814 if (args.mda_cr != NULL)
815 dev->si_cred = crhold(args.mda_cr);
816 dev->si_uid = args.mda_uid;
817 dev->si_gid = args.mda_gid;
818 dev->si_mode = args.mda_mode;
821 clean_unrhdrl(devfs_inos);
822 dev_unlock_and_free();
824 notify_create(dev, args.mda_flags);
831 make_dev_s(struct make_dev_args *args, struct cdev **dres,
832 const char *fmt, ...)
838 res = make_dev_sv(args, dres, fmt, ap);
844 make_dev_credv(int flags, struct cdev **dres, struct cdevsw *devsw, int unit,
845 struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
848 struct make_dev_args args;
850 make_dev_args_init(&args);
851 args.mda_flags = flags;
852 args.mda_devsw = devsw;
856 args.mda_mode = mode;
857 args.mda_unit = unit;
858 return (make_dev_sv(&args, dres, fmt, ap));
862 make_dev(struct cdevsw *devsw, int unit, uid_t uid, gid_t gid, int mode,
863 const char *fmt, ...)
870 res = make_dev_credv(0, &dev, devsw, unit, NULL, uid, gid, mode, fmt,
873 KASSERT(res == 0 && dev != NULL,
874 ("make_dev: failed make_dev_credv (error=%d)", res));
879 make_dev_cred(struct cdevsw *devsw, int unit, struct ucred *cr, uid_t uid,
880 gid_t gid, int mode, const char *fmt, ...)
887 res = make_dev_credv(0, &dev, devsw, unit, cr, uid, gid, mode, fmt, ap);
890 KASSERT(res == 0 && dev != NULL,
891 ("make_dev_cred: failed make_dev_credv (error=%d)", res));
896 make_dev_credf(int flags, struct cdevsw *devsw, int unit, struct ucred *cr,
897 uid_t uid, gid_t gid, int mode, const char *fmt, ...)
904 res = make_dev_credv(flags, &dev, devsw, unit, cr, uid, gid, mode,
908 KASSERT(((flags & MAKEDEV_NOWAIT) != 0 && res == ENOMEM) ||
909 ((flags & MAKEDEV_CHECKNAME) != 0 && res != ENOMEM) || res == 0,
910 ("make_dev_credf: failed make_dev_credv (error=%d)", res));
911 return (res == 0 ? dev : NULL);
915 make_dev_p(int flags, struct cdev **cdev, struct cdevsw *devsw,
916 struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt, ...)
922 res = make_dev_credv(flags, cdev, devsw, 0, cr, uid, gid, mode,
926 KASSERT(((flags & MAKEDEV_NOWAIT) != 0 && res == ENOMEM) ||
927 ((flags & MAKEDEV_CHECKNAME) != 0 && res != ENOMEM) || res == 0,
928 ("make_dev_p: failed make_dev_credv (error=%d)", res));
933 dev_dependsl(struct cdev *pdev, struct cdev *cdev)
936 cdev->si_parent = pdev;
937 cdev->si_flags |= SI_CHILD;
938 LIST_INSERT_HEAD(&pdev->si_children, cdev, si_siblings);
943 dev_depends(struct cdev *pdev, struct cdev *cdev)
947 dev_dependsl(pdev, cdev);
952 make_dev_alias_v(int flags, struct cdev **cdev, struct cdev *pdev,
953 const char *fmt, va_list ap)
958 KASSERT(pdev != NULL, ("make_dev_alias_v: pdev is NULL"));
959 KASSERT((flags & MAKEDEV_WAITOK) == 0 || (flags & MAKEDEV_NOWAIT) == 0,
960 ("make_dev_alias_v: both WAITOK and NOWAIT specified"));
961 KASSERT((flags & ~(MAKEDEV_WAITOK | MAKEDEV_NOWAIT |
962 MAKEDEV_CHECKNAME)) == 0,
963 ("make_dev_alias_v: invalid flags specified (flags=%02x)", flags));
965 dev = devfs_alloc(flags);
969 dev->si_flags |= SI_ALIAS;
970 error = prep_devname(dev, fmt, ap);
972 if ((flags & MAKEDEV_CHECKNAME) == 0) {
973 panic("make_dev_alias_v: bad si_name "
974 "(error=%d, si_name=%s)", error, dev->si_name);
980 dev->si_flags |= SI_NAMED;
982 dev_dependsl(pdev, dev);
983 clean_unrhdrl(devfs_inos);
986 notify_create(dev, flags);
993 make_dev_alias(struct cdev *pdev, const char *fmt, ...)
1000 res = make_dev_alias_v(MAKEDEV_WAITOK, &dev, pdev, fmt, ap);
1003 KASSERT(res == 0 && dev != NULL,
1004 ("make_dev_alias: failed make_dev_alias_v (error=%d)", res));
1009 make_dev_alias_p(int flags, struct cdev **cdev, struct cdev *pdev,
1010 const char *fmt, ...)
1016 res = make_dev_alias_v(flags, cdev, pdev, fmt, ap);
1022 make_dev_physpath_alias(int flags, struct cdev **cdev, struct cdev *pdev,
1023 struct cdev *old_alias, const char *physpath)
1027 int max_parentpath_len;
1029 int devfspathbuf_len;
1035 physpath_len = strlen(physpath);
1037 if (physpath_len == 0)
1040 if (strncmp("id1,", physpath, 4) == 0) {
1043 if (physpath_len == 0)
1047 max_parentpath_len = SPECNAMELEN - physpath_len - /*/*/1;
1048 parentpath_len = strlen(pdev->si_name);
1049 if (max_parentpath_len < parentpath_len) {
1051 printf("WARNING: Unable to alias %s "
1052 "to %s/%s - path too long\n",
1053 pdev->si_name, physpath, pdev->si_name);
1058 mflags = (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK;
1059 devfspathbuf_len = physpath_len + /*/*/1 + parentpath_len + /*NUL*/1;
1060 devfspath = malloc(devfspathbuf_len, M_DEVBUF, mflags);
1061 if (devfspath == NULL) {
1066 sprintf(devfspath, "%s/%s", physpath, pdev->si_name);
1067 if (old_alias != NULL && strcmp(old_alias->si_name, devfspath) == 0) {
1068 /* Retain the existing alias. */
1073 ret = make_dev_alias_p(flags, cdev, pdev, "%s", devfspath);
1076 if (old_alias != NULL)
1077 destroy_dev(old_alias);
1078 if (devfspath != NULL)
1079 free(devfspath, M_DEVBUF);
1084 destroy_devl(struct cdev *dev)
1087 struct cdev_privdata *p;
1088 struct cdev_priv *cdp;
1090 mtx_assert(&devmtx, MA_OWNED);
1091 KASSERT(dev->si_flags & SI_NAMED,
1092 ("WARNING: Driver mistake: destroy_dev on %d\n", dev2unit(dev)));
1093 KASSERT((dev->si_flags & SI_ETERNAL) == 0,
1094 ("WARNING: Driver mistake: destroy_dev on eternal %d\n",
1097 cdp = cdev2priv(dev);
1098 if ((cdp->cdp_flags & CDP_UNREF_DTR) == 0) {
1100 * Avoid race with dev_rel(), e.g. from the populate
1101 * loop. If CDP_UNREF_DTR flag is set, the reference
1102 * to be dropped at the end of destroy_devl() was
1103 * already taken by delist_dev_locked().
1110 /* Remove name marking */
1111 dev->si_flags &= ~SI_NAMED;
1113 /* If we are a child, remove us from the parents list */
1114 if (dev->si_flags & SI_CHILD) {
1115 LIST_REMOVE(dev, si_siblings);
1116 dev->si_flags &= ~SI_CHILD;
1119 /* Kill our children */
1120 while (!LIST_EMPTY(&dev->si_children))
1121 destroy_devl(LIST_FIRST(&dev->si_children));
1123 /* Remove from clone list */
1124 if (dev->si_flags & SI_CLONELIST) {
1125 LIST_REMOVE(dev, si_clone);
1126 dev->si_flags &= ~SI_CLONELIST;
1129 csw = dev->si_devsw;
1130 dev->si_devsw = NULL; /* already NULL for SI_ALIAS */
1131 while (csw != NULL && csw->d_purge != NULL && dev->si_threadcount) {
1133 msleep(csw, &devmtx, PRIBIO, "devprg", hz/10);
1134 if (dev->si_threadcount)
1135 printf("Still %lu threads in %s\n",
1136 dev->si_threadcount, devtoname(dev));
1138 while (dev->si_threadcount != 0) {
1139 /* Use unique dummy wait ident */
1140 msleep(&csw, &devmtx, PRIBIO, "devdrn", hz / 10);
1144 if ((cdp->cdp_flags & CDP_UNREF_DTR) == 0) {
1145 /* avoid out of order notify events */
1146 notify_destroy(dev);
1148 mtx_lock(&cdevpriv_mtx);
1149 while ((p = LIST_FIRST(&cdp->cdp_fdpriv)) != NULL) {
1150 devfs_destroy_cdevpriv(p);
1151 mtx_lock(&cdevpriv_mtx);
1153 mtx_unlock(&cdevpriv_mtx);
1158 bzero(&dev->__si_u, sizeof(dev->__si_u));
1160 if (!(dev->si_flags & SI_ALIAS)) {
1161 /* Remove from cdevsw list */
1162 LIST_REMOVE(dev, si_list);
1164 /* If cdevsw has no more struct cdev *'s, clean it */
1165 if (LIST_EMPTY(&csw->d_devs)) {
1167 wakeup(&csw->d_devs);
1170 dev->si_flags &= ~SI_ALIAS;
1171 cdp->cdp_flags &= ~CDP_UNREF_DTR;
1174 if (dev->si_refcount > 0)
1175 LIST_INSERT_HEAD(&dead_cdevsw.d_devs, dev, si_list);
1177 dev_free_devlocked(dev);
1181 delist_dev_locked(struct cdev *dev)
1183 struct cdev_priv *cdp;
1186 mtx_assert(&devmtx, MA_OWNED);
1187 cdp = cdev2priv(dev);
1188 if ((cdp->cdp_flags & CDP_UNREF_DTR) != 0)
1190 cdp->cdp_flags |= CDP_UNREF_DTR;
1193 LIST_FOREACH(child, &dev->si_children, si_siblings)
1194 delist_dev_locked(child);
1196 /* ensure the destroy event is queued in order */
1197 notify_destroy(dev);
1202 * This function will delist a character device and its children from
1203 * the directory listing and create a destroy event without waiting
1204 * for all character device references to go away. At some later point
1205 * destroy_dev() must be called to complete the character device
1206 * destruction. After calling this function the character device name
1207 * can instantly be re-used.
1210 delist_dev(struct cdev *dev)
1213 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "delist_dev");
1215 delist_dev_locked(dev);
1220 destroy_dev(struct cdev *dev)
1223 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "destroy_dev");
1226 dev_unlock_and_free();
1230 devtoname(struct cdev *dev)
1233 return (dev->si_name);
1237 dev_stdclone(char *name, char **namep, const char *stem, int *unit)
1242 if (bcmp(stem, name, i) != 0)
1244 if (!isdigit(name[i]))
1247 if (name[i] == '0' && isdigit(name[i+1]))
1249 while (isdigit(name[i])) {
1251 u += name[i++] - '0';
1264 * Helper functions for cloning device drivers.
1266 * The objective here is to make it unnecessary for the device drivers to
1267 * use rman or similar to manage their unit number space. Due to the way
1268 * we do "on-demand" devices, using rman or other "private" methods
1269 * will be very tricky to lock down properly once we lock down this file.
1271 * Instead we give the drivers these routines which puts the struct cdev *'s
1272 * that are to be managed on their own list, and gives the driver the ability
1273 * to ask for the first free unit number or a given specified unit number.
1275 * In addition these routines support paired devices (pty, nmdm and similar)
1276 * by respecting a number of "flag" bits in the minor number.
1281 LIST_HEAD(,cdev) head;
1285 clone_setup(struct clonedevs **cdp)
1288 *cdp = malloc(sizeof **cdp, M_DEVBUF, M_WAITOK | M_ZERO);
1289 LIST_INIT(&(*cdp)->head);
1293 clone_create(struct clonedevs **cdp, struct cdevsw *csw, int *up,
1294 struct cdev **dp, int extra)
1296 struct clonedevs *cd;
1297 struct cdev *dev, *ndev, *dl, *de;
1298 struct make_dev_args args;
1301 KASSERT(*cdp != NULL,
1302 ("clone_setup() not called in driver \"%s\"", csw->d_name));
1303 KASSERT(!(extra & CLONE_UNITMASK),
1304 ("Illegal extra bits (0x%x) in clone_create", extra));
1305 KASSERT(*up <= CLONE_UNITMASK,
1306 ("Too high unit (0x%x) in clone_create", *up));
1307 KASSERT(csw->d_flags & D_NEEDMINOR,
1308 ("clone_create() on cdevsw without minor numbers"));
1312 * Search the list for a lot of things in one go:
1313 * A preexisting match is returned immediately.
1314 * The lowest free unit number if we are passed -1, and the place
1315 * in the list where we should insert that new element.
1316 * The place to insert a specified unit number, if applicable
1317 * the end of the list.
1320 ndev = devfs_alloc(MAKEDEV_WAITOK);
1322 prep_cdevsw(csw, MAKEDEV_WAITOK);
1326 LIST_FOREACH(dev, &cd->head, si_clone) {
1327 KASSERT(dev->si_flags & SI_CLONELIST,
1328 ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1330 if (u == (unit | extra)) {
1336 if (unit == -1 && u == low) {
1340 } else if (u < (unit | extra)) {
1343 } else if (u > (unit | extra)) {
1349 unit = low & CLONE_UNITMASK;
1350 make_dev_args_init(&args);
1351 args.mda_unit = unit | extra;
1352 args.mda_devsw = csw;
1353 dev = newdev(&args, ndev);
1354 if (dev->si_flags & SI_CLONELIST) {
1355 printf("dev %p (%s) is on clonelist\n", dev, dev->si_name);
1356 printf("unit=%d, low=%d, extra=0x%x\n", unit, low, extra);
1357 LIST_FOREACH(dev, &cd->head, si_clone) {
1358 printf("\t%p %s\n", dev, dev->si_name);
1362 KASSERT(!(dev->si_flags & SI_CLONELIST),
1363 ("Dev %p(%s) should not be on clonelist", dev, dev->si_name));
1365 LIST_INSERT_BEFORE(dl, dev, si_clone);
1366 else if (de != NULL)
1367 LIST_INSERT_AFTER(de, dev, si_clone);
1369 LIST_INSERT_HEAD(&cd->head, dev, si_clone);
1370 dev->si_flags |= SI_CLONELIST;
1372 dev_unlock_and_free();
1377 * Kill everything still on the list. The driver should already have
1378 * disposed of any softc hung of the struct cdev *'s at this time.
1381 clone_cleanup(struct clonedevs **cdp)
1384 struct cdev_priv *cp;
1385 struct clonedevs *cd;
1391 while (!LIST_EMPTY(&cd->head)) {
1392 dev = LIST_FIRST(&cd->head);
1393 LIST_REMOVE(dev, si_clone);
1394 KASSERT(dev->si_flags & SI_CLONELIST,
1395 ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1396 dev->si_flags &= ~SI_CLONELIST;
1397 cp = cdev2priv(dev);
1398 if (!(cp->cdp_flags & CDP_SCHED_DTR)) {
1399 cp->cdp_flags |= CDP_SCHED_DTR;
1400 KASSERT(dev->si_flags & SI_NAMED,
1401 ("Driver has goofed in cloning underways udev %x unit %x", dev2udev(dev), dev2unit(dev)));
1405 dev_unlock_and_free();
1410 static TAILQ_HEAD(, cdev_priv) dev_ddtr =
1411 TAILQ_HEAD_INITIALIZER(dev_ddtr);
1412 static struct task dev_dtr_task = TASK_INITIALIZER(0, destroy_dev_tq, NULL);
1415 destroy_dev_tq(void *ctx, int pending)
1417 struct cdev_priv *cp;
1423 while (!TAILQ_EMPTY(&dev_ddtr)) {
1424 cp = TAILQ_FIRST(&dev_ddtr);
1426 KASSERT(cp->cdp_flags & CDP_SCHED_DTR,
1427 ("cdev %p in dev_destroy_tq without CDP_SCHED_DTR", cp));
1428 TAILQ_REMOVE(&dev_ddtr, cp, cdp_dtr_list);
1429 cb = cp->cdp_dtr_cb;
1430 cb_arg = cp->cdp_dtr_cb_arg;
1432 dev_unlock_and_free();
1442 * devmtx shall be locked on entry. devmtx will be unlocked after
1446 destroy_dev_sched_cbl(struct cdev *dev, void (*cb)(void *), void *arg)
1448 struct cdev_priv *cp;
1450 mtx_assert(&devmtx, MA_OWNED);
1451 cp = cdev2priv(dev);
1452 if (cp->cdp_flags & CDP_SCHED_DTR) {
1457 cp->cdp_flags |= CDP_SCHED_DTR;
1458 cp->cdp_dtr_cb = cb;
1459 cp->cdp_dtr_cb_arg = arg;
1460 TAILQ_INSERT_TAIL(&dev_ddtr, cp, cdp_dtr_list);
1462 taskqueue_enqueue(taskqueue_swi_giant, &dev_dtr_task);
1467 destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg)
1471 return (destroy_dev_sched_cbl(dev, cb, arg));
1475 destroy_dev_sched(struct cdev *dev)
1478 return (destroy_dev_sched_cb(dev, NULL, NULL));
1482 destroy_dev_drain(struct cdevsw *csw)
1486 while (!LIST_EMPTY(&csw->d_devs)) {
1487 msleep(&csw->d_devs, &devmtx, PRIBIO, "devscd", hz/10);
1493 drain_dev_clone_events(void)
1496 sx_xlock(&clone_drain_lock);
1497 sx_xunlock(&clone_drain_lock);
1500 #include "opt_ddb.h"
1502 #include <sys/kernel.h>
1504 #include <ddb/ddb.h>
1506 DB_SHOW_COMMAND(cdev, db_show_cdev)
1508 struct cdev_priv *cdp;
1514 TAILQ_FOREACH(cdp, &cdevp_list, cdp_list) {
1516 db_printf("%s %p\n", dev->si_name, dev);
1523 dev = (struct cdev *)addr;
1524 cdp = cdev2priv(dev);
1525 db_printf("dev %s ref %d use %ld thr %ld inuse %u fdpriv %p\n",
1526 dev->si_name, dev->si_refcount, dev->si_usecount,
1527 dev->si_threadcount, cdp->cdp_inuse, cdp->cdp_fdpriv.lh_first);
1528 db_printf("devsw %p si_drv0 %d si_drv1 %p si_drv2 %p\n",
1529 dev->si_devsw, dev->si_drv0, dev->si_drv1, dev->si_drv2);
1530 flags = dev->si_flags;
1531 #define SI_FLAG(flag) do { \
1532 if (flags & (flag)) { \
1533 if (buf[0] != '\0') \
1534 strlcat(buf, ", ", sizeof(buf)); \
1535 strlcat(buf, (#flag) + 3, sizeof(buf)); \
1540 SI_FLAG(SI_ETERNAL);
1543 SI_FLAG(SI_CHEAPCLONE);
1545 SI_FLAG(SI_DUMPDEV);
1546 SI_FLAG(SI_CLONELIST);
1547 db_printf("si_flags %s\n", buf);
1549 flags = cdp->cdp_flags;
1550 #define CDP_FLAG(flag) do { \
1551 if (flags & (flag)) { \
1552 if (buf[0] != '\0') \
1553 strlcat(buf, ", ", sizeof(buf)); \
1554 strlcat(buf, (#flag) + 4, sizeof(buf)); \
1559 CDP_FLAG(CDP_ACTIVE);
1560 CDP_FLAG(CDP_SCHED_DTR);
1561 db_printf("cdp_flags %s\n", buf);