tty.c revision 259441
1/*-
2 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Portions of this software were developed under sponsorship from Snow
6 * B.V., the Netherlands.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: head/sys/kern/tty.c 259441 2013-12-16 00:50:14Z marcel $");
32
33#include "opt_capsicum.h"
34#include "opt_compat.h"
35
36#include <sys/param.h>
37#include <sys/capability.h>
38#include <sys/conf.h>
39#include <sys/cons.h>
40#include <sys/fcntl.h>
41#include <sys/file.h>
42#include <sys/filedesc.h>
43#include <sys/filio.h>
44#ifdef COMPAT_43TTY
45#include <sys/ioctl_compat.h>
46#endif /* COMPAT_43TTY */
47#include <sys/kernel.h>
48#include <sys/limits.h>
49#include <sys/malloc.h>
50#include <sys/mount.h>
51#include <sys/poll.h>
52#include <sys/priv.h>
53#include <sys/proc.h>
54#include <sys/serial.h>
55#include <sys/signal.h>
56#include <sys/stat.h>
57#include <sys/sx.h>
58#include <sys/sysctl.h>
59#include <sys/systm.h>
60#include <sys/tty.h>
61#include <sys/ttycom.h>
62#define TTYDEFCHARS
63#include <sys/ttydefaults.h>
64#undef TTYDEFCHARS
65#include <sys/ucred.h>
66#include <sys/vnode.h>
67
68#include <machine/stdarg.h>
69
70static MALLOC_DEFINE(M_TTY, "tty", "tty device");
71
72static void tty_rel_free(struct tty *tp);
73
74static TAILQ_HEAD(, tty) tty_list = TAILQ_HEAD_INITIALIZER(tty_list);
75static struct sx tty_list_sx;
76SX_SYSINIT(tty_list, &tty_list_sx, "tty list");
77static unsigned int tty_list_count = 0;
78
79/* Character device of /dev/console. */
80static struct cdev	*dev_console;
81static const char	*dev_console_filename;
82
83/*
84 * Flags that are supported and stored by this implementation.
85 */
86#define TTYSUP_IFLAG	(IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK|ISTRIP|\
87			INLCR|IGNCR|ICRNL|IXON|IXOFF|IXANY|IMAXBEL)
88#define TTYSUP_OFLAG	(OPOST|ONLCR|TAB3|ONOEOT|OCRNL|ONOCR|ONLRET)
89#define TTYSUP_LFLAG	(ECHOKE|ECHOE|ECHOK|ECHO|ECHONL|ECHOPRT|\
90			ECHOCTL|ISIG|ICANON|ALTWERASE|IEXTEN|TOSTOP|\
91			FLUSHO|NOKERNINFO|NOFLSH)
92#define TTYSUP_CFLAG	(CIGNORE|CSIZE|CSTOPB|CREAD|PARENB|PARODD|\
93			HUPCL|CLOCAL|CCTS_OFLOW|CRTS_IFLOW|CDTR_IFLOW|\
94			CDSR_OFLOW|CCAR_OFLOW)
95
96#define	TTY_CALLOUT(tp,d) (dev2unit(d) & TTYUNIT_CALLOUT)
97
98/*
99 * Set TTY buffer sizes.
100 */
101
102#define	TTYBUF_MAX	65536
103
104static void
105tty_watermarks(struct tty *tp)
106{
107	size_t bs = 0;
108
109	/* Provide an input buffer for 0.2 seconds of data. */
110	if (tp->t_termios.c_cflag & CREAD)
111		bs = MIN(tp->t_termios.c_ispeed / 5, TTYBUF_MAX);
112	ttyinq_setsize(&tp->t_inq, tp, bs);
113
114	/* Set low watermark at 10% (when 90% is available). */
115	tp->t_inlow = (ttyinq_getallocatedsize(&tp->t_inq) * 9) / 10;
116
117	/* Provide an output buffer for 0.2 seconds of data. */
118	bs = MIN(tp->t_termios.c_ospeed / 5, TTYBUF_MAX);
119	ttyoutq_setsize(&tp->t_outq, tp, bs);
120
121	/* Set low watermark at 10% (when 90% is available). */
122	tp->t_outlow = (ttyoutq_getallocatedsize(&tp->t_outq) * 9) / 10;
123}
124
125static int
126tty_drain(struct tty *tp)
127{
128	int error;
129
130	if (ttyhook_hashook(tp, getc_inject))
131		/* buffer is inaccessible */
132		return (0);
133
134	while (ttyoutq_bytesused(&tp->t_outq) > 0) {
135		ttydevsw_outwakeup(tp);
136		/* Could be handled synchronously. */
137		if (ttyoutq_bytesused(&tp->t_outq) == 0)
138			return (0);
139
140		/* Wait for data to be drained. */
141		error = tty_wait(tp, &tp->t_outwait);
142		if (error)
143			return (error);
144	}
145
146	return (0);
147}
148
149/*
150 * Though ttydev_enter() and ttydev_leave() seem to be related, they
151 * don't have to be used together. ttydev_enter() is used by the cdev
152 * operations to prevent an actual operation from being processed when
153 * the TTY has been abandoned. ttydev_leave() is used by ttydev_open()
154 * and ttydev_close() to determine whether per-TTY data should be
155 * deallocated.
156 */
157
158static __inline int
159ttydev_enter(struct tty *tp)
160{
161	tty_lock(tp);
162
163	if (tty_gone(tp) || !tty_opened(tp)) {
164		/* Device is already gone. */
165		tty_unlock(tp);
166		return (ENXIO);
167	}
168
169	return (0);
170}
171
172static void
173ttydev_leave(struct tty *tp)
174{
175	tty_lock_assert(tp, MA_OWNED);
176
177	if (tty_opened(tp) || tp->t_flags & TF_OPENCLOSE) {
178		/* Device is still opened somewhere. */
179		tty_unlock(tp);
180		return;
181	}
182
183	tp->t_flags |= TF_OPENCLOSE;
184
185	/* Stop asynchronous I/O. */
186	funsetown(&tp->t_sigio);
187
188	/* Remove console TTY. */
189	if (constty == tp)
190		constty_clear();
191
192	/* Drain any output. */
193	MPASS((tp->t_flags & TF_STOPPED) == 0);
194	if (!tty_gone(tp)) {
195		while (tty_drain(tp) == ERESTART)
196			;
197	}
198
199	ttydisc_close(tp);
200
201	/* Destroy associated buffers already. */
202	ttyinq_free(&tp->t_inq);
203	tp->t_inlow = 0;
204	ttyoutq_free(&tp->t_outq);
205	tp->t_outlow = 0;
206
207	knlist_clear(&tp->t_inpoll.si_note, 1);
208	knlist_clear(&tp->t_outpoll.si_note, 1);
209
210	if (!tty_gone(tp))
211		ttydevsw_close(tp);
212
213	tp->t_flags &= ~TF_OPENCLOSE;
214	cv_broadcast(&tp->t_dcdwait);
215	tty_rel_free(tp);
216}
217
218/*
219 * Operations that are exposed through the character device in /dev.
220 */
221static int
222ttydev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
223{
224	struct tty *tp;
225	int error = 0;
226
227	while ((tp = dev->si_drv1) == NULL) {
228		error = tsleep(&dev->si_drv1, PCATCH, "ttdrv1", 1);
229		if (error != EWOULDBLOCK)
230			return (error);
231	}
232
233	tty_lock(tp);
234	if (tty_gone(tp)) {
235		/* Device is already gone. */
236		tty_unlock(tp);
237		return (ENXIO);
238	}
239
240	/*
241	 * Block when other processes are currently opening or closing
242	 * the TTY.
243	 */
244	while (tp->t_flags & TF_OPENCLOSE) {
245		error = tty_wait(tp, &tp->t_dcdwait);
246		if (error != 0) {
247			tty_unlock(tp);
248			return (error);
249		}
250	}
251	tp->t_flags |= TF_OPENCLOSE;
252
253	/*
254	 * Make sure the "tty" and "cua" device cannot be opened at the
255	 * same time.
256	 */
257	if (TTY_CALLOUT(tp, dev)) {
258		if (tp->t_flags & TF_OPENED_IN) {
259			error = EBUSY;
260			goto done;
261		}
262	} else {
263		if (tp->t_flags & TF_OPENED_OUT) {
264			error = EBUSY;
265			goto done;
266		}
267	}
268
269	if (tp->t_flags & TF_EXCLUDE && priv_check(td, PRIV_TTY_EXCLUSIVE)) {
270		error = EBUSY;
271		goto done;
272	}
273
274	if (!tty_opened(tp)) {
275		/* Set proper termios flags. */
276		if (TTY_CALLOUT(tp, dev))
277			tp->t_termios = tp->t_termios_init_out;
278		else
279			tp->t_termios = tp->t_termios_init_in;
280		ttydevsw_param(tp, &tp->t_termios);
281		/* Prevent modem control on callout devices and /dev/console. */
282		if (TTY_CALLOUT(tp, dev) || dev == dev_console)
283			tp->t_termios.c_cflag |= CLOCAL;
284
285		ttydevsw_modem(tp, SER_DTR|SER_RTS, 0);
286
287		error = ttydevsw_open(tp);
288		if (error != 0)
289			goto done;
290
291		ttydisc_open(tp);
292		tty_watermarks(tp);
293	}
294
295	/* Wait for Carrier Detect. */
296	if ((oflags & O_NONBLOCK) == 0 &&
297	    (tp->t_termios.c_cflag & CLOCAL) == 0) {
298		while ((ttydevsw_modem(tp, 0, 0) & SER_DCD) == 0) {
299			error = tty_wait(tp, &tp->t_dcdwait);
300			if (error != 0)
301				goto done;
302		}
303	}
304
305	if (dev == dev_console)
306		tp->t_flags |= TF_OPENED_CONS;
307	else if (TTY_CALLOUT(tp, dev))
308		tp->t_flags |= TF_OPENED_OUT;
309	else
310		tp->t_flags |= TF_OPENED_IN;
311
312done:	tp->t_flags &= ~TF_OPENCLOSE;
313	cv_broadcast(&tp->t_dcdwait);
314	ttydev_leave(tp);
315
316	return (error);
317}
318
319static int
320ttydev_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
321{
322	struct tty *tp = dev->si_drv1;
323
324	tty_lock(tp);
325
326	/*
327	 * Don't actually close the device if it is being used as the
328	 * console.
329	 */
330	MPASS((tp->t_flags & TF_OPENED) != TF_OPENED);
331	if (dev == dev_console)
332		tp->t_flags &= ~TF_OPENED_CONS;
333	else
334		tp->t_flags &= ~(TF_OPENED_IN|TF_OPENED_OUT);
335
336	if (tp->t_flags & TF_OPENED) {
337		tty_unlock(tp);
338		return (0);
339	}
340
341	/*
342	 * This can only be called once. The callin and the callout
343	 * devices cannot be opened at the same time.
344	 */
345	tp->t_flags &= ~(TF_EXCLUDE|TF_STOPPED);
346
347	/* Properly wake up threads that are stuck - revoke(). */
348	tp->t_revokecnt++;
349	tty_wakeup(tp, FREAD|FWRITE);
350	cv_broadcast(&tp->t_bgwait);
351	cv_broadcast(&tp->t_dcdwait);
352
353	ttydev_leave(tp);
354
355	return (0);
356}
357
358static __inline int
359tty_is_ctty(struct tty *tp, struct proc *p)
360{
361	tty_lock_assert(tp, MA_OWNED);
362
363	return (p->p_session == tp->t_session && p->p_flag & P_CONTROLT);
364}
365
366int
367tty_wait_background(struct tty *tp, struct thread *td, int sig)
368{
369	struct proc *p = td->td_proc;
370	struct pgrp *pg;
371	ksiginfo_t ksi;
372	int error;
373
374	MPASS(sig == SIGTTIN || sig == SIGTTOU);
375	tty_lock_assert(tp, MA_OWNED);
376
377	for (;;) {
378		PROC_LOCK(p);
379		/*
380		 * The process should only sleep, when:
381		 * - This terminal is the controling terminal
382		 * - Its process group is not the foreground process
383		 *   group
384		 * - The parent process isn't waiting for the child to
385		 *   exit
386		 * - the signal to send to the process isn't masked
387		 */
388		if (!tty_is_ctty(tp, p) || p->p_pgrp == tp->t_pgrp) {
389			/* Allow the action to happen. */
390			PROC_UNLOCK(p);
391			return (0);
392		}
393
394		if (SIGISMEMBER(p->p_sigacts->ps_sigignore, sig) ||
395		    SIGISMEMBER(td->td_sigmask, sig)) {
396			/* Only allow them in write()/ioctl(). */
397			PROC_UNLOCK(p);
398			return (sig == SIGTTOU ? 0 : EIO);
399		}
400
401		pg = p->p_pgrp;
402		if (p->p_flag & P_PPWAIT || pg->pg_jobc == 0) {
403			/* Don't allow the action to happen. */
404			PROC_UNLOCK(p);
405			return (EIO);
406		}
407		PROC_UNLOCK(p);
408
409		/*
410		 * Send the signal and sleep until we're the new
411		 * foreground process group.
412		 */
413		if (sig != 0) {
414			ksiginfo_init(&ksi);
415			ksi.ksi_code = SI_KERNEL;
416			ksi.ksi_signo = sig;
417			sig = 0;
418		}
419		PGRP_LOCK(pg);
420		pgsignal(pg, ksi.ksi_signo, 1, &ksi);
421		PGRP_UNLOCK(pg);
422
423		error = tty_wait(tp, &tp->t_bgwait);
424		if (error)
425			return (error);
426	}
427}
428
429static int
430ttydev_read(struct cdev *dev, struct uio *uio, int ioflag)
431{
432	struct tty *tp = dev->si_drv1;
433	int error;
434
435	error = ttydev_enter(tp);
436	if (error)
437		goto done;
438	error = ttydisc_read(tp, uio, ioflag);
439	tty_unlock(tp);
440
441	/*
442	 * The read() call should not throw an error when the device is
443	 * being destroyed. Silently convert it to an EOF.
444	 */
445done:	if (error == ENXIO)
446		error = 0;
447	return (error);
448}
449
450static int
451ttydev_write(struct cdev *dev, struct uio *uio, int ioflag)
452{
453	struct tty *tp = dev->si_drv1;
454	int error;
455
456	error = ttydev_enter(tp);
457	if (error)
458		return (error);
459
460	if (tp->t_termios.c_lflag & TOSTOP) {
461		error = tty_wait_background(tp, curthread, SIGTTOU);
462		if (error)
463			goto done;
464	}
465
466	if (ioflag & IO_NDELAY && tp->t_flags & TF_BUSY_OUT) {
467		/* Allow non-blocking writes to bypass serialization. */
468		error = ttydisc_write(tp, uio, ioflag);
469	} else {
470		/* Serialize write() calls. */
471		while (tp->t_flags & TF_BUSY_OUT) {
472			error = tty_wait(tp, &tp->t_outserwait);
473			if (error)
474				goto done;
475		}
476
477		tp->t_flags |= TF_BUSY_OUT;
478		error = ttydisc_write(tp, uio, ioflag);
479		tp->t_flags &= ~TF_BUSY_OUT;
480		cv_signal(&tp->t_outserwait);
481	}
482
483done:	tty_unlock(tp);
484	return (error);
485}
486
487static int
488ttydev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
489    struct thread *td)
490{
491	struct tty *tp = dev->si_drv1;
492	int error;
493
494	error = ttydev_enter(tp);
495	if (error)
496		return (error);
497
498	switch (cmd) {
499	case TIOCCBRK:
500	case TIOCCONS:
501	case TIOCDRAIN:
502	case TIOCEXCL:
503	case TIOCFLUSH:
504	case TIOCNXCL:
505	case TIOCSBRK:
506	case TIOCSCTTY:
507	case TIOCSETA:
508	case TIOCSETAF:
509	case TIOCSETAW:
510	case TIOCSPGRP:
511	case TIOCSTART:
512	case TIOCSTAT:
513	case TIOCSTI:
514	case TIOCSTOP:
515	case TIOCSWINSZ:
516#if 0
517	case TIOCSDRAINWAIT:
518	case TIOCSETD:
519#endif
520#ifdef COMPAT_43TTY
521	case  TIOCLBIC:
522	case  TIOCLBIS:
523	case  TIOCLSET:
524	case  TIOCSETC:
525	case OTIOCSETD:
526	case  TIOCSETN:
527	case  TIOCSETP:
528	case  TIOCSLTC:
529#endif /* COMPAT_43TTY */
530		/*
531		 * If the ioctl() causes the TTY to be modified, let it
532		 * wait in the background.
533		 */
534		error = tty_wait_background(tp, curthread, SIGTTOU);
535		if (error)
536			goto done;
537	}
538
539	if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
540		struct termios *old = &tp->t_termios;
541		struct termios *new = (struct termios *)data;
542		struct termios *lock = TTY_CALLOUT(tp, dev) ?
543		    &tp->t_termios_lock_out : &tp->t_termios_lock_in;
544		int cc;
545
546		/*
547		 * Lock state devices.  Just overwrite the values of the
548		 * commands that are currently in use.
549		 */
550		new->c_iflag = (old->c_iflag & lock->c_iflag) |
551		    (new->c_iflag & ~lock->c_iflag);
552		new->c_oflag = (old->c_oflag & lock->c_oflag) |
553		    (new->c_oflag & ~lock->c_oflag);
554		new->c_cflag = (old->c_cflag & lock->c_cflag) |
555		    (new->c_cflag & ~lock->c_cflag);
556		new->c_lflag = (old->c_lflag & lock->c_lflag) |
557		    (new->c_lflag & ~lock->c_lflag);
558		for (cc = 0; cc < NCCS; ++cc)
559			if (lock->c_cc[cc])
560				new->c_cc[cc] = old->c_cc[cc];
561		if (lock->c_ispeed)
562			new->c_ispeed = old->c_ispeed;
563		if (lock->c_ospeed)
564			new->c_ospeed = old->c_ospeed;
565	}
566
567	error = tty_ioctl(tp, cmd, data, fflag, td);
568done:	tty_unlock(tp);
569
570	return (error);
571}
572
573static int
574ttydev_poll(struct cdev *dev, int events, struct thread *td)
575{
576	struct tty *tp = dev->si_drv1;
577	int error, revents = 0;
578
579	error = ttydev_enter(tp);
580	if (error)
581		return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
582
583	if (events & (POLLIN|POLLRDNORM)) {
584		/* See if we can read something. */
585		if (ttydisc_read_poll(tp) > 0)
586			revents |= events & (POLLIN|POLLRDNORM);
587	}
588
589	if (tp->t_flags & TF_ZOMBIE) {
590		/* Hangup flag on zombie state. */
591		revents |= POLLHUP;
592	} else if (events & (POLLOUT|POLLWRNORM)) {
593		/* See if we can write something. */
594		if (ttydisc_write_poll(tp) > 0)
595			revents |= events & (POLLOUT|POLLWRNORM);
596	}
597
598	if (revents == 0) {
599		if (events & (POLLIN|POLLRDNORM))
600			selrecord(td, &tp->t_inpoll);
601		if (events & (POLLOUT|POLLWRNORM))
602			selrecord(td, &tp->t_outpoll);
603	}
604
605	tty_unlock(tp);
606
607	return (revents);
608}
609
610static int
611ttydev_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
612    int nprot, vm_memattr_t *memattr)
613{
614	struct tty *tp = dev->si_drv1;
615	int error;
616
617	/* Handle mmap() through the driver. */
618
619	error = ttydev_enter(tp);
620	if (error)
621		return (-1);
622	error = ttydevsw_mmap(tp, offset, paddr, nprot, memattr);
623	tty_unlock(tp);
624
625	return (error);
626}
627
628/*
629 * kqueue support.
630 */
631
632static void
633tty_kqops_read_detach(struct knote *kn)
634{
635	struct tty *tp = kn->kn_hook;
636
637	knlist_remove(&tp->t_inpoll.si_note, kn, 0);
638}
639
640static int
641tty_kqops_read_event(struct knote *kn, long hint)
642{
643	struct tty *tp = kn->kn_hook;
644
645	tty_lock_assert(tp, MA_OWNED);
646
647	if (tty_gone(tp) || tp->t_flags & TF_ZOMBIE) {
648		kn->kn_flags |= EV_EOF;
649		return (1);
650	} else {
651		kn->kn_data = ttydisc_read_poll(tp);
652		return (kn->kn_data > 0);
653	}
654}
655
656static void
657tty_kqops_write_detach(struct knote *kn)
658{
659	struct tty *tp = kn->kn_hook;
660
661	knlist_remove(&tp->t_outpoll.si_note, kn, 0);
662}
663
664static int
665tty_kqops_write_event(struct knote *kn, long hint)
666{
667	struct tty *tp = kn->kn_hook;
668
669	tty_lock_assert(tp, MA_OWNED);
670
671	if (tty_gone(tp)) {
672		kn->kn_flags |= EV_EOF;
673		return (1);
674	} else {
675		kn->kn_data = ttydisc_write_poll(tp);
676		return (kn->kn_data > 0);
677	}
678}
679
680static struct filterops tty_kqops_read = {
681	.f_isfd = 1,
682	.f_detach = tty_kqops_read_detach,
683	.f_event = tty_kqops_read_event,
684};
685static struct filterops tty_kqops_write = {
686	.f_isfd = 1,
687	.f_detach = tty_kqops_write_detach,
688	.f_event = tty_kqops_write_event,
689};
690
691static int
692ttydev_kqfilter(struct cdev *dev, struct knote *kn)
693{
694	struct tty *tp = dev->si_drv1;
695	int error;
696
697	error = ttydev_enter(tp);
698	if (error)
699		return (error);
700
701	switch (kn->kn_filter) {
702	case EVFILT_READ:
703		kn->kn_hook = tp;
704		kn->kn_fop = &tty_kqops_read;
705		knlist_add(&tp->t_inpoll.si_note, kn, 1);
706		break;
707	case EVFILT_WRITE:
708		kn->kn_hook = tp;
709		kn->kn_fop = &tty_kqops_write;
710		knlist_add(&tp->t_outpoll.si_note, kn, 1);
711		break;
712	default:
713		error = EINVAL;
714		break;
715	}
716
717	tty_unlock(tp);
718	return (error);
719}
720
721static struct cdevsw ttydev_cdevsw = {
722	.d_version	= D_VERSION,
723	.d_open		= ttydev_open,
724	.d_close	= ttydev_close,
725	.d_read		= ttydev_read,
726	.d_write	= ttydev_write,
727	.d_ioctl	= ttydev_ioctl,
728	.d_kqfilter	= ttydev_kqfilter,
729	.d_poll		= ttydev_poll,
730	.d_mmap		= ttydev_mmap,
731	.d_name		= "ttydev",
732	.d_flags	= D_TTY,
733};
734
735/*
736 * Init/lock-state devices
737 */
738
739static int
740ttyil_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
741{
742	struct tty *tp;
743	int error = 0;
744
745	while ((tp = dev->si_drv1) == NULL) {
746		error = tsleep(&dev->si_drv1, PCATCH, "ttdrv1", 1);
747		if (error != EWOULDBLOCK)
748			return (error);
749	}
750	tty_lock(tp);
751	if (tty_gone(tp))
752		error = ENODEV;
753	tty_unlock(tp);
754
755	return (error);
756}
757
758static int
759ttyil_close(struct cdev *dev, int flag, int mode, struct thread *td)
760{
761	return (0);
762}
763
764static int
765ttyil_rdwr(struct cdev *dev, struct uio *uio, int ioflag)
766{
767	return (ENODEV);
768}
769
770static int
771ttyil_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
772    struct thread *td)
773{
774	struct tty *tp = dev->si_drv1;
775	int error;
776
777	tty_lock(tp);
778	if (tty_gone(tp)) {
779		error = ENODEV;
780		goto done;
781	}
782
783	error = ttydevsw_cioctl(tp, dev2unit(dev), cmd, data, td);
784	if (error != ENOIOCTL)
785		goto done;
786	error = 0;
787
788	switch (cmd) {
789	case TIOCGETA:
790		/* Obtain terminal flags through tcgetattr(). */
791		*(struct termios*)data = *(struct termios*)dev->si_drv2;
792		break;
793	case TIOCSETA:
794		/* Set terminal flags through tcsetattr(). */
795		error = priv_check(td, PRIV_TTY_SETA);
796		if (error)
797			break;
798		*(struct termios*)dev->si_drv2 = *(struct termios*)data;
799		break;
800	case TIOCGETD:
801		*(int *)data = TTYDISC;
802		break;
803	case TIOCGWINSZ:
804		bzero(data, sizeof(struct winsize));
805		break;
806	default:
807		error = ENOTTY;
808	}
809
810done:	tty_unlock(tp);
811	return (error);
812}
813
814static struct cdevsw ttyil_cdevsw = {
815	.d_version	= D_VERSION,
816	.d_open		= ttyil_open,
817	.d_close	= ttyil_close,
818	.d_read		= ttyil_rdwr,
819	.d_write	= ttyil_rdwr,
820	.d_ioctl	= ttyil_ioctl,
821	.d_name		= "ttyil",
822	.d_flags	= D_TTY,
823};
824
825static void
826tty_init_termios(struct tty *tp)
827{
828	struct termios *t = &tp->t_termios_init_in;
829
830	t->c_cflag = TTYDEF_CFLAG;
831	t->c_iflag = TTYDEF_IFLAG;
832	t->c_lflag = TTYDEF_LFLAG;
833	t->c_oflag = TTYDEF_OFLAG;
834	t->c_ispeed = TTYDEF_SPEED;
835	t->c_ospeed = TTYDEF_SPEED;
836	memcpy(&t->c_cc, ttydefchars, sizeof ttydefchars);
837
838	tp->t_termios_init_out = *t;
839}
840
841void
842tty_init_console(struct tty *tp, speed_t s)
843{
844	struct termios *ti = &tp->t_termios_init_in;
845	struct termios *to = &tp->t_termios_init_out;
846
847	if (s != 0) {
848		ti->c_ispeed = ti->c_ospeed = s;
849		to->c_ispeed = to->c_ospeed = s;
850	}
851
852	ti->c_cflag |= CLOCAL;
853	to->c_cflag |= CLOCAL;
854}
855
856/*
857 * Standard device routine implementations, mostly meant for
858 * pseudo-terminal device drivers. When a driver creates a new terminal
859 * device class, missing routines are patched.
860 */
861
862static int
863ttydevsw_defopen(struct tty *tp)
864{
865
866	return (0);
867}
868
869static void
870ttydevsw_defclose(struct tty *tp)
871{
872}
873
874static void
875ttydevsw_defoutwakeup(struct tty *tp)
876{
877
878	panic("Terminal device has output, while not implemented");
879}
880
881static void
882ttydevsw_definwakeup(struct tty *tp)
883{
884}
885
886static int
887ttydevsw_defioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
888{
889
890	return (ENOIOCTL);
891}
892
893static int
894ttydevsw_defcioctl(struct tty *tp, int unit, u_long cmd, caddr_t data, struct thread *td)
895{
896
897	return (ENOIOCTL);
898}
899
900static int
901ttydevsw_defparam(struct tty *tp, struct termios *t)
902{
903
904	/*
905	 * Allow the baud rate to be adjusted for pseudo-devices, but at
906	 * least restrict it to 115200 to prevent excessive buffer
907	 * usage.  Also disallow 0, to prevent foot shooting.
908	 */
909	if (t->c_ispeed < B50)
910		t->c_ispeed = B50;
911	else if (t->c_ispeed > B115200)
912		t->c_ispeed = B115200;
913	if (t->c_ospeed < B50)
914		t->c_ospeed = B50;
915	else if (t->c_ospeed > B115200)
916		t->c_ospeed = B115200;
917	t->c_cflag |= CREAD;
918
919	return (0);
920}
921
922static int
923ttydevsw_defmodem(struct tty *tp, int sigon, int sigoff)
924{
925
926	/* Simulate a carrier to make the TTY layer happy. */
927	return (SER_DCD);
928}
929
930static int
931ttydevsw_defmmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t *paddr,
932    int nprot, vm_memattr_t *memattr)
933{
934
935	return (-1);
936}
937
938static void
939ttydevsw_defpktnotify(struct tty *tp, char event)
940{
941}
942
943static void
944ttydevsw_deffree(void *softc)
945{
946
947	panic("Terminal device freed without a free-handler");
948}
949
950/*
951 * TTY allocation and deallocation. TTY devices can be deallocated when
952 * the driver doesn't use it anymore, when the TTY isn't a session's
953 * controlling TTY and when the device node isn't opened through devfs.
954 */
955
956struct tty *
957tty_alloc(struct ttydevsw *tsw, void *sc)
958{
959
960	return (tty_alloc_mutex(tsw, sc, NULL));
961}
962
963struct tty *
964tty_alloc_mutex(struct ttydevsw *tsw, void *sc, struct mtx *mutex)
965{
966	struct tty *tp;
967
968	/* Make sure the driver defines all routines. */
969#define PATCH_FUNC(x) do {				\
970	if (tsw->tsw_ ## x == NULL)			\
971		tsw->tsw_ ## x = ttydevsw_def ## x;	\
972} while (0)
973	PATCH_FUNC(open);
974	PATCH_FUNC(close);
975	PATCH_FUNC(outwakeup);
976	PATCH_FUNC(inwakeup);
977	PATCH_FUNC(ioctl);
978	PATCH_FUNC(cioctl);
979	PATCH_FUNC(param);
980	PATCH_FUNC(modem);
981	PATCH_FUNC(mmap);
982	PATCH_FUNC(pktnotify);
983	PATCH_FUNC(free);
984#undef PATCH_FUNC
985
986	tp = malloc(sizeof(struct tty), M_TTY, M_WAITOK|M_ZERO);
987	tp->t_devsw = tsw;
988	tp->t_devswsoftc = sc;
989	tp->t_flags = tsw->tsw_flags;
990
991	tty_init_termios(tp);
992
993	cv_init(&tp->t_inwait, "ttyin");
994	cv_init(&tp->t_outwait, "ttyout");
995	cv_init(&tp->t_outserwait, "ttyosr");
996	cv_init(&tp->t_bgwait, "ttybg");
997	cv_init(&tp->t_dcdwait, "ttydcd");
998
999	/* Allow drivers to use a custom mutex to lock the TTY. */
1000	if (mutex != NULL) {
1001		tp->t_mtx = mutex;
1002	} else {
1003		tp->t_mtx = &tp->t_mtxobj;
1004		mtx_init(&tp->t_mtxobj, "ttymtx", NULL, MTX_DEF);
1005	}
1006
1007	knlist_init_mtx(&tp->t_inpoll.si_note, tp->t_mtx);
1008	knlist_init_mtx(&tp->t_outpoll.si_note, tp->t_mtx);
1009
1010	sx_xlock(&tty_list_sx);
1011	TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
1012	tty_list_count++;
1013	sx_xunlock(&tty_list_sx);
1014
1015	return (tp);
1016}
1017
1018static void
1019tty_dealloc(void *arg)
1020{
1021	struct tty *tp = arg;
1022
1023	sx_xlock(&tty_list_sx);
1024	TAILQ_REMOVE(&tty_list, tp, t_list);
1025	tty_list_count--;
1026	sx_xunlock(&tty_list_sx);
1027
1028	/* Make sure we haven't leaked buffers. */
1029	MPASS(ttyinq_getsize(&tp->t_inq) == 0);
1030	MPASS(ttyoutq_getsize(&tp->t_outq) == 0);
1031
1032	seldrain(&tp->t_inpoll);
1033	seldrain(&tp->t_outpoll);
1034	knlist_destroy(&tp->t_inpoll.si_note);
1035	knlist_destroy(&tp->t_outpoll.si_note);
1036
1037	cv_destroy(&tp->t_inwait);
1038	cv_destroy(&tp->t_outwait);
1039	cv_destroy(&tp->t_bgwait);
1040	cv_destroy(&tp->t_dcdwait);
1041	cv_destroy(&tp->t_outserwait);
1042
1043	if (tp->t_mtx == &tp->t_mtxobj)
1044		mtx_destroy(&tp->t_mtxobj);
1045	ttydevsw_free(tp);
1046	free(tp, M_TTY);
1047}
1048
1049static void
1050tty_rel_free(struct tty *tp)
1051{
1052	struct cdev *dev;
1053
1054	tty_lock_assert(tp, MA_OWNED);
1055
1056#define	TF_ACTIVITY	(TF_GONE|TF_OPENED|TF_HOOK|TF_OPENCLOSE)
1057	if (tp->t_sessioncnt != 0 || (tp->t_flags & TF_ACTIVITY) != TF_GONE) {
1058		/* TTY is still in use. */
1059		tty_unlock(tp);
1060		return;
1061	}
1062
1063	/* TTY can be deallocated. */
1064	dev = tp->t_dev;
1065	tp->t_dev = NULL;
1066	tty_unlock(tp);
1067
1068	if (dev != NULL)
1069		destroy_dev_sched_cb(dev, tty_dealloc, tp);
1070}
1071
1072void
1073tty_rel_pgrp(struct tty *tp, struct pgrp *pg)
1074{
1075	MPASS(tp->t_sessioncnt > 0);
1076	tty_lock_assert(tp, MA_OWNED);
1077
1078	if (tp->t_pgrp == pg)
1079		tp->t_pgrp = NULL;
1080
1081	tty_unlock(tp);
1082}
1083
1084void
1085tty_rel_sess(struct tty *tp, struct session *sess)
1086{
1087	MPASS(tp->t_sessioncnt > 0);
1088
1089	/* Current session has left. */
1090	if (tp->t_session == sess) {
1091		tp->t_session = NULL;
1092		MPASS(tp->t_pgrp == NULL);
1093	}
1094	tp->t_sessioncnt--;
1095	tty_rel_free(tp);
1096}
1097
1098void
1099tty_rel_gone(struct tty *tp)
1100{
1101	MPASS(!tty_gone(tp));
1102
1103	/* Simulate carrier removal. */
1104	ttydisc_modem(tp, 0);
1105
1106	/* Wake up all blocked threads. */
1107	tty_wakeup(tp, FREAD|FWRITE);
1108	cv_broadcast(&tp->t_bgwait);
1109	cv_broadcast(&tp->t_dcdwait);
1110
1111	tp->t_flags |= TF_GONE;
1112	tty_rel_free(tp);
1113}
1114
1115/*
1116 * Exposing information about current TTY's through sysctl
1117 */
1118
1119static void
1120tty_to_xtty(struct tty *tp, struct xtty *xt)
1121{
1122	tty_lock_assert(tp, MA_OWNED);
1123
1124	xt->xt_size = sizeof(struct xtty);
1125	xt->xt_insize = ttyinq_getsize(&tp->t_inq);
1126	xt->xt_incc = ttyinq_bytescanonicalized(&tp->t_inq);
1127	xt->xt_inlc = ttyinq_bytesline(&tp->t_inq);
1128	xt->xt_inlow = tp->t_inlow;
1129	xt->xt_outsize = ttyoutq_getsize(&tp->t_outq);
1130	xt->xt_outcc = ttyoutq_bytesused(&tp->t_outq);
1131	xt->xt_outlow = tp->t_outlow;
1132	xt->xt_column = tp->t_column;
1133	xt->xt_pgid = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1134	xt->xt_sid = tp->t_session ? tp->t_session->s_sid : 0;
1135	xt->xt_flags = tp->t_flags;
1136	xt->xt_dev = tp->t_dev ? dev2udev(tp->t_dev) : NODEV;
1137}
1138
1139static int
1140sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
1141{
1142	unsigned long lsize;
1143	struct xtty *xtlist, *xt;
1144	struct tty *tp;
1145	int error;
1146
1147	sx_slock(&tty_list_sx);
1148	lsize = tty_list_count * sizeof(struct xtty);
1149	if (lsize == 0) {
1150		sx_sunlock(&tty_list_sx);
1151		return (0);
1152	}
1153
1154	xtlist = xt = malloc(lsize, M_TTY, M_WAITOK);
1155
1156	TAILQ_FOREACH(tp, &tty_list, t_list) {
1157		tty_lock(tp);
1158		tty_to_xtty(tp, xt);
1159		tty_unlock(tp);
1160		xt++;
1161	}
1162	sx_sunlock(&tty_list_sx);
1163
1164	error = SYSCTL_OUT(req, xtlist, lsize);
1165	free(xtlist, M_TTY);
1166	return (error);
1167}
1168
1169SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
1170	0, 0, sysctl_kern_ttys, "S,xtty", "List of TTYs");
1171
1172/*
1173 * Device node creation. Device has been set up, now we can expose it to
1174 * the user.
1175 */
1176
1177void
1178tty_makedev(struct tty *tp, struct ucred *cred, const char *fmt, ...)
1179{
1180	va_list ap;
1181	struct cdev *dev;
1182	const char *prefix = "tty";
1183	char name[SPECNAMELEN - 3]; /* for "tty" and "cua". */
1184	uid_t uid;
1185	gid_t gid;
1186	mode_t mode;
1187
1188	/* Remove "tty" prefix from devices like PTY's. */
1189	if (tp->t_flags & TF_NOPREFIX)
1190		prefix = "";
1191
1192	va_start(ap, fmt);
1193	vsnrprintf(name, sizeof name, 32, fmt, ap);
1194	va_end(ap);
1195
1196	if (cred == NULL) {
1197		/* System device. */
1198		uid = UID_ROOT;
1199		gid = GID_WHEEL;
1200		mode = S_IRUSR|S_IWUSR;
1201	} else {
1202		/* User device. */
1203		uid = cred->cr_ruid;
1204		gid = GID_TTY;
1205		mode = S_IRUSR|S_IWUSR|S_IWGRP;
1206	}
1207
1208	/* Master call-in device. */
1209	dev = make_dev_cred(&ttydev_cdevsw, 0, cred,
1210	    uid, gid, mode, "%s%s", prefix, name);
1211	dev->si_drv1 = tp;
1212	wakeup(&dev->si_drv1);
1213	tp->t_dev = dev;
1214
1215	/* Slave call-in devices. */
1216	if (tp->t_flags & TF_INITLOCK) {
1217		dev = make_dev_cred(&ttyil_cdevsw, TTYUNIT_INIT, cred,
1218		    uid, gid, mode, "%s%s.init", prefix, name);
1219		dev_depends(tp->t_dev, dev);
1220		dev->si_drv1 = tp;
1221		wakeup(&dev->si_drv1);
1222		dev->si_drv2 = &tp->t_termios_init_in;
1223
1224		dev = make_dev_cred(&ttyil_cdevsw, TTYUNIT_LOCK, cred,
1225		    uid, gid, mode, "%s%s.lock", prefix, name);
1226		dev_depends(tp->t_dev, dev);
1227		dev->si_drv1 = tp;
1228		wakeup(&dev->si_drv1);
1229		dev->si_drv2 = &tp->t_termios_lock_in;
1230	}
1231
1232	/* Call-out devices. */
1233	if (tp->t_flags & TF_CALLOUT) {
1234		dev = make_dev_cred(&ttydev_cdevsw, TTYUNIT_CALLOUT, cred,
1235		    UID_UUCP, GID_DIALER, 0660, "cua%s", name);
1236		dev_depends(tp->t_dev, dev);
1237		dev->si_drv1 = tp;
1238		wakeup(&dev->si_drv1);
1239
1240		/* Slave call-out devices. */
1241		if (tp->t_flags & TF_INITLOCK) {
1242			dev = make_dev_cred(&ttyil_cdevsw,
1243			    TTYUNIT_CALLOUT | TTYUNIT_INIT, cred,
1244			    UID_UUCP, GID_DIALER, 0660, "cua%s.init", name);
1245			dev_depends(tp->t_dev, dev);
1246			dev->si_drv1 = tp;
1247			wakeup(&dev->si_drv1);
1248			dev->si_drv2 = &tp->t_termios_init_out;
1249
1250			dev = make_dev_cred(&ttyil_cdevsw,
1251			    TTYUNIT_CALLOUT | TTYUNIT_LOCK, cred,
1252			    UID_UUCP, GID_DIALER, 0660, "cua%s.lock", name);
1253			dev_depends(tp->t_dev, dev);
1254			dev->si_drv1 = tp;
1255			wakeup(&dev->si_drv1);
1256			dev->si_drv2 = &tp->t_termios_lock_out;
1257		}
1258	}
1259}
1260
1261/*
1262 * Signalling processes.
1263 */
1264
1265void
1266tty_signal_sessleader(struct tty *tp, int sig)
1267{
1268	struct proc *p;
1269
1270	tty_lock_assert(tp, MA_OWNED);
1271	MPASS(sig >= 1 && sig < NSIG);
1272
1273	/* Make signals start output again. */
1274	tp->t_flags &= ~TF_STOPPED;
1275
1276	if (tp->t_session != NULL && tp->t_session->s_leader != NULL) {
1277		p = tp->t_session->s_leader;
1278		PROC_LOCK(p);
1279		kern_psignal(p, sig);
1280		PROC_UNLOCK(p);
1281	}
1282}
1283
1284void
1285tty_signal_pgrp(struct tty *tp, int sig)
1286{
1287	ksiginfo_t ksi;
1288
1289	tty_lock_assert(tp, MA_OWNED);
1290	MPASS(sig >= 1 && sig < NSIG);
1291
1292	/* Make signals start output again. */
1293	tp->t_flags &= ~TF_STOPPED;
1294
1295	if (sig == SIGINFO && !(tp->t_termios.c_lflag & NOKERNINFO))
1296		tty_info(tp);
1297	if (tp->t_pgrp != NULL) {
1298		ksiginfo_init(&ksi);
1299		ksi.ksi_signo = sig;
1300		ksi.ksi_code = SI_KERNEL;
1301		PGRP_LOCK(tp->t_pgrp);
1302		pgsignal(tp->t_pgrp, sig, 1, &ksi);
1303		PGRP_UNLOCK(tp->t_pgrp);
1304	}
1305}
1306
1307void
1308tty_wakeup(struct tty *tp, int flags)
1309{
1310	if (tp->t_flags & TF_ASYNC && tp->t_sigio != NULL)
1311		pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
1312
1313	if (flags & FWRITE) {
1314		cv_broadcast(&tp->t_outwait);
1315		selwakeup(&tp->t_outpoll);
1316		KNOTE_LOCKED(&tp->t_outpoll.si_note, 0);
1317	}
1318	if (flags & FREAD) {
1319		cv_broadcast(&tp->t_inwait);
1320		selwakeup(&tp->t_inpoll);
1321		KNOTE_LOCKED(&tp->t_inpoll.si_note, 0);
1322	}
1323}
1324
1325int
1326tty_wait(struct tty *tp, struct cv *cv)
1327{
1328	int error;
1329	int revokecnt = tp->t_revokecnt;
1330
1331	tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1332	MPASS(!tty_gone(tp));
1333
1334	error = cv_wait_sig(cv, tp->t_mtx);
1335
1336	/* Restart the system call when we may have been revoked. */
1337	if (tp->t_revokecnt != revokecnt)
1338		return (ERESTART);
1339
1340	/* Bail out when the device slipped away. */
1341	if (tty_gone(tp))
1342		return (ENXIO);
1343
1344	return (error);
1345}
1346
1347int
1348tty_timedwait(struct tty *tp, struct cv *cv, int hz)
1349{
1350	int error;
1351	int revokecnt = tp->t_revokecnt;
1352
1353	tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1354	MPASS(!tty_gone(tp));
1355
1356	error = cv_timedwait_sig(cv, tp->t_mtx, hz);
1357
1358	/* Restart the system call when we may have been revoked. */
1359	if (tp->t_revokecnt != revokecnt)
1360		return (ERESTART);
1361
1362	/* Bail out when the device slipped away. */
1363	if (tty_gone(tp))
1364		return (ENXIO);
1365
1366	return (error);
1367}
1368
1369void
1370tty_flush(struct tty *tp, int flags)
1371{
1372	if (flags & FWRITE) {
1373		tp->t_flags &= ~TF_HIWAT_OUT;
1374		ttyoutq_flush(&tp->t_outq);
1375		tty_wakeup(tp, FWRITE);
1376		ttydevsw_pktnotify(tp, TIOCPKT_FLUSHWRITE);
1377	}
1378	if (flags & FREAD) {
1379		tty_hiwat_in_unblock(tp);
1380		ttyinq_flush(&tp->t_inq);
1381		ttydevsw_inwakeup(tp);
1382		ttydevsw_pktnotify(tp, TIOCPKT_FLUSHREAD);
1383	}
1384}
1385
1386void
1387tty_set_winsize(struct tty *tp, const struct winsize *wsz)
1388{
1389
1390	if (memcmp(&tp->t_winsize, wsz, sizeof(*wsz)) == 0)
1391		return;
1392	tp->t_winsize = *wsz;
1393	tty_signal_pgrp(tp, SIGWINCH);
1394}
1395
1396static int
1397tty_generic_ioctl(struct tty *tp, u_long cmd, void *data, int fflag,
1398    struct thread *td)
1399{
1400	int error;
1401
1402	switch (cmd) {
1403	/*
1404	 * Modem commands.
1405	 * The SER_* and TIOCM_* flags are the same, but one bit
1406	 * shifted. I don't know why.
1407	 */
1408	case TIOCSDTR:
1409		ttydevsw_modem(tp, SER_DTR, 0);
1410		return (0);
1411	case TIOCCDTR:
1412		ttydevsw_modem(tp, 0, SER_DTR);
1413		return (0);
1414	case TIOCMSET: {
1415		int bits = *(int *)data;
1416		ttydevsw_modem(tp,
1417		    (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1,
1418		    ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1419		return (0);
1420	}
1421	case TIOCMBIS: {
1422		int bits = *(int *)data;
1423		ttydevsw_modem(tp, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1, 0);
1424		return (0);
1425	}
1426	case TIOCMBIC: {
1427		int bits = *(int *)data;
1428		ttydevsw_modem(tp, 0, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1429		return (0);
1430	}
1431	case TIOCMGET:
1432		*(int *)data = TIOCM_LE + (ttydevsw_modem(tp, 0, 0) << 1);
1433		return (0);
1434
1435	case FIOASYNC:
1436		if (*(int *)data)
1437			tp->t_flags |= TF_ASYNC;
1438		else
1439			tp->t_flags &= ~TF_ASYNC;
1440		return (0);
1441	case FIONBIO:
1442		/* This device supports non-blocking operation. */
1443		return (0);
1444	case FIONREAD:
1445		*(int *)data = ttyinq_bytescanonicalized(&tp->t_inq);
1446		return (0);
1447	case FIONWRITE:
1448	case TIOCOUTQ:
1449		*(int *)data = ttyoutq_bytesused(&tp->t_outq);
1450		return (0);
1451	case FIOSETOWN:
1452		if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1453			/* Not allowed to set ownership. */
1454			return (ENOTTY);
1455
1456		/* Temporarily unlock the TTY to set ownership. */
1457		tty_unlock(tp);
1458		error = fsetown(*(int *)data, &tp->t_sigio);
1459		tty_lock(tp);
1460		return (error);
1461	case FIOGETOWN:
1462		if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1463			/* Not allowed to set ownership. */
1464			return (ENOTTY);
1465
1466		/* Get ownership. */
1467		*(int *)data = fgetown(&tp->t_sigio);
1468		return (0);
1469	case TIOCGETA:
1470		/* Obtain terminal flags through tcgetattr(). */
1471		*(struct termios*)data = tp->t_termios;
1472		return (0);
1473	case TIOCSETA:
1474	case TIOCSETAW:
1475	case TIOCSETAF: {
1476		struct termios *t = data;
1477
1478		/*
1479		 * Who makes up these funny rules? According to POSIX,
1480		 * input baud rate is set equal to the output baud rate
1481		 * when zero.
1482		 */
1483		if (t->c_ispeed == 0)
1484			t->c_ispeed = t->c_ospeed;
1485
1486		/* Discard any unsupported bits. */
1487		t->c_iflag &= TTYSUP_IFLAG;
1488		t->c_oflag &= TTYSUP_OFLAG;
1489		t->c_lflag &= TTYSUP_LFLAG;
1490		t->c_cflag &= TTYSUP_CFLAG;
1491
1492		/* Set terminal flags through tcsetattr(). */
1493		if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1494			error = tty_drain(tp);
1495			if (error)
1496				return (error);
1497			if (cmd == TIOCSETAF)
1498				tty_flush(tp, FREAD);
1499		}
1500
1501		/*
1502		 * Only call param() when the flags really change.
1503		 */
1504		if ((t->c_cflag & CIGNORE) == 0 &&
1505		    (tp->t_termios.c_cflag != t->c_cflag ||
1506		    ((tp->t_termios.c_iflag ^ t->c_iflag) &
1507		    (IXON|IXOFF|IXANY)) ||
1508		    tp->t_termios.c_ispeed != t->c_ispeed ||
1509		    tp->t_termios.c_ospeed != t->c_ospeed)) {
1510			error = ttydevsw_param(tp, t);
1511			if (error)
1512				return (error);
1513
1514			/* XXX: CLOCAL? */
1515
1516			tp->t_termios.c_cflag = t->c_cflag & ~CIGNORE;
1517			tp->t_termios.c_ispeed = t->c_ispeed;
1518			tp->t_termios.c_ospeed = t->c_ospeed;
1519
1520			/* Baud rate has changed - update watermarks. */
1521			tty_watermarks(tp);
1522		}
1523
1524		/* Copy new non-device driver parameters. */
1525		tp->t_termios.c_iflag = t->c_iflag;
1526		tp->t_termios.c_oflag = t->c_oflag;
1527		tp->t_termios.c_lflag = t->c_lflag;
1528		memcpy(&tp->t_termios.c_cc, t->c_cc, sizeof t->c_cc);
1529
1530		ttydisc_optimize(tp);
1531
1532		if ((t->c_lflag & ICANON) == 0) {
1533			/*
1534			 * When in non-canonical mode, wake up all
1535			 * readers. Canonicalize any partial input. VMIN
1536			 * and VTIME could also be adjusted.
1537			 */
1538			ttyinq_canonicalize(&tp->t_inq);
1539			tty_wakeup(tp, FREAD);
1540		}
1541
1542		/*
1543		 * For packet mode: notify the PTY consumer that VSTOP
1544		 * and VSTART may have been changed.
1545		 */
1546		if (tp->t_termios.c_iflag & IXON &&
1547		    tp->t_termios.c_cc[VSTOP] == CTRL('S') &&
1548		    tp->t_termios.c_cc[VSTART] == CTRL('Q'))
1549			ttydevsw_pktnotify(tp, TIOCPKT_DOSTOP);
1550		else
1551			ttydevsw_pktnotify(tp, TIOCPKT_NOSTOP);
1552		return (0);
1553	}
1554	case TIOCGETD:
1555		/* For compatibility - we only support TTYDISC. */
1556		*(int *)data = TTYDISC;
1557		return (0);
1558	case TIOCGPGRP:
1559		if (!tty_is_ctty(tp, td->td_proc))
1560			return (ENOTTY);
1561
1562		if (tp->t_pgrp != NULL)
1563			*(int *)data = tp->t_pgrp->pg_id;
1564		else
1565			*(int *)data = NO_PID;
1566		return (0);
1567	case TIOCGSID:
1568		if (!tty_is_ctty(tp, td->td_proc))
1569			return (ENOTTY);
1570
1571		MPASS(tp->t_session);
1572		*(int *)data = tp->t_session->s_sid;
1573		return (0);
1574	case TIOCSCTTY: {
1575		struct proc *p = td->td_proc;
1576
1577		/* XXX: This looks awful. */
1578		tty_unlock(tp);
1579		sx_xlock(&proctree_lock);
1580		tty_lock(tp);
1581
1582		if (!SESS_LEADER(p)) {
1583			/* Only the session leader may do this. */
1584			sx_xunlock(&proctree_lock);
1585			return (EPERM);
1586		}
1587
1588		if (tp->t_session != NULL && tp->t_session == p->p_session) {
1589			/* This is already our controlling TTY. */
1590			sx_xunlock(&proctree_lock);
1591			return (0);
1592		}
1593
1594		if (p->p_session->s_ttyp != NULL ||
1595		    (tp->t_session != NULL && tp->t_session->s_ttyvp != NULL &&
1596		    tp->t_session->s_ttyvp->v_type != VBAD)) {
1597			/*
1598			 * There is already a relation between a TTY and
1599			 * a session, or the caller is not the session
1600			 * leader.
1601			 *
1602			 * Allow the TTY to be stolen when the vnode is
1603			 * invalid, but the reference to the TTY is
1604			 * still active.  This allows immediate reuse of
1605			 * TTYs of which the session leader has been
1606			 * killed or the TTY revoked.
1607			 */
1608			sx_xunlock(&proctree_lock);
1609			return (EPERM);
1610		}
1611
1612		/* Connect the session to the TTY. */
1613		tp->t_session = p->p_session;
1614		tp->t_session->s_ttyp = tp;
1615		tp->t_sessioncnt++;
1616		sx_xunlock(&proctree_lock);
1617
1618		/* Assign foreground process group. */
1619		tp->t_pgrp = p->p_pgrp;
1620		PROC_LOCK(p);
1621		p->p_flag |= P_CONTROLT;
1622		PROC_UNLOCK(p);
1623
1624		return (0);
1625	}
1626	case TIOCSPGRP: {
1627		struct pgrp *pg;
1628
1629		/*
1630		 * XXX: Temporarily unlock the TTY to locate the process
1631		 * group. This code would be lot nicer if we would ever
1632		 * decompose proctree_lock.
1633		 */
1634		tty_unlock(tp);
1635		sx_slock(&proctree_lock);
1636		pg = pgfind(*(int *)data);
1637		if (pg != NULL)
1638			PGRP_UNLOCK(pg);
1639		if (pg == NULL || pg->pg_session != td->td_proc->p_session) {
1640			sx_sunlock(&proctree_lock);
1641			tty_lock(tp);
1642			return (EPERM);
1643		}
1644		tty_lock(tp);
1645
1646		/*
1647		 * Determine if this TTY is the controlling TTY after
1648		 * relocking the TTY.
1649		 */
1650		if (!tty_is_ctty(tp, td->td_proc)) {
1651			sx_sunlock(&proctree_lock);
1652			return (ENOTTY);
1653		}
1654		tp->t_pgrp = pg;
1655		sx_sunlock(&proctree_lock);
1656
1657		/* Wake up the background process groups. */
1658		cv_broadcast(&tp->t_bgwait);
1659		return (0);
1660	}
1661	case TIOCFLUSH: {
1662		int flags = *(int *)data;
1663
1664		if (flags == 0)
1665			flags = (FREAD|FWRITE);
1666		else
1667			flags &= (FREAD|FWRITE);
1668		tty_flush(tp, flags);
1669		return (0);
1670	}
1671	case TIOCDRAIN:
1672		/* Drain TTY output. */
1673		return tty_drain(tp);
1674	case TIOCCONS:
1675		/* Set terminal as console TTY. */
1676		if (*(int *)data) {
1677			error = priv_check(td, PRIV_TTY_CONSOLE);
1678			if (error)
1679				return (error);
1680
1681			/*
1682			 * XXX: constty should really need to be locked!
1683			 * XXX: allow disconnected constty's to be stolen!
1684			 */
1685
1686			if (constty == tp)
1687				return (0);
1688			if (constty != NULL)
1689				return (EBUSY);
1690
1691			tty_unlock(tp);
1692			constty_set(tp);
1693			tty_lock(tp);
1694		} else if (constty == tp) {
1695			constty_clear();
1696		}
1697		return (0);
1698	case TIOCGWINSZ:
1699		/* Obtain window size. */
1700		*(struct winsize*)data = tp->t_winsize;
1701		return (0);
1702	case TIOCSWINSZ:
1703		/* Set window size. */
1704		tty_set_winsize(tp, data);
1705		return (0);
1706	case TIOCEXCL:
1707		tp->t_flags |= TF_EXCLUDE;
1708		return (0);
1709	case TIOCNXCL:
1710		tp->t_flags &= ~TF_EXCLUDE;
1711		return (0);
1712	case TIOCSTOP:
1713		tp->t_flags |= TF_STOPPED;
1714		ttydevsw_pktnotify(tp, TIOCPKT_STOP);
1715		return (0);
1716	case TIOCSTART:
1717		tp->t_flags &= ~TF_STOPPED;
1718		ttydevsw_outwakeup(tp);
1719		ttydevsw_pktnotify(tp, TIOCPKT_START);
1720		return (0);
1721	case TIOCSTAT:
1722		tty_info(tp);
1723		return (0);
1724	case TIOCSTI:
1725		if ((fflag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1726			return (EPERM);
1727		if (!tty_is_ctty(tp, td->td_proc) &&
1728		    priv_check(td, PRIV_TTY_STI))
1729			return (EACCES);
1730		ttydisc_rint(tp, *(char *)data, 0);
1731		ttydisc_rint_done(tp);
1732		return (0);
1733	}
1734
1735#ifdef COMPAT_43TTY
1736	return tty_ioctl_compat(tp, cmd, data, fflag, td);
1737#else /* !COMPAT_43TTY */
1738	return (ENOIOCTL);
1739#endif /* COMPAT_43TTY */
1740}
1741
1742int
1743tty_ioctl(struct tty *tp, u_long cmd, void *data, int fflag, struct thread *td)
1744{
1745	int error;
1746
1747	tty_lock_assert(tp, MA_OWNED);
1748
1749	if (tty_gone(tp))
1750		return (ENXIO);
1751
1752	error = ttydevsw_ioctl(tp, cmd, data, td);
1753	if (error == ENOIOCTL)
1754		error = tty_generic_ioctl(tp, cmd, data, fflag, td);
1755
1756	return (error);
1757}
1758
1759dev_t
1760tty_udev(struct tty *tp)
1761{
1762	if (tp->t_dev)
1763		return dev2udev(tp->t_dev);
1764	else
1765		return NODEV;
1766}
1767
1768int
1769tty_checkoutq(struct tty *tp)
1770{
1771
1772	/* 256 bytes should be enough to print a log message. */
1773	return (ttyoutq_bytesleft(&tp->t_outq) >= 256);
1774}
1775
1776void
1777tty_hiwat_in_block(struct tty *tp)
1778{
1779
1780	if ((tp->t_flags & TF_HIWAT_IN) == 0 &&
1781	    tp->t_termios.c_iflag & IXOFF &&
1782	    tp->t_termios.c_cc[VSTOP] != _POSIX_VDISABLE) {
1783		/*
1784		 * Input flow control. Only enter the high watermark when we
1785		 * can successfully store the VSTOP character.
1786		 */
1787		if (ttyoutq_write_nofrag(&tp->t_outq,
1788		    &tp->t_termios.c_cc[VSTOP], 1) == 0)
1789			tp->t_flags |= TF_HIWAT_IN;
1790	} else {
1791		/* No input flow control. */
1792		tp->t_flags |= TF_HIWAT_IN;
1793	}
1794}
1795
1796void
1797tty_hiwat_in_unblock(struct tty *tp)
1798{
1799
1800	if (tp->t_flags & TF_HIWAT_IN &&
1801	    tp->t_termios.c_iflag & IXOFF &&
1802	    tp->t_termios.c_cc[VSTART] != _POSIX_VDISABLE) {
1803		/*
1804		 * Input flow control. Only leave the high watermark when we
1805		 * can successfully store the VSTART character.
1806		 */
1807		if (ttyoutq_write_nofrag(&tp->t_outq,
1808		    &tp->t_termios.c_cc[VSTART], 1) == 0)
1809			tp->t_flags &= ~TF_HIWAT_IN;
1810	} else {
1811		/* No input flow control. */
1812		tp->t_flags &= ~TF_HIWAT_IN;
1813	}
1814
1815	if (!tty_gone(tp))
1816		ttydevsw_inwakeup(tp);
1817}
1818
1819/*
1820 * TTY hooks interface.
1821 */
1822
1823static int
1824ttyhook_defrint(struct tty *tp, char c, int flags)
1825{
1826
1827	if (ttyhook_rint_bypass(tp, &c, 1) != 1)
1828		return (-1);
1829
1830	return (0);
1831}
1832
1833int
1834ttyhook_register(struct tty **rtp, struct proc *p, int fd,
1835    struct ttyhook *th, void *softc)
1836{
1837	struct tty *tp;
1838	struct file *fp;
1839	struct cdev *dev;
1840	struct cdevsw *cdp;
1841	struct filedesc *fdp;
1842	cap_rights_t rights;
1843	int error, ref;
1844
1845	/* Validate the file descriptor. */
1846	fdp = p->p_fd;
1847	error = fget_unlocked(fdp, fd, cap_rights_init(&rights, CAP_TTYHOOK),
1848	    0, &fp, NULL);
1849	if (error != 0)
1850		return (error);
1851	if (fp->f_ops == &badfileops) {
1852		error = EBADF;
1853		goto done1;
1854	}
1855
1856	/*
1857	 * Make sure the vnode is bound to a character device.
1858	 * Unlocked check for the vnode type is ok there, because we
1859	 * only shall prevent calling devvn_refthread on the file that
1860	 * never has been opened over a character device.
1861	 */
1862	if (fp->f_type != DTYPE_VNODE || fp->f_vnode->v_type != VCHR) {
1863		error = EINVAL;
1864		goto done1;
1865	}
1866
1867	/* Make sure it is a TTY. */
1868	cdp = devvn_refthread(fp->f_vnode, &dev, &ref);
1869	if (cdp == NULL) {
1870		error = ENXIO;
1871		goto done1;
1872	}
1873	if (dev != fp->f_data) {
1874		error = ENXIO;
1875		goto done2;
1876	}
1877	if (cdp != &ttydev_cdevsw) {
1878		error = ENOTTY;
1879		goto done2;
1880	}
1881	tp = dev->si_drv1;
1882
1883	/* Try to attach the hook to the TTY. */
1884	error = EBUSY;
1885	tty_lock(tp);
1886	MPASS((tp->t_hook == NULL) == ((tp->t_flags & TF_HOOK) == 0));
1887	if (tp->t_flags & TF_HOOK)
1888		goto done3;
1889
1890	tp->t_flags |= TF_HOOK;
1891	tp->t_hook = th;
1892	tp->t_hooksoftc = softc;
1893	*rtp = tp;
1894	error = 0;
1895
1896	/* Maybe we can switch into bypass mode now. */
1897	ttydisc_optimize(tp);
1898
1899	/* Silently convert rint() calls to rint_bypass() when possible. */
1900	if (!ttyhook_hashook(tp, rint) && ttyhook_hashook(tp, rint_bypass))
1901		th->th_rint = ttyhook_defrint;
1902
1903done3:	tty_unlock(tp);
1904done2:	dev_relthread(dev, ref);
1905done1:	fdrop(fp, curthread);
1906	return (error);
1907}
1908
1909void
1910ttyhook_unregister(struct tty *tp)
1911{
1912
1913	tty_lock_assert(tp, MA_OWNED);
1914	MPASS(tp->t_flags & TF_HOOK);
1915
1916	/* Disconnect the hook. */
1917	tp->t_flags &= ~TF_HOOK;
1918	tp->t_hook = NULL;
1919
1920	/* Maybe we need to leave bypass mode. */
1921	ttydisc_optimize(tp);
1922
1923	/* Maybe deallocate the TTY as well. */
1924	tty_rel_free(tp);
1925}
1926
1927/*
1928 * /dev/console handling.
1929 */
1930
1931static int
1932ttyconsdev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
1933{
1934	struct tty *tp;
1935
1936	/* System has no console device. */
1937	if (dev_console_filename == NULL)
1938		return (ENXIO);
1939
1940	/* Look up corresponding TTY by device name. */
1941	sx_slock(&tty_list_sx);
1942	TAILQ_FOREACH(tp, &tty_list, t_list) {
1943		if (strcmp(dev_console_filename, tty_devname(tp)) == 0) {
1944			dev_console->si_drv1 = tp;
1945			break;
1946		}
1947	}
1948	sx_sunlock(&tty_list_sx);
1949
1950	/* System console has no TTY associated. */
1951	if (dev_console->si_drv1 == NULL)
1952		return (ENXIO);
1953
1954	return (ttydev_open(dev, oflags, devtype, td));
1955}
1956
1957static int
1958ttyconsdev_write(struct cdev *dev, struct uio *uio, int ioflag)
1959{
1960
1961	log_console(uio);
1962
1963	return (ttydev_write(dev, uio, ioflag));
1964}
1965
1966/*
1967 * /dev/console is a little different than normal TTY's.  When opened,
1968 * it determines which TTY to use.  When data gets written to it, it
1969 * will be logged in the kernel message buffer.
1970 */
1971static struct cdevsw ttyconsdev_cdevsw = {
1972	.d_version	= D_VERSION,
1973	.d_open		= ttyconsdev_open,
1974	.d_close	= ttydev_close,
1975	.d_read		= ttydev_read,
1976	.d_write	= ttyconsdev_write,
1977	.d_ioctl	= ttydev_ioctl,
1978	.d_kqfilter	= ttydev_kqfilter,
1979	.d_poll		= ttydev_poll,
1980	.d_mmap		= ttydev_mmap,
1981	.d_name		= "ttyconsdev",
1982	.d_flags	= D_TTY,
1983};
1984
1985static void
1986ttyconsdev_init(void *unused)
1987{
1988
1989	dev_console = make_dev_credf(MAKEDEV_ETERNAL, &ttyconsdev_cdevsw, 0,
1990	    NULL, UID_ROOT, GID_WHEEL, 0600, "console");
1991}
1992
1993SYSINIT(tty, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyconsdev_init, NULL);
1994
1995void
1996ttyconsdev_select(const char *name)
1997{
1998
1999	dev_console_filename = name;
2000}
2001
2002/*
2003 * Debugging routines.
2004 */
2005
2006#include "opt_ddb.h"
2007#ifdef DDB
2008#include <ddb/ddb.h>
2009#include <ddb/db_sym.h>
2010
2011static struct {
2012	int flag;
2013	char val;
2014} ttystates[] = {
2015#if 0
2016	{ TF_NOPREFIX,		'N' },
2017#endif
2018	{ TF_INITLOCK,		'I' },
2019	{ TF_CALLOUT,		'C' },
2020
2021	/* Keep these together -> 'Oi' and 'Oo'. */
2022	{ TF_OPENED,		'O' },
2023	{ TF_OPENED_IN,		'i' },
2024	{ TF_OPENED_OUT,	'o' },
2025	{ TF_OPENED_CONS,	'c' },
2026
2027	{ TF_GONE,		'G' },
2028	{ TF_OPENCLOSE,		'B' },
2029	{ TF_ASYNC,		'Y' },
2030	{ TF_LITERAL,		'L' },
2031
2032	/* Keep these together -> 'Hi' and 'Ho'. */
2033	{ TF_HIWAT,		'H' },
2034	{ TF_HIWAT_IN,		'i' },
2035	{ TF_HIWAT_OUT,		'o' },
2036
2037	{ TF_STOPPED,		'S' },
2038	{ TF_EXCLUDE,		'X' },
2039	{ TF_BYPASS,		'l' },
2040	{ TF_ZOMBIE,		'Z' },
2041	{ TF_HOOK,		's' },
2042
2043	/* Keep these together -> 'bi' and 'bo'. */
2044	{ TF_BUSY,		'b' },
2045	{ TF_BUSY_IN,		'i' },
2046	{ TF_BUSY_OUT,		'o' },
2047
2048	{ 0,			'\0'},
2049};
2050
2051#define	TTY_FLAG_BITS \
2052	"\20\1NOPREFIX\2INITLOCK\3CALLOUT\4OPENED_IN\5OPENED_OUT\6GONE" \
2053	"\7OPENCLOSE\10ASYNC\11LITERAL\12HIWAT_IN\13HIWAT_OUT\14STOPPED" \
2054	"\15EXCLUDE\16BYPASS\17ZOMBIE\20HOOK"
2055
2056#define DB_PRINTSYM(name, addr) \
2057	db_printf("%s  " #name ": ", sep); \
2058	db_printsym((db_addr_t) addr, DB_STGY_ANY); \
2059	db_printf("\n");
2060
2061static void
2062_db_show_devsw(const char *sep, const struct ttydevsw *tsw)
2063{
2064	db_printf("%sdevsw: ", sep);
2065	db_printsym((db_addr_t)tsw, DB_STGY_ANY);
2066	db_printf(" (%p)\n", tsw);
2067	DB_PRINTSYM(open, tsw->tsw_open);
2068	DB_PRINTSYM(close, tsw->tsw_close);
2069	DB_PRINTSYM(outwakeup, tsw->tsw_outwakeup);
2070	DB_PRINTSYM(inwakeup, tsw->tsw_inwakeup);
2071	DB_PRINTSYM(ioctl, tsw->tsw_ioctl);
2072	DB_PRINTSYM(param, tsw->tsw_param);
2073	DB_PRINTSYM(modem, tsw->tsw_modem);
2074	DB_PRINTSYM(mmap, tsw->tsw_mmap);
2075	DB_PRINTSYM(pktnotify, tsw->tsw_pktnotify);
2076	DB_PRINTSYM(free, tsw->tsw_free);
2077}
2078static void
2079_db_show_hooks(const char *sep, const struct ttyhook *th)
2080{
2081	db_printf("%shook: ", sep);
2082	db_printsym((db_addr_t)th, DB_STGY_ANY);
2083	db_printf(" (%p)\n", th);
2084	if (th == NULL)
2085		return;
2086	DB_PRINTSYM(rint, th->th_rint);
2087	DB_PRINTSYM(rint_bypass, th->th_rint_bypass);
2088	DB_PRINTSYM(rint_done, th->th_rint_done);
2089	DB_PRINTSYM(rint_poll, th->th_rint_poll);
2090	DB_PRINTSYM(getc_inject, th->th_getc_inject);
2091	DB_PRINTSYM(getc_capture, th->th_getc_capture);
2092	DB_PRINTSYM(getc_poll, th->th_getc_poll);
2093	DB_PRINTSYM(close, th->th_close);
2094}
2095
2096static void
2097_db_show_termios(const char *name, const struct termios *t)
2098{
2099
2100	db_printf("%s: iflag 0x%x oflag 0x%x cflag 0x%x "
2101	    "lflag 0x%x ispeed %u ospeed %u\n", name,
2102	    t->c_iflag, t->c_oflag, t->c_cflag, t->c_lflag,
2103	    t->c_ispeed, t->c_ospeed);
2104}
2105
2106/* DDB command to show TTY statistics. */
2107DB_SHOW_COMMAND(tty, db_show_tty)
2108{
2109	struct tty *tp;
2110
2111	if (!have_addr) {
2112		db_printf("usage: show tty <addr>\n");
2113		return;
2114	}
2115	tp = (struct tty *)addr;
2116
2117	db_printf("0x%p: %s\n", tp, tty_devname(tp));
2118	db_printf("\tmtx: %p\n", tp->t_mtx);
2119	db_printf("\tflags: %b\n", tp->t_flags, TTY_FLAG_BITS);
2120	db_printf("\trevokecnt: %u\n", tp->t_revokecnt);
2121
2122	/* Buffering mechanisms. */
2123	db_printf("\tinq: %p begin %u linestart %u reprint %u end %u "
2124	    "nblocks %u quota %u\n", &tp->t_inq, tp->t_inq.ti_begin,
2125	    tp->t_inq.ti_linestart, tp->t_inq.ti_reprint, tp->t_inq.ti_end,
2126	    tp->t_inq.ti_nblocks, tp->t_inq.ti_quota);
2127	db_printf("\toutq: %p begin %u end %u nblocks %u quota %u\n",
2128	    &tp->t_outq, tp->t_outq.to_begin, tp->t_outq.to_end,
2129	    tp->t_outq.to_nblocks, tp->t_outq.to_quota);
2130	db_printf("\tinlow: %zu\n", tp->t_inlow);
2131	db_printf("\toutlow: %zu\n", tp->t_outlow);
2132	_db_show_termios("\ttermios", &tp->t_termios);
2133	db_printf("\twinsize: row %u col %u xpixel %u ypixel %u\n",
2134	    tp->t_winsize.ws_row, tp->t_winsize.ws_col,
2135	    tp->t_winsize.ws_xpixel, tp->t_winsize.ws_ypixel);
2136	db_printf("\tcolumn: %u\n", tp->t_column);
2137	db_printf("\twritepos: %u\n", tp->t_writepos);
2138	db_printf("\tcompatflags: 0x%x\n", tp->t_compatflags);
2139
2140	/* Init/lock-state devices. */
2141	_db_show_termios("\ttermios_init_in", &tp->t_termios_init_in);
2142	_db_show_termios("\ttermios_init_out", &tp->t_termios_init_out);
2143	_db_show_termios("\ttermios_lock_in", &tp->t_termios_lock_in);
2144	_db_show_termios("\ttermios_lock_out", &tp->t_termios_lock_out);
2145
2146	/* Hooks */
2147	_db_show_devsw("\t", tp->t_devsw);
2148	_db_show_hooks("\t", tp->t_hook);
2149
2150	/* Process info. */
2151	db_printf("\tpgrp: %p gid %d jobc %d\n", tp->t_pgrp,
2152	    tp->t_pgrp ? tp->t_pgrp->pg_id : 0,
2153	    tp->t_pgrp ? tp->t_pgrp->pg_jobc : 0);
2154	db_printf("\tsession: %p", tp->t_session);
2155	if (tp->t_session != NULL)
2156	    db_printf(" count %u leader %p tty %p sid %d login %s",
2157		tp->t_session->s_count, tp->t_session->s_leader,
2158		tp->t_session->s_ttyp, tp->t_session->s_sid,
2159		tp->t_session->s_login);
2160	db_printf("\n");
2161	db_printf("\tsessioncnt: %u\n", tp->t_sessioncnt);
2162	db_printf("\tdevswsoftc: %p\n", tp->t_devswsoftc);
2163	db_printf("\thooksoftc: %p\n", tp->t_hooksoftc);
2164	db_printf("\tdev: %p\n", tp->t_dev);
2165}
2166
2167/* DDB command to list TTYs. */
2168DB_SHOW_ALL_COMMAND(ttys, db_show_all_ttys)
2169{
2170	struct tty *tp;
2171	size_t isiz, osiz;
2172	int i, j;
2173
2174	/* Make the output look like `pstat -t'. */
2175	db_printf("PTR        ");
2176#if defined(__LP64__)
2177	db_printf("        ");
2178#endif
2179	db_printf("      LINE   INQ  CAN  LIN  LOW  OUTQ  USE  LOW   "
2180	    "COL  SESS  PGID STATE\n");
2181
2182	TAILQ_FOREACH(tp, &tty_list, t_list) {
2183		isiz = tp->t_inq.ti_nblocks * TTYINQ_DATASIZE;
2184		osiz = tp->t_outq.to_nblocks * TTYOUTQ_DATASIZE;
2185
2186		db_printf("%p %10s %5zu %4u %4u %4zu %5zu %4u %4zu %5u %5d %5d ",
2187		    tp,
2188		    tty_devname(tp),
2189		    isiz,
2190		    tp->t_inq.ti_linestart - tp->t_inq.ti_begin,
2191		    tp->t_inq.ti_end - tp->t_inq.ti_linestart,
2192		    isiz - tp->t_inlow,
2193		    osiz,
2194		    tp->t_outq.to_end - tp->t_outq.to_begin,
2195		    osiz - tp->t_outlow,
2196		    MIN(tp->t_column, 99999),
2197		    tp->t_session ? tp->t_session->s_sid : 0,
2198		    tp->t_pgrp ? tp->t_pgrp->pg_id : 0);
2199
2200		/* Flag bits. */
2201		for (i = j = 0; ttystates[i].flag; i++)
2202			if (tp->t_flags & ttystates[i].flag) {
2203				db_printf("%c", ttystates[i].val);
2204				j++;
2205			}
2206		if (j == 0)
2207			db_printf("-");
2208		db_printf("\n");
2209	}
2210}
2211#endif /* DDB */
2212