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)
131 if (ttyhook_hashook(tp, getc_inject))
132 /* buffer is inaccessible */
135 while (ttyoutq_bytesused(&tp->t_outq) > 0 || ttydevsw_busy(tp)) {
136 ttydevsw_outwakeup(tp);
137 /* Could be handled synchronously. */
138 bytesused = ttyoutq_bytesused(&tp->t_outq);
139 if (bytesused == 0 && !ttydevsw_busy(tp))
142 /* Wait for data to be drained. */
144 error = tty_timedwait(tp, &tp->t_outwait, hz);
145 if (error == EWOULDBLOCK &&
146 ttyoutq_bytesused(&tp->t_outq) < bytesused)
149 error = tty_wait(tp, &tp->t_outwait);
159 * Though ttydev_enter() and ttydev_leave() seem to be related, they
160 * don't have to be used together. ttydev_enter() is used by the cdev
161 * operations to prevent an actual operation from being processed when
162 * the TTY has been abandoned. ttydev_leave() is used by ttydev_open()
163 * and ttydev_close() to determine whether per-TTY data should be
168 ttydev_enter(struct tty *tp)
173 if (tty_gone(tp) || !tty_opened(tp)) {
174 /* Device is already gone. */
183 ttydev_leave(struct tty *tp)
186 tty_lock_assert(tp, MA_OWNED);
188 if (tty_opened(tp) || tp->t_flags & TF_OPENCLOSE) {
189 /* Device is still opened somewhere. */
194 tp->t_flags |= TF_OPENCLOSE;
196 /* Stop asynchronous I/O. */
197 funsetown(&tp->t_sigio);
199 /* Remove console TTY. */
203 /* Drain any output. */
209 /* Free i/o queues now since they might be large. */
210 ttyinq_free(&tp->t_inq);
212 ttyoutq_free(&tp->t_outq);
215 knlist_clear(&tp->t_inpoll.si_note, 1);
216 knlist_clear(&tp->t_outpoll.si_note, 1);
221 tp->t_flags &= ~TF_OPENCLOSE;
222 cv_broadcast(&tp->t_dcdwait);
227 * Operations that are exposed through the character device in /dev.
230 ttydev_open(struct cdev *dev, int oflags, int devtype __unused,
240 /* Device is already gone. */
246 * Block when other processes are currently opening or closing
249 while (tp->t_flags & TF_OPENCLOSE) {
250 error = tty_wait(tp, &tp->t_dcdwait);
256 tp->t_flags |= TF_OPENCLOSE;
259 * Make sure the "tty" and "cua" device cannot be opened at the
260 * same time. The console is a "tty" device.
262 if (TTY_CALLOUT(tp, dev)) {
263 if (tp->t_flags & (TF_OPENED_CONS | TF_OPENED_IN)) {
268 if (tp->t_flags & TF_OPENED_OUT) {
274 if (tp->t_flags & TF_EXCLUDE && priv_check(td, PRIV_TTY_EXCLUSIVE)) {
279 if (!tty_opened(tp)) {
280 /* Set proper termios flags. */
281 if (TTY_CALLOUT(tp, dev))
282 tp->t_termios = tp->t_termios_init_out;
284 tp->t_termios = tp->t_termios_init_in;
285 ttydevsw_param(tp, &tp->t_termios);
286 /* Prevent modem control on callout devices and /dev/console. */
287 if (TTY_CALLOUT(tp, dev) || dev == dev_console)
288 tp->t_termios.c_cflag |= CLOCAL;
290 ttydevsw_modem(tp, SER_DTR|SER_RTS, 0);
292 error = ttydevsw_open(tp);
297 tty_watermarks(tp); /* XXXGL: drops lock */
300 /* Wait for Carrier Detect. */
301 if ((oflags & O_NONBLOCK) == 0 &&
302 (tp->t_termios.c_cflag & CLOCAL) == 0) {
303 while ((ttydevsw_modem(tp, 0, 0) & SER_DCD) == 0) {
304 error = tty_wait(tp, &tp->t_dcdwait);
310 if (dev == dev_console)
311 tp->t_flags |= TF_OPENED_CONS;
312 else if (TTY_CALLOUT(tp, dev))
313 tp->t_flags |= TF_OPENED_OUT;
315 tp->t_flags |= TF_OPENED_IN;
316 MPASS((tp->t_flags & (TF_OPENED_CONS | TF_OPENED_IN)) == 0 ||
317 (tp->t_flags & TF_OPENED_OUT) == 0);
319 done: tp->t_flags &= ~TF_OPENCLOSE;
320 cv_broadcast(&tp->t_dcdwait);
327 ttydev_close(struct cdev *dev, int fflag, int devtype __unused,
328 struct thread *td __unused)
330 struct tty *tp = dev->si_drv1;
335 * Don't actually close the device if it is being used as the
338 MPASS((tp->t_flags & (TF_OPENED_CONS | TF_OPENED_IN)) == 0 ||
339 (tp->t_flags & TF_OPENED_OUT) == 0);
340 if (dev == dev_console)
341 tp->t_flags &= ~TF_OPENED_CONS;
343 tp->t_flags &= ~(TF_OPENED_IN|TF_OPENED_OUT);
345 if (tp->t_flags & TF_OPENED) {
350 /* If revoking, flush output now to avoid draining it later. */
352 tty_flush(tp, FWRITE);
354 tp->t_flags &= ~TF_EXCLUDE;
356 /* Properly wake up threads that are stuck - revoke(). */
358 tty_wakeup(tp, FREAD|FWRITE);
359 cv_broadcast(&tp->t_bgwait);
360 cv_broadcast(&tp->t_dcdwait);
368 tty_is_ctty(struct tty *tp, struct proc *p)
371 tty_lock_assert(tp, MA_OWNED);
373 return (p->p_session == tp->t_session && p->p_flag & P_CONTROLT);
377 tty_wait_background(struct tty *tp, struct thread *td, int sig)
379 struct proc *p = td->td_proc;
384 MPASS(sig == SIGTTIN || sig == SIGTTOU);
385 tty_lock_assert(tp, MA_OWNED);
390 * The process should only sleep, when:
391 * - This terminal is the controlling terminal
392 * - Its process group is not the foreground process
394 * - The parent process isn't waiting for the child to
396 * - the signal to send to the process isn't masked
398 if (!tty_is_ctty(tp, p) || p->p_pgrp == tp->t_pgrp) {
399 /* Allow the action to happen. */
404 if (SIGISMEMBER(p->p_sigacts->ps_sigignore, sig) ||
405 SIGISMEMBER(td->td_sigmask, sig)) {
406 /* Only allow them in write()/ioctl(). */
408 return (sig == SIGTTOU ? 0 : EIO);
412 if (p->p_flag & P_PPWAIT || pg->pg_jobc == 0) {
413 /* Don't allow the action to happen. */
420 * Send the signal and sleep until we're the new
421 * foreground process group.
425 ksi.ksi_code = SI_KERNEL;
430 pgsignal(pg, ksi.ksi_signo, 1, &ksi);
433 error = tty_wait(tp, &tp->t_bgwait);
440 ttydev_read(struct cdev *dev, struct uio *uio, int ioflag)
442 struct tty *tp = dev->si_drv1;
445 error = ttydev_enter(tp);
448 error = ttydisc_read(tp, uio, ioflag);
452 * The read() call should not throw an error when the device is
453 * being destroyed. Silently convert it to an EOF.
455 done: if (error == ENXIO)
461 ttydev_write(struct cdev *dev, struct uio *uio, int ioflag)
463 struct tty *tp = dev->si_drv1;
466 error = ttydev_enter(tp);
470 if (tp->t_termios.c_lflag & TOSTOP) {
471 error = tty_wait_background(tp, curthread, SIGTTOU);
476 if (ioflag & IO_NDELAY && tp->t_flags & TF_BUSY_OUT) {
477 /* Allow non-blocking writes to bypass serialization. */
478 error = ttydisc_write(tp, uio, ioflag);
480 /* Serialize write() calls. */
481 while (tp->t_flags & TF_BUSY_OUT) {
482 error = tty_wait(tp, &tp->t_outserwait);
487 tp->t_flags |= TF_BUSY_OUT;
488 error = ttydisc_write(tp, uio, ioflag);
489 tp->t_flags &= ~TF_BUSY_OUT;
490 cv_signal(&tp->t_outserwait);
493 done: tty_unlock(tp);
498 ttydev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
501 struct tty *tp = dev->si_drv1;
504 error = ttydev_enter(tp);
539 #endif /* COMPAT_43TTY */
541 * If the ioctl() causes the TTY to be modified, let it
542 * wait in the background.
544 error = tty_wait_background(tp, curthread, SIGTTOU);
549 if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
550 struct termios *old = &tp->t_termios;
551 struct termios *new = (struct termios *)data;
552 struct termios *lock = TTY_CALLOUT(tp, dev) ?
553 &tp->t_termios_lock_out : &tp->t_termios_lock_in;
557 * Lock state devices. Just overwrite the values of the
558 * commands that are currently in use.
560 new->c_iflag = (old->c_iflag & lock->c_iflag) |
561 (new->c_iflag & ~lock->c_iflag);
562 new->c_oflag = (old->c_oflag & lock->c_oflag) |
563 (new->c_oflag & ~lock->c_oflag);
564 new->c_cflag = (old->c_cflag & lock->c_cflag) |
565 (new->c_cflag & ~lock->c_cflag);
566 new->c_lflag = (old->c_lflag & lock->c_lflag) |
567 (new->c_lflag & ~lock->c_lflag);
568 for (cc = 0; cc < NCCS; ++cc)
570 new->c_cc[cc] = old->c_cc[cc];
572 new->c_ispeed = old->c_ispeed;
574 new->c_ospeed = old->c_ospeed;
577 error = tty_ioctl(tp, cmd, data, fflag, td);
578 done: tty_unlock(tp);
584 ttydev_poll(struct cdev *dev, int events, struct thread *td)
586 struct tty *tp = dev->si_drv1;
587 int error, revents = 0;
589 error = ttydev_enter(tp);
591 return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
593 if (events & (POLLIN|POLLRDNORM)) {
594 /* See if we can read something. */
595 if (ttydisc_read_poll(tp) > 0)
596 revents |= events & (POLLIN|POLLRDNORM);
599 if (tp->t_flags & TF_ZOMBIE) {
600 /* Hangup flag on zombie state. */
602 } else if (events & (POLLOUT|POLLWRNORM)) {
603 /* See if we can write something. */
604 if (ttydisc_write_poll(tp) > 0)
605 revents |= events & (POLLOUT|POLLWRNORM);
609 if (events & (POLLIN|POLLRDNORM))
610 selrecord(td, &tp->t_inpoll);
611 if (events & (POLLOUT|POLLWRNORM))
612 selrecord(td, &tp->t_outpoll);
621 ttydev_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
622 int nprot, vm_memattr_t *memattr)
624 struct tty *tp = dev->si_drv1;
627 /* Handle mmap() through the driver. */
629 error = ttydev_enter(tp);
632 error = ttydevsw_mmap(tp, offset, paddr, nprot, memattr);
643 tty_kqops_read_detach(struct knote *kn)
645 struct tty *tp = kn->kn_hook;
647 knlist_remove(&tp->t_inpoll.si_note, kn, 0);
651 tty_kqops_read_event(struct knote *kn, long hint __unused)
653 struct tty *tp = kn->kn_hook;
655 tty_lock_assert(tp, MA_OWNED);
657 if (tty_gone(tp) || tp->t_flags & TF_ZOMBIE) {
658 kn->kn_flags |= EV_EOF;
661 kn->kn_data = ttydisc_read_poll(tp);
662 return (kn->kn_data > 0);
667 tty_kqops_write_detach(struct knote *kn)
669 struct tty *tp = kn->kn_hook;
671 knlist_remove(&tp->t_outpoll.si_note, kn, 0);
675 tty_kqops_write_event(struct knote *kn, long hint __unused)
677 struct tty *tp = kn->kn_hook;
679 tty_lock_assert(tp, MA_OWNED);
682 kn->kn_flags |= EV_EOF;
685 kn->kn_data = ttydisc_write_poll(tp);
686 return (kn->kn_data > 0);
690 static struct filterops tty_kqops_read = {
692 .f_detach = tty_kqops_read_detach,
693 .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 __unused, int devtype __unused,
768 ttyil_close(struct cdev *dev __unused, int flag __unused, int mode __unused,
769 struct thread *td __unused)
776 ttyil_rdwr(struct cdev *dev __unused, struct uio *uio __unused,
784 ttyil_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
787 struct tty *tp = dev->si_drv1;
796 error = ttydevsw_cioctl(tp, dev2unit(dev), cmd, data, td);
797 if (error != ENOIOCTL)
803 /* Obtain terminal flags through tcgetattr(). */
804 *(struct termios*)data = *(struct termios*)dev->si_drv2;
807 /* Set terminal flags through tcsetattr(). */
808 error = priv_check(td, PRIV_TTY_SETA);
811 *(struct termios*)dev->si_drv2 = *(struct termios*)data;
814 *(int *)data = TTYDISC;
817 bzero(data, sizeof(struct winsize));
823 done: tty_unlock(tp);
827 static struct cdevsw ttyil_cdevsw = {
828 .d_version = D_VERSION,
829 .d_open = ttyil_open,
830 .d_close = ttyil_close,
831 .d_read = ttyil_rdwr,
832 .d_write = ttyil_rdwr,
833 .d_ioctl = ttyil_ioctl,
839 tty_init_termios(struct tty *tp)
841 struct termios *t = &tp->t_termios_init_in;
843 t->c_cflag = TTYDEF_CFLAG;
844 t->c_iflag = TTYDEF_IFLAG;
845 t->c_lflag = TTYDEF_LFLAG;
846 t->c_oflag = TTYDEF_OFLAG;
847 t->c_ispeed = TTYDEF_SPEED;
848 t->c_ospeed = TTYDEF_SPEED;
849 memcpy(&t->c_cc, ttydefchars, sizeof ttydefchars);
851 tp->t_termios_init_out = *t;
855 tty_init_console(struct tty *tp, speed_t s)
857 struct termios *ti = &tp->t_termios_init_in;
858 struct termios *to = &tp->t_termios_init_out;
861 ti->c_ispeed = ti->c_ospeed = s;
862 to->c_ispeed = to->c_ospeed = s;
865 ti->c_cflag |= CLOCAL;
866 to->c_cflag |= CLOCAL;
870 * Standard device routine implementations, mostly meant for
871 * pseudo-terminal device drivers. When a driver creates a new terminal
872 * device class, missing routines are patched.
876 ttydevsw_defopen(struct tty *tp __unused)
883 ttydevsw_defclose(struct tty *tp __unused)
889 ttydevsw_defoutwakeup(struct tty *tp __unused)
892 panic("Terminal device has output, while not implemented");
896 ttydevsw_definwakeup(struct tty *tp __unused)
902 ttydevsw_defioctl(struct tty *tp __unused, u_long cmd __unused,
903 caddr_t data __unused, struct thread *td __unused)
910 ttydevsw_defcioctl(struct tty *tp __unused, int unit __unused,
911 u_long cmd __unused, caddr_t data __unused, struct thread *td __unused)
918 ttydevsw_defparam(struct tty *tp __unused, struct termios *t)
922 * Allow the baud rate to be adjusted for pseudo-devices, but at
923 * least restrict it to 115200 to prevent excessive buffer
924 * usage. Also disallow 0, to prevent foot shooting.
926 if (t->c_ispeed < B50)
928 else if (t->c_ispeed > B115200)
929 t->c_ispeed = B115200;
930 if (t->c_ospeed < B50)
932 else if (t->c_ospeed > B115200)
933 t->c_ospeed = B115200;
940 ttydevsw_defmodem(struct tty *tp __unused, int sigon __unused,
944 /* Simulate a carrier to make the TTY layer happy. */
949 ttydevsw_defmmap(struct tty *tp __unused, vm_ooffset_t offset __unused,
950 vm_paddr_t *paddr __unused, int nprot __unused,
951 vm_memattr_t *memattr __unused)
958 ttydevsw_defpktnotify(struct tty *tp __unused, char event __unused)
964 ttydevsw_deffree(void *softc __unused)
967 panic("Terminal device freed without a free-handler");
971 ttydevsw_defbusy(struct tty *tp __unused)
978 * TTY allocation and deallocation. TTY devices can be deallocated when
979 * the driver doesn't use it anymore, when the TTY isn't a session's
980 * controlling TTY and when the device node isn't opened through devfs.
984 tty_alloc(struct ttydevsw *tsw, void *sc)
987 return (tty_alloc_mutex(tsw, sc, NULL));
991 tty_alloc_mutex(struct ttydevsw *tsw, void *sc, struct mtx *mutex)
995 /* Make sure the driver defines all routines. */
996 #define PATCH_FUNC(x) do { \
997 if (tsw->tsw_ ## x == NULL) \
998 tsw->tsw_ ## x = ttydevsw_def ## x; \
1002 PATCH_FUNC(outwakeup);
1003 PATCH_FUNC(inwakeup);
1009 PATCH_FUNC(pktnotify);
1014 tp = malloc(sizeof(struct tty), M_TTY, M_WAITOK|M_ZERO);
1016 tp->t_devswsoftc = sc;
1017 tp->t_flags = tsw->tsw_flags;
1019 tty_init_termios(tp);
1021 cv_init(&tp->t_inwait, "ttyin");
1022 cv_init(&tp->t_outwait, "ttyout");
1023 cv_init(&tp->t_outserwait, "ttyosr");
1024 cv_init(&tp->t_bgwait, "ttybg");
1025 cv_init(&tp->t_dcdwait, "ttydcd");
1027 /* Allow drivers to use a custom mutex to lock the TTY. */
1028 if (mutex != NULL) {
1031 tp->t_mtx = &tp->t_mtxobj;
1032 mtx_init(&tp->t_mtxobj, "ttymtx", NULL, MTX_DEF);
1035 knlist_init_mtx(&tp->t_inpoll.si_note, tp->t_mtx);
1036 knlist_init_mtx(&tp->t_outpoll.si_note, tp->t_mtx);
1042 tty_dealloc(void *arg)
1044 struct tty *tp = arg;
1047 * ttyydev_leave() usually frees the i/o queues earlier, but it is
1048 * not always called between queue allocation and here. The queues
1049 * may be allocated by ioctls on a pty control device without the
1050 * corresponding pty slave device ever being open, or after it is
1053 ttyinq_free(&tp->t_inq);
1054 ttyoutq_free(&tp->t_outq);
1055 seldrain(&tp->t_inpoll);
1056 seldrain(&tp->t_outpoll);
1057 knlist_destroy(&tp->t_inpoll.si_note);
1058 knlist_destroy(&tp->t_outpoll.si_note);
1060 cv_destroy(&tp->t_inwait);
1061 cv_destroy(&tp->t_outwait);
1062 cv_destroy(&tp->t_bgwait);
1063 cv_destroy(&tp->t_dcdwait);
1064 cv_destroy(&tp->t_outserwait);
1066 if (tp->t_mtx == &tp->t_mtxobj)
1067 mtx_destroy(&tp->t_mtxobj);
1073 tty_rel_free(struct tty *tp)
1077 tty_lock_assert(tp, MA_OWNED);
1079 #define TF_ACTIVITY (TF_GONE|TF_OPENED|TF_HOOK|TF_OPENCLOSE)
1080 if (tp->t_sessioncnt != 0 || (tp->t_flags & TF_ACTIVITY) != TF_GONE) {
1081 /* TTY is still in use. */
1086 /* TTY can be deallocated. */
1092 sx_xlock(&tty_list_sx);
1093 TAILQ_REMOVE(&tty_list, tp, t_list);
1095 sx_xunlock(&tty_list_sx);
1096 destroy_dev_sched_cb(dev, tty_dealloc, tp);
1101 tty_rel_pgrp(struct tty *tp, struct pgrp *pg)
1104 MPASS(tp->t_sessioncnt > 0);
1105 tty_lock_assert(tp, MA_OWNED);
1107 if (tp->t_pgrp == pg)
1114 tty_rel_sess(struct tty *tp, struct session *sess)
1117 MPASS(tp->t_sessioncnt > 0);
1119 /* Current session has left. */
1120 if (tp->t_session == sess) {
1121 tp->t_session = NULL;
1122 MPASS(tp->t_pgrp == NULL);
1129 tty_rel_gone(struct tty *tp)
1132 MPASS(!tty_gone(tp));
1134 /* Simulate carrier removal. */
1135 ttydisc_modem(tp, 0);
1137 /* Wake up all blocked threads. */
1138 tty_wakeup(tp, FREAD|FWRITE);
1139 cv_broadcast(&tp->t_bgwait);
1140 cv_broadcast(&tp->t_dcdwait);
1142 tp->t_flags |= TF_GONE;
1147 * Exposing information about current TTY's through sysctl
1151 tty_to_xtty(struct tty *tp, struct xtty *xt)
1154 tty_lock_assert(tp, MA_OWNED);
1156 xt->xt_size = sizeof(struct xtty);
1157 xt->xt_insize = ttyinq_getsize(&tp->t_inq);
1158 xt->xt_incc = ttyinq_bytescanonicalized(&tp->t_inq);
1159 xt->xt_inlc = ttyinq_bytesline(&tp->t_inq);
1160 xt->xt_inlow = tp->t_inlow;
1161 xt->xt_outsize = ttyoutq_getsize(&tp->t_outq);
1162 xt->xt_outcc = ttyoutq_bytesused(&tp->t_outq);
1163 xt->xt_outlow = tp->t_outlow;
1164 xt->xt_column = tp->t_column;
1165 xt->xt_pgid = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1166 xt->xt_sid = tp->t_session ? tp->t_session->s_sid : 0;
1167 xt->xt_flags = tp->t_flags;
1168 xt->xt_dev = tp->t_dev ? dev2udev(tp->t_dev) : NODEV;
1172 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
1174 unsigned long lsize;
1175 struct xtty *xtlist, *xt;
1179 sx_slock(&tty_list_sx);
1180 lsize = tty_list_count * sizeof(struct xtty);
1182 sx_sunlock(&tty_list_sx);
1186 xtlist = xt = malloc(lsize, M_TTY, M_WAITOK);
1188 TAILQ_FOREACH(tp, &tty_list, t_list) {
1190 tty_to_xtty(tp, xt);
1194 sx_sunlock(&tty_list_sx);
1196 error = SYSCTL_OUT(req, xtlist, lsize);
1197 free(xtlist, M_TTY);
1201 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
1202 0, 0, sysctl_kern_ttys, "S,xtty", "List of TTYs");
1205 * Device node creation. Device has been set up, now we can expose it to
1210 tty_makedevf(struct tty *tp, struct ucred *cred, int flags,
1211 const char *fmt, ...)
1214 struct make_dev_args args;
1215 struct cdev *dev, *init, *lock, *cua, *cinit, *clock;
1216 const char *prefix = "tty";
1217 char name[SPECNAMELEN - 3]; /* for "tty" and "cua". */
1223 /* Remove "tty" prefix from devices like PTY's. */
1224 if (tp->t_flags & TF_NOPREFIX)
1228 vsnrprintf(name, sizeof name, 32, fmt, ap);
1232 /* System device. */
1235 mode = S_IRUSR|S_IWUSR;
1238 uid = cred->cr_ruid;
1240 mode = S_IRUSR|S_IWUSR|S_IWGRP;
1243 flags = flags & TTYMK_CLONING ? MAKEDEV_REF : 0;
1244 flags |= MAKEDEV_CHECKNAME;
1246 /* Master call-in device. */
1247 make_dev_args_init(&args);
1248 args.mda_flags = flags;
1249 args.mda_devsw = &ttydev_cdevsw;
1253 args.mda_mode = mode;
1254 args.mda_si_drv1 = tp;
1255 error = make_dev_s(&args, &dev, "%s%s", prefix, name);
1260 init = lock = cua = cinit = clock = NULL;
1262 /* Slave call-in devices. */
1263 if (tp->t_flags & TF_INITLOCK) {
1264 args.mda_devsw = &ttyil_cdevsw;
1265 args.mda_unit = TTYUNIT_INIT;
1266 args.mda_si_drv1 = tp;
1267 args.mda_si_drv2 = &tp->t_termios_init_in;
1268 error = make_dev_s(&args, &init, "%s%s.init", prefix, name);
1271 dev_depends(dev, init);
1273 args.mda_unit = TTYUNIT_LOCK;
1274 args.mda_si_drv2 = &tp->t_termios_lock_in;
1275 error = make_dev_s(&args, &lock, "%s%s.lock", prefix, name);
1278 dev_depends(dev, lock);
1281 /* Call-out devices. */
1282 if (tp->t_flags & TF_CALLOUT) {
1283 make_dev_args_init(&args);
1284 args.mda_flags = flags;
1285 args.mda_devsw = &ttydev_cdevsw;
1287 args.mda_uid = UID_UUCP;
1288 args.mda_gid = GID_DIALER;
1289 args.mda_mode = 0660;
1290 args.mda_unit = TTYUNIT_CALLOUT;
1291 args.mda_si_drv1 = tp;
1292 error = make_dev_s(&args, &cua, "cua%s", name);
1295 dev_depends(dev, cua);
1297 /* Slave call-out devices. */
1298 if (tp->t_flags & TF_INITLOCK) {
1299 args.mda_devsw = &ttyil_cdevsw;
1300 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_INIT;
1301 args.mda_si_drv2 = &tp->t_termios_init_out;
1302 error = make_dev_s(&args, &cinit, "cua%s.init", name);
1305 dev_depends(dev, cinit);
1307 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_LOCK;
1308 args.mda_si_drv2 = &tp->t_termios_lock_out;
1309 error = make_dev_s(&args, &clock, "cua%s.lock", name);
1312 dev_depends(dev, clock);
1316 sx_xlock(&tty_list_sx);
1317 TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
1319 sx_xunlock(&tty_list_sx);
1338 * Signalling processes.
1342 tty_signal_sessleader(struct tty *tp, int sig)
1346 tty_lock_assert(tp, MA_OWNED);
1347 MPASS(sig >= 1 && sig < NSIG);
1349 /* Make signals start output again. */
1350 tp->t_flags &= ~TF_STOPPED;
1352 if (tp->t_session != NULL && tp->t_session->s_leader != NULL) {
1353 p = tp->t_session->s_leader;
1355 kern_psignal(p, sig);
1361 tty_signal_pgrp(struct tty *tp, int sig)
1365 tty_lock_assert(tp, MA_OWNED);
1366 MPASS(sig >= 1 && sig < NSIG);
1368 /* Make signals start output again. */
1369 tp->t_flags &= ~TF_STOPPED;
1371 if (sig == SIGINFO && !(tp->t_termios.c_lflag & NOKERNINFO))
1373 if (tp->t_pgrp != NULL) {
1374 ksiginfo_init(&ksi);
1375 ksi.ksi_signo = sig;
1376 ksi.ksi_code = SI_KERNEL;
1377 PGRP_LOCK(tp->t_pgrp);
1378 pgsignal(tp->t_pgrp, sig, 1, &ksi);
1379 PGRP_UNLOCK(tp->t_pgrp);
1384 tty_wakeup(struct tty *tp, int flags)
1387 if (tp->t_flags & TF_ASYNC && tp->t_sigio != NULL)
1388 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
1390 if (flags & FWRITE) {
1391 cv_broadcast(&tp->t_outwait);
1392 selwakeup(&tp->t_outpoll);
1393 KNOTE_LOCKED(&tp->t_outpoll.si_note, 0);
1395 if (flags & FREAD) {
1396 cv_broadcast(&tp->t_inwait);
1397 selwakeup(&tp->t_inpoll);
1398 KNOTE_LOCKED(&tp->t_inpoll.si_note, 0);
1403 tty_wait(struct tty *tp, struct cv *cv)
1406 int revokecnt = tp->t_revokecnt;
1408 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1409 MPASS(!tty_gone(tp));
1411 error = cv_wait_sig(cv, tp->t_mtx);
1413 /* Bail out when the device slipped away. */
1417 /* Restart the system call when we may have been revoked. */
1418 if (tp->t_revokecnt != revokecnt)
1425 tty_timedwait(struct tty *tp, struct cv *cv, int hz)
1428 int revokecnt = tp->t_revokecnt;
1430 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1431 MPASS(!tty_gone(tp));
1433 error = cv_timedwait_sig(cv, tp->t_mtx, hz);
1435 /* Bail out when the device slipped away. */
1439 /* Restart the system call when we may have been revoked. */
1440 if (tp->t_revokecnt != revokecnt)
1447 tty_flush(struct tty *tp, int flags)
1450 if (flags & FWRITE) {
1451 tp->t_flags &= ~TF_HIWAT_OUT;
1452 ttyoutq_flush(&tp->t_outq);
1453 tty_wakeup(tp, FWRITE);
1454 if (!tty_gone(tp)) {
1455 ttydevsw_outwakeup(tp);
1456 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHWRITE);
1459 if (flags & FREAD) {
1460 tty_hiwat_in_unblock(tp);
1461 ttyinq_flush(&tp->t_inq);
1462 tty_wakeup(tp, FREAD);
1463 if (!tty_gone(tp)) {
1464 ttydevsw_inwakeup(tp);
1465 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHREAD);
1471 tty_set_winsize(struct tty *tp, const struct winsize *wsz)
1474 if (memcmp(&tp->t_winsize, wsz, sizeof(*wsz)) == 0)
1476 tp->t_winsize = *wsz;
1477 tty_signal_pgrp(tp, SIGWINCH);
1481 tty_generic_ioctl(struct tty *tp, u_long cmd, void *data, int fflag,
1489 * The SER_* and TIOCM_* flags are the same, but one bit
1490 * shifted. I don't know why.
1493 ttydevsw_modem(tp, SER_DTR, 0);
1496 ttydevsw_modem(tp, 0, SER_DTR);
1499 int bits = *(int *)data;
1501 (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1,
1502 ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1506 int bits = *(int *)data;
1507 ttydevsw_modem(tp, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1, 0);
1511 int bits = *(int *)data;
1512 ttydevsw_modem(tp, 0, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1516 *(int *)data = TIOCM_LE + (ttydevsw_modem(tp, 0, 0) << 1);
1521 tp->t_flags |= TF_ASYNC;
1523 tp->t_flags &= ~TF_ASYNC;
1526 /* This device supports non-blocking operation. */
1529 *(int *)data = ttyinq_bytescanonicalized(&tp->t_inq);
1533 *(int *)data = ttyoutq_bytesused(&tp->t_outq);
1536 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1537 /* Not allowed to set ownership. */
1540 /* Temporarily unlock the TTY to set ownership. */
1542 error = fsetown(*(int *)data, &tp->t_sigio);
1546 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1547 /* Not allowed to set ownership. */
1550 /* Get ownership. */
1551 *(int *)data = fgetown(&tp->t_sigio);
1554 /* Obtain terminal flags through tcgetattr(). */
1555 *(struct termios*)data = tp->t_termios;
1560 struct termios *t = data;
1563 * Who makes up these funny rules? According to POSIX,
1564 * input baud rate is set equal to the output baud rate
1567 if (t->c_ispeed == 0)
1568 t->c_ispeed = t->c_ospeed;
1570 /* Discard any unsupported bits. */
1571 t->c_iflag &= TTYSUP_IFLAG;
1572 t->c_oflag &= TTYSUP_OFLAG;
1573 t->c_lflag &= TTYSUP_LFLAG;
1574 t->c_cflag &= TTYSUP_CFLAG;
1576 /* Set terminal flags through tcsetattr(). */
1577 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1578 error = tty_drain(tp, 0);
1581 if (cmd == TIOCSETAF)
1582 tty_flush(tp, FREAD);
1586 * Only call param() when the flags really change.
1588 if ((t->c_cflag & CIGNORE) == 0 &&
1589 (tp->t_termios.c_cflag != t->c_cflag ||
1590 ((tp->t_termios.c_iflag ^ t->c_iflag) &
1591 (IXON|IXOFF|IXANY)) ||
1592 tp->t_termios.c_ispeed != t->c_ispeed ||
1593 tp->t_termios.c_ospeed != t->c_ospeed)) {
1594 error = ttydevsw_param(tp, t);
1600 tp->t_termios.c_cflag = t->c_cflag & ~CIGNORE;
1601 tp->t_termios.c_ispeed = t->c_ispeed;
1602 tp->t_termios.c_ospeed = t->c_ospeed;
1604 /* Baud rate has changed - update watermarks. */
1608 /* Copy new non-device driver parameters. */
1609 tp->t_termios.c_iflag = t->c_iflag;
1610 tp->t_termios.c_oflag = t->c_oflag;
1611 tp->t_termios.c_lflag = t->c_lflag;
1612 memcpy(&tp->t_termios.c_cc, t->c_cc, sizeof t->c_cc);
1614 ttydisc_optimize(tp);
1616 if ((t->c_lflag & ICANON) == 0) {
1618 * When in non-canonical mode, wake up all
1619 * readers. Canonicalize any partial input. VMIN
1620 * and VTIME could also be adjusted.
1622 ttyinq_canonicalize(&tp->t_inq);
1623 tty_wakeup(tp, FREAD);
1627 * For packet mode: notify the PTY consumer that VSTOP
1628 * and VSTART may have been changed.
1630 if (tp->t_termios.c_iflag & IXON &&
1631 tp->t_termios.c_cc[VSTOP] == CTRL('S') &&
1632 tp->t_termios.c_cc[VSTART] == CTRL('Q'))
1633 ttydevsw_pktnotify(tp, TIOCPKT_DOSTOP);
1635 ttydevsw_pktnotify(tp, TIOCPKT_NOSTOP);
1639 /* For compatibility - we only support TTYDISC. */
1640 *(int *)data = TTYDISC;
1643 if (!tty_is_ctty(tp, td->td_proc))
1646 if (tp->t_pgrp != NULL)
1647 *(int *)data = tp->t_pgrp->pg_id;
1649 *(int *)data = NO_PID;
1652 if (!tty_is_ctty(tp, td->td_proc))
1655 MPASS(tp->t_session);
1656 *(int *)data = tp->t_session->s_sid;
1659 struct proc *p = td->td_proc;
1661 /* XXX: This looks awful. */
1663 sx_xlock(&proctree_lock);
1666 if (!SESS_LEADER(p)) {
1667 /* Only the session leader may do this. */
1668 sx_xunlock(&proctree_lock);
1672 if (tp->t_session != NULL && tp->t_session == p->p_session) {
1673 /* This is already our controlling TTY. */
1674 sx_xunlock(&proctree_lock);
1678 if (p->p_session->s_ttyp != NULL ||
1679 (tp->t_session != NULL && tp->t_session->s_ttyvp != NULL &&
1680 tp->t_session->s_ttyvp->v_type != VBAD)) {
1682 * There is already a relation between a TTY and
1683 * a session, or the caller is not the session
1686 * Allow the TTY to be stolen when the vnode is
1687 * invalid, but the reference to the TTY is
1688 * still active. This allows immediate reuse of
1689 * TTYs of which the session leader has been
1690 * killed or the TTY revoked.
1692 sx_xunlock(&proctree_lock);
1696 /* Connect the session to the TTY. */
1697 tp->t_session = p->p_session;
1698 tp->t_session->s_ttyp = tp;
1700 sx_xunlock(&proctree_lock);
1702 /* Assign foreground process group. */
1703 tp->t_pgrp = p->p_pgrp;
1705 p->p_flag |= P_CONTROLT;
1714 * XXX: Temporarily unlock the TTY to locate the process
1715 * group. This code would be lot nicer if we would ever
1716 * decompose proctree_lock.
1719 sx_slock(&proctree_lock);
1720 pg = pgfind(*(int *)data);
1723 if (pg == NULL || pg->pg_session != td->td_proc->p_session) {
1724 sx_sunlock(&proctree_lock);
1731 * Determine if this TTY is the controlling TTY after
1732 * relocking the TTY.
1734 if (!tty_is_ctty(tp, td->td_proc)) {
1735 sx_sunlock(&proctree_lock);
1739 sx_sunlock(&proctree_lock);
1741 /* Wake up the background process groups. */
1742 cv_broadcast(&tp->t_bgwait);
1746 int flags = *(int *)data;
1749 flags = (FREAD|FWRITE);
1751 flags &= (FREAD|FWRITE);
1752 tty_flush(tp, flags);
1756 /* Drain TTY output. */
1757 return tty_drain(tp, 0);
1759 /* Set terminal as console TTY. */
1761 error = priv_check(td, PRIV_TTY_CONSOLE);
1766 * XXX: constty should really need to be locked!
1767 * XXX: allow disconnected constty's to be stolen!
1772 if (constty != NULL)
1778 } else if (constty == tp) {
1783 /* Obtain window size. */
1784 *(struct winsize*)data = tp->t_winsize;
1787 /* Set window size. */
1788 tty_set_winsize(tp, data);
1791 tp->t_flags |= TF_EXCLUDE;
1794 tp->t_flags &= ~TF_EXCLUDE;
1797 tp->t_flags |= TF_STOPPED;
1798 ttydevsw_pktnotify(tp, TIOCPKT_STOP);
1801 tp->t_flags &= ~TF_STOPPED;
1802 ttydevsw_outwakeup(tp);
1803 ttydevsw_pktnotify(tp, TIOCPKT_START);
1809 if ((fflag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1811 if (!tty_is_ctty(tp, td->td_proc) &&
1812 priv_check(td, PRIV_TTY_STI))
1814 ttydisc_rint(tp, *(char *)data, 0);
1815 ttydisc_rint_done(tp);
1820 return tty_ioctl_compat(tp, cmd, data, fflag, td);
1821 #else /* !COMPAT_43TTY */
1823 #endif /* COMPAT_43TTY */
1827 tty_ioctl(struct tty *tp, u_long cmd, void *data, int fflag, struct thread *td)
1831 tty_lock_assert(tp, MA_OWNED);
1836 error = ttydevsw_ioctl(tp, cmd, data, td);
1837 if (error == ENOIOCTL)
1838 error = tty_generic_ioctl(tp, cmd, data, fflag, td);
1844 tty_udev(struct tty *tp)
1848 return (dev2udev(tp->t_dev));
1854 tty_checkoutq(struct tty *tp)
1857 /* 256 bytes should be enough to print a log message. */
1858 return (ttyoutq_bytesleft(&tp->t_outq) >= 256);
1862 tty_hiwat_in_block(struct tty *tp)
1865 if ((tp->t_flags & TF_HIWAT_IN) == 0 &&
1866 tp->t_termios.c_iflag & IXOFF &&
1867 tp->t_termios.c_cc[VSTOP] != _POSIX_VDISABLE) {
1869 * Input flow control. Only enter the high watermark when we
1870 * can successfully store the VSTOP character.
1872 if (ttyoutq_write_nofrag(&tp->t_outq,
1873 &tp->t_termios.c_cc[VSTOP], 1) == 0)
1874 tp->t_flags |= TF_HIWAT_IN;
1876 /* No input flow control. */
1877 tp->t_flags |= TF_HIWAT_IN;
1882 tty_hiwat_in_unblock(struct tty *tp)
1885 if (tp->t_flags & TF_HIWAT_IN &&
1886 tp->t_termios.c_iflag & IXOFF &&
1887 tp->t_termios.c_cc[VSTART] != _POSIX_VDISABLE) {
1889 * Input flow control. Only leave the high watermark when we
1890 * can successfully store the VSTART character.
1892 if (ttyoutq_write_nofrag(&tp->t_outq,
1893 &tp->t_termios.c_cc[VSTART], 1) == 0)
1894 tp->t_flags &= ~TF_HIWAT_IN;
1896 /* No input flow control. */
1897 tp->t_flags &= ~TF_HIWAT_IN;
1901 ttydevsw_inwakeup(tp);
1905 * TTY hooks interface.
1909 ttyhook_defrint(struct tty *tp, char c, int flags)
1912 if (ttyhook_rint_bypass(tp, &c, 1) != 1)
1919 ttyhook_register(struct tty **rtp, struct proc *p, int fd, struct ttyhook *th,
1926 struct filedesc *fdp;
1927 cap_rights_t rights;
1930 /* Validate the file descriptor. */
1932 error = fget_unlocked(fdp, fd, cap_rights_init(&rights, CAP_TTYHOOK),
1936 if (fp->f_ops == &badfileops) {
1942 * Make sure the vnode is bound to a character device.
1943 * Unlocked check for the vnode type is ok there, because we
1944 * only shall prevent calling devvn_refthread on the file that
1945 * never has been opened over a character device.
1947 if (fp->f_type != DTYPE_VNODE || fp->f_vnode->v_type != VCHR) {
1952 /* Make sure it is a TTY. */
1953 cdp = devvn_refthread(fp->f_vnode, &dev, &ref);
1958 if (dev != fp->f_data) {
1962 if (cdp != &ttydev_cdevsw) {
1968 /* Try to attach the hook to the TTY. */
1971 MPASS((tp->t_hook == NULL) == ((tp->t_flags & TF_HOOK) == 0));
1972 if (tp->t_flags & TF_HOOK)
1975 tp->t_flags |= TF_HOOK;
1977 tp->t_hooksoftc = softc;
1981 /* Maybe we can switch into bypass mode now. */
1982 ttydisc_optimize(tp);
1984 /* Silently convert rint() calls to rint_bypass() when possible. */
1985 if (!ttyhook_hashook(tp, rint) && ttyhook_hashook(tp, rint_bypass))
1986 th->th_rint = ttyhook_defrint;
1988 done3: tty_unlock(tp);
1989 done2: dev_relthread(dev, ref);
1990 done1: fdrop(fp, curthread);
1995 ttyhook_unregister(struct tty *tp)
1998 tty_lock_assert(tp, MA_OWNED);
1999 MPASS(tp->t_flags & TF_HOOK);
2001 /* Disconnect the hook. */
2002 tp->t_flags &= ~TF_HOOK;
2005 /* Maybe we need to leave bypass mode. */
2006 ttydisc_optimize(tp);
2008 /* Maybe deallocate the TTY as well. */
2013 * /dev/console handling.
2017 ttyconsdev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
2021 /* System has no console device. */
2022 if (dev_console_filename == NULL)
2025 /* Look up corresponding TTY by device name. */
2026 sx_slock(&tty_list_sx);
2027 TAILQ_FOREACH(tp, &tty_list, t_list) {
2028 if (strcmp(dev_console_filename, tty_devname(tp)) == 0) {
2029 dev_console->si_drv1 = tp;
2033 sx_sunlock(&tty_list_sx);
2035 /* System console has no TTY associated. */
2036 if (dev_console->si_drv1 == NULL)
2039 return (ttydev_open(dev, oflags, devtype, td));
2043 ttyconsdev_write(struct cdev *dev, struct uio *uio, int ioflag)
2048 return (ttydev_write(dev, uio, ioflag));
2052 * /dev/console is a little different than normal TTY's. When opened,
2053 * it determines which TTY to use. When data gets written to it, it
2054 * will be logged in the kernel message buffer.
2056 static struct cdevsw ttyconsdev_cdevsw = {
2057 .d_version = D_VERSION,
2058 .d_open = ttyconsdev_open,
2059 .d_close = ttydev_close,
2060 .d_read = ttydev_read,
2061 .d_write = ttyconsdev_write,
2062 .d_ioctl = ttydev_ioctl,
2063 .d_kqfilter = ttydev_kqfilter,
2064 .d_poll = ttydev_poll,
2065 .d_mmap = ttydev_mmap,
2066 .d_name = "ttyconsdev",
2071 ttyconsdev_init(void *unused __unused)
2074 dev_console = make_dev_credf(MAKEDEV_ETERNAL, &ttyconsdev_cdevsw, 0,
2075 NULL, UID_ROOT, GID_WHEEL, 0600, "console");
2078 SYSINIT(tty, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyconsdev_init, NULL);
2081 ttyconsdev_select(const char *name)
2084 dev_console_filename = name;
2088 * Debugging routines.
2091 #include "opt_ddb.h"
2093 #include <ddb/ddb.h>
2094 #include <ddb/db_sym.h>
2096 static const struct {
2101 { TF_NOPREFIX, 'N' },
2103 { TF_INITLOCK, 'I' },
2104 { TF_CALLOUT, 'C' },
2106 /* Keep these together -> 'Oi' and 'Oo'. */
2108 { TF_OPENED_IN, 'i' },
2109 { TF_OPENED_OUT, 'o' },
2110 { TF_OPENED_CONS, 'c' },
2113 { TF_OPENCLOSE, 'B' },
2115 { TF_LITERAL, 'L' },
2117 /* Keep these together -> 'Hi' and 'Ho'. */
2119 { TF_HIWAT_IN, 'i' },
2120 { TF_HIWAT_OUT, 'o' },
2122 { TF_STOPPED, 'S' },
2123 { TF_EXCLUDE, 'X' },
2128 /* Keep these together -> 'bi' and 'bo'. */
2130 { TF_BUSY_IN, 'i' },
2131 { TF_BUSY_OUT, 'o' },
2136 #define TTY_FLAG_BITS \
2137 "\20\1NOPREFIX\2INITLOCK\3CALLOUT\4OPENED_IN" \
2138 "\5OPENED_OUT\6OPENED_CONS\7GONE\10OPENCLOSE" \
2139 "\11ASYNC\12LITERAL\13HIWAT_IN\14HIWAT_OUT" \
2140 "\15STOPPED\16EXCLUDE\17BYPASS\20ZOMBIE" \
2141 "\21HOOK\22BUSY_IN\23BUSY_OUT"
2143 #define DB_PRINTSYM(name, addr) \
2144 db_printf("%s " #name ": ", sep); \
2145 db_printsym((db_addr_t) addr, DB_STGY_ANY); \
2149 _db_show_devsw(const char *sep, const struct ttydevsw *tsw)
2152 db_printf("%sdevsw: ", sep);
2153 db_printsym((db_addr_t)tsw, DB_STGY_ANY);
2154 db_printf(" (%p)\n", tsw);
2155 DB_PRINTSYM(open, tsw->tsw_open);
2156 DB_PRINTSYM(close, tsw->tsw_close);
2157 DB_PRINTSYM(outwakeup, tsw->tsw_outwakeup);
2158 DB_PRINTSYM(inwakeup, tsw->tsw_inwakeup);
2159 DB_PRINTSYM(ioctl, tsw->tsw_ioctl);
2160 DB_PRINTSYM(param, tsw->tsw_param);
2161 DB_PRINTSYM(modem, tsw->tsw_modem);
2162 DB_PRINTSYM(mmap, tsw->tsw_mmap);
2163 DB_PRINTSYM(pktnotify, tsw->tsw_pktnotify);
2164 DB_PRINTSYM(free, tsw->tsw_free);
2168 _db_show_hooks(const char *sep, const struct ttyhook *th)
2171 db_printf("%shook: ", sep);
2172 db_printsym((db_addr_t)th, DB_STGY_ANY);
2173 db_printf(" (%p)\n", th);
2176 DB_PRINTSYM(rint, th->th_rint);
2177 DB_PRINTSYM(rint_bypass, th->th_rint_bypass);
2178 DB_PRINTSYM(rint_done, th->th_rint_done);
2179 DB_PRINTSYM(rint_poll, th->th_rint_poll);
2180 DB_PRINTSYM(getc_inject, th->th_getc_inject);
2181 DB_PRINTSYM(getc_capture, th->th_getc_capture);
2182 DB_PRINTSYM(getc_poll, th->th_getc_poll);
2183 DB_PRINTSYM(close, th->th_close);
2187 _db_show_termios(const char *name, const struct termios *t)
2190 db_printf("%s: iflag 0x%x oflag 0x%x cflag 0x%x "
2191 "lflag 0x%x ispeed %u ospeed %u\n", name,
2192 t->c_iflag, t->c_oflag, t->c_cflag, t->c_lflag,
2193 t->c_ispeed, t->c_ospeed);
2196 /* DDB command to show TTY statistics. */
2197 DB_SHOW_COMMAND(tty, db_show_tty)
2202 db_printf("usage: show tty <addr>\n");
2205 tp = (struct tty *)addr;
2207 db_printf("%p: %s\n", tp, tty_devname(tp));
2208 db_printf("\tmtx: %p\n", tp->t_mtx);
2209 db_printf("\tflags: 0x%b\n", tp->t_flags, TTY_FLAG_BITS);
2210 db_printf("\trevokecnt: %u\n", tp->t_revokecnt);
2212 /* Buffering mechanisms. */
2213 db_printf("\tinq: %p begin %u linestart %u reprint %u end %u "
2214 "nblocks %u quota %u\n", &tp->t_inq, tp->t_inq.ti_begin,
2215 tp->t_inq.ti_linestart, tp->t_inq.ti_reprint, tp->t_inq.ti_end,
2216 tp->t_inq.ti_nblocks, tp->t_inq.ti_quota);
2217 db_printf("\toutq: %p begin %u end %u nblocks %u quota %u\n",
2218 &tp->t_outq, tp->t_outq.to_begin, tp->t_outq.to_end,
2219 tp->t_outq.to_nblocks, tp->t_outq.to_quota);
2220 db_printf("\tinlow: %zu\n", tp->t_inlow);
2221 db_printf("\toutlow: %zu\n", tp->t_outlow);
2222 _db_show_termios("\ttermios", &tp->t_termios);
2223 db_printf("\twinsize: row %u col %u xpixel %u ypixel %u\n",
2224 tp->t_winsize.ws_row, tp->t_winsize.ws_col,
2225 tp->t_winsize.ws_xpixel, tp->t_winsize.ws_ypixel);
2226 db_printf("\tcolumn: %u\n", tp->t_column);
2227 db_printf("\twritepos: %u\n", tp->t_writepos);
2228 db_printf("\tcompatflags: 0x%x\n", tp->t_compatflags);
2230 /* Init/lock-state devices. */
2231 _db_show_termios("\ttermios_init_in", &tp->t_termios_init_in);
2232 _db_show_termios("\ttermios_init_out", &tp->t_termios_init_out);
2233 _db_show_termios("\ttermios_lock_in", &tp->t_termios_lock_in);
2234 _db_show_termios("\ttermios_lock_out", &tp->t_termios_lock_out);
2237 _db_show_devsw("\t", tp->t_devsw);
2238 _db_show_hooks("\t", tp->t_hook);
2241 db_printf("\tpgrp: %p gid %d jobc %d\n", tp->t_pgrp,
2242 tp->t_pgrp ? tp->t_pgrp->pg_id : 0,
2243 tp->t_pgrp ? tp->t_pgrp->pg_jobc : 0);
2244 db_printf("\tsession: %p", tp->t_session);
2245 if (tp->t_session != NULL)
2246 db_printf(" count %u leader %p tty %p sid %d login %s",
2247 tp->t_session->s_count, tp->t_session->s_leader,
2248 tp->t_session->s_ttyp, tp->t_session->s_sid,
2249 tp->t_session->s_login);
2251 db_printf("\tsessioncnt: %u\n", tp->t_sessioncnt);
2252 db_printf("\tdevswsoftc: %p\n", tp->t_devswsoftc);
2253 db_printf("\thooksoftc: %p\n", tp->t_hooksoftc);
2254 db_printf("\tdev: %p\n", tp->t_dev);
2257 /* DDB command to list TTYs. */
2258 DB_SHOW_ALL_COMMAND(ttys, db_show_all_ttys)
2264 /* Make the output look like `pstat -t'. */
2266 #if defined(__LP64__)
2269 db_printf(" LINE INQ CAN LIN LOW OUTQ USE LOW "
2270 "COL SESS PGID STATE\n");
2272 TAILQ_FOREACH(tp, &tty_list, t_list) {
2273 isiz = tp->t_inq.ti_nblocks * TTYINQ_DATASIZE;
2274 osiz = tp->t_outq.to_nblocks * TTYOUTQ_DATASIZE;
2276 db_printf("%p %10s %5zu %4u %4u %4zu %5zu %4u %4zu %5u %5d "
2277 "%5d ", tp, tty_devname(tp), isiz,
2278 tp->t_inq.ti_linestart - tp->t_inq.ti_begin,
2279 tp->t_inq.ti_end - tp->t_inq.ti_linestart,
2280 isiz - tp->t_inlow, osiz,
2281 tp->t_outq.to_end - tp->t_outq.to_begin,
2282 osiz - tp->t_outlow, MIN(tp->t_column, 99999),
2283 tp->t_session ? tp->t_session->s_sid : 0,
2284 tp->t_pgrp ? tp->t_pgrp->pg_id : 0);
2287 for (i = j = 0; ttystates[i].flag; i++)
2288 if (tp->t_flags & ttystates[i].flag) {
2289 db_printf("%c", ttystates[i].val);