kern_conf.c revision 179828
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: head/sys/kern/kern_conf.c 179828 2008-06-16 17:34:59Z kib $");
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/tty.h>
46#include <sys/ucred.h>
47#include <sys/taskqueue.h>
48#include <machine/stdarg.h>
49
50#include <fs/devfs/devfs_int.h>
51
52static MALLOC_DEFINE(M_DEVT, "cdev", "cdev storage");
53
54struct mtx devmtx;
55static void destroy_devl(struct cdev *dev);
56static int destroy_dev_sched_cbl(struct cdev *dev,
57    void (*cb)(void *), void *arg);
58static struct cdev *make_dev_credv(int flags,
59    struct cdevsw *devsw, int minornr,
60    struct ucred *cr, uid_t uid, gid_t gid, int mode, const char *fmt,
61    va_list ap);
62
63static struct cdev_priv_list cdevp_free_list =
64    TAILQ_HEAD_INITIALIZER(cdevp_free_list);
65static SLIST_HEAD(free_cdevsw, cdevsw) cdevsw_gt_post_list =
66    SLIST_HEAD_INITIALIZER();
67
68void
69dev_lock(void)
70{
71
72	mtx_lock(&devmtx);
73}
74
75/*
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
79 * dropped.
80 */
81static void
82dev_unlock_and_free(void)
83{
84	struct cdev_priv_list cdp_free;
85	struct free_cdevsw csw_free;
86	struct cdev_priv *cdp;
87	struct cdevsw *csw;
88
89	mtx_assert(&devmtx, MA_OWNED);
90
91	/*
92	 * Make the local copy of the list heads while the dev_mtx is
93	 * held. Free it later.
94	 */
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);
99
100	mtx_unlock(&devmtx);
101
102	while ((cdp = TAILQ_FIRST(&cdp_free)) != NULL) {
103		TAILQ_REMOVE(&cdp_free, cdp, cdp_list);
104		devfs_free(&cdp->cdp_c);
105	}
106	while ((csw = SLIST_FIRST(&csw_free)) != NULL) {
107		SLIST_REMOVE_HEAD(&csw_free, d_postfree_list);
108		free(csw, M_DEVT);
109	}
110}
111
112static void
113dev_free_devlocked(struct cdev *cdev)
114{
115	struct cdev_priv *cdp;
116
117	mtx_assert(&devmtx, MA_OWNED);
118	cdp = cdev2priv(cdev);
119	TAILQ_INSERT_HEAD(&cdevp_free_list, cdp, cdp_list);
120}
121
122static void
123cdevsw_free_devlocked(struct cdevsw *csw)
124{
125
126	mtx_assert(&devmtx, MA_OWNED);
127	SLIST_INSERT_HEAD(&cdevsw_gt_post_list, csw, d_postfree_list);
128}
129
130void
131dev_unlock(void)
132{
133
134	mtx_unlock(&devmtx);
135}
136
137void
138dev_ref(struct cdev *dev)
139{
140
141	mtx_assert(&devmtx, MA_NOTOWNED);
142	mtx_lock(&devmtx);
143	dev->si_refcount++;
144	mtx_unlock(&devmtx);
145}
146
147void
148dev_refl(struct cdev *dev)
149{
150
151	mtx_assert(&devmtx, MA_OWNED);
152	dev->si_refcount++;
153}
154
155void
156dev_rel(struct cdev *dev)
157{
158	int flag = 0;
159
160	mtx_assert(&devmtx, MA_NOTOWNED);
161	dev_lock();
162	dev->si_refcount--;
163	KASSERT(dev->si_refcount >= 0,
164	    ("dev_rel(%s) gave negative count", devtoname(dev)));
165#if 0
166	if (dev->si_usecount == 0 &&
167	    (dev->si_flags & SI_CHEAPCLONE) && (dev->si_flags & SI_NAMED))
168		;
169	else
170#endif
171	if (dev->si_devsw == NULL && dev->si_refcount == 0) {
172		LIST_REMOVE(dev, si_list);
173		flag = 1;
174	}
175	dev_unlock();
176	if (flag)
177		devfs_free(dev);
178}
179
180struct cdevsw *
181dev_refthread(struct cdev *dev)
182{
183	struct cdevsw *csw;
184	struct cdev_priv *cdp;
185
186	mtx_assert(&devmtx, MA_NOTOWNED);
187	dev_lock();
188	csw = dev->si_devsw;
189	if (csw != NULL) {
190		cdp = cdev2priv(dev);
191		if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0)
192			dev->si_threadcount++;
193		else
194			csw = NULL;
195	}
196	dev_unlock();
197	return (csw);
198}
199
200struct cdevsw *
201devvn_refthread(struct vnode *vp, struct cdev **devp)
202{
203	struct cdevsw *csw;
204	struct cdev_priv *cdp;
205
206	mtx_assert(&devmtx, MA_NOTOWNED);
207	csw = NULL;
208	dev_lock();
209	*devp = vp->v_rdev;
210	if (*devp != NULL) {
211		cdp = cdev2priv(*devp);
212		if ((cdp->cdp_flags & CDP_SCHED_DTR) == 0) {
213			csw = (*devp)->si_devsw;
214			if (csw != NULL)
215				(*devp)->si_threadcount++;
216		}
217	}
218	dev_unlock();
219	return (csw);
220}
221
222void
223dev_relthread(struct cdev *dev)
224{
225
226	mtx_assert(&devmtx, MA_NOTOWNED);
227	dev_lock();
228	KASSERT(dev->si_threadcount > 0,
229	    ("%s threadcount is wrong", dev->si_name));
230	dev->si_threadcount--;
231	dev_unlock();
232}
233
234int
235nullop(void)
236{
237
238	return (0);
239}
240
241int
242eopnotsupp(void)
243{
244
245	return (EOPNOTSUPP);
246}
247
248static int
249enxio(void)
250{
251	return (ENXIO);
252}
253
254static int
255enodev(void)
256{
257	return (ENODEV);
258}
259
260/* Define a dead_cdevsw for use when devices leave unexpectedly. */
261
262#define dead_open	(d_open_t *)enxio
263#define dead_close	(d_close_t *)enxio
264#define dead_read	(d_read_t *)enxio
265#define dead_write	(d_write_t *)enxio
266#define dead_ioctl	(d_ioctl_t *)enxio
267#define dead_poll	(d_poll_t *)enodev
268#define dead_mmap	(d_mmap_t *)enodev
269
270static void
271dead_strategy(struct bio *bp)
272{
273
274	biofinish(bp, NULL, ENXIO);
275}
276
277#define dead_dump	(dumper_t *)enxio
278#define dead_kqfilter	(d_kqfilter_t *)enxio
279
280static struct cdevsw dead_cdevsw = {
281	.d_version =	D_VERSION,
282	.d_flags =	D_NEEDGIANT, /* XXX: does dead_strategy need this ? */
283	.d_open =	dead_open,
284	.d_close =	dead_close,
285	.d_read =	dead_read,
286	.d_write =	dead_write,
287	.d_ioctl =	dead_ioctl,
288	.d_poll =	dead_poll,
289	.d_mmap =	dead_mmap,
290	.d_strategy =	dead_strategy,
291	.d_name =	"dead",
292	.d_dump =	dead_dump,
293	.d_kqfilter =	dead_kqfilter
294};
295
296/* Default methods if driver does not specify method */
297
298#define null_open	(d_open_t *)nullop
299#define null_close	(d_close_t *)nullop
300#define no_read		(d_read_t *)enodev
301#define no_write	(d_write_t *)enodev
302#define no_ioctl	(d_ioctl_t *)enodev
303#define no_mmap		(d_mmap_t *)enodev
304#define no_kqfilter	(d_kqfilter_t *)enodev
305
306static void
307no_strategy(struct bio *bp)
308{
309
310	biofinish(bp, NULL, ENODEV);
311}
312
313static int
314no_poll(struct cdev *dev __unused, int events, struct thread *td __unused)
315{
316	/*
317	 * Return true for read/write.  If the user asked for something
318	 * special, return POLLNVAL, so that clients have a way of
319	 * determining reliably whether or not the extended
320	 * functionality is present without hard-coding knowledge
321	 * of specific filesystem implementations.
322	 * Stay in sync with vop_nopoll().
323	 */
324	if (events & ~POLLSTANDARD)
325		return (POLLNVAL);
326
327	return (events & (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM));
328}
329
330#define no_dump		(dumper_t *)enodev
331
332static int
333giant_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
334{
335	struct cdevsw *dsw;
336	int retval;
337
338	dsw = dev_refthread(dev);
339	if (dsw == NULL)
340		return (ENXIO);
341	mtx_lock(&Giant);
342	retval = dsw->d_gianttrick->d_open(dev, oflags, devtype, td);
343	mtx_unlock(&Giant);
344	dev_relthread(dev);
345	return (retval);
346}
347
348static int
349giant_fdopen(struct cdev *dev, int oflags, struct thread *td, struct file *fp)
350{
351	struct cdevsw *dsw;
352	int retval;
353
354	dsw = dev_refthread(dev);
355	if (dsw == NULL)
356		return (ENXIO);
357	mtx_lock(&Giant);
358	retval = dsw->d_gianttrick->d_fdopen(dev, oflags, td, fp);
359	mtx_unlock(&Giant);
360	dev_relthread(dev);
361	return (retval);
362}
363
364static int
365giant_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
366{
367	struct cdevsw *dsw;
368	int retval;
369
370	dsw = dev_refthread(dev);
371	if (dsw == NULL)
372		return (ENXIO);
373	mtx_lock(&Giant);
374	retval = dsw->d_gianttrick->d_close(dev, fflag, devtype, td);
375	mtx_unlock(&Giant);
376	dev_relthread(dev);
377	return (retval);
378}
379
380static void
381giant_strategy(struct bio *bp)
382{
383	struct cdevsw *dsw;
384	struct cdev *dev;
385
386	dev = bp->bio_dev;
387	dsw = dev_refthread(dev);
388	if (dsw == NULL) {
389		biofinish(bp, NULL, ENXIO);
390		return;
391	}
392	mtx_lock(&Giant);
393	dsw->d_gianttrick->d_strategy(bp);
394	mtx_unlock(&Giant);
395	dev_relthread(dev);
396}
397
398static int
399giant_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
400{
401	struct cdevsw *dsw;
402	int retval;
403
404	dsw = dev_refthread(dev);
405	if (dsw == NULL)
406		return (ENXIO);
407	mtx_lock(&Giant);
408	retval = dsw->d_gianttrick->d_ioctl(dev, cmd, data, fflag, td);
409	mtx_unlock(&Giant);
410	dev_relthread(dev);
411	return (retval);
412}
413
414static int
415giant_read(struct cdev *dev, struct uio *uio, int ioflag)
416{
417	struct cdevsw *dsw;
418	int retval;
419
420	dsw = dev_refthread(dev);
421	if (dsw == NULL)
422		return (ENXIO);
423	mtx_lock(&Giant);
424	retval = dsw->d_gianttrick->d_read(dev, uio, ioflag);
425	mtx_unlock(&Giant);
426	dev_relthread(dev);
427	return (retval);
428}
429
430static int
431giant_write(struct cdev *dev, struct uio *uio, int ioflag)
432{
433	struct cdevsw *dsw;
434	int retval;
435
436	dsw = dev_refthread(dev);
437	if (dsw == NULL)
438		return (ENXIO);
439	mtx_lock(&Giant);
440	retval = dsw->d_gianttrick->d_write(dev, uio, ioflag);
441	mtx_unlock(&Giant);
442	dev_relthread(dev);
443	return (retval);
444}
445
446static int
447giant_poll(struct cdev *dev, int events, struct thread *td)
448{
449	struct cdevsw *dsw;
450	int retval;
451
452	dsw = dev_refthread(dev);
453	if (dsw == NULL)
454		return (ENXIO);
455	mtx_lock(&Giant);
456	retval = dsw->d_gianttrick->d_poll(dev, events, td);
457	mtx_unlock(&Giant);
458	dev_relthread(dev);
459	return (retval);
460}
461
462static int
463giant_kqfilter(struct cdev *dev, struct knote *kn)
464{
465	struct cdevsw *dsw;
466	int retval;
467
468	dsw = dev_refthread(dev);
469	if (dsw == NULL)
470		return (ENXIO);
471	mtx_lock(&Giant);
472	retval = dsw->d_gianttrick->d_kqfilter(dev, kn);
473	mtx_unlock(&Giant);
474	dev_relthread(dev);
475	return (retval);
476}
477
478static int
479giant_mmap(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, int nprot)
480{
481	struct cdevsw *dsw;
482	int retval;
483
484	dsw = dev_refthread(dev);
485	if (dsw == NULL)
486		return (ENXIO);
487	mtx_lock(&Giant);
488	retval = dsw->d_gianttrick->d_mmap(dev, offset, paddr, nprot);
489	mtx_unlock(&Giant);
490	dev_relthread(dev);
491	return (retval);
492}
493
494
495static void
496notify(struct cdev *dev, const char *ev)
497{
498	static const char prefix[] = "cdev=";
499	char *data;
500	int namelen;
501
502	if (cold)
503		return;
504	namelen = strlen(dev->si_name);
505	data = malloc(namelen + sizeof(prefix), M_TEMP, M_WAITOK);
506	memcpy(data, prefix, sizeof(prefix) - 1);
507	memcpy(data + sizeof(prefix) - 1, dev->si_name, namelen + 1);
508	devctl_notify("DEVFS", "CDEV", ev, data);
509	free(data, M_TEMP);
510}
511
512static void
513notify_create(struct cdev *dev)
514{
515
516	notify(dev, "CREATE");
517}
518
519static void
520notify_destroy(struct cdev *dev)
521{
522
523	notify(dev, "DESTROY");
524}
525
526static struct cdev *
527newdev(struct cdevsw *csw, int y, struct cdev *si)
528{
529	struct cdev *si2;
530	dev_t	udev;
531
532	mtx_assert(&devmtx, MA_OWNED);
533	udev = y;
534	if (csw->d_flags & D_NEEDMINOR) {
535		/* We may want to return an existing device */
536		LIST_FOREACH(si2, &csw->d_devs, si_list) {
537			if (si2->si_drv0 == udev) {
538				dev_free_devlocked(si);
539				return (si2);
540			}
541		}
542	}
543	si->si_drv0 = udev;
544	si->si_devsw = csw;
545	LIST_INSERT_HEAD(&csw->d_devs, si, si_list);
546	return (si);
547}
548
549#define UMINORMASK	0xffff00ffU
550
551int
552uminor(dev_t dev)
553{
554	return (dev & UMINORMASK);
555}
556
557int
558umajor(dev_t dev)
559{
560	return ((dev & ~UMINORMASK) >> 8);
561}
562
563static void
564fini_cdevsw(struct cdevsw *devsw)
565{
566	struct cdevsw *gt;
567
568	if (devsw->d_gianttrick != NULL) {
569		gt = devsw->d_gianttrick;
570		memcpy(devsw, gt, sizeof *devsw);
571		cdevsw_free_devlocked(gt);
572		devsw->d_gianttrick = NULL;
573	}
574	devsw->d_flags &= ~D_INIT;
575}
576
577static void
578prep_cdevsw(struct cdevsw *devsw)
579{
580	struct cdevsw *dsw2;
581
582	mtx_assert(&devmtx, MA_OWNED);
583	if (devsw->d_flags & D_INIT)
584		return;
585	if (devsw->d_flags & D_NEEDGIANT) {
586		dev_unlock();
587		dsw2 = malloc(sizeof *dsw2, M_DEVT, M_WAITOK);
588		dev_lock();
589	} else
590		dsw2 = NULL;
591	if (devsw->d_flags & D_INIT) {
592		if (dsw2 != NULL)
593			cdevsw_free_devlocked(dsw2);
594		return;
595	}
596
597	if (devsw->d_version != D_VERSION_01) {
598		printf(
599		    "WARNING: Device driver \"%s\" has wrong version %s\n",
600		    devsw->d_name == NULL ? "???" : devsw->d_name,
601		    "and is disabled.  Recompile KLD module.");
602		devsw->d_open = dead_open;
603		devsw->d_close = dead_close;
604		devsw->d_read = dead_read;
605		devsw->d_write = dead_write;
606		devsw->d_ioctl = dead_ioctl;
607		devsw->d_poll = dead_poll;
608		devsw->d_mmap = dead_mmap;
609		devsw->d_strategy = dead_strategy;
610		devsw->d_dump = dead_dump;
611		devsw->d_kqfilter = dead_kqfilter;
612	}
613
614	if (devsw->d_flags & D_TTY) {
615		if (devsw->d_ioctl == NULL)	devsw->d_ioctl = ttyioctl;
616		if (devsw->d_read == NULL)	devsw->d_read = ttyread;
617		if (devsw->d_write == NULL)	devsw->d_write = ttywrite;
618		if (devsw->d_kqfilter == NULL)	devsw->d_kqfilter = ttykqfilter;
619		if (devsw->d_poll == NULL)	devsw->d_poll = ttypoll;
620	}
621
622	if (devsw->d_flags & D_NEEDGIANT) {
623		if (devsw->d_gianttrick == NULL) {
624			memcpy(dsw2, devsw, sizeof *dsw2);
625			devsw->d_gianttrick = dsw2;
626			dsw2 = NULL;
627		}
628	}
629
630#define FIXUP(member, noop, giant) 				\
631	do {							\
632		if (devsw->member == NULL) {			\
633			devsw->member = noop;			\
634		} else if (devsw->d_flags & D_NEEDGIANT)	\
635			devsw->member = giant;			\
636		}						\
637	while (0)
638
639	FIXUP(d_open,		null_open,	giant_open);
640	FIXUP(d_fdopen,		NULL,		giant_fdopen);
641	FIXUP(d_close,		null_close,	giant_close);
642	FIXUP(d_read,		no_read,	giant_read);
643	FIXUP(d_write,		no_write,	giant_write);
644	FIXUP(d_ioctl,		no_ioctl,	giant_ioctl);
645	FIXUP(d_poll,		no_poll,	giant_poll);
646	FIXUP(d_mmap,		no_mmap,	giant_mmap);
647	FIXUP(d_strategy,	no_strategy,	giant_strategy);
648	FIXUP(d_kqfilter,	no_kqfilter,	giant_kqfilter);
649
650	if (devsw->d_dump == NULL)	devsw->d_dump = no_dump;
651
652	LIST_INIT(&devsw->d_devs);
653
654	devsw->d_flags |= D_INIT;
655
656	if (dsw2 != NULL)
657		cdevsw_free_devlocked(dsw2);
658}
659
660struct cdev *
661make_dev_credv(int flags, struct cdevsw *devsw, int minornr,
662    struct ucred *cr, uid_t uid,
663    gid_t gid, int mode, const char *fmt, va_list ap)
664{
665	struct cdev *dev;
666	int i;
667
668	dev = devfs_alloc();
669	dev_lock();
670	prep_cdevsw(devsw);
671	dev = newdev(devsw, minornr, dev);
672	if (flags & MAKEDEV_REF)
673		dev_refl(dev);
674	if (dev->si_flags & SI_CHEAPCLONE &&
675	    dev->si_flags & SI_NAMED) {
676		/*
677		 * This is allowed as it removes races and generally
678		 * simplifies cloning devices.
679		 * XXX: still ??
680		 */
681		dev_unlock_and_free();
682		return (dev);
683	}
684	KASSERT(!(dev->si_flags & SI_NAMED),
685	    ("make_dev() by driver %s on pre-existing device (min=%x, name=%s)",
686	    devsw->d_name, minor(dev), devtoname(dev)));
687
688	i = vsnrprintf(dev->__si_namebuf, sizeof dev->__si_namebuf, 32, fmt, ap);
689	if (i > (sizeof dev->__si_namebuf - 1)) {
690		printf("WARNING: Device name truncated! (%s)\n",
691		    dev->__si_namebuf);
692	}
693
694	dev->si_flags |= SI_NAMED;
695#ifdef MAC
696	if (cr != NULL)
697		dev->si_cred = crhold(cr);
698	else
699#endif
700		dev->si_cred = NULL;
701	dev->si_uid = uid;
702	dev->si_gid = gid;
703	dev->si_mode = mode;
704
705	devfs_create(dev);
706	clean_unrhdrl(devfs_inos);
707	dev_unlock_and_free();
708
709	notify_create(dev);
710
711	return (dev);
712}
713
714struct cdev *
715make_dev(struct cdevsw *devsw, int minornr, uid_t uid, gid_t gid, int mode,
716    const char *fmt, ...)
717{
718	struct cdev *dev;
719	va_list ap;
720
721	va_start(ap, fmt);
722	dev = make_dev_credv(0, devsw, minornr, NULL, uid, gid, mode, fmt, ap);
723	va_end(ap);
724	return (dev);
725}
726
727struct cdev *
728make_dev_cred(struct cdevsw *devsw, int minornr, struct ucred *cr, uid_t uid,
729    gid_t gid, int mode, const char *fmt, ...)
730{
731	struct cdev *dev;
732	va_list ap;
733
734	va_start(ap, fmt);
735	dev = make_dev_credv(0, devsw, minornr, cr, uid, gid, mode, fmt, ap);
736	va_end(ap);
737
738	return (dev);
739}
740
741struct cdev *
742make_dev_credf(int flags, struct cdevsw *devsw, int minornr,
743    struct ucred *cr, uid_t uid,
744    gid_t gid, int mode, const char *fmt, ...)
745{
746	struct cdev *dev;
747	va_list ap;
748
749	va_start(ap, fmt);
750	dev = make_dev_credv(flags, devsw, minornr, cr, uid, gid, mode,
751	    fmt, ap);
752	va_end(ap);
753
754	return (dev);
755}
756
757static void
758dev_dependsl(struct cdev *pdev, struct cdev *cdev)
759{
760
761	cdev->si_parent = pdev;
762	cdev->si_flags |= SI_CHILD;
763	LIST_INSERT_HEAD(&pdev->si_children, cdev, si_siblings);
764}
765
766
767void
768dev_depends(struct cdev *pdev, struct cdev *cdev)
769{
770
771	dev_lock();
772	dev_dependsl(pdev, cdev);
773	dev_unlock();
774}
775
776struct cdev *
777make_dev_alias(struct cdev *pdev, const char *fmt, ...)
778{
779	struct cdev *dev;
780	va_list ap;
781	int i;
782
783	dev = devfs_alloc();
784	dev_lock();
785	dev->si_flags |= SI_ALIAS;
786	dev->si_flags |= SI_NAMED;
787	va_start(ap, fmt);
788	i = vsnrprintf(dev->__si_namebuf, sizeof dev->__si_namebuf, 32, fmt, ap);
789	if (i > (sizeof dev->__si_namebuf - 1)) {
790		printf("WARNING: Device name truncated! (%s)\n",
791		    dev->__si_namebuf);
792	}
793	va_end(ap);
794
795	devfs_create(dev);
796	clean_unrhdrl(devfs_inos);
797	dev_unlock();
798	dev_depends(pdev, dev);
799
800	notify_create(dev);
801
802	return (dev);
803}
804
805static void
806destroy_devl(struct cdev *dev)
807{
808	struct cdevsw *csw;
809	struct cdev_privdata *p, *p1;
810
811	mtx_assert(&devmtx, MA_OWNED);
812	KASSERT(dev->si_flags & SI_NAMED,
813	    ("WARNING: Driver mistake: destroy_dev on %d\n", minor(dev)));
814
815	devfs_destroy(dev);
816
817	/* Remove name marking */
818	dev->si_flags &= ~SI_NAMED;
819
820	/* If we are a child, remove us from the parents list */
821	if (dev->si_flags & SI_CHILD) {
822		LIST_REMOVE(dev, si_siblings);
823		dev->si_flags &= ~SI_CHILD;
824	}
825
826	/* Kill our children */
827	while (!LIST_EMPTY(&dev->si_children))
828		destroy_devl(LIST_FIRST(&dev->si_children));
829
830	/* Remove from clone list */
831	if (dev->si_flags & SI_CLONELIST) {
832		LIST_REMOVE(dev, si_clone);
833		dev->si_flags &= ~SI_CLONELIST;
834	}
835
836	dev->si_refcount++;	/* Avoid race with dev_rel() */
837	csw = dev->si_devsw;
838	dev->si_devsw = NULL;	/* already NULL for SI_ALIAS */
839	while (csw != NULL && csw->d_purge != NULL && dev->si_threadcount) {
840		csw->d_purge(dev);
841		msleep(csw, &devmtx, PRIBIO, "devprg", hz/10);
842		if (dev->si_threadcount)
843			printf("Still %lu threads in %s\n",
844			    dev->si_threadcount, devtoname(dev));
845	}
846	while (dev->si_threadcount != 0) {
847		/* Use unique dummy wait ident */
848		msleep(&csw, &devmtx, PRIBIO, "devdrn", hz / 10);
849	}
850
851	dev_unlock();
852	notify_destroy(dev);
853	mtx_lock(&cdevpriv_mtx);
854	LIST_FOREACH_SAFE(p, &cdev2priv(dev)->cdp_fdpriv, cdpd_list, p1) {
855		devfs_destroy_cdevpriv(p);
856		mtx_lock(&cdevpriv_mtx);
857	}
858	mtx_unlock(&cdevpriv_mtx);
859	dev_lock();
860
861	dev->si_drv1 = 0;
862	dev->si_drv2 = 0;
863	bzero(&dev->__si_u, sizeof(dev->__si_u));
864
865	if (!(dev->si_flags & SI_ALIAS)) {
866		/* Remove from cdevsw list */
867		LIST_REMOVE(dev, si_list);
868
869		/* If cdevsw has no more struct cdev *'s, clean it */
870		if (LIST_EMPTY(&csw->d_devs)) {
871			fini_cdevsw(csw);
872			wakeup(&csw->d_devs);
873		}
874	}
875	dev->si_flags &= ~SI_ALIAS;
876	dev->si_refcount--;	/* Avoid race with dev_rel() */
877
878	if (dev->si_refcount > 0) {
879		LIST_INSERT_HEAD(&dead_cdevsw.d_devs, dev, si_list);
880	} else {
881		dev_free_devlocked(dev);
882	}
883}
884
885void
886destroy_dev(struct cdev *dev)
887{
888
889	dev_lock();
890	destroy_devl(dev);
891	dev_unlock_and_free();
892}
893
894const char *
895devtoname(struct cdev *dev)
896{
897	char *p;
898	struct cdevsw *csw;
899	int mynor;
900
901	if (dev->si_name[0] == '#' || dev->si_name[0] == '\0') {
902		p = dev->si_name;
903		csw = dev_refthread(dev);
904		if (csw != NULL) {
905			sprintf(p, "(%s)", csw->d_name);
906			dev_relthread(dev);
907		}
908		p += strlen(p);
909		mynor = minor(dev);
910		if (mynor < 0 || mynor > 255)
911			sprintf(p, "/%#x", (u_int)mynor);
912		else
913			sprintf(p, "/%d", mynor);
914	}
915	return (dev->si_name);
916}
917
918int
919dev_stdclone(char *name, char **namep, const char *stem, int *unit)
920{
921	int u, i;
922
923	i = strlen(stem);
924	if (bcmp(stem, name, i) != 0)
925		return (0);
926	if (!isdigit(name[i]))
927		return (0);
928	u = 0;
929	if (name[i] == '0' && isdigit(name[i+1]))
930		return (0);
931	while (isdigit(name[i])) {
932		u *= 10;
933		u += name[i++] - '0';
934	}
935	if (u > 0xffffff)
936		return (0);
937	*unit = u;
938	if (namep)
939		*namep = &name[i];
940	if (name[i])
941		return (2);
942	return (1);
943}
944
945/*
946 * Helper functions for cloning device drivers.
947 *
948 * The objective here is to make it unnecessary for the device drivers to
949 * use rman or similar to manage their unit number space.  Due to the way
950 * we do "on-demand" devices, using rman or other "private" methods
951 * will be very tricky to lock down properly once we lock down this file.
952 *
953 * Instead we give the drivers these routines which puts the struct cdev *'s
954 * that are to be managed on their own list, and gives the driver the ability
955 * to ask for the first free unit number or a given specified unit number.
956 *
957 * In addition these routines support paired devices (pty, nmdm and similar)
958 * by respecting a number of "flag" bits in the minor number.
959 *
960 */
961
962struct clonedevs {
963	LIST_HEAD(,cdev)	head;
964};
965
966void
967clone_setup(struct clonedevs **cdp)
968{
969
970	*cdp = malloc(sizeof **cdp, M_DEVBUF, M_WAITOK | M_ZERO);
971	LIST_INIT(&(*cdp)->head);
972}
973
974int
975clone_create(struct clonedevs **cdp, struct cdevsw *csw, int *up, struct cdev **dp, int extra)
976{
977	struct clonedevs *cd;
978	struct cdev *dev, *ndev, *dl, *de;
979	int unit, low, u;
980
981	KASSERT(*cdp != NULL,
982	    ("clone_setup() not called in driver \"%s\"", csw->d_name));
983	KASSERT(!(extra & CLONE_UNITMASK),
984	    ("Illegal extra bits (0x%x) in clone_create", extra));
985	KASSERT(*up <= CLONE_UNITMASK,
986	    ("Too high unit (0x%x) in clone_create", *up));
987	KASSERT(csw->d_flags & D_NEEDMINOR,
988	    ("clone_create() on cdevsw without minor numbers"));
989
990
991	/*
992	 * Search the list for a lot of things in one go:
993	 *   A preexisting match is returned immediately.
994	 *   The lowest free unit number if we are passed -1, and the place
995	 *	 in the list where we should insert that new element.
996	 *   The place to insert a specified unit number, if applicable
997	 *       the end of the list.
998	 */
999	unit = *up;
1000	ndev = devfs_alloc();
1001	dev_lock();
1002	prep_cdevsw(csw);
1003	low = extra;
1004	de = dl = NULL;
1005	cd = *cdp;
1006	LIST_FOREACH(dev, &cd->head, si_clone) {
1007		KASSERT(dev->si_flags & SI_CLONELIST,
1008		    ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1009		u = dev2unit(dev);
1010		if (u == (unit | extra)) {
1011			*dp = dev;
1012			dev_unlock();
1013			devfs_free(ndev);
1014			return (0);
1015		}
1016		if (unit == -1 && u == low) {
1017			low++;
1018			de = dev;
1019			continue;
1020		} else if (u < (unit | extra)) {
1021			de = dev;
1022			continue;
1023		} else if (u > (unit | extra)) {
1024			dl = dev;
1025			break;
1026		}
1027	}
1028	if (unit == -1)
1029		unit = low & CLONE_UNITMASK;
1030	dev = newdev(csw, unit2minor(unit | extra), ndev);
1031	if (dev->si_flags & SI_CLONELIST) {
1032		printf("dev %p (%s) is on clonelist\n", dev, dev->si_name);
1033		printf("unit=%d, low=%d, extra=0x%x\n", unit, low, extra);
1034		LIST_FOREACH(dev, &cd->head, si_clone) {
1035			printf("\t%p %s\n", dev, dev->si_name);
1036		}
1037		panic("foo");
1038	}
1039	KASSERT(!(dev->si_flags & SI_CLONELIST),
1040	    ("Dev %p(%s) should not be on clonelist", dev, dev->si_name));
1041	if (dl != NULL)
1042		LIST_INSERT_BEFORE(dl, dev, si_clone);
1043	else if (de != NULL)
1044		LIST_INSERT_AFTER(de, dev, si_clone);
1045	else
1046		LIST_INSERT_HEAD(&cd->head, dev, si_clone);
1047	dev->si_flags |= SI_CLONELIST;
1048	*up = unit;
1049	dev_unlock_and_free();
1050	return (1);
1051}
1052
1053/*
1054 * Kill everything still on the list.  The driver should already have
1055 * disposed of any softc hung of the struct cdev *'s at this time.
1056 */
1057void
1058clone_cleanup(struct clonedevs **cdp)
1059{
1060	struct cdev *dev;
1061	struct cdev_priv *cp;
1062	struct clonedevs *cd;
1063
1064	cd = *cdp;
1065	if (cd == NULL)
1066		return;
1067	dev_lock();
1068	while (!LIST_EMPTY(&cd->head)) {
1069		dev = LIST_FIRST(&cd->head);
1070		LIST_REMOVE(dev, si_clone);
1071		KASSERT(dev->si_flags & SI_CLONELIST,
1072		    ("Dev %p(%s) should be on clonelist", dev, dev->si_name));
1073		dev->si_flags &= ~SI_CLONELIST;
1074		cp = cdev2priv(dev);
1075		if (!(cp->cdp_flags & CDP_SCHED_DTR)) {
1076			cp->cdp_flags |= CDP_SCHED_DTR;
1077			KASSERT(dev->si_flags & SI_NAMED,
1078				("Driver has goofed in cloning underways udev %x", dev->si_drv0));
1079			destroy_devl(dev);
1080		}
1081	}
1082	dev_unlock_and_free();
1083	free(cd, M_DEVBUF);
1084	*cdp = NULL;
1085}
1086
1087static TAILQ_HEAD(, cdev_priv) dev_ddtr =
1088	TAILQ_HEAD_INITIALIZER(dev_ddtr);
1089static struct task dev_dtr_task;
1090
1091static void
1092destroy_dev_tq(void *ctx, int pending)
1093{
1094	struct cdev_priv *cp;
1095	struct cdev *dev;
1096	void (*cb)(void *);
1097	void *cb_arg;
1098
1099	dev_lock();
1100	while (!TAILQ_EMPTY(&dev_ddtr)) {
1101		cp = TAILQ_FIRST(&dev_ddtr);
1102		dev = &cp->cdp_c;
1103		KASSERT(cp->cdp_flags & CDP_SCHED_DTR,
1104		    ("cdev %p in dev_destroy_tq without CDP_SCHED_DTR", cp));
1105		TAILQ_REMOVE(&dev_ddtr, cp, cdp_dtr_list);
1106		cb = cp->cdp_dtr_cb;
1107		cb_arg = cp->cdp_dtr_cb_arg;
1108		destroy_devl(dev);
1109		dev_unlock_and_free();
1110		dev_rel(dev);
1111		if (cb != NULL)
1112			cb(cb_arg);
1113		dev_lock();
1114	}
1115	dev_unlock();
1116}
1117
1118/*
1119 * devmtx shall be locked on entry. devmtx will be unlocked after
1120 * function return.
1121 */
1122static int
1123destroy_dev_sched_cbl(struct cdev *dev, void (*cb)(void *), void *arg)
1124{
1125	struct cdev_priv *cp;
1126
1127	mtx_assert(&devmtx, MA_OWNED);
1128	cp = cdev2priv(dev);
1129	if (cp->cdp_flags & CDP_SCHED_DTR) {
1130		dev_unlock();
1131		return (0);
1132	}
1133	dev_refl(dev);
1134	cp->cdp_flags |= CDP_SCHED_DTR;
1135	cp->cdp_dtr_cb = cb;
1136	cp->cdp_dtr_cb_arg = arg;
1137	TAILQ_INSERT_TAIL(&dev_ddtr, cp, cdp_dtr_list);
1138	dev_unlock();
1139	taskqueue_enqueue(taskqueue_swi_giant, &dev_dtr_task);
1140	return (1);
1141}
1142
1143int
1144destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg)
1145{
1146	dev_lock();
1147	return (destroy_dev_sched_cbl(dev, cb, arg));
1148}
1149
1150int
1151destroy_dev_sched(struct cdev *dev)
1152{
1153	return (destroy_dev_sched_cb(dev, NULL, NULL));
1154}
1155
1156void
1157destroy_dev_drain(struct cdevsw *csw)
1158{
1159
1160	dev_lock();
1161	while (!LIST_EMPTY(&csw->d_devs)) {
1162		msleep(&csw->d_devs, &devmtx, PRIBIO, "devscd", hz/10);
1163	}
1164	dev_unlock();
1165}
1166
1167void
1168drain_dev_clone_events(void)
1169{
1170
1171	sx_xlock(&clone_drain_lock);
1172	sx_xunlock(&clone_drain_lock);
1173}
1174
1175static void
1176devdtr_init(void *dummy __unused)
1177{
1178
1179	TASK_INIT(&dev_dtr_task, 0, destroy_dev_tq, NULL);
1180}
1181
1182SYSINIT(devdtr, SI_SUB_DEVFS, SI_ORDER_SECOND, devdtr_init, NULL);
1183