2 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
5 * Portions of this software were developed under sponsorship from Snow
6 * B.V., the Netherlands.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include "opt_capsicum.h"
34 #include "opt_compat.h"
36 #include <sys/param.h>
37 #include <sys/capsicum.h>
40 #include <sys/fcntl.h>
42 #include <sys/filedesc.h>
43 #include <sys/filio.h>
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>
54 #include <sys/serial.h>
55 #include <sys/signal.h>
58 #include <sys/sysctl.h>
59 #include <sys/systm.h>
61 #include <sys/ttycom.h>
63 #include <sys/ttydefaults.h>
65 #include <sys/ucred.h>
66 #include <sys/vnode.h>
68 #include <machine/stdarg.h>
70 static MALLOC_DEFINE(M_TTY, "tty", "tty device");
72 static void tty_rel_free(struct tty *tp);
74 static TAILQ_HEAD(, tty) tty_list = TAILQ_HEAD_INITIALIZER(tty_list);
75 static struct sx tty_list_sx;
76 SX_SYSINIT(tty_list, &tty_list_sx, "tty list");
77 static unsigned int tty_list_count = 0;
79 /* Character device of /dev/console. */
80 static struct cdev *dev_console;
81 static const char *dev_console_filename;
84 * Flags that are supported and stored by this implementation.
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)
96 #define TTY_CALLOUT(tp,d) (dev2unit(d) & TTYUNIT_CALLOUT)
99 * Set TTY buffer sizes.
102 #define TTYBUF_MAX 65536
105 tty_watermarks(struct tty *tp)
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);
114 /* Set low watermark at 10% (when 90% is available). */
115 tp->t_inlow = (ttyinq_getallocatedsize(&tp->t_inq) * 9) / 10;
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);
121 /* Set low watermark at 10% (when 90% is available). */
122 tp->t_outlow = (ttyoutq_getallocatedsize(&tp->t_outq) * 9) / 10;
126 tty_drain(struct tty *tp, int leaving)
129 int error, revokecnt;
131 if (ttyhook_hashook(tp, getc_inject))
132 /* buffer is inaccessible */
135 while (ttyoutq_bytesused(&tp->t_outq) > 0) {
136 ttydevsw_outwakeup(tp);
137 /* Could be handled synchronously. */
138 bytesused = ttyoutq_bytesused(&tp->t_outq);
142 /* Wait for data to be drained. */
144 revokecnt = tp->t_revokecnt;
145 error = tty_timedwait(tp, &tp->t_outwait, hz);
148 if (revokecnt != tp->t_revokecnt)
152 if (ttyoutq_bytesused(&tp->t_outq) < bytesused)
157 error = tty_wait(tp, &tp->t_outwait);
167 * Though ttydev_enter() and ttydev_leave() seem to be related, they
168 * don't have to be used together. ttydev_enter() is used by the cdev
169 * operations to prevent an actual operation from being processed when
170 * the TTY has been abandoned. ttydev_leave() is used by ttydev_open()
171 * and ttydev_close() to determine whether per-TTY data should be
176 ttydev_enter(struct tty *tp)
180 if (tty_gone(tp) || !tty_opened(tp)) {
181 /* Device is already gone. */
190 ttydev_leave(struct tty *tp)
192 tty_lock_assert(tp, MA_OWNED);
194 if (tty_opened(tp) || tp->t_flags & TF_OPENCLOSE) {
195 /* Device is still opened somewhere. */
200 tp->t_flags |= TF_OPENCLOSE;
202 /* Stop asynchronous I/O. */
203 funsetown(&tp->t_sigio);
205 /* Remove console TTY. */
209 /* Drain any output. */
210 MPASS((tp->t_flags & TF_STOPPED) == 0);
216 /* Destroy associated buffers already. */
217 ttyinq_free(&tp->t_inq);
219 ttyoutq_free(&tp->t_outq);
222 knlist_clear(&tp->t_inpoll.si_note, 1);
223 knlist_clear(&tp->t_outpoll.si_note, 1);
228 tp->t_flags &= ~TF_OPENCLOSE;
229 cv_broadcast(&tp->t_dcdwait);
234 * Operations that are exposed through the character device in /dev.
237 ttydev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
246 /* Device is already gone. */
252 * Block when other processes are currently opening or closing
255 while (tp->t_flags & TF_OPENCLOSE) {
256 error = tty_wait(tp, &tp->t_dcdwait);
262 tp->t_flags |= TF_OPENCLOSE;
265 * Make sure the "tty" and "cua" device cannot be opened at the
268 if (TTY_CALLOUT(tp, dev)) {
269 if (tp->t_flags & TF_OPENED_IN) {
274 if (tp->t_flags & TF_OPENED_OUT) {
280 if (tp->t_flags & TF_EXCLUDE && priv_check(td, PRIV_TTY_EXCLUSIVE)) {
285 if (!tty_opened(tp)) {
286 /* Set proper termios flags. */
287 if (TTY_CALLOUT(tp, dev))
288 tp->t_termios = tp->t_termios_init_out;
290 tp->t_termios = tp->t_termios_init_in;
291 ttydevsw_param(tp, &tp->t_termios);
292 /* Prevent modem control on callout devices and /dev/console. */
293 if (TTY_CALLOUT(tp, dev) || dev == dev_console)
294 tp->t_termios.c_cflag |= CLOCAL;
296 ttydevsw_modem(tp, SER_DTR|SER_RTS, 0);
298 error = ttydevsw_open(tp);
303 tty_watermarks(tp); /* XXXGL: drops lock */
306 /* Wait for Carrier Detect. */
307 if ((oflags & O_NONBLOCK) == 0 &&
308 (tp->t_termios.c_cflag & CLOCAL) == 0) {
309 while ((ttydevsw_modem(tp, 0, 0) & SER_DCD) == 0) {
310 error = tty_wait(tp, &tp->t_dcdwait);
316 if (dev == dev_console)
317 tp->t_flags |= TF_OPENED_CONS;
318 else if (TTY_CALLOUT(tp, dev))
319 tp->t_flags |= TF_OPENED_OUT;
321 tp->t_flags |= TF_OPENED_IN;
323 done: tp->t_flags &= ~TF_OPENCLOSE;
324 cv_broadcast(&tp->t_dcdwait);
331 ttydev_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
333 struct tty *tp = dev->si_drv1;
338 * Don't actually close the device if it is being used as the
341 MPASS((tp->t_flags & TF_OPENED) != TF_OPENED);
342 if (dev == dev_console)
343 tp->t_flags &= ~TF_OPENED_CONS;
345 tp->t_flags &= ~(TF_OPENED_IN|TF_OPENED_OUT);
347 if (tp->t_flags & TF_OPENED) {
353 * This can only be called once. The callin and the callout
354 * devices cannot be opened at the same time.
356 tp->t_flags &= ~(TF_EXCLUDE|TF_STOPPED);
358 /* Properly wake up threads that are stuck - revoke(). */
360 tty_wakeup(tp, FREAD|FWRITE);
361 cv_broadcast(&tp->t_bgwait);
362 cv_broadcast(&tp->t_dcdwait);
370 tty_is_ctty(struct tty *tp, struct proc *p)
372 tty_lock_assert(tp, MA_OWNED);
374 return (p->p_session == tp->t_session && p->p_flag & P_CONTROLT);
378 tty_wait_background(struct tty *tp, struct thread *td, int sig)
380 struct proc *p = td->td_proc;
385 MPASS(sig == SIGTTIN || sig == SIGTTOU);
386 tty_lock_assert(tp, MA_OWNED);
391 * The process should only sleep, when:
392 * - This terminal is the controling terminal
393 * - Its process group is not the foreground process
395 * - The parent process isn't waiting for the child to
397 * - the signal to send to the process isn't masked
399 if (!tty_is_ctty(tp, p) || p->p_pgrp == tp->t_pgrp) {
400 /* Allow the action to happen. */
405 if (SIGISMEMBER(p->p_sigacts->ps_sigignore, sig) ||
406 SIGISMEMBER(td->td_sigmask, sig)) {
407 /* Only allow them in write()/ioctl(). */
409 return (sig == SIGTTOU ? 0 : EIO);
413 if (p->p_flag & P_PPWAIT || pg->pg_jobc == 0) {
414 /* Don't allow the action to happen. */
421 * Send the signal and sleep until we're the new
422 * foreground process group.
426 ksi.ksi_code = SI_KERNEL;
431 pgsignal(pg, ksi.ksi_signo, 1, &ksi);
434 error = tty_wait(tp, &tp->t_bgwait);
441 ttydev_read(struct cdev *dev, struct uio *uio, int ioflag)
443 struct tty *tp = dev->si_drv1;
446 error = ttydev_enter(tp);
449 error = ttydisc_read(tp, uio, ioflag);
453 * The read() call should not throw an error when the device is
454 * being destroyed. Silently convert it to an EOF.
456 done: if (error == ENXIO)
462 ttydev_write(struct cdev *dev, struct uio *uio, int ioflag)
464 struct tty *tp = dev->si_drv1;
467 error = ttydev_enter(tp);
471 if (tp->t_termios.c_lflag & TOSTOP) {
472 error = tty_wait_background(tp, curthread, SIGTTOU);
477 if (ioflag & IO_NDELAY && tp->t_flags & TF_BUSY_OUT) {
478 /* Allow non-blocking writes to bypass serialization. */
479 error = ttydisc_write(tp, uio, ioflag);
481 /* Serialize write() calls. */
482 while (tp->t_flags & TF_BUSY_OUT) {
483 error = tty_wait(tp, &tp->t_outserwait);
488 tp->t_flags |= TF_BUSY_OUT;
489 error = ttydisc_write(tp, uio, ioflag);
490 tp->t_flags &= ~TF_BUSY_OUT;
491 cv_signal(&tp->t_outserwait);
494 done: tty_unlock(tp);
499 ttydev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
502 struct tty *tp = dev->si_drv1;
505 error = ttydev_enter(tp);
540 #endif /* COMPAT_43TTY */
542 * If the ioctl() causes the TTY to be modified, let it
543 * wait in the background.
545 error = tty_wait_background(tp, curthread, SIGTTOU);
550 if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
551 struct termios *old = &tp->t_termios;
552 struct termios *new = (struct termios *)data;
553 struct termios *lock = TTY_CALLOUT(tp, dev) ?
554 &tp->t_termios_lock_out : &tp->t_termios_lock_in;
558 * Lock state devices. Just overwrite the values of the
559 * commands that are currently in use.
561 new->c_iflag = (old->c_iflag & lock->c_iflag) |
562 (new->c_iflag & ~lock->c_iflag);
563 new->c_oflag = (old->c_oflag & lock->c_oflag) |
564 (new->c_oflag & ~lock->c_oflag);
565 new->c_cflag = (old->c_cflag & lock->c_cflag) |
566 (new->c_cflag & ~lock->c_cflag);
567 new->c_lflag = (old->c_lflag & lock->c_lflag) |
568 (new->c_lflag & ~lock->c_lflag);
569 for (cc = 0; cc < NCCS; ++cc)
571 new->c_cc[cc] = old->c_cc[cc];
573 new->c_ispeed = old->c_ispeed;
575 new->c_ospeed = old->c_ospeed;
578 error = tty_ioctl(tp, cmd, data, fflag, td);
579 done: tty_unlock(tp);
585 ttydev_poll(struct cdev *dev, int events, struct thread *td)
587 struct tty *tp = dev->si_drv1;
588 int error, revents = 0;
590 error = ttydev_enter(tp);
592 return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
594 if (events & (POLLIN|POLLRDNORM)) {
595 /* See if we can read something. */
596 if (ttydisc_read_poll(tp) > 0)
597 revents |= events & (POLLIN|POLLRDNORM);
600 if (tp->t_flags & TF_ZOMBIE) {
601 /* Hangup flag on zombie state. */
603 } else if (events & (POLLOUT|POLLWRNORM)) {
604 /* See if we can write something. */
605 if (ttydisc_write_poll(tp) > 0)
606 revents |= events & (POLLOUT|POLLWRNORM);
610 if (events & (POLLIN|POLLRDNORM))
611 selrecord(td, &tp->t_inpoll);
612 if (events & (POLLOUT|POLLWRNORM))
613 selrecord(td, &tp->t_outpoll);
622 ttydev_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
623 int nprot, vm_memattr_t *memattr)
625 struct tty *tp = dev->si_drv1;
628 /* Handle mmap() through the driver. */
630 error = ttydev_enter(tp);
633 error = ttydevsw_mmap(tp, offset, paddr, nprot, memattr);
644 tty_kqops_read_detach(struct knote *kn)
646 struct tty *tp = kn->kn_hook;
648 knlist_remove(&tp->t_inpoll.si_note, kn, 0);
652 tty_kqops_read_event(struct knote *kn, long hint)
654 struct tty *tp = kn->kn_hook;
656 tty_lock_assert(tp, MA_OWNED);
658 if (tty_gone(tp) || tp->t_flags & TF_ZOMBIE) {
659 kn->kn_flags |= EV_EOF;
662 kn->kn_data = ttydisc_read_poll(tp);
663 return (kn->kn_data > 0);
668 tty_kqops_write_detach(struct knote *kn)
670 struct tty *tp = kn->kn_hook;
672 knlist_remove(&tp->t_outpoll.si_note, kn, 0);
676 tty_kqops_write_event(struct knote *kn, long hint)
678 struct tty *tp = kn->kn_hook;
680 tty_lock_assert(tp, MA_OWNED);
683 kn->kn_flags |= EV_EOF;
686 kn->kn_data = ttydisc_write_poll(tp);
687 return (kn->kn_data > 0);
691 static struct filterops tty_kqops_read = {
693 .f_detach = tty_kqops_read_detach,
694 .f_event = tty_kqops_read_event,
696 static struct filterops tty_kqops_write = {
698 .f_detach = tty_kqops_write_detach,
699 .f_event = tty_kqops_write_event,
703 ttydev_kqfilter(struct cdev *dev, struct knote *kn)
705 struct tty *tp = dev->si_drv1;
708 error = ttydev_enter(tp);
712 switch (kn->kn_filter) {
715 kn->kn_fop = &tty_kqops_read;
716 knlist_add(&tp->t_inpoll.si_note, kn, 1);
720 kn->kn_fop = &tty_kqops_write;
721 knlist_add(&tp->t_outpoll.si_note, kn, 1);
732 static struct cdevsw ttydev_cdevsw = {
733 .d_version = D_VERSION,
734 .d_open = ttydev_open,
735 .d_close = ttydev_close,
736 .d_read = ttydev_read,
737 .d_write = ttydev_write,
738 .d_ioctl = ttydev_ioctl,
739 .d_kqfilter = ttydev_kqfilter,
740 .d_poll = ttydev_poll,
741 .d_mmap = ttydev_mmap,
747 * Init/lock-state devices
751 ttyil_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
767 ttyil_close(struct cdev *dev, int flag, int mode, struct thread *td)
773 ttyil_rdwr(struct cdev *dev, struct uio *uio, int ioflag)
779 ttyil_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
782 struct tty *tp = dev->si_drv1;
791 error = ttydevsw_cioctl(tp, dev2unit(dev), cmd, data, td);
792 if (error != ENOIOCTL)
798 /* Obtain terminal flags through tcgetattr(). */
799 *(struct termios*)data = *(struct termios*)dev->si_drv2;
802 /* Set terminal flags through tcsetattr(). */
803 error = priv_check(td, PRIV_TTY_SETA);
806 *(struct termios*)dev->si_drv2 = *(struct termios*)data;
809 *(int *)data = TTYDISC;
812 bzero(data, sizeof(struct winsize));
818 done: tty_unlock(tp);
822 static struct cdevsw ttyil_cdevsw = {
823 .d_version = D_VERSION,
824 .d_open = ttyil_open,
825 .d_close = ttyil_close,
826 .d_read = ttyil_rdwr,
827 .d_write = ttyil_rdwr,
828 .d_ioctl = ttyil_ioctl,
834 tty_init_termios(struct tty *tp)
836 struct termios *t = &tp->t_termios_init_in;
838 t->c_cflag = TTYDEF_CFLAG;
839 t->c_iflag = TTYDEF_IFLAG;
840 t->c_lflag = TTYDEF_LFLAG;
841 t->c_oflag = TTYDEF_OFLAG;
842 t->c_ispeed = TTYDEF_SPEED;
843 t->c_ospeed = TTYDEF_SPEED;
844 memcpy(&t->c_cc, ttydefchars, sizeof ttydefchars);
846 tp->t_termios_init_out = *t;
850 tty_init_console(struct tty *tp, speed_t s)
852 struct termios *ti = &tp->t_termios_init_in;
853 struct termios *to = &tp->t_termios_init_out;
856 ti->c_ispeed = ti->c_ospeed = s;
857 to->c_ispeed = to->c_ospeed = s;
860 ti->c_cflag |= CLOCAL;
861 to->c_cflag |= CLOCAL;
865 * Standard device routine implementations, mostly meant for
866 * pseudo-terminal device drivers. When a driver creates a new terminal
867 * device class, missing routines are patched.
871 ttydevsw_defopen(struct tty *tp)
878 ttydevsw_defclose(struct tty *tp)
883 ttydevsw_defoutwakeup(struct tty *tp)
886 panic("Terminal device has output, while not implemented");
890 ttydevsw_definwakeup(struct tty *tp)
895 ttydevsw_defioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
902 ttydevsw_defcioctl(struct tty *tp, int unit, u_long cmd, caddr_t data, struct thread *td)
909 ttydevsw_defparam(struct tty *tp, struct termios *t)
913 * Allow the baud rate to be adjusted for pseudo-devices, but at
914 * least restrict it to 115200 to prevent excessive buffer
915 * usage. Also disallow 0, to prevent foot shooting.
917 if (t->c_ispeed < B50)
919 else if (t->c_ispeed > B115200)
920 t->c_ispeed = B115200;
921 if (t->c_ospeed < B50)
923 else if (t->c_ospeed > B115200)
924 t->c_ospeed = B115200;
931 ttydevsw_defmodem(struct tty *tp, int sigon, int sigoff)
934 /* Simulate a carrier to make the TTY layer happy. */
939 ttydevsw_defmmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t *paddr,
940 int nprot, vm_memattr_t *memattr)
947 ttydevsw_defpktnotify(struct tty *tp, char event)
952 ttydevsw_deffree(void *softc)
955 panic("Terminal device freed without a free-handler");
959 * TTY allocation and deallocation. TTY devices can be deallocated when
960 * the driver doesn't use it anymore, when the TTY isn't a session's
961 * controlling TTY and when the device node isn't opened through devfs.
965 tty_alloc(struct ttydevsw *tsw, void *sc)
968 return (tty_alloc_mutex(tsw, sc, NULL));
972 tty_alloc_mutex(struct ttydevsw *tsw, void *sc, struct mtx *mutex)
976 /* Make sure the driver defines all routines. */
977 #define PATCH_FUNC(x) do { \
978 if (tsw->tsw_ ## x == NULL) \
979 tsw->tsw_ ## x = ttydevsw_def ## x; \
983 PATCH_FUNC(outwakeup);
984 PATCH_FUNC(inwakeup);
990 PATCH_FUNC(pktnotify);
994 tp = malloc(sizeof(struct tty), M_TTY, M_WAITOK|M_ZERO);
996 tp->t_devswsoftc = sc;
997 tp->t_flags = tsw->tsw_flags;
999 tty_init_termios(tp);
1001 cv_init(&tp->t_inwait, "ttyin");
1002 cv_init(&tp->t_outwait, "ttyout");
1003 cv_init(&tp->t_outserwait, "ttyosr");
1004 cv_init(&tp->t_bgwait, "ttybg");
1005 cv_init(&tp->t_dcdwait, "ttydcd");
1007 /* Allow drivers to use a custom mutex to lock the TTY. */
1008 if (mutex != NULL) {
1011 tp->t_mtx = &tp->t_mtxobj;
1012 mtx_init(&tp->t_mtxobj, "ttymtx", NULL, MTX_DEF);
1015 knlist_init_mtx(&tp->t_inpoll.si_note, tp->t_mtx);
1016 knlist_init_mtx(&tp->t_outpoll.si_note, tp->t_mtx);
1022 tty_dealloc(void *arg)
1024 struct tty *tp = arg;
1026 /* Make sure we haven't leaked buffers. */
1027 MPASS(ttyinq_getsize(&tp->t_inq) == 0);
1028 MPASS(ttyoutq_getsize(&tp->t_outq) == 0);
1030 seldrain(&tp->t_inpoll);
1031 seldrain(&tp->t_outpoll);
1032 knlist_destroy(&tp->t_inpoll.si_note);
1033 knlist_destroy(&tp->t_outpoll.si_note);
1035 cv_destroy(&tp->t_inwait);
1036 cv_destroy(&tp->t_outwait);
1037 cv_destroy(&tp->t_bgwait);
1038 cv_destroy(&tp->t_dcdwait);
1039 cv_destroy(&tp->t_outserwait);
1041 if (tp->t_mtx == &tp->t_mtxobj)
1042 mtx_destroy(&tp->t_mtxobj);
1048 tty_rel_free(struct tty *tp)
1052 tty_lock_assert(tp, MA_OWNED);
1054 #define TF_ACTIVITY (TF_GONE|TF_OPENED|TF_HOOK|TF_OPENCLOSE)
1055 if (tp->t_sessioncnt != 0 || (tp->t_flags & TF_ACTIVITY) != TF_GONE) {
1056 /* TTY is still in use. */
1061 /* TTY can be deallocated. */
1067 sx_xlock(&tty_list_sx);
1068 TAILQ_REMOVE(&tty_list, tp, t_list);
1070 sx_xunlock(&tty_list_sx);
1071 destroy_dev_sched_cb(dev, tty_dealloc, tp);
1076 tty_rel_pgrp(struct tty *tp, struct pgrp *pg)
1078 MPASS(tp->t_sessioncnt > 0);
1079 tty_lock_assert(tp, MA_OWNED);
1081 if (tp->t_pgrp == pg)
1088 tty_rel_sess(struct tty *tp, struct session *sess)
1090 MPASS(tp->t_sessioncnt > 0);
1092 /* Current session has left. */
1093 if (tp->t_session == sess) {
1094 tp->t_session = NULL;
1095 MPASS(tp->t_pgrp == NULL);
1102 tty_rel_gone(struct tty *tp)
1104 MPASS(!tty_gone(tp));
1106 /* Simulate carrier removal. */
1107 ttydisc_modem(tp, 0);
1109 /* Wake up all blocked threads. */
1110 tty_wakeup(tp, FREAD|FWRITE);
1111 cv_broadcast(&tp->t_bgwait);
1112 cv_broadcast(&tp->t_dcdwait);
1114 tp->t_flags |= TF_GONE;
1119 * Exposing information about current TTY's through sysctl
1123 tty_to_xtty(struct tty *tp, struct xtty *xt)
1125 tty_lock_assert(tp, MA_OWNED);
1127 xt->xt_size = sizeof(struct xtty);
1128 xt->xt_insize = ttyinq_getsize(&tp->t_inq);
1129 xt->xt_incc = ttyinq_bytescanonicalized(&tp->t_inq);
1130 xt->xt_inlc = ttyinq_bytesline(&tp->t_inq);
1131 xt->xt_inlow = tp->t_inlow;
1132 xt->xt_outsize = ttyoutq_getsize(&tp->t_outq);
1133 xt->xt_outcc = ttyoutq_bytesused(&tp->t_outq);
1134 xt->xt_outlow = tp->t_outlow;
1135 xt->xt_column = tp->t_column;
1136 xt->xt_pgid = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1137 xt->xt_sid = tp->t_session ? tp->t_session->s_sid : 0;
1138 xt->xt_flags = tp->t_flags;
1139 xt->xt_dev = tp->t_dev ? dev2udev(tp->t_dev) : NODEV;
1143 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
1145 unsigned long lsize;
1146 struct xtty *xtlist, *xt;
1150 sx_slock(&tty_list_sx);
1151 lsize = tty_list_count * sizeof(struct xtty);
1153 sx_sunlock(&tty_list_sx);
1157 xtlist = xt = malloc(lsize, M_TTY, M_WAITOK);
1159 TAILQ_FOREACH(tp, &tty_list, t_list) {
1161 tty_to_xtty(tp, xt);
1165 sx_sunlock(&tty_list_sx);
1167 error = SYSCTL_OUT(req, xtlist, lsize);
1168 free(xtlist, M_TTY);
1172 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
1173 0, 0, sysctl_kern_ttys, "S,xtty", "List of TTYs");
1176 * Device node creation. Device has been set up, now we can expose it to
1181 tty_makedevf(struct tty *tp, struct ucred *cred, int flags,
1182 const char *fmt, ...)
1185 struct make_dev_args args;
1186 struct cdev *dev, *init, *lock, *cua, *cinit, *clock;
1187 const char *prefix = "tty";
1188 char name[SPECNAMELEN - 3]; /* for "tty" and "cua". */
1194 /* Remove "tty" prefix from devices like PTY's. */
1195 if (tp->t_flags & TF_NOPREFIX)
1199 vsnrprintf(name, sizeof name, 32, fmt, ap);
1203 /* System device. */
1206 mode = S_IRUSR|S_IWUSR;
1209 uid = cred->cr_ruid;
1211 mode = S_IRUSR|S_IWUSR|S_IWGRP;
1214 flags = flags & TTYMK_CLONING ? MAKEDEV_REF : 0;
1215 flags |= MAKEDEV_CHECKNAME;
1217 /* Master call-in device. */
1218 make_dev_args_init(&args);
1219 args.mda_flags = flags;
1220 args.mda_devsw = &ttydev_cdevsw;
1224 args.mda_mode = mode;
1225 args.mda_si_drv1 = tp;
1226 error = make_dev_s(&args, &dev, "%s%s", prefix, name);
1231 init = lock = cua = cinit = clock = NULL;
1233 /* Slave call-in devices. */
1234 if (tp->t_flags & TF_INITLOCK) {
1235 args.mda_devsw = &ttyil_cdevsw;
1236 args.mda_unit = TTYUNIT_INIT;
1237 args.mda_si_drv1 = tp;
1238 args.mda_si_drv2 = &tp->t_termios_init_in;
1239 error = make_dev_s(&args, &init, "%s%s.init", prefix, name);
1242 dev_depends(dev, init);
1244 args.mda_unit = TTYUNIT_LOCK;
1245 args.mda_si_drv2 = &tp->t_termios_lock_in;
1246 error = make_dev_s(&args, &lock, "%s%s.lock", prefix, name);
1249 dev_depends(dev, lock);
1252 /* Call-out devices. */
1253 if (tp->t_flags & TF_CALLOUT) {
1254 make_dev_args_init(&args);
1255 args.mda_flags = flags;
1256 args.mda_devsw = &ttydev_cdevsw;
1258 args.mda_uid = UID_UUCP;
1259 args.mda_gid = GID_DIALER;
1260 args.mda_mode = 0660;
1261 args.mda_unit = TTYUNIT_CALLOUT;
1262 args.mda_si_drv1 = tp;
1263 error = make_dev_s(&args, &cua, "cua%s", name);
1266 dev_depends(dev, cua);
1268 /* Slave call-out devices. */
1269 if (tp->t_flags & TF_INITLOCK) {
1270 args.mda_devsw = &ttyil_cdevsw;
1271 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_INIT;
1272 args.mda_si_drv2 = &tp->t_termios_init_out;
1273 error = make_dev_s(&args, &cinit, "cua%s.init", name);
1276 dev_depends(dev, cinit);
1278 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_LOCK;
1279 args.mda_si_drv2 = &tp->t_termios_lock_out;
1280 error = make_dev_s(&args, &clock, "cua%s.lock", name);
1283 dev_depends(dev, clock);
1287 sx_xlock(&tty_list_sx);
1288 TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
1290 sx_xunlock(&tty_list_sx);
1309 * Signalling processes.
1313 tty_signal_sessleader(struct tty *tp, int sig)
1317 tty_lock_assert(tp, MA_OWNED);
1318 MPASS(sig >= 1 && sig < NSIG);
1320 /* Make signals start output again. */
1321 tp->t_flags &= ~TF_STOPPED;
1323 if (tp->t_session != NULL && tp->t_session->s_leader != NULL) {
1324 p = tp->t_session->s_leader;
1326 kern_psignal(p, sig);
1332 tty_signal_pgrp(struct tty *tp, int sig)
1336 tty_lock_assert(tp, MA_OWNED);
1337 MPASS(sig >= 1 && sig < NSIG);
1339 /* Make signals start output again. */
1340 tp->t_flags &= ~TF_STOPPED;
1342 if (sig == SIGINFO && !(tp->t_termios.c_lflag & NOKERNINFO))
1344 if (tp->t_pgrp != NULL) {
1345 ksiginfo_init(&ksi);
1346 ksi.ksi_signo = sig;
1347 ksi.ksi_code = SI_KERNEL;
1348 PGRP_LOCK(tp->t_pgrp);
1349 pgsignal(tp->t_pgrp, sig, 1, &ksi);
1350 PGRP_UNLOCK(tp->t_pgrp);
1355 tty_wakeup(struct tty *tp, int flags)
1357 if (tp->t_flags & TF_ASYNC && tp->t_sigio != NULL)
1358 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
1360 if (flags & FWRITE) {
1361 cv_broadcast(&tp->t_outwait);
1362 selwakeup(&tp->t_outpoll);
1363 KNOTE_LOCKED(&tp->t_outpoll.si_note, 0);
1365 if (flags & FREAD) {
1366 cv_broadcast(&tp->t_inwait);
1367 selwakeup(&tp->t_inpoll);
1368 KNOTE_LOCKED(&tp->t_inpoll.si_note, 0);
1373 tty_wait(struct tty *tp, struct cv *cv)
1376 int revokecnt = tp->t_revokecnt;
1378 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1379 MPASS(!tty_gone(tp));
1381 error = cv_wait_sig(cv, tp->t_mtx);
1383 /* Bail out when the device slipped away. */
1387 /* Restart the system call when we may have been revoked. */
1388 if (tp->t_revokecnt != revokecnt)
1395 tty_timedwait(struct tty *tp, struct cv *cv, int hz)
1398 int revokecnt = tp->t_revokecnt;
1400 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1401 MPASS(!tty_gone(tp));
1403 error = cv_timedwait_sig(cv, tp->t_mtx, hz);
1405 /* Bail out when the device slipped away. */
1409 /* Restart the system call when we may have been revoked. */
1410 if (tp->t_revokecnt != revokecnt)
1417 tty_flush(struct tty *tp, int flags)
1419 if (flags & FWRITE) {
1420 tp->t_flags &= ~TF_HIWAT_OUT;
1421 ttyoutq_flush(&tp->t_outq);
1422 tty_wakeup(tp, FWRITE);
1423 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHWRITE);
1425 if (flags & FREAD) {
1426 tty_hiwat_in_unblock(tp);
1427 ttyinq_flush(&tp->t_inq);
1428 ttydevsw_inwakeup(tp);
1429 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHREAD);
1434 tty_set_winsize(struct tty *tp, const struct winsize *wsz)
1437 if (memcmp(&tp->t_winsize, wsz, sizeof(*wsz)) == 0)
1439 tp->t_winsize = *wsz;
1440 tty_signal_pgrp(tp, SIGWINCH);
1444 tty_generic_ioctl(struct tty *tp, u_long cmd, void *data, int fflag,
1452 * The SER_* and TIOCM_* flags are the same, but one bit
1453 * shifted. I don't know why.
1456 ttydevsw_modem(tp, SER_DTR, 0);
1459 ttydevsw_modem(tp, 0, SER_DTR);
1462 int bits = *(int *)data;
1464 (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1,
1465 ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1469 int bits = *(int *)data;
1470 ttydevsw_modem(tp, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1, 0);
1474 int bits = *(int *)data;
1475 ttydevsw_modem(tp, 0, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1479 *(int *)data = TIOCM_LE + (ttydevsw_modem(tp, 0, 0) << 1);
1484 tp->t_flags |= TF_ASYNC;
1486 tp->t_flags &= ~TF_ASYNC;
1489 /* This device supports non-blocking operation. */
1492 *(int *)data = ttyinq_bytescanonicalized(&tp->t_inq);
1496 *(int *)data = ttyoutq_bytesused(&tp->t_outq);
1499 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1500 /* Not allowed to set ownership. */
1503 /* Temporarily unlock the TTY to set ownership. */
1505 error = fsetown(*(int *)data, &tp->t_sigio);
1509 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1510 /* Not allowed to set ownership. */
1513 /* Get ownership. */
1514 *(int *)data = fgetown(&tp->t_sigio);
1517 /* Obtain terminal flags through tcgetattr(). */
1518 *(struct termios*)data = tp->t_termios;
1523 struct termios *t = data;
1526 * Who makes up these funny rules? According to POSIX,
1527 * input baud rate is set equal to the output baud rate
1530 if (t->c_ispeed == 0)
1531 t->c_ispeed = t->c_ospeed;
1533 /* Discard any unsupported bits. */
1534 t->c_iflag &= TTYSUP_IFLAG;
1535 t->c_oflag &= TTYSUP_OFLAG;
1536 t->c_lflag &= TTYSUP_LFLAG;
1537 t->c_cflag &= TTYSUP_CFLAG;
1539 /* Set terminal flags through tcsetattr(). */
1540 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1541 error = tty_drain(tp, 0);
1544 if (cmd == TIOCSETAF)
1545 tty_flush(tp, FREAD);
1549 * Only call param() when the flags really change.
1551 if ((t->c_cflag & CIGNORE) == 0 &&
1552 (tp->t_termios.c_cflag != t->c_cflag ||
1553 ((tp->t_termios.c_iflag ^ t->c_iflag) &
1554 (IXON|IXOFF|IXANY)) ||
1555 tp->t_termios.c_ispeed != t->c_ispeed ||
1556 tp->t_termios.c_ospeed != t->c_ospeed)) {
1557 error = ttydevsw_param(tp, t);
1563 tp->t_termios.c_cflag = t->c_cflag & ~CIGNORE;
1564 tp->t_termios.c_ispeed = t->c_ispeed;
1565 tp->t_termios.c_ospeed = t->c_ospeed;
1567 /* Baud rate has changed - update watermarks. */
1571 /* Copy new non-device driver parameters. */
1572 tp->t_termios.c_iflag = t->c_iflag;
1573 tp->t_termios.c_oflag = t->c_oflag;
1574 tp->t_termios.c_lflag = t->c_lflag;
1575 memcpy(&tp->t_termios.c_cc, t->c_cc, sizeof t->c_cc);
1577 ttydisc_optimize(tp);
1579 if ((t->c_lflag & ICANON) == 0) {
1581 * When in non-canonical mode, wake up all
1582 * readers. Canonicalize any partial input. VMIN
1583 * and VTIME could also be adjusted.
1585 ttyinq_canonicalize(&tp->t_inq);
1586 tty_wakeup(tp, FREAD);
1590 * For packet mode: notify the PTY consumer that VSTOP
1591 * and VSTART may have been changed.
1593 if (tp->t_termios.c_iflag & IXON &&
1594 tp->t_termios.c_cc[VSTOP] == CTRL('S') &&
1595 tp->t_termios.c_cc[VSTART] == CTRL('Q'))
1596 ttydevsw_pktnotify(tp, TIOCPKT_DOSTOP);
1598 ttydevsw_pktnotify(tp, TIOCPKT_NOSTOP);
1602 /* For compatibility - we only support TTYDISC. */
1603 *(int *)data = TTYDISC;
1606 if (!tty_is_ctty(tp, td->td_proc))
1609 if (tp->t_pgrp != NULL)
1610 *(int *)data = tp->t_pgrp->pg_id;
1612 *(int *)data = NO_PID;
1615 if (!tty_is_ctty(tp, td->td_proc))
1618 MPASS(tp->t_session);
1619 *(int *)data = tp->t_session->s_sid;
1622 struct proc *p = td->td_proc;
1624 /* XXX: This looks awful. */
1626 sx_xlock(&proctree_lock);
1629 if (!SESS_LEADER(p)) {
1630 /* Only the session leader may do this. */
1631 sx_xunlock(&proctree_lock);
1635 if (tp->t_session != NULL && tp->t_session == p->p_session) {
1636 /* This is already our controlling TTY. */
1637 sx_xunlock(&proctree_lock);
1641 if (p->p_session->s_ttyp != NULL ||
1642 (tp->t_session != NULL && tp->t_session->s_ttyvp != NULL &&
1643 tp->t_session->s_ttyvp->v_type != VBAD)) {
1645 * There is already a relation between a TTY and
1646 * a session, or the caller is not the session
1649 * Allow the TTY to be stolen when the vnode is
1650 * invalid, but the reference to the TTY is
1651 * still active. This allows immediate reuse of
1652 * TTYs of which the session leader has been
1653 * killed or the TTY revoked.
1655 sx_xunlock(&proctree_lock);
1659 /* Connect the session to the TTY. */
1660 tp->t_session = p->p_session;
1661 tp->t_session->s_ttyp = tp;
1663 sx_xunlock(&proctree_lock);
1665 /* Assign foreground process group. */
1666 tp->t_pgrp = p->p_pgrp;
1668 p->p_flag |= P_CONTROLT;
1677 * XXX: Temporarily unlock the TTY to locate the process
1678 * group. This code would be lot nicer if we would ever
1679 * decompose proctree_lock.
1682 sx_slock(&proctree_lock);
1683 pg = pgfind(*(int *)data);
1686 if (pg == NULL || pg->pg_session != td->td_proc->p_session) {
1687 sx_sunlock(&proctree_lock);
1694 * Determine if this TTY is the controlling TTY after
1695 * relocking the TTY.
1697 if (!tty_is_ctty(tp, td->td_proc)) {
1698 sx_sunlock(&proctree_lock);
1702 sx_sunlock(&proctree_lock);
1704 /* Wake up the background process groups. */
1705 cv_broadcast(&tp->t_bgwait);
1709 int flags = *(int *)data;
1712 flags = (FREAD|FWRITE);
1714 flags &= (FREAD|FWRITE);
1715 tty_flush(tp, flags);
1719 /* Drain TTY output. */
1720 return tty_drain(tp, 0);
1722 /* Set terminal as console TTY. */
1724 error = priv_check(td, PRIV_TTY_CONSOLE);
1729 * XXX: constty should really need to be locked!
1730 * XXX: allow disconnected constty's to be stolen!
1735 if (constty != NULL)
1741 } else if (constty == tp) {
1746 /* Obtain window size. */
1747 *(struct winsize*)data = tp->t_winsize;
1750 /* Set window size. */
1751 tty_set_winsize(tp, data);
1754 tp->t_flags |= TF_EXCLUDE;
1757 tp->t_flags &= ~TF_EXCLUDE;
1760 tp->t_flags |= TF_STOPPED;
1761 ttydevsw_pktnotify(tp, TIOCPKT_STOP);
1764 tp->t_flags &= ~TF_STOPPED;
1765 ttydevsw_outwakeup(tp);
1766 ttydevsw_pktnotify(tp, TIOCPKT_START);
1772 if ((fflag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1774 if (!tty_is_ctty(tp, td->td_proc) &&
1775 priv_check(td, PRIV_TTY_STI))
1777 ttydisc_rint(tp, *(char *)data, 0);
1778 ttydisc_rint_done(tp);
1783 return tty_ioctl_compat(tp, cmd, data, fflag, td);
1784 #else /* !COMPAT_43TTY */
1786 #endif /* COMPAT_43TTY */
1790 tty_ioctl(struct tty *tp, u_long cmd, void *data, int fflag, struct thread *td)
1794 tty_lock_assert(tp, MA_OWNED);
1799 error = ttydevsw_ioctl(tp, cmd, data, td);
1800 if (error == ENOIOCTL)
1801 error = tty_generic_ioctl(tp, cmd, data, fflag, td);
1807 tty_udev(struct tty *tp)
1810 return dev2udev(tp->t_dev);
1816 tty_checkoutq(struct tty *tp)
1819 /* 256 bytes should be enough to print a log message. */
1820 return (ttyoutq_bytesleft(&tp->t_outq) >= 256);
1824 tty_hiwat_in_block(struct tty *tp)
1827 if ((tp->t_flags & TF_HIWAT_IN) == 0 &&
1828 tp->t_termios.c_iflag & IXOFF &&
1829 tp->t_termios.c_cc[VSTOP] != _POSIX_VDISABLE) {
1831 * Input flow control. Only enter the high watermark when we
1832 * can successfully store the VSTOP character.
1834 if (ttyoutq_write_nofrag(&tp->t_outq,
1835 &tp->t_termios.c_cc[VSTOP], 1) == 0)
1836 tp->t_flags |= TF_HIWAT_IN;
1838 /* No input flow control. */
1839 tp->t_flags |= TF_HIWAT_IN;
1844 tty_hiwat_in_unblock(struct tty *tp)
1847 if (tp->t_flags & TF_HIWAT_IN &&
1848 tp->t_termios.c_iflag & IXOFF &&
1849 tp->t_termios.c_cc[VSTART] != _POSIX_VDISABLE) {
1851 * Input flow control. Only leave the high watermark when we
1852 * can successfully store the VSTART character.
1854 if (ttyoutq_write_nofrag(&tp->t_outq,
1855 &tp->t_termios.c_cc[VSTART], 1) == 0)
1856 tp->t_flags &= ~TF_HIWAT_IN;
1858 /* No input flow control. */
1859 tp->t_flags &= ~TF_HIWAT_IN;
1863 ttydevsw_inwakeup(tp);
1867 * TTY hooks interface.
1871 ttyhook_defrint(struct tty *tp, char c, int flags)
1874 if (ttyhook_rint_bypass(tp, &c, 1) != 1)
1881 ttyhook_register(struct tty **rtp, struct proc *p, int fd,
1882 struct ttyhook *th, void *softc)
1888 struct filedesc *fdp;
1889 cap_rights_t rights;
1892 /* Validate the file descriptor. */
1894 error = fget_unlocked(fdp, fd, cap_rights_init(&rights, CAP_TTYHOOK),
1898 if (fp->f_ops == &badfileops) {
1904 * Make sure the vnode is bound to a character device.
1905 * Unlocked check for the vnode type is ok there, because we
1906 * only shall prevent calling devvn_refthread on the file that
1907 * never has been opened over a character device.
1909 if (fp->f_type != DTYPE_VNODE || fp->f_vnode->v_type != VCHR) {
1914 /* Make sure it is a TTY. */
1915 cdp = devvn_refthread(fp->f_vnode, &dev, &ref);
1920 if (dev != fp->f_data) {
1924 if (cdp != &ttydev_cdevsw) {
1930 /* Try to attach the hook to the TTY. */
1933 MPASS((tp->t_hook == NULL) == ((tp->t_flags & TF_HOOK) == 0));
1934 if (tp->t_flags & TF_HOOK)
1937 tp->t_flags |= TF_HOOK;
1939 tp->t_hooksoftc = softc;
1943 /* Maybe we can switch into bypass mode now. */
1944 ttydisc_optimize(tp);
1946 /* Silently convert rint() calls to rint_bypass() when possible. */
1947 if (!ttyhook_hashook(tp, rint) && ttyhook_hashook(tp, rint_bypass))
1948 th->th_rint = ttyhook_defrint;
1950 done3: tty_unlock(tp);
1951 done2: dev_relthread(dev, ref);
1952 done1: fdrop(fp, curthread);
1957 ttyhook_unregister(struct tty *tp)
1960 tty_lock_assert(tp, MA_OWNED);
1961 MPASS(tp->t_flags & TF_HOOK);
1963 /* Disconnect the hook. */
1964 tp->t_flags &= ~TF_HOOK;
1967 /* Maybe we need to leave bypass mode. */
1968 ttydisc_optimize(tp);
1970 /* Maybe deallocate the TTY as well. */
1975 * /dev/console handling.
1979 ttyconsdev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
1983 /* System has no console device. */
1984 if (dev_console_filename == NULL)
1987 /* Look up corresponding TTY by device name. */
1988 sx_slock(&tty_list_sx);
1989 TAILQ_FOREACH(tp, &tty_list, t_list) {
1990 if (strcmp(dev_console_filename, tty_devname(tp)) == 0) {
1991 dev_console->si_drv1 = tp;
1995 sx_sunlock(&tty_list_sx);
1997 /* System console has no TTY associated. */
1998 if (dev_console->si_drv1 == NULL)
2001 return (ttydev_open(dev, oflags, devtype, td));
2005 ttyconsdev_write(struct cdev *dev, struct uio *uio, int ioflag)
2010 return (ttydev_write(dev, uio, ioflag));
2014 * /dev/console is a little different than normal TTY's. When opened,
2015 * it determines which TTY to use. When data gets written to it, it
2016 * will be logged in the kernel message buffer.
2018 static struct cdevsw ttyconsdev_cdevsw = {
2019 .d_version = D_VERSION,
2020 .d_open = ttyconsdev_open,
2021 .d_close = ttydev_close,
2022 .d_read = ttydev_read,
2023 .d_write = ttyconsdev_write,
2024 .d_ioctl = ttydev_ioctl,
2025 .d_kqfilter = ttydev_kqfilter,
2026 .d_poll = ttydev_poll,
2027 .d_mmap = ttydev_mmap,
2028 .d_name = "ttyconsdev",
2033 ttyconsdev_init(void *unused)
2036 dev_console = make_dev_credf(MAKEDEV_ETERNAL, &ttyconsdev_cdevsw, 0,
2037 NULL, UID_ROOT, GID_WHEEL, 0600, "console");
2040 SYSINIT(tty, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyconsdev_init, NULL);
2043 ttyconsdev_select(const char *name)
2046 dev_console_filename = name;
2050 * Debugging routines.
2053 #include "opt_ddb.h"
2055 #include <ddb/ddb.h>
2056 #include <ddb/db_sym.h>
2063 { TF_NOPREFIX, 'N' },
2065 { TF_INITLOCK, 'I' },
2066 { TF_CALLOUT, 'C' },
2068 /* Keep these together -> 'Oi' and 'Oo'. */
2070 { TF_OPENED_IN, 'i' },
2071 { TF_OPENED_OUT, 'o' },
2072 { TF_OPENED_CONS, 'c' },
2075 { TF_OPENCLOSE, 'B' },
2077 { TF_LITERAL, 'L' },
2079 /* Keep these together -> 'Hi' and 'Ho'. */
2081 { TF_HIWAT_IN, 'i' },
2082 { TF_HIWAT_OUT, 'o' },
2084 { TF_STOPPED, 'S' },
2085 { TF_EXCLUDE, 'X' },
2090 /* Keep these together -> 'bi' and 'bo'. */
2092 { TF_BUSY_IN, 'i' },
2093 { TF_BUSY_OUT, 'o' },
2098 #define TTY_FLAG_BITS \
2099 "\20\1NOPREFIX\2INITLOCK\3CALLOUT\4OPENED_IN\5OPENED_OUT\6GONE" \
2100 "\7OPENCLOSE\10ASYNC\11LITERAL\12HIWAT_IN\13HIWAT_OUT\14STOPPED" \
2101 "\15EXCLUDE\16BYPASS\17ZOMBIE\20HOOK"
2103 #define DB_PRINTSYM(name, addr) \
2104 db_printf("%s " #name ": ", sep); \
2105 db_printsym((db_addr_t) addr, DB_STGY_ANY); \
2109 _db_show_devsw(const char *sep, const struct ttydevsw *tsw)
2111 db_printf("%sdevsw: ", sep);
2112 db_printsym((db_addr_t)tsw, DB_STGY_ANY);
2113 db_printf(" (%p)\n", tsw);
2114 DB_PRINTSYM(open, tsw->tsw_open);
2115 DB_PRINTSYM(close, tsw->tsw_close);
2116 DB_PRINTSYM(outwakeup, tsw->tsw_outwakeup);
2117 DB_PRINTSYM(inwakeup, tsw->tsw_inwakeup);
2118 DB_PRINTSYM(ioctl, tsw->tsw_ioctl);
2119 DB_PRINTSYM(param, tsw->tsw_param);
2120 DB_PRINTSYM(modem, tsw->tsw_modem);
2121 DB_PRINTSYM(mmap, tsw->tsw_mmap);
2122 DB_PRINTSYM(pktnotify, tsw->tsw_pktnotify);
2123 DB_PRINTSYM(free, tsw->tsw_free);
2126 _db_show_hooks(const char *sep, const struct ttyhook *th)
2128 db_printf("%shook: ", sep);
2129 db_printsym((db_addr_t)th, DB_STGY_ANY);
2130 db_printf(" (%p)\n", th);
2133 DB_PRINTSYM(rint, th->th_rint);
2134 DB_PRINTSYM(rint_bypass, th->th_rint_bypass);
2135 DB_PRINTSYM(rint_done, th->th_rint_done);
2136 DB_PRINTSYM(rint_poll, th->th_rint_poll);
2137 DB_PRINTSYM(getc_inject, th->th_getc_inject);
2138 DB_PRINTSYM(getc_capture, th->th_getc_capture);
2139 DB_PRINTSYM(getc_poll, th->th_getc_poll);
2140 DB_PRINTSYM(close, th->th_close);
2144 _db_show_termios(const char *name, const struct termios *t)
2147 db_printf("%s: iflag 0x%x oflag 0x%x cflag 0x%x "
2148 "lflag 0x%x ispeed %u ospeed %u\n", name,
2149 t->c_iflag, t->c_oflag, t->c_cflag, t->c_lflag,
2150 t->c_ispeed, t->c_ospeed);
2153 /* DDB command to show TTY statistics. */
2154 DB_SHOW_COMMAND(tty, db_show_tty)
2159 db_printf("usage: show tty <addr>\n");
2162 tp = (struct tty *)addr;
2164 db_printf("0x%p: %s\n", tp, tty_devname(tp));
2165 db_printf("\tmtx: %p\n", tp->t_mtx);
2166 db_printf("\tflags: %b\n", tp->t_flags, TTY_FLAG_BITS);
2167 db_printf("\trevokecnt: %u\n", tp->t_revokecnt);
2169 /* Buffering mechanisms. */
2170 db_printf("\tinq: %p begin %u linestart %u reprint %u end %u "
2171 "nblocks %u quota %u\n", &tp->t_inq, tp->t_inq.ti_begin,
2172 tp->t_inq.ti_linestart, tp->t_inq.ti_reprint, tp->t_inq.ti_end,
2173 tp->t_inq.ti_nblocks, tp->t_inq.ti_quota);
2174 db_printf("\toutq: %p begin %u end %u nblocks %u quota %u\n",
2175 &tp->t_outq, tp->t_outq.to_begin, tp->t_outq.to_end,
2176 tp->t_outq.to_nblocks, tp->t_outq.to_quota);
2177 db_printf("\tinlow: %zu\n", tp->t_inlow);
2178 db_printf("\toutlow: %zu\n", tp->t_outlow);
2179 _db_show_termios("\ttermios", &tp->t_termios);
2180 db_printf("\twinsize: row %u col %u xpixel %u ypixel %u\n",
2181 tp->t_winsize.ws_row, tp->t_winsize.ws_col,
2182 tp->t_winsize.ws_xpixel, tp->t_winsize.ws_ypixel);
2183 db_printf("\tcolumn: %u\n", tp->t_column);
2184 db_printf("\twritepos: %u\n", tp->t_writepos);
2185 db_printf("\tcompatflags: 0x%x\n", tp->t_compatflags);
2187 /* Init/lock-state devices. */
2188 _db_show_termios("\ttermios_init_in", &tp->t_termios_init_in);
2189 _db_show_termios("\ttermios_init_out", &tp->t_termios_init_out);
2190 _db_show_termios("\ttermios_lock_in", &tp->t_termios_lock_in);
2191 _db_show_termios("\ttermios_lock_out", &tp->t_termios_lock_out);
2194 _db_show_devsw("\t", tp->t_devsw);
2195 _db_show_hooks("\t", tp->t_hook);
2198 db_printf("\tpgrp: %p gid %d jobc %d\n", tp->t_pgrp,
2199 tp->t_pgrp ? tp->t_pgrp->pg_id : 0,
2200 tp->t_pgrp ? tp->t_pgrp->pg_jobc : 0);
2201 db_printf("\tsession: %p", tp->t_session);
2202 if (tp->t_session != NULL)
2203 db_printf(" count %u leader %p tty %p sid %d login %s",
2204 tp->t_session->s_count, tp->t_session->s_leader,
2205 tp->t_session->s_ttyp, tp->t_session->s_sid,
2206 tp->t_session->s_login);
2208 db_printf("\tsessioncnt: %u\n", tp->t_sessioncnt);
2209 db_printf("\tdevswsoftc: %p\n", tp->t_devswsoftc);
2210 db_printf("\thooksoftc: %p\n", tp->t_hooksoftc);
2211 db_printf("\tdev: %p\n", tp->t_dev);
2214 /* DDB command to list TTYs. */
2215 DB_SHOW_ALL_COMMAND(ttys, db_show_all_ttys)
2221 /* Make the output look like `pstat -t'. */
2223 #if defined(__LP64__)
2226 db_printf(" LINE INQ CAN LIN LOW OUTQ USE LOW "
2227 "COL SESS PGID STATE\n");
2229 TAILQ_FOREACH(tp, &tty_list, t_list) {
2230 isiz = tp->t_inq.ti_nblocks * TTYINQ_DATASIZE;
2231 osiz = tp->t_outq.to_nblocks * TTYOUTQ_DATASIZE;
2233 db_printf("%p %10s %5zu %4u %4u %4zu %5zu %4u %4zu %5u %5d %5d ",
2237 tp->t_inq.ti_linestart - tp->t_inq.ti_begin,
2238 tp->t_inq.ti_end - tp->t_inq.ti_linestart,
2241 tp->t_outq.to_end - tp->t_outq.to_begin,
2242 osiz - tp->t_outlow,
2243 MIN(tp->t_column, 99999),
2244 tp->t_session ? tp->t_session->s_sid : 0,
2245 tp->t_pgrp ? tp->t_pgrp->pg_id : 0);
2248 for (i = j = 0; ttystates[i].flag; i++)
2249 if (tp->t_flags & ttystates[i].flag) {
2250 db_printf("%c", ttystates[i].val);