FreeBSD/Linux Kernel Cross Reference
sys/kern/kern_conf.c
1 /*-
2 * Copyright (c) 1999-2002 Poul-Henning Kamp
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/systm.h>
33 #include <sys/bus.h>
34 #include <sys/bio.h>
35 #include <sys/lock.h>
36 #include <sys/mutex.h>
37 #include <sys/module.h>
38 #include <sys/malloc.h>
39 #include <sys/conf.h>
40 #include <sys/vnode.h>
41 #include <sys/queue.h>
42 #include <sys/poll.h>
43 #include <sys/sx.h>
44 #include <sys/ctype.h>
45 #include <sys/ucred.h>
46 #include <sys/taskqueue.h>
47 #include <machine/stdarg.h>
48
49 #include <fs/devfs/devfs_int.h>
50 #include <vm/vm.h>
51
52 static MALLOC_DEFINE(M_DEVT, "cdev", "cdev storage");
53
54 struct mtx devmtx;
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 int make_dev_credv(int flags, struct cdev **dres, struct cdevsw *devsw,
59 int unit, struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
60 va_list ap);
61
62 static struct cdev_priv_list cdevp_free_list =
63 TAILQ_HEAD_INITIALIZER(cdevp_free_list);
64 static SLIST_HEAD(free_cdevsw, cdevsw) cdevsw_gt_post_list =
65 SLIST_HEAD_INITIALIZER(cdevsw_gt_post_list);
66
67 void
68 dev_lock(void)
69 {
70
71 mtx_lock(&devmtx);
72 }
73
74 /*
75 * Free all the memory collected while the cdev mutex was
76 * locked. Since devmtx is after the system map mutex, free() cannot
77 * be called immediately and is postponed until cdev mutex can be
78 * dropped.
79 */
80 static void
81 dev_unlock_and_free(void)
82 {
83 struct cdev_priv_list cdp_free;
84 struct free_cdevsw csw_free;
85 struct cdev_priv *cdp;
86 struct cdevsw *csw;
87
88 mtx_assert(&devmtx, MA_OWNED);
89
90 /*
91 * Make the local copy of the list heads while the dev_mtx is
92 * held. Free it later.
93 */
94 TAILQ_INIT(&cdp_free);
95 TAILQ_CONCAT(&cdp_free, &cdevp_free_list, cdp_list);
96 csw_free = cdevsw_gt_post_list;
97 SLIST_INIT(&cdevsw_gt_post_list);
98
99 mtx_unlock(&devmtx);
100
101 while ((cdp = TAILQ_FIRST(&cdp_free)) != NULL) {
102 TAILQ_REMOVE(&cdp_free, cdp, cdp_list);
103 devfs_free(&cdp->cdp_c);
104 }
105 while ((csw = SLIST_FIRST(&csw_free)) != NULL) {
106 SLIST_REMOVE_HEAD(&csw_free, d_postfree_list);
107 free(csw, M_DEVT);
108 }
109 }
110
111 static void
112 dev_free_devlocked(struct cdev *cdev)
113 {
114 struct cdev_priv *cdp;
115
116 mtx_assert(&devmtx, MA_OWNED);
117 cdp = cdev2priv(cdev);
118 KASSERT((cdp->cdp_flags & CDP_UNREF_DTR) == 0,
119 ("destroy_dev() was not called after delist_dev(%p)", cdev));
120 TAILQ_INSERT_HEAD(&cdevp_free_list, cdp, cdp_list);
121 }
122
123 static void
124 cdevsw_free_devlocked(struct cdevsw *csw)
125 {
126
127 mtx_assert(&devmtx, MA_OWNED);
128 SLIST_INSERT_HEAD(&cdevsw_gt_post_list, csw, d_postfree_list);
129 }
130
131 void
132 dev_unlock(void)
133 {
134
135 mtx_unlock(&devmtx);
136 }
137
138 void
139 dev_ref(struct cdev *dev)
140 {
141
142 mtx_assert(&devmtx, MA_NOTOWNED);
143 mtx_lock(&devmtx);
144 dev->si_refcount++;
145 mtx_unlock(&devmtx);
146 }
147
148 void
149 dev_refl(struct cdev *dev)
150 {
151
152 mtx_assert(&devmtx, MA_OWNED);
153 dev->si_refcount++;
154 }
155
156 void
157 dev_rel(struct cdev *dev)
158 {
159 int flag = 0;
160
161 mtx_assert(&devmtx, MA_NOTOWNED);
162 dev_lock();
163 dev->si_refcount--;
164 KASSERT(dev->si_refcount >= 0,
165 ("dev_rel(%s) gave negative count", devtoname(dev)));
166 #if 0
167 if (dev->si_usecount == 0 &&
168 (dev->si_flags & SI_CHEAPCLONE) && (dev->si_flags & SI_NAMED))
169 ;
170 else
171 #endif
172 if (dev->si_devsw == NULL && dev->si_refcount == 0) {
173 LIST_REMOVE(dev, si_list);
174 flag = 1;
175 }
176 dev_unlock();
177 if (flag)
178 devfs_free(dev);
179 }
180
181 struct cdevsw *
182 dev_refthread(struct cdev *dev, int *ref)
183 {
184 struct cdevsw *csw;
185 struct cdev_priv *cdp;
186
187 mtx_assert(&devmtx, MA_NOTOWNED);
188 if ((dev->si_flags & SI_ETERNAL) != 0) {
189 *ref = 0;
190 return (dev->si_devsw);
191 }
192 dev_lock();
193 csw = dev->si_devsw;
194 if (csw != NULL) {
195 cdp = cdev2priv(dev);
196 if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0)
197 dev->si_threadcount++;
198 else
199 csw = NULL;
200 }
201 dev_unlock();
202 *ref = 1;
203 return (csw);
204 }
205
206 struct cdevsw *
207 devvn_refthread(struct vnode *vp, struct cdev **devp, int *ref)
208 {
209 struct cdevsw *csw;
210 struct cdev_priv *cdp;
211 struct cdev *dev;
212
213 mtx_assert(&devmtx, MA_NOTOWNED);
214 if ((vp->v_vflag & VV_ETERNALDEV) != 0) {
215 dev = vp->v_rdev;
216 if (dev == NULL)
217 return (NULL);
218 KASSERT((dev->si_flags & SI_ETERNAL) != 0,
219 ("Not eternal cdev"));
220 *ref = 0;
221 csw = dev->si_devsw;
222 KASSERT(csw != NULL, ("Eternal cdev is destroyed"));
223 *devp = dev;
224 return (csw);
225 }
226
227 csw = NULL;
228 dev_lock();
229 dev = vp->v_rdev;
230 if (dev == NULL) {
231 dev_unlock();
232 return (NULL);
233 }
234 cdp = cdev2priv(dev);
235 if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0) {
236 csw = dev->si_devsw;
237 if (csw != NULL)
238 dev->si_threadcount++;
239 }
240 dev_unlock();
241 if (csw != NULL) {
242 *devp = dev;
243 *ref = 1;
244 }
245 return (csw);
246 }
247
248 void
249 dev_relthread(struct cdev *dev, int ref)
250 {
251
252 mtx_assert(&devmtx, MA_NOTOWNED);
253 if (!ref)
254 return;
255 dev_lock();
256 KASSERT(dev->si_threadcount > 0,
257 ("%s threadcount is wrong", dev->si_name));
258 dev->si_threadcount--;
259 dev_unlock();
260 }
261
262 int
263 nullop(void)
264 {
265
266 return (0);
267 }
268
269 int
270 eopnotsupp(void)
271 {
272
273 return (EOPNOTSUPP);
274 }
275
276 static int
277 enxio(void)
278 {
279 return (ENXIO);
280 }
281
282 static int
283 enodev(void)
284 {
285 return (ENODEV);
286 }
287
288 /* Define a dead_cdevsw for use when devices leave unexpectedly. */
289
290 #define dead_open (d_open_t *)enxio
291 #define dead_close (d_close_t *)enxio
292 #define dead_read (d_read_t *)enxio
293 #define dead_write (d_write_t *)enxio
294 #define dead_ioctl (d_ioctl_t *)enxio
295 #define dead_poll (d_poll_t *)enodev
296 #define dead_mmap (d_mmap_t *)enodev
297
298 static void
299 dead_strategy(struct bio *bp)
300 {
301
302 biofinish(bp, NULL, ENXIO);
303 }
304
305 #define dead_dump (dumper_t *)enxio
306 #define dead_kqfilter (d_kqfilter_t *)enxio
307 #define dead_mmap_single (d_mmap_single_t *)enodev
308
309 static struct cdevsw dead_cdevsw = {
310 .d_version = D_VERSION,
311 .d_open = dead_open,
312 .d_close = dead_close,
313 .d_read = dead_read,
314 .d_write = dead_write,
315 .d_ioctl = dead_ioctl,
316 .d_poll = dead_poll,
317 .d_mmap = dead_mmap,
318 .d_strategy = dead_strategy,
319 .d_name = "dead",
320 .d_dump = dead_dump,
321 .d_kqfilter = dead_kqfilter,
322 .d_mmap_single = dead_mmap_single
323 };
324
325 /* Default methods if driver does not specify method */
326
327 #define null_open (d_open_t *)nullop
328 #define null_close (d_close_t *)nullop
329 #define no_read (d_read_t *)enodev
330 #define no_write (d_write_t *)enodev
331 #define no_ioctl (d_ioctl_t *)enodev
332 #define no_mmap (d_mmap2_t *)enodev
333 #define no_kqfilter (d_kqfilter_t *)enodev
334 #define no_mmap_single (d_mmap_single_t *)enodev
335
336 static void
337 no_strategy(struct bio *bp)
338 {
339
340 biofinish(bp, NULL, ENODEV);
341 }
342
343 static int
344 no_poll(struct cdev *dev __unused, int events, struct thread *td __unused)
345 {
346
347 return (poll_no_poll(events));
348 }
349
350 #define no_dump (dumper_t *)enodev
351
352 static int
353 giant_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
354 {
355 struct cdevsw *dsw;
356 int ref, retval;
357
358 dsw = dev_refthread(dev, &ref);
359 if (dsw == NULL)
360 return (ENXIO);
361 mtx_lock(&Giant);
362 retval = dsw->d_gianttrick->d_open(dev, oflags, devtype, td);
363 mtx_unlock(&Giant);
364 dev_relthread(dev, ref);
365 return (retval);
366 }
367
368 static int
369 giant_fdopen(struct cdev *dev, int oflags, struct thread *td, struct file *fp)
370 {
371 struct cdevsw *dsw;
372 int ref, retval;
373
374 dsw = dev_refthread(dev, &ref);
375 if (dsw == NULL)
376 return (ENXIO);
377 mtx_lock(&Giant);
378 retval = dsw->d_gianttrick->d_fdopen(dev, oflags, td, fp);
379 mtx_unlock(&Giant);
380 dev_relthread(dev, ref);
381 return (retval);
382 }
383
384 static int
385 giant_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
386 {
387 struct cdevsw *dsw;
388 int ref, retval;
389
390 dsw = dev_refthread(dev, &ref);
391 if (dsw == NULL)
392 return (ENXIO);
393 mtx_lock(&Giant);
394 retval = dsw->d_gianttrick->d_close(dev, fflag, devtype, td);
395 mtx_unlock(&Giant);
396 dev_relthread(dev, ref);
397 return (retval);
398 }
399
400 static void
401 giant_strategy(struct bio *bp)
402 {
403 struct cdevsw *dsw;
404 struct cdev *dev;
405 int ref;
406
407 dev = bp->bio_dev;
408 dsw = dev_refthread(dev, &ref);
409 if (dsw == NULL) {
410 biofinish(bp, NULL, ENXIO);
411 return;
412 }
413 mtx_lock(&Giant);
414 dsw->d_gianttrick->d_strategy(bp);
415 mtx_unlock(&Giant);
416 dev_relthread(dev, ref);
417 }
418
419 static int
420 giant_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
421 {
422 struct cdevsw *dsw;
423 int ref, retval;
424
425 dsw = dev_refthread(dev, &ref);
426 if (dsw == NULL)
427 return (ENXIO);
428 mtx_lock(&Giant);
429 retval = dsw->d_gianttrick->d_ioctl(dev, cmd, data, fflag, td);
430 mtx_unlock(&Giant);
431 dev_relthread(dev, ref);
432 return (retval);
433 }
434
435 static int
436 giant_read(struct cdev *dev, struct uio *uio, int ioflag)
437 {
438 struct cdevsw *dsw;
439 int ref, retval;
440
441 dsw = dev_refthread(dev, &ref);
442 if (dsw == NULL)
443 return (ENXIO);
444 mtx_lock(&Giant);
445 retval = dsw->d_gianttrick->d_read(dev, uio, ioflag);
446 mtx_unlock(&Giant);
447 dev_relthread(dev, ref);
448 return (retval);
449 }
450
451 static int
452 giant_write(struct cdev *dev, struct uio *uio, int ioflag)
453 {
454 struct cdevsw *dsw;
455 int ref, retval;
456
457 dsw = dev_refthread(dev, &ref);
458 if (dsw == NULL)
459 return (ENXIO);
460 mtx_lock(&Giant);
461 retval = dsw->d_gianttrick->d_write(dev, uio, ioflag);
462 mtx_unlock(&Giant);
463 dev_relthread(dev, ref);
464 return (retval);
465 }
466
467 static int
468 giant_poll(struct cdev *dev, int events, struct thread *td)
469 {
470 struct cdevsw *dsw;
471 int ref, retval;
472
473 dsw = dev_refthread(dev, &ref);
474 if (dsw == NULL)
475 return (ENXIO);
476 mtx_lock(&Giant);
477 retval = dsw->d_gianttrick->d_poll(dev, events, td);
478 mtx_unlock(&Giant);
479 dev_relthread(dev, ref);
480 return (retval);
481 }
482
483 static int
484 giant_kqfilter(struct cdev *dev, struct knote *kn)
485 {
486 struct cdevsw *dsw;
487 int ref, retval;
488
489 dsw = dev_refthread(dev, &ref);
490 if (dsw == NULL)
491 return (ENXIO);
492 mtx_lock(&Giant);
493 retval = dsw->d_gianttrick->d_kqfilter(dev, kn);
494 mtx_unlock(&Giant);
495 dev_relthread(dev, ref);
496 return (retval);
497 }
498
499 static int
500 giant_mmap(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, int nprot,
501 vm_memattr_t *memattr)
502 {
503 struct cdevsw *dsw;
504 int ref, retval;
505
506 dsw = dev_refthread(dev, &ref);
507 if (dsw == NULL)
508 return (ENXIO);
509 mtx_lock(&Giant);
510 if (dsw->d_gianttrick->d_flags & D_MMAP2)
511 retval = dsw->d_gianttrick->d_mmap2(dev, offset, paddr, nprot,
512 memattr);
513 else
514 retval = dsw->d_gianttrick->d_mmap(dev, offset, paddr, nprot);
515 mtx_unlock(&Giant);
516 dev_relthread(dev, ref);
517 return (retval);
518 }
519
520 static int
521 giant_mmap_single(struct cdev *dev, vm_ooffset_t *offset, vm_size_t size,
522 vm_object_t *object, int nprot)
523 {
524 struct cdevsw *dsw;
525 int ref, retval;
526
527 dsw = dev_refthread(dev, &ref);
528 if (dsw == NULL)
529 return (ENXIO);
530 mtx_lock(&Giant);
531 retval = dsw->d_gianttrick->d_mmap_single(dev, offset, size, object,
532 nprot);
533 mtx_unlock(&Giant);
534 dev_relthread(dev, ref);
535 return (retval);
536 }
537
538 static void
539 notify(struct cdev *dev, const char *ev, int flags)
540 {
541 static const char prefix[] = "cdev=";
542 char *data;
543 int namelen, mflags;
544
545 if (cold)
546 return;
547 mflags = (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK;
548 namelen = strlen(dev->si_name);
549 data = malloc(namelen + sizeof(prefix), M_TEMP, mflags);
550 if (data == NULL)
551 return;
552 memcpy(data, prefix, sizeof(prefix) - 1);
553 memcpy(data + sizeof(prefix) - 1, dev->si_name, namelen + 1);
554 devctl_notify_f("DEVFS", "CDEV", ev, data, mflags);
555 free(data, M_TEMP);
556 }
557
558 static void
559 notify_create(struct cdev *dev, int flags)
560 {
561
562 notify(dev, "CREATE", flags);
563 }
564
565 static void
566 notify_destroy(struct cdev *dev)
567 {
568
569 notify(dev, "DESTROY", MAKEDEV_WAITOK);
570 }
571
572 static struct cdev *
573 newdev(struct cdevsw *csw, int unit, struct cdev *si)
574 {
575 struct cdev *si2;
576
577 mtx_assert(&devmtx, MA_OWNED);
578 if (csw->d_flags & D_NEEDMINOR) {
579 /* We may want to return an existing device */
580 LIST_FOREACH(si2, &csw->d_devs, si_list) {
581 if (dev2unit(si2) == unit) {
582 dev_free_devlocked(si);
583 return (si2);
584 }
585 }
586 }
587 si->si_drv0 = unit;
588 si->si_devsw = csw;
589 LIST_INSERT_HEAD(&csw->d_devs, si, si_list);
590 return (si);
591 }
592
593 static void
594 fini_cdevsw(struct cdevsw *devsw)
595 {
596 struct cdevsw *gt;
597
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;
603 }
604 devsw->d_flags &= ~D_INIT;
605 }
606
607 static int
608 prep_cdevsw(struct cdevsw *devsw, int flags)
609 {
610 struct cdevsw *dsw2;
611
612 mtx_assert(&devmtx, MA_OWNED);
613 if (devsw->d_flags & D_INIT)
614 return (0);
615 if (devsw->d_flags & D_NEEDGIANT) {
616 dev_unlock();
617 dsw2 = malloc(sizeof *dsw2, M_DEVT,
618 (flags & MAKEDEV_NOWAIT) ? M_NOWAIT : M_WAITOK);
619 dev_lock();
620 if (dsw2 == NULL && !(devsw->d_flags & D_INIT))
621 return (ENOMEM);
622 } else
623 dsw2 = NULL;
624 if (devsw->d_flags & D_INIT) {
625 if (dsw2 != NULL)
626 cdevsw_free_devlocked(dsw2);
627 return (0);
628 }
629
630 if (devsw->d_version != D_VERSION_01 &&
631 devsw->d_version != D_VERSION_02) {
632 printf(
633 "WARNING: Device driver \"%s\" has wrong version %s\n",
634 devsw->d_name == NULL ? "???" : devsw->d_name,
635 "and is disabled. Recompile KLD module.");
636 devsw->d_open = dead_open;
637 devsw->d_close = dead_close;
638 devsw->d_read = dead_read;
639 devsw->d_write = dead_write;
640 devsw->d_ioctl = dead_ioctl;
641 devsw->d_poll = dead_poll;
642 devsw->d_mmap = dead_mmap;
643 devsw->d_strategy = dead_strategy;
644 devsw->d_dump = dead_dump;
645 devsw->d_kqfilter = dead_kqfilter;
646 }
647 if (devsw->d_version == D_VERSION_01)
648 devsw->d_mmap_single = NULL;
649
650 if (devsw->d_flags & D_NEEDGIANT) {
651 if (devsw->d_gianttrick == NULL) {
652 memcpy(dsw2, devsw, sizeof *dsw2);
653 devsw->d_gianttrick = dsw2;
654 devsw->d_flags |= D_MMAP2;
655 dsw2 = NULL;
656 }
657 }
658
659 #define FIXUP(member, noop, giant) \
660 do { \
661 if (devsw->member == NULL) { \
662 devsw->member = noop; \
663 } else if (devsw->d_flags & D_NEEDGIANT) \
664 devsw->member = giant; \
665 } \
666 while (0)
667
668 FIXUP(d_open, null_open, giant_open);
669 FIXUP(d_fdopen, NULL, giant_fdopen);
670 FIXUP(d_close, null_close, giant_close);
671 FIXUP(d_read, no_read, giant_read);
672 FIXUP(d_write, no_write, giant_write);
673 FIXUP(d_ioctl, no_ioctl, giant_ioctl);
674 FIXUP(d_poll, no_poll, giant_poll);
675 FIXUP(d_mmap2, no_mmap, giant_mmap);
676 FIXUP(d_strategy, no_strategy, giant_strategy);
677 FIXUP(d_kqfilter, no_kqfilter, giant_kqfilter);
678 FIXUP(d_mmap_single, no_mmap_single, giant_mmap_single);
679
680 if (devsw->d_dump == NULL) devsw->d_dump = no_dump;
681
682 LIST_INIT(&devsw->d_devs);
683
684 devsw->d_flags |= D_INIT;
685
686 if (dsw2 != NULL)
687 cdevsw_free_devlocked(dsw2);
688 return (0);
689 }
690
691 static int
692 make_dev_credv(int flags, struct cdev **dres, struct cdevsw *devsw, int unit,
693 struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
694 va_list ap)
695 {
696 struct cdev *dev;
697 int i, res;
698
699 KASSERT((flags & MAKEDEV_WAITOK) == 0 || (flags & MAKEDEV_NOWAIT) == 0,
700 ("make_dev_credv: both WAITOK and NOWAIT specified"));
701 dev = devfs_alloc(flags);
702 if (dev == NULL)
703 return (ENOMEM);
704 dev_lock();
705 res = prep_cdevsw(devsw, flags);
706 if (res != 0) {
707 dev_unlock();
708 devfs_free(dev);
709 return (res);
710 }
711 dev = newdev(devsw, unit, dev);
712 if (flags & MAKEDEV_REF)
713 dev_refl(dev);
714 if (flags & MAKEDEV_ETERNAL)
715 dev->si_flags |= SI_ETERNAL;
716 if (dev->si_flags & SI_CHEAPCLONE &&
717 dev->si_flags & SI_NAMED) {
718 /*
719 * This is allowed as it removes races and generally
720 * simplifies cloning devices.
721 * XXX: still ??
722 */
723 dev_unlock_and_free();
724 *dres = dev;
725 return (0);
726 }
727 KASSERT(!(dev->si_flags & SI_NAMED),
728 ("make_dev() by driver %s on pre-existing device (min=%x, name=%s)",
729 devsw->d_name, dev2unit(dev), devtoname(dev)));
730
731 i = vsnrprintf(dev->__si_namebuf, sizeof dev->__si_namebuf, 32, fmt, ap);
732 if (i > (sizeof dev->__si_namebuf - 1)) {
733 printf("WARNING: Device name truncated! (%s)\n",
734 dev->__si_namebuf);
735 }
736
737 dev->si_flags |= SI_NAMED;
738 if (cr != NULL)
739 dev->si_cred = crhold(cr);
740 dev->si_uid = uid;
741 dev->si_gid = gid;
742 dev->si_mode = mode;
743
744 devfs_create(dev);
745 clean_unrhdrl(devfs_inos);
746 dev_unlock_and_free();
747
748 notify_create(dev, flags);
749
750 *dres = dev;
751 return (0);
752 }
753
754 struct cdev *
755 make_dev(struct cdevsw *devsw, int unit, uid_t uid, gid_t gid, int mode,
756 const char *fmt, ...)
757 {
758 struct cdev *dev;
759 va_list ap;
760 int res;
761
762 va_start(ap, fmt);
763 res = make_dev_credv(0, &dev, devsw, unit, NULL, uid, gid, mode, fmt,
764 ap);
765 va_end(ap);
766 KASSERT(res == 0 && dev != NULL, ("make_dev: failed make_dev_credv"));
767 return (dev);
768 }
769
770 struct cdev *
771 make_dev_cred(struct cdevsw *devsw, int unit, struct ucred *cr, uid_t uid,
772 gid_t gid, int mode, const char *fmt, ...)
773 {
774 struct cdev *dev;
775 va_list ap;
776 int res;
777
778 va_start(ap, fmt);
779 res = make_dev_credv(0, &dev, devsw, unit, cr, uid, gid, mode, fmt, ap);
780 va_end(ap);
781
782 KASSERT(res == 0 && dev != NULL,
783 ("make_dev_cred: failed make_dev_credv"));
784 return (dev);
785 }
786
787 struct cdev *
788 make_dev_credf(int flags, struct cdevsw *devsw, int unit, struct ucred *cr,
789 uid_t uid, gid_t gid, int mode, const char *fmt, ...)
790 {
791 struct cdev *dev;
792 va_list ap;
793 int res;
794
795 va_start(ap, fmt);
796 res = make_dev_credv(flags, &dev, devsw, unit, cr, uid, gid, mode,
797 fmt, ap);
798 va_end(ap);
799
800 KASSERT((flags & MAKEDEV_NOWAIT) != 0 || res == 0,
801 ("make_dev_credf: failed make_dev_credv"));
802 return (res == 0 ? dev : NULL);
803 }
804
805 int
806 make_dev_p(int flags, struct cdev **cdev, struct cdevsw *devsw,
807 struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt, ...)
808 {
809 va_list ap;
810 int res;
811
812 va_start(ap, fmt);
813 res = make_dev_credv(flags, cdev, devsw, 0, cr, uid, gid, mode,
814 fmt, ap);
815 va_end(ap);
816
817 KASSERT((flags & MAKEDEV_NOWAIT) != 0 || res == 0,
818 ("make_dev_p: failed make_dev_credv"));
819 return (res);
820 }
821
822 static void
823 dev_dependsl(struct cdev *pdev, struct cdev *cdev)
824 {
825
826 cdev->si_parent = pdev;
827 cdev->si_flags |= SI_CHILD;
828 LIST_INSERT_HEAD(&pdev->si_children, cdev, si_siblings);
829 }
830
831
832 void
833 dev_depends(struct cdev *pdev, struct cdev *cdev)
834 {
835
836 dev_lock();
837 dev_dependsl(pdev, cdev);
838 dev_unlock();
839 }
840
841 struct cdev *
842 make_dev_alias(struct cdev *pdev, const char *fmt, ...)
843 {
844 struct cdev *dev;
845 va_list ap;
846 int i;
847
848 KASSERT(pdev != NULL, ("NULL pdev"));
849 dev = devfs_alloc(MAKEDEV_WAITOK);
850 dev_lock();
851 dev->si_flags |= SI_ALIAS;
852 dev->si_flags |= SI_NAMED;
853 va_start(ap, fmt);
854 i = vsnrprintf(dev->__si_namebuf, sizeof dev->__si_namebuf, 32, fmt, ap);
855 if (i > (sizeof dev->__si_namebuf - 1)) {
856 printf("WARNING: Device name truncated! (%s)\n",
857 dev->__si_namebuf);
858 }
859 va_end(ap);
860
861 devfs_create(dev);
862 dev_dependsl(pdev, dev);
863 clean_unrhdrl(devfs_inos);
864 dev_unlock();
865
866 notify_create(dev, MAKEDEV_WAITOK);
867
868 return (dev);
869 }
870
871 static void
872 destroy_devl(struct cdev *dev)
873 {
874 struct cdevsw *csw;
875 struct cdev_privdata *p;
876 struct cdev_priv *cdp;
877
878 mtx_assert(&devmtx, MA_OWNED);
879 KASSERT(dev->si_flags & SI_NAMED,
880 ("WARNING: Driver mistake: destroy_dev on %d\n", dev2unit(dev)));
881 KASSERT((dev->si_flags & SI_ETERNAL) == 0,
882 ("WARNING: Driver mistake: destroy_dev on eternal %d\n",
883 dev2unit(dev)));
884
885 cdp = cdev2priv(dev);
886 if ((cdp->cdp_flags & CDP_UNREF_DTR) == 0) {
887 /*
888 * Avoid race with dev_rel(), e.g. from the populate
889 * loop. If CDP_UNREF_DTR flag is set, the reference
890 * to be dropped at the end of destroy_devl() was
891 * already taken by delist_dev_locked().
892 */
893 dev_refl(dev);
894
895 devfs_destroy(dev);
896 }
897
898 /* Remove name marking */
899 dev->si_flags &= ~SI_NAMED;
900
901 /* If we are a child, remove us from the parents list */
902 if (dev->si_flags & SI_CHILD) {
903 LIST_REMOVE(dev, si_siblings);
904 dev->si_flags &= ~SI_CHILD;
905 }
906
907 /* Kill our children */
908 while (!LIST_EMPTY(&dev->si_children))
909 destroy_devl(LIST_FIRST(&dev->si_children));
910
911 /* Remove from clone list */
912 if (dev->si_flags & SI_CLONELIST) {
913 LIST_REMOVE(dev, si_clone);
914 dev->si_flags &= ~SI_CLONELIST;
915 }
916
917 csw = dev->si_devsw;
918 dev->si_devsw = NULL; /* already NULL for SI_ALIAS */
919 while (csw != NULL && csw->d_purge != NULL && dev->si_threadcount) {
920 csw->d_purge(dev);
921 msleep(csw, &devmtx, PRIBIO, "devprg", hz/10);
922 if (dev->si_threadcount)
923 printf("Still %lu threads in %s\n",
924 dev->si_threadcount, devtoname(dev));
925 }
926 while (dev->si_threadcount != 0) {
927 /* Use unique dummy wait ident */
928 msleep(&csw, &devmtx, PRIBIO, "devdrn", hz / 10);
929 }
930
931 dev_unlock();
932 if ((cdp->cdp_flags & CDP_UNREF_DTR) == 0) {
933 /* avoid out of order notify events */
934 notify_destroy(dev);
935 }
936 mtx_lock(&cdevpriv_mtx);
937 while ((p = LIST_FIRST(&cdp->cdp_fdpriv)) != NULL) {
938 devfs_destroy_cdevpriv(p);
939 mtx_lock(&cdevpriv_mtx);
940 }
941 mtx_unlock(&cdevpriv_mtx);
942 dev_lock();
943
944 dev->si_drv1 = 0;
945 dev->si_drv2 = 0;
946 bzero(&dev->__si_u, sizeof(dev->__si_u));
947
948 if (!(dev->si_flags & SI_ALIAS)) {
949 /* Remove from cdevsw list */
950 LIST_REMOVE(dev, si_list);
951
952 /* If cdevsw has no more struct cdev *'s, clean it */
953 if (LIST_EMPTY(&csw->d_devs)) {
954 fini_cdevsw(csw);
955 wakeup(&csw->d_devs);
956 }
957 }
958 dev->si_flags &= ~SI_ALIAS;
959 cdp->cdp_flags &= ~CDP_UNREF_DTR;
960 dev->si_refcount--;
961
962 if (dev->si_refcount > 0)
963 LIST_INSERT_HEAD(&dead_cdevsw.d_devs, dev, si_list);
964 else
965 dev_free_devlocked(dev);
966 }
967
968 static void
969 delist_dev_locked(struct cdev *dev)
970 {
971 struct cdev_priv *cdp;
972 struct cdev *child;
973
974 mtx_assert(&devmtx, MA_OWNED);
975 cdp = cdev2priv(dev);
976 if ((cdp->cdp_flags & CDP_UNREF_DTR) != 0)
977 return;
978 cdp->cdp_flags |= CDP_UNREF_DTR;
979 dev_refl(dev);
980 devfs_destroy(dev);
981 LIST_FOREACH(child, &dev->si_children, si_siblings)
982 delist_dev_locked(child);
983 dev_unlock();
984 /* ensure the destroy event is queued in order */
985 notify_destroy(dev);
986 dev_lock();
987 }
988
989 /*
990 * This function will delist a character device and its children from
991 * the directory listing and create a destroy event without waiting
992 * for all character device references to go away. At some later point
993 * destroy_dev() must be called to complete the character device
994 * destruction. After calling this function the character device name
995 * can instantly be re-used.
996 */
997 void
998 delist_dev(struct cdev *dev)
999 {
1000
1001 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "delist_dev");
1002 dev_lock();
1003 delist_dev_locked(dev);
1004 dev_unlock();
1005 }
1006
1007 void
1008 destroy_dev(struct cdev *dev)
1009 {
1010
1011 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, "destroy_dev");
1012 dev_lock();
1013 destroy_devl(dev);
1014 dev_unlock_and_free();
1015 }
1016
1017 const char *
1018 devtoname(struct cdev *dev)
1019 {
1020
1021 return (dev->si_name);
1022 }
1023
1024 int
1025 dev_stdclone(char *name, char **namep, const char *stem, int *unit)
1026 {
1027 int u, i;
1028
1029 i = strlen(stem);
1030 if (bcmp(stem, name, i) != 0)
1031 return (0);
1032 if (!isdigit(name[i]))
1033 return (0);
1034 u = 0;
1035 if (name[i] == '' && isdigit(name[i+1]))
1036 return (0);
1037 while (isdigit(name[i])) {
1038 u *= 10;
1039 u += name[i++] - '';
1040 }
1041 if (u > 0xffffff)
1042 return (0);
1043 *unit = u;
1044 if (namep)
1045 *namep = &name[i];
1046 if (name[i])
1047 return (2);
1048 return (1);
1049 }
1050
1051 /*
1052 * Helper functions for cloning device drivers.
1053 *
1054 * The objective here is to make it unnecessary for the device drivers to
1055 * use rman or similar to manage their unit number space. Due to the way
1056 * we do "on-demand" devices, using rman or other "private" methods
1057 * will be very tricky to lock down properly once we lock down this file.
1058 *
1059 * Instead we give the drivers these routines which puts the struct cdev *'s
1060 * that are to be managed on their own list, and gives the driver the ability
1061 * to ask for the first free unit number or a given specified unit number.
1062 *
1063 * In addition these routines support paired devices (pty, nmdm and similar)
1064 * by respecting a number of "flag" bits in the minor number.
1065 *
1066 */
1067
1068 struct clonedevs {
1069 LIST_HEAD(,cdev) head;
1070 };
1071
1072 void
1073 clone_setup(struct clonedevs **cdp)
1074 {
1075
1076 *cdp = malloc(sizeof **cdp, M_DEVBUF, M_WAITOK | M_ZERO);
1077 LIST_INIT(&(*cdp)->head);
1078 }
1079
1080 int
1081 clone_create(struct clonedevs **cdp, struct cdevsw *csw, int *up,
1082 struct cdev **dp, int extra)
1083 {
1084 struct clonedevs *cd;
1085 struct cdev *dev, *ndev, *dl, *de;
1086 int unit, low, u;
1087
1088 KASSERT(*cdp != NULL,
1089 ("clone_setup() not called in driver \"%s\"", csw->d_name));
1090 KASSERT(!(extra & CLONE_UNITMASK),
1091 ("Illegal extra bits (0x%x) in clone_create", extra));
1092 KASSERT(*up <= CLONE_UNITMASK,
1093 ("Too high unit (0x%x) in clone_create", *up));
1094 KASSERT(csw->d_flags & D_NEEDMINOR,
1095 ("clone_create() on cdevsw without minor numbers"));
1096
1097
1098 /*
1099 * Search the list for a lot of things in one go:
1100 * A preexisting match is returned immediately.
1101 * The lowest free unit number if we are passed -1, and the place
1102 * in the list where we should insert that new element.
1103 * The place to insert a specified unit number, if applicable
1104 * the end of the list.
1105 */
1106 unit = *up;
1107 ndev = devfs_alloc(MAKEDEV_WAITOK);
1108 dev_lock();
1109 prep_cdevsw(csw, MAKEDEV_WAITOK);
1110 low = extra;
1111 de = dl = NULL;
1112 cd = *cdp;
1113 LIST_FOREACH(dev, &cd->head, si_clone) {
1114 KASSERT(dev->si_flags & SI_CLONELIST,
1115 ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1116 u = dev2unit(dev);
1117 if (u == (unit | extra)) {
1118 *dp = dev;
1119 dev_unlock();
1120 devfs_free(ndev);
1121 return (0);
1122 }
1123 if (unit == -1 && u == low) {
1124 low++;
1125 de = dev;
1126 continue;
1127 } else if (u < (unit | extra)) {
1128 de = dev;
1129 continue;
1130 } else if (u > (unit | extra)) {
1131 dl = dev;
1132 break;
1133 }
1134 }
1135 if (unit == -1)
1136 unit = low & CLONE_UNITMASK;
1137 dev = newdev(csw, unit | extra, ndev);
1138 if (dev->si_flags & SI_CLONELIST) {
1139 printf("dev %p (%s) is on clonelist\n", dev, dev->si_name);
1140 printf("unit=%d, low=%d, extra=0x%x\n", unit, low, extra);
1141 LIST_FOREACH(dev, &cd->head, si_clone) {
1142 printf("\t%p %s\n", dev, dev->si_name);
1143 }
1144 panic("foo");
1145 }
1146 KASSERT(!(dev->si_flags & SI_CLONELIST),
1147 ("Dev %p(%s) should not be on clonelist", dev, dev->si_name));
1148 if (dl != NULL)
1149 LIST_INSERT_BEFORE(dl, dev, si_clone);
1150 else if (de != NULL)
1151 LIST_INSERT_AFTER(de, dev, si_clone);
1152 else
1153 LIST_INSERT_HEAD(&cd->head, dev, si_clone);
1154 dev->si_flags |= SI_CLONELIST;
1155 *up = unit;
1156 dev_unlock_and_free();
1157 return (1);
1158 }
1159
1160 /*
1161 * Kill everything still on the list. The driver should already have
1162 * disposed of any softc hung of the struct cdev *'s at this time.
1163 */
1164 void
1165 clone_cleanup(struct clonedevs **cdp)
1166 {
1167 struct cdev *dev;
1168 struct cdev_priv *cp;
1169 struct clonedevs *cd;
1170
1171 cd = *cdp;
1172 if (cd == NULL)
1173 return;
1174 dev_lock();
1175 while (!LIST_EMPTY(&cd->head)) {
1176 dev = LIST_FIRST(&cd->head);
1177 LIST_REMOVE(dev, si_clone);
1178 KASSERT(dev->si_flags & SI_CLONELIST,
1179 ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1180 dev->si_flags &= ~SI_CLONELIST;
1181 cp = cdev2priv(dev);
1182 if (!(cp->cdp_flags & CDP_SCHED_DTR)) {
1183 cp->cdp_flags |= CDP_SCHED_DTR;
1184 KASSERT(dev->si_flags & SI_NAMED,
1185 ("Driver has goofed in cloning underways udev %x unit %x", dev2udev(dev), dev2unit(dev)));
1186 destroy_devl(dev);
1187 }
1188 }
1189 dev_unlock_and_free();
1190 free(cd, M_DEVBUF);
1191 *cdp = NULL;
1192 }
1193
1194 static TAILQ_HEAD(, cdev_priv) dev_ddtr =
1195 TAILQ_HEAD_INITIALIZER(dev_ddtr);
1196 static struct task dev_dtr_task;
1197
1198 static void
1199 destroy_dev_tq(void *ctx, int pending)
1200 {
1201 struct cdev_priv *cp;
1202 struct cdev *dev;
1203 void (*cb)(void *);
1204 void *cb_arg;
1205
1206 dev_lock();
1207 while (!TAILQ_EMPTY(&dev_ddtr)) {
1208 cp = TAILQ_FIRST(&dev_ddtr);
1209 dev = &cp->cdp_c;
1210 KASSERT(cp->cdp_flags & CDP_SCHED_DTR,
1211 ("cdev %p in dev_destroy_tq without CDP_SCHED_DTR", cp));
1212 TAILQ_REMOVE(&dev_ddtr, cp, cdp_dtr_list);
1213 cb = cp->cdp_dtr_cb;
1214 cb_arg = cp->cdp_dtr_cb_arg;
1215 destroy_devl(dev);
1216 dev_unlock_and_free();
1217 dev_rel(dev);
1218 if (cb != NULL)
1219 cb(cb_arg);
1220 dev_lock();
1221 }
1222 dev_unlock();
1223 }
1224
1225 /*
1226 * devmtx shall be locked on entry. devmtx will be unlocked after
1227 * function return.
1228 */
1229 static int
1230 destroy_dev_sched_cbl(struct cdev *dev, void (*cb)(void *), void *arg)
1231 {
1232 struct cdev_priv *cp;
1233
1234 mtx_assert(&devmtx, MA_OWNED);
1235 cp = cdev2priv(dev);
1236 if (cp->cdp_flags & CDP_SCHED_DTR) {
1237 dev_unlock();
1238 return (0);
1239 }
1240 dev_refl(dev);
1241 cp->cdp_flags |= CDP_SCHED_DTR;
1242 cp->cdp_dtr_cb = cb;
1243 cp->cdp_dtr_cb_arg = arg;
1244 TAILQ_INSERT_TAIL(&dev_ddtr, cp, cdp_dtr_list);
1245 dev_unlock();
1246 taskqueue_enqueue(taskqueue_swi_giant, &dev_dtr_task);
1247 return (1);
1248 }
1249
1250 int
1251 destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg)
1252 {
1253
1254 dev_lock();
1255 return (destroy_dev_sched_cbl(dev, cb, arg));
1256 }
1257
1258 int
1259 destroy_dev_sched(struct cdev *dev)
1260 {
1261
1262 return (destroy_dev_sched_cb(dev, NULL, NULL));
1263 }
1264
1265 void
1266 destroy_dev_drain(struct cdevsw *csw)
1267 {
1268
1269 dev_lock();
1270 while (!LIST_EMPTY(&csw->d_devs)) {
1271 msleep(&csw->d_devs, &devmtx, PRIBIO, "devscd", hz/10);
1272 }
1273 dev_unlock();
1274 }
1275
1276 void
1277 drain_dev_clone_events(void)
1278 {
1279
1280 sx_xlock(&clone_drain_lock);
1281 sx_xunlock(&clone_drain_lock);
1282 }
1283
1284 static void
1285 devdtr_init(void *dummy __unused)
1286 {
1287
1288 TASK_INIT(&dev_dtr_task, 0, destroy_dev_tq, NULL);
1289 }
1290
1291 SYSINIT(devdtr, SI_SUB_DEVFS, SI_ORDER_SECOND, devdtr_init, NULL);
1292
1293 #include "opt_ddb.h"
1294 #ifdef DDB
1295 #include <sys/kernel.h>
1296
1297 #include <ddb/ddb.h>
1298
1299 DB_SHOW_COMMAND(cdev, db_show_cdev)
1300 {
1301 struct cdev_priv *cdp;
1302 struct cdev *dev;
1303 u_int flags;
1304 char buf[512];
1305
1306 if (!have_addr) {
1307 TAILQ_FOREACH(cdp, &cdevp_list, cdp_list) {
1308 dev = &cdp->cdp_c;
1309 db_printf("%s %p\n", dev->si_name, dev);
1310 if (db_pager_quit)
1311 break;
1312 }
1313 return;
1314 }
1315
1316 dev = (struct cdev *)addr;
1317 cdp = cdev2priv(dev);
1318 db_printf("dev %s ref %d use %ld thr %ld inuse %u fdpriv %p\n",
1319 dev->si_name, dev->si_refcount, dev->si_usecount,
1320 dev->si_threadcount, cdp->cdp_inuse, cdp->cdp_fdpriv.lh_first);
1321 db_printf("devsw %p si_drv0 %d si_drv1 %p si_drv2 %p\n",
1322 dev->si_devsw, dev->si_drv0, dev->si_drv1, dev->si_drv2);
1323 flags = dev->si_flags;
1324 #define SI_FLAG(flag) do { \
1325 if (flags & (flag)) { \
1326 if (buf[0] != '\0') \
1327 strlcat(buf, ", ", sizeof(buf)); \
1328 strlcat(buf, (#flag) + 3, sizeof(buf)); \
1329 flags &= ~(flag); \
1330 } \
1331 } while (0)
1332 buf[0] = '\0';
1333 SI_FLAG(SI_ETERNAL);
1334 SI_FLAG(SI_ALIAS);
1335 SI_FLAG(SI_NAMED);
1336 SI_FLAG(SI_CHEAPCLONE);
1337 SI_FLAG(SI_CHILD);
1338 SI_FLAG(SI_DEVOPEN);
1339 SI_FLAG(SI_CONSOPEN);
1340 SI_FLAG(SI_DUMPDEV);
1341 SI_FLAG(SI_CANDELETE);
1342 SI_FLAG(SI_CLONELIST);
1343 db_printf("si_flags %s\n", buf);
1344
1345 flags = cdp->cdp_flags;
1346 #define CDP_FLAG(flag) do { \
1347 if (flags & (flag)) { \
1348 if (buf[0] != '\0') \
1349 strlcat(buf, ", ", sizeof(buf)); \
1350 strlcat(buf, (#flag) + 4, sizeof(buf)); \
1351 flags &= ~(flag); \
1352 } \
1353 } while (0)
1354 buf[0] = '\0';
1355 CDP_FLAG(CDP_ACTIVE);
1356 CDP_FLAG(CDP_SCHED_DTR);
1357 db_printf("cdp_flags %s\n", buf);
1358 }
1359 #endif
Cache object: a4614b8c04ed1ea7c1e7947170d391cd
|