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 || 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 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)
181 if (tty_gone(tp) || !tty_opened(tp)) {
182 /* Device is already gone. */
191 ttydev_leave(struct tty *tp)
194 tty_lock_assert(tp, MA_OWNED);
196 if (tty_opened(tp) || tp->t_flags & TF_OPENCLOSE) {
197 /* Device is still opened somewhere. */
202 tp->t_flags |= TF_OPENCLOSE;
204 /* Stop asynchronous I/O. */
205 funsetown(&tp->t_sigio);
207 /* Remove console TTY. */
211 /* Drain any output. */
212 MPASS((tp->t_flags & TF_STOPPED) == 0);
218 /* Free i/o queues now since they might be large. */
219 ttyinq_free(&tp->t_inq);
221 ttyoutq_free(&tp->t_outq);
224 knlist_clear(&tp->t_inpoll.si_note, 1);
225 knlist_clear(&tp->t_outpoll.si_note, 1);
230 tp->t_flags &= ~TF_OPENCLOSE;
231 cv_broadcast(&tp->t_dcdwait);
236 * Operations that are exposed through the character device in /dev.
239 ttydev_open(struct cdev *dev, int oflags, int devtype __unused,
249 /* Device is already gone. */
255 * Block when other processes are currently opening or closing
258 while (tp->t_flags & TF_OPENCLOSE) {
259 error = tty_wait(tp, &tp->t_dcdwait);
265 tp->t_flags |= TF_OPENCLOSE;
268 * Make sure the "tty" and "cua" device cannot be opened at the
269 * same time. The console is a "tty" device.
271 if (TTY_CALLOUT(tp, dev)) {
272 if (tp->t_flags & (TF_OPENED_CONS | TF_OPENED_IN)) {
277 if (tp->t_flags & TF_OPENED_OUT) {
283 if (tp->t_flags & TF_EXCLUDE && priv_check(td, PRIV_TTY_EXCLUSIVE)) {
288 if (!tty_opened(tp)) {
289 /* Set proper termios flags. */
290 if (TTY_CALLOUT(tp, dev))
291 tp->t_termios = tp->t_termios_init_out;
293 tp->t_termios = tp->t_termios_init_in;
294 ttydevsw_param(tp, &tp->t_termios);
295 /* Prevent modem control on callout devices and /dev/console. */
296 if (TTY_CALLOUT(tp, dev) || dev == dev_console)
297 tp->t_termios.c_cflag |= CLOCAL;
299 ttydevsw_modem(tp, SER_DTR|SER_RTS, 0);
301 error = ttydevsw_open(tp);
306 tty_watermarks(tp); /* XXXGL: drops lock */
309 /* Wait for Carrier Detect. */
310 if ((oflags & O_NONBLOCK) == 0 &&
311 (tp->t_termios.c_cflag & CLOCAL) == 0) {
312 while ((ttydevsw_modem(tp, 0, 0) & SER_DCD) == 0) {
313 error = tty_wait(tp, &tp->t_dcdwait);
319 if (dev == dev_console)
320 tp->t_flags |= TF_OPENED_CONS;
321 else if (TTY_CALLOUT(tp, dev))
322 tp->t_flags |= TF_OPENED_OUT;
324 tp->t_flags |= TF_OPENED_IN;
325 MPASS((tp->t_flags & (TF_OPENED_CONS | TF_OPENED_IN)) == 0 ||
326 (tp->t_flags & TF_OPENED_OUT) == 0);
328 done: tp->t_flags &= ~TF_OPENCLOSE;
329 cv_broadcast(&tp->t_dcdwait);
336 ttydev_close(struct cdev *dev, int fflag, int devtype __unused,
337 struct thread *td __unused)
339 struct tty *tp = dev->si_drv1;
344 * Don't actually close the device if it is being used as the
347 MPASS((tp->t_flags & (TF_OPENED_CONS | TF_OPENED_IN)) == 0 ||
348 (tp->t_flags & TF_OPENED_OUT) == 0);
349 if (dev == dev_console)
350 tp->t_flags &= ~TF_OPENED_CONS;
352 tp->t_flags &= ~(TF_OPENED_IN|TF_OPENED_OUT);
354 if (tp->t_flags & TF_OPENED) {
360 * This can only be called once. The callin and the callout
361 * devices cannot be opened at the same time.
363 tp->t_flags &= ~(TF_EXCLUDE|TF_STOPPED);
365 /* Properly wake up threads that are stuck - revoke(). */
367 tty_wakeup(tp, FREAD|FWRITE);
368 cv_broadcast(&tp->t_bgwait);
369 cv_broadcast(&tp->t_dcdwait);
377 tty_is_ctty(struct tty *tp, struct proc *p)
380 tty_lock_assert(tp, MA_OWNED);
382 return (p->p_session == tp->t_session && p->p_flag & P_CONTROLT);
386 tty_wait_background(struct tty *tp, struct thread *td, int sig)
388 struct proc *p = td->td_proc;
393 MPASS(sig == SIGTTIN || sig == SIGTTOU);
394 tty_lock_assert(tp, MA_OWNED);
399 * The process should only sleep, when:
400 * - This terminal is the controling terminal
401 * - Its process group is not the foreground process
403 * - The parent process isn't waiting for the child to
405 * - the signal to send to the process isn't masked
407 if (!tty_is_ctty(tp, p) || p->p_pgrp == tp->t_pgrp) {
408 /* Allow the action to happen. */
413 if (SIGISMEMBER(p->p_sigacts->ps_sigignore, sig) ||
414 SIGISMEMBER(td->td_sigmask, sig)) {
415 /* Only allow them in write()/ioctl(). */
417 return (sig == SIGTTOU ? 0 : EIO);
421 if (p->p_flag & P_PPWAIT || pg->pg_jobc == 0) {
422 /* Don't allow the action to happen. */
429 * Send the signal and sleep until we're the new
430 * foreground process group.
434 ksi.ksi_code = SI_KERNEL;
439 pgsignal(pg, ksi.ksi_signo, 1, &ksi);
442 error = tty_wait(tp, &tp->t_bgwait);
449 ttydev_read(struct cdev *dev, struct uio *uio, int ioflag)
451 struct tty *tp = dev->si_drv1;
454 error = ttydev_enter(tp);
457 error = ttydisc_read(tp, uio, ioflag);
461 * The read() call should not throw an error when the device is
462 * being destroyed. Silently convert it to an EOF.
464 done: if (error == ENXIO)
470 ttydev_write(struct cdev *dev, struct uio *uio, int ioflag)
472 struct tty *tp = dev->si_drv1;
475 error = ttydev_enter(tp);
479 if (tp->t_termios.c_lflag & TOSTOP) {
480 error = tty_wait_background(tp, curthread, SIGTTOU);
485 if (ioflag & IO_NDELAY && tp->t_flags & TF_BUSY_OUT) {
486 /* Allow non-blocking writes to bypass serialization. */
487 error = ttydisc_write(tp, uio, ioflag);
489 /* Serialize write() calls. */
490 while (tp->t_flags & TF_BUSY_OUT) {
491 error = tty_wait(tp, &tp->t_outserwait);
496 tp->t_flags |= TF_BUSY_OUT;
497 error = ttydisc_write(tp, uio, ioflag);
498 tp->t_flags &= ~TF_BUSY_OUT;
499 cv_signal(&tp->t_outserwait);
502 done: tty_unlock(tp);
507 ttydev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
510 struct tty *tp = dev->si_drv1;
513 error = ttydev_enter(tp);
548 #endif /* COMPAT_43TTY */
550 * If the ioctl() causes the TTY to be modified, let it
551 * wait in the background.
553 error = tty_wait_background(tp, curthread, SIGTTOU);
558 if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
559 struct termios *old = &tp->t_termios;
560 struct termios *new = (struct termios *)data;
561 struct termios *lock = TTY_CALLOUT(tp, dev) ?
562 &tp->t_termios_lock_out : &tp->t_termios_lock_in;
566 * Lock state devices. Just overwrite the values of the
567 * commands that are currently in use.
569 new->c_iflag = (old->c_iflag & lock->c_iflag) |
570 (new->c_iflag & ~lock->c_iflag);
571 new->c_oflag = (old->c_oflag & lock->c_oflag) |
572 (new->c_oflag & ~lock->c_oflag);
573 new->c_cflag = (old->c_cflag & lock->c_cflag) |
574 (new->c_cflag & ~lock->c_cflag);
575 new->c_lflag = (old->c_lflag & lock->c_lflag) |
576 (new->c_lflag & ~lock->c_lflag);
577 for (cc = 0; cc < NCCS; ++cc)
579 new->c_cc[cc] = old->c_cc[cc];
581 new->c_ispeed = old->c_ispeed;
583 new->c_ospeed = old->c_ospeed;
586 error = tty_ioctl(tp, cmd, data, fflag, td);
587 done: tty_unlock(tp);
593 ttydev_poll(struct cdev *dev, int events, struct thread *td)
595 struct tty *tp = dev->si_drv1;
596 int error, revents = 0;
598 error = ttydev_enter(tp);
600 return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
602 if (events & (POLLIN|POLLRDNORM)) {
603 /* See if we can read something. */
604 if (ttydisc_read_poll(tp) > 0)
605 revents |= events & (POLLIN|POLLRDNORM);
608 if (tp->t_flags & TF_ZOMBIE) {
609 /* Hangup flag on zombie state. */
611 } else if (events & (POLLOUT|POLLWRNORM)) {
612 /* See if we can write something. */
613 if (ttydisc_write_poll(tp) > 0)
614 revents |= events & (POLLOUT|POLLWRNORM);
618 if (events & (POLLIN|POLLRDNORM))
619 selrecord(td, &tp->t_inpoll);
620 if (events & (POLLOUT|POLLWRNORM))
621 selrecord(td, &tp->t_outpoll);
630 ttydev_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
631 int nprot, vm_memattr_t *memattr)
633 struct tty *tp = dev->si_drv1;
636 /* Handle mmap() through the driver. */
638 error = ttydev_enter(tp);
641 error = ttydevsw_mmap(tp, offset, paddr, nprot, memattr);
652 tty_kqops_read_detach(struct knote *kn)
654 struct tty *tp = kn->kn_hook;
656 knlist_remove(&tp->t_inpoll.si_note, kn, 0);
660 tty_kqops_read_event(struct knote *kn, long hint __unused)
662 struct tty *tp = kn->kn_hook;
664 tty_lock_assert(tp, MA_OWNED);
666 if (tty_gone(tp) || tp->t_flags & TF_ZOMBIE) {
667 kn->kn_flags |= EV_EOF;
670 kn->kn_data = ttydisc_read_poll(tp);
671 return (kn->kn_data > 0);
676 tty_kqops_write_detach(struct knote *kn)
678 struct tty *tp = kn->kn_hook;
680 knlist_remove(&tp->t_outpoll.si_note, kn, 0);
684 tty_kqops_write_event(struct knote *kn, long hint __unused)
686 struct tty *tp = kn->kn_hook;
688 tty_lock_assert(tp, MA_OWNED);
691 kn->kn_flags |= EV_EOF;
694 kn->kn_data = ttydisc_write_poll(tp);
695 return (kn->kn_data > 0);
699 static struct filterops tty_kqops_read = {
701 .f_detach = tty_kqops_read_detach,
702 .f_event = tty_kqops_read_event,
705 static struct filterops tty_kqops_write = {
707 .f_detach = tty_kqops_write_detach,
708 .f_event = tty_kqops_write_event,
712 ttydev_kqfilter(struct cdev *dev, struct knote *kn)
714 struct tty *tp = dev->si_drv1;
717 error = ttydev_enter(tp);
721 switch (kn->kn_filter) {
724 kn->kn_fop = &tty_kqops_read;
725 knlist_add(&tp->t_inpoll.si_note, kn, 1);
729 kn->kn_fop = &tty_kqops_write;
730 knlist_add(&tp->t_outpoll.si_note, kn, 1);
741 static struct cdevsw ttydev_cdevsw = {
742 .d_version = D_VERSION,
743 .d_open = ttydev_open,
744 .d_close = ttydev_close,
745 .d_read = ttydev_read,
746 .d_write = ttydev_write,
747 .d_ioctl = ttydev_ioctl,
748 .d_kqfilter = ttydev_kqfilter,
749 .d_poll = ttydev_poll,
750 .d_mmap = ttydev_mmap,
756 * Init/lock-state devices
760 ttyil_open(struct cdev *dev, int oflags __unused, int devtype __unused,
777 ttyil_close(struct cdev *dev __unused, int flag __unused, int mode __unused,
778 struct thread *td __unused)
785 ttyil_rdwr(struct cdev *dev __unused, struct uio *uio __unused,
793 ttyil_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
796 struct tty *tp = dev->si_drv1;
805 error = ttydevsw_cioctl(tp, dev2unit(dev), cmd, data, td);
806 if (error != ENOIOCTL)
812 /* Obtain terminal flags through tcgetattr(). */
813 *(struct termios*)data = *(struct termios*)dev->si_drv2;
816 /* Set terminal flags through tcsetattr(). */
817 error = priv_check(td, PRIV_TTY_SETA);
820 *(struct termios*)dev->si_drv2 = *(struct termios*)data;
823 *(int *)data = TTYDISC;
826 bzero(data, sizeof(struct winsize));
832 done: tty_unlock(tp);
836 static struct cdevsw ttyil_cdevsw = {
837 .d_version = D_VERSION,
838 .d_open = ttyil_open,
839 .d_close = ttyil_close,
840 .d_read = ttyil_rdwr,
841 .d_write = ttyil_rdwr,
842 .d_ioctl = ttyil_ioctl,
848 tty_init_termios(struct tty *tp)
850 struct termios *t = &tp->t_termios_init_in;
852 t->c_cflag = TTYDEF_CFLAG;
853 t->c_iflag = TTYDEF_IFLAG;
854 t->c_lflag = TTYDEF_LFLAG;
855 t->c_oflag = TTYDEF_OFLAG;
856 t->c_ispeed = TTYDEF_SPEED;
857 t->c_ospeed = TTYDEF_SPEED;
858 memcpy(&t->c_cc, ttydefchars, sizeof ttydefchars);
860 tp->t_termios_init_out = *t;
864 tty_init_console(struct tty *tp, speed_t s)
866 struct termios *ti = &tp->t_termios_init_in;
867 struct termios *to = &tp->t_termios_init_out;
870 ti->c_ispeed = ti->c_ospeed = s;
871 to->c_ispeed = to->c_ospeed = s;
874 ti->c_cflag |= CLOCAL;
875 to->c_cflag |= CLOCAL;
879 * Standard device routine implementations, mostly meant for
880 * pseudo-terminal device drivers. When a driver creates a new terminal
881 * device class, missing routines are patched.
885 ttydevsw_defopen(struct tty *tp __unused)
892 ttydevsw_defclose(struct tty *tp __unused)
898 ttydevsw_defoutwakeup(struct tty *tp __unused)
901 panic("Terminal device has output, while not implemented");
905 ttydevsw_definwakeup(struct tty *tp __unused)
911 ttydevsw_defioctl(struct tty *tp __unused, u_long cmd __unused,
912 caddr_t data __unused, struct thread *td __unused)
919 ttydevsw_defcioctl(struct tty *tp __unused, int unit __unused,
920 u_long cmd __unused, caddr_t data __unused, struct thread *td __unused)
927 ttydevsw_defparam(struct tty *tp __unused, struct termios *t)
931 * Allow the baud rate to be adjusted for pseudo-devices, but at
932 * least restrict it to 115200 to prevent excessive buffer
933 * usage. Also disallow 0, to prevent foot shooting.
935 if (t->c_ispeed < B50)
937 else if (t->c_ispeed > B115200)
938 t->c_ispeed = B115200;
939 if (t->c_ospeed < B50)
941 else if (t->c_ospeed > B115200)
942 t->c_ospeed = B115200;
949 ttydevsw_defmodem(struct tty *tp __unused, int sigon __unused,
953 /* Simulate a carrier to make the TTY layer happy. */
958 ttydevsw_defmmap(struct tty *tp __unused, vm_ooffset_t offset __unused,
959 vm_paddr_t *paddr __unused, int nprot __unused,
960 vm_memattr_t *memattr __unused)
967 ttydevsw_defpktnotify(struct tty *tp __unused, char event __unused)
973 ttydevsw_deffree(void *softc __unused)
976 panic("Terminal device freed without a free-handler");
980 ttydevsw_defbusy(struct tty *tp __unused)
987 * TTY allocation and deallocation. TTY devices can be deallocated when
988 * the driver doesn't use it anymore, when the TTY isn't a session's
989 * controlling TTY and when the device node isn't opened through devfs.
993 tty_alloc(struct ttydevsw *tsw, void *sc)
996 return (tty_alloc_mutex(tsw, sc, NULL));
1000 tty_alloc_mutex(struct ttydevsw *tsw, void *sc, struct mtx *mutex)
1004 /* Make sure the driver defines all routines. */
1005 #define PATCH_FUNC(x) do { \
1006 if (tsw->tsw_ ## x == NULL) \
1007 tsw->tsw_ ## x = ttydevsw_def ## x; \
1011 PATCH_FUNC(outwakeup);
1012 PATCH_FUNC(inwakeup);
1018 PATCH_FUNC(pktnotify);
1023 tp = malloc(sizeof(struct tty), M_TTY, M_WAITOK|M_ZERO);
1025 tp->t_devswsoftc = sc;
1026 tp->t_flags = tsw->tsw_flags;
1028 tty_init_termios(tp);
1030 cv_init(&tp->t_inwait, "ttyin");
1031 cv_init(&tp->t_outwait, "ttyout");
1032 cv_init(&tp->t_outserwait, "ttyosr");
1033 cv_init(&tp->t_bgwait, "ttybg");
1034 cv_init(&tp->t_dcdwait, "ttydcd");
1036 /* Allow drivers to use a custom mutex to lock the TTY. */
1037 if (mutex != NULL) {
1040 tp->t_mtx = &tp->t_mtxobj;
1041 mtx_init(&tp->t_mtxobj, "ttymtx", NULL, MTX_DEF);
1044 knlist_init_mtx(&tp->t_inpoll.si_note, tp->t_mtx);
1045 knlist_init_mtx(&tp->t_outpoll.si_note, tp->t_mtx);
1051 tty_dealloc(void *arg)
1053 struct tty *tp = arg;
1056 * ttyydev_leave() usually frees the i/o queues earlier, but it is
1057 * not always called between queue allocation and here. The queues
1058 * may be allocated by ioctls on a pty control device without the
1059 * corresponding pty slave device ever being open, or after it is
1062 ttyinq_free(&tp->t_inq);
1063 ttyoutq_free(&tp->t_outq);
1064 seldrain(&tp->t_inpoll);
1065 seldrain(&tp->t_outpoll);
1066 knlist_destroy(&tp->t_inpoll.si_note);
1067 knlist_destroy(&tp->t_outpoll.si_note);
1069 cv_destroy(&tp->t_inwait);
1070 cv_destroy(&tp->t_outwait);
1071 cv_destroy(&tp->t_bgwait);
1072 cv_destroy(&tp->t_dcdwait);
1073 cv_destroy(&tp->t_outserwait);
1075 if (tp->t_mtx == &tp->t_mtxobj)
1076 mtx_destroy(&tp->t_mtxobj);
1082 tty_rel_free(struct tty *tp)
1086 tty_lock_assert(tp, MA_OWNED);
1088 #define TF_ACTIVITY (TF_GONE|TF_OPENED|TF_HOOK|TF_OPENCLOSE)
1089 if (tp->t_sessioncnt != 0 || (tp->t_flags & TF_ACTIVITY) != TF_GONE) {
1090 /* TTY is still in use. */
1095 /* TTY can be deallocated. */
1101 sx_xlock(&tty_list_sx);
1102 TAILQ_REMOVE(&tty_list, tp, t_list);
1104 sx_xunlock(&tty_list_sx);
1105 destroy_dev_sched_cb(dev, tty_dealloc, tp);
1110 tty_rel_pgrp(struct tty *tp, struct pgrp *pg)
1113 MPASS(tp->t_sessioncnt > 0);
1114 tty_lock_assert(tp, MA_OWNED);
1116 if (tp->t_pgrp == pg)
1123 tty_rel_sess(struct tty *tp, struct session *sess)
1126 MPASS(tp->t_sessioncnt > 0);
1128 /* Current session has left. */
1129 if (tp->t_session == sess) {
1130 tp->t_session = NULL;
1131 MPASS(tp->t_pgrp == NULL);
1138 tty_rel_gone(struct tty *tp)
1141 MPASS(!tty_gone(tp));
1143 /* Simulate carrier removal. */
1144 ttydisc_modem(tp, 0);
1146 /* Wake up all blocked threads. */
1147 tty_wakeup(tp, FREAD|FWRITE);
1148 cv_broadcast(&tp->t_bgwait);
1149 cv_broadcast(&tp->t_dcdwait);
1151 tp->t_flags |= TF_GONE;
1156 * Exposing information about current TTY's through sysctl
1160 tty_to_xtty(struct tty *tp, struct xtty *xt)
1163 tty_lock_assert(tp, MA_OWNED);
1165 xt->xt_size = sizeof(struct xtty);
1166 xt->xt_insize = ttyinq_getsize(&tp->t_inq);
1167 xt->xt_incc = ttyinq_bytescanonicalized(&tp->t_inq);
1168 xt->xt_inlc = ttyinq_bytesline(&tp->t_inq);
1169 xt->xt_inlow = tp->t_inlow;
1170 xt->xt_outsize = ttyoutq_getsize(&tp->t_outq);
1171 xt->xt_outcc = ttyoutq_bytesused(&tp->t_outq);
1172 xt->xt_outlow = tp->t_outlow;
1173 xt->xt_column = tp->t_column;
1174 xt->xt_pgid = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1175 xt->xt_sid = tp->t_session ? tp->t_session->s_sid : 0;
1176 xt->xt_flags = tp->t_flags;
1177 xt->xt_dev = tp->t_dev ? dev2udev(tp->t_dev) : NODEV;
1181 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
1183 unsigned long lsize;
1184 struct xtty *xtlist, *xt;
1188 sx_slock(&tty_list_sx);
1189 lsize = tty_list_count * sizeof(struct xtty);
1191 sx_sunlock(&tty_list_sx);
1195 xtlist = xt = malloc(lsize, M_TTY, M_WAITOK);
1197 TAILQ_FOREACH(tp, &tty_list, t_list) {
1199 tty_to_xtty(tp, xt);
1203 sx_sunlock(&tty_list_sx);
1205 error = SYSCTL_OUT(req, xtlist, lsize);
1206 free(xtlist, M_TTY);
1210 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
1211 0, 0, sysctl_kern_ttys, "S,xtty", "List of TTYs");
1214 * Device node creation. Device has been set up, now we can expose it to
1219 tty_vmakedevf(struct tty *tp, struct ucred *cred, int flags,
1220 const char *fmt, va_list ap)
1222 struct make_dev_args args;
1223 struct cdev *dev, *init, *lock, *cua, *cinit, *clock;
1224 const char *prefix = "tty";
1225 char name[SPECNAMELEN - 3]; /* for "tty" and "cua". */
1231 /* Remove "tty" prefix from devices like PTY's. */
1232 if (tp->t_flags & TF_NOPREFIX)
1235 vsnrprintf(name, sizeof name, 32, fmt, ap);
1238 /* System device. */
1241 mode = S_IRUSR|S_IWUSR;
1244 uid = cred->cr_ruid;
1246 mode = S_IRUSR|S_IWUSR|S_IWGRP;
1249 flags = flags & TTYMK_CLONING ? MAKEDEV_REF : 0;
1250 flags |= MAKEDEV_CHECKNAME;
1252 /* Master call-in device. */
1253 make_dev_args_init(&args);
1254 args.mda_flags = flags;
1255 args.mda_devsw = &ttydev_cdevsw;
1259 args.mda_mode = mode;
1260 args.mda_si_drv1 = tp;
1261 error = make_dev_s(&args, &dev, "%s%s", prefix, name);
1266 init = lock = cua = cinit = clock = NULL;
1268 /* Slave call-in devices. */
1269 if (tp->t_flags & TF_INITLOCK) {
1270 args.mda_devsw = &ttyil_cdevsw;
1271 args.mda_unit = TTYUNIT_INIT;
1272 args.mda_si_drv1 = tp;
1273 args.mda_si_drv2 = &tp->t_termios_init_in;
1274 error = make_dev_s(&args, &init, "%s%s.init", prefix, name);
1277 dev_depends(dev, init);
1279 args.mda_unit = TTYUNIT_LOCK;
1280 args.mda_si_drv2 = &tp->t_termios_lock_in;
1281 error = make_dev_s(&args, &lock, "%s%s.lock", prefix, name);
1284 dev_depends(dev, lock);
1287 /* Call-out devices. */
1288 if (tp->t_flags & TF_CALLOUT) {
1289 make_dev_args_init(&args);
1290 args.mda_flags = flags;
1291 args.mda_devsw = &ttydev_cdevsw;
1293 args.mda_uid = UID_UUCP;
1294 args.mda_gid = GID_DIALER;
1295 args.mda_mode = 0660;
1296 args.mda_unit = TTYUNIT_CALLOUT;
1297 args.mda_si_drv1 = tp;
1298 error = make_dev_s(&args, &cua, "cua%s", name);
1301 dev_depends(dev, cua);
1303 /* Slave call-out devices. */
1304 if (tp->t_flags & TF_INITLOCK) {
1305 args.mda_devsw = &ttyil_cdevsw;
1306 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_INIT;
1307 args.mda_si_drv2 = &tp->t_termios_init_out;
1308 error = make_dev_s(&args, &cinit, "cua%s.init", name);
1311 dev_depends(dev, cinit);
1313 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_LOCK;
1314 args.mda_si_drv2 = &tp->t_termios_lock_out;
1315 error = make_dev_s(&args, &clock, "cua%s.lock", name);
1318 dev_depends(dev, clock);
1322 sx_xlock(&tty_list_sx);
1323 TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
1325 sx_xunlock(&tty_list_sx);
1344 tty_makedevf(struct tty *tp, struct ucred *cred, int flags,
1345 const char *fmt, ...)
1351 error = tty_vmakedevf(tp, cred, flags, fmt, ap);
1358 tty_makedev(struct tty *tp, struct ucred *cred, const char *fmt, ...)
1363 (void) tty_vmakedevf(tp, cred, 0, fmt, ap);
1368 * Signalling processes.
1372 tty_signal_sessleader(struct tty *tp, int sig)
1376 tty_lock_assert(tp, MA_OWNED);
1377 MPASS(sig >= 1 && sig < NSIG);
1379 /* Make signals start output again. */
1380 tp->t_flags &= ~TF_STOPPED;
1382 if (tp->t_session != NULL && tp->t_session->s_leader != NULL) {
1383 p = tp->t_session->s_leader;
1385 kern_psignal(p, sig);
1391 tty_signal_pgrp(struct tty *tp, int sig)
1395 tty_lock_assert(tp, MA_OWNED);
1396 MPASS(sig >= 1 && sig < NSIG);
1398 /* Make signals start output again. */
1399 tp->t_flags &= ~TF_STOPPED;
1401 if (sig == SIGINFO && !(tp->t_termios.c_lflag & NOKERNINFO))
1403 if (tp->t_pgrp != NULL) {
1404 ksiginfo_init(&ksi);
1405 ksi.ksi_signo = sig;
1406 ksi.ksi_code = SI_KERNEL;
1407 PGRP_LOCK(tp->t_pgrp);
1408 pgsignal(tp->t_pgrp, sig, 1, &ksi);
1409 PGRP_UNLOCK(tp->t_pgrp);
1414 tty_wakeup(struct tty *tp, int flags)
1417 if (tp->t_flags & TF_ASYNC && tp->t_sigio != NULL)
1418 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
1420 if (flags & FWRITE) {
1421 cv_broadcast(&tp->t_outwait);
1422 selwakeup(&tp->t_outpoll);
1423 KNOTE_LOCKED(&tp->t_outpoll.si_note, 0);
1425 if (flags & FREAD) {
1426 cv_broadcast(&tp->t_inwait);
1427 selwakeup(&tp->t_inpoll);
1428 KNOTE_LOCKED(&tp->t_inpoll.si_note, 0);
1433 tty_wait(struct tty *tp, struct cv *cv)
1436 int revokecnt = tp->t_revokecnt;
1438 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1439 MPASS(!tty_gone(tp));
1441 error = cv_wait_sig(cv, tp->t_mtx);
1443 /* Bail out when the device slipped away. */
1447 /* Restart the system call when we may have been revoked. */
1448 if (tp->t_revokecnt != revokecnt)
1455 tty_timedwait(struct tty *tp, struct cv *cv, int hz)
1458 int revokecnt = tp->t_revokecnt;
1460 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1461 MPASS(!tty_gone(tp));
1463 error = cv_timedwait_sig(cv, tp->t_mtx, hz);
1465 /* Bail out when the device slipped away. */
1469 /* Restart the system call when we may have been revoked. */
1470 if (tp->t_revokecnt != revokecnt)
1477 tty_flush(struct tty *tp, int flags)
1480 if (flags & FWRITE) {
1481 tp->t_flags &= ~TF_HIWAT_OUT;
1482 ttyoutq_flush(&tp->t_outq);
1483 tty_wakeup(tp, FWRITE);
1484 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHWRITE);
1486 if (flags & FREAD) {
1487 tty_hiwat_in_unblock(tp);
1488 ttyinq_flush(&tp->t_inq);
1489 ttydevsw_inwakeup(tp);
1490 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHREAD);
1495 tty_set_winsize(struct tty *tp, const struct winsize *wsz)
1498 if (memcmp(&tp->t_winsize, wsz, sizeof(*wsz)) == 0)
1500 tp->t_winsize = *wsz;
1501 tty_signal_pgrp(tp, SIGWINCH);
1505 tty_generic_ioctl(struct tty *tp, u_long cmd, void *data, int fflag,
1513 * The SER_* and TIOCM_* flags are the same, but one bit
1514 * shifted. I don't know why.
1517 ttydevsw_modem(tp, SER_DTR, 0);
1520 ttydevsw_modem(tp, 0, SER_DTR);
1523 int bits = *(int *)data;
1525 (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1,
1526 ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1530 int bits = *(int *)data;
1531 ttydevsw_modem(tp, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1, 0);
1535 int bits = *(int *)data;
1536 ttydevsw_modem(tp, 0, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1540 *(int *)data = TIOCM_LE + (ttydevsw_modem(tp, 0, 0) << 1);
1545 tp->t_flags |= TF_ASYNC;
1547 tp->t_flags &= ~TF_ASYNC;
1550 /* This device supports non-blocking operation. */
1553 *(int *)data = ttyinq_bytescanonicalized(&tp->t_inq);
1557 *(int *)data = ttyoutq_bytesused(&tp->t_outq);
1560 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1561 /* Not allowed to set ownership. */
1564 /* Temporarily unlock the TTY to set ownership. */
1566 error = fsetown(*(int *)data, &tp->t_sigio);
1570 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1571 /* Not allowed to set ownership. */
1574 /* Get ownership. */
1575 *(int *)data = fgetown(&tp->t_sigio);
1578 /* Obtain terminal flags through tcgetattr(). */
1579 *(struct termios*)data = tp->t_termios;
1584 struct termios *t = data;
1587 * Who makes up these funny rules? According to POSIX,
1588 * input baud rate is set equal to the output baud rate
1591 if (t->c_ispeed == 0)
1592 t->c_ispeed = t->c_ospeed;
1594 /* Discard any unsupported bits. */
1595 t->c_iflag &= TTYSUP_IFLAG;
1596 t->c_oflag &= TTYSUP_OFLAG;
1597 t->c_lflag &= TTYSUP_LFLAG;
1598 t->c_cflag &= TTYSUP_CFLAG;
1600 /* Set terminal flags through tcsetattr(). */
1601 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1602 error = tty_drain(tp, 0);
1605 if (cmd == TIOCSETAF)
1606 tty_flush(tp, FREAD);
1610 * Only call param() when the flags really change.
1612 if ((t->c_cflag & CIGNORE) == 0 &&
1613 (tp->t_termios.c_cflag != t->c_cflag ||
1614 ((tp->t_termios.c_iflag ^ t->c_iflag) &
1615 (IXON|IXOFF|IXANY)) ||
1616 tp->t_termios.c_ispeed != t->c_ispeed ||
1617 tp->t_termios.c_ospeed != t->c_ospeed)) {
1618 error = ttydevsw_param(tp, t);
1624 tp->t_termios.c_cflag = t->c_cflag & ~CIGNORE;
1625 tp->t_termios.c_ispeed = t->c_ispeed;
1626 tp->t_termios.c_ospeed = t->c_ospeed;
1628 /* Baud rate has changed - update watermarks. */
1632 /* Copy new non-device driver parameters. */
1633 tp->t_termios.c_iflag = t->c_iflag;
1634 tp->t_termios.c_oflag = t->c_oflag;
1635 tp->t_termios.c_lflag = t->c_lflag;
1636 memcpy(&tp->t_termios.c_cc, t->c_cc, sizeof t->c_cc);
1638 ttydisc_optimize(tp);
1640 if ((t->c_lflag & ICANON) == 0) {
1642 * When in non-canonical mode, wake up all
1643 * readers. Canonicalize any partial input. VMIN
1644 * and VTIME could also be adjusted.
1646 ttyinq_canonicalize(&tp->t_inq);
1647 tty_wakeup(tp, FREAD);
1651 * For packet mode: notify the PTY consumer that VSTOP
1652 * and VSTART may have been changed.
1654 if (tp->t_termios.c_iflag & IXON &&
1655 tp->t_termios.c_cc[VSTOP] == CTRL('S') &&
1656 tp->t_termios.c_cc[VSTART] == CTRL('Q'))
1657 ttydevsw_pktnotify(tp, TIOCPKT_DOSTOP);
1659 ttydevsw_pktnotify(tp, TIOCPKT_NOSTOP);
1663 /* For compatibility - we only support TTYDISC. */
1664 *(int *)data = TTYDISC;
1667 if (!tty_is_ctty(tp, td->td_proc))
1670 if (tp->t_pgrp != NULL)
1671 *(int *)data = tp->t_pgrp->pg_id;
1673 *(int *)data = NO_PID;
1676 if (!tty_is_ctty(tp, td->td_proc))
1679 MPASS(tp->t_session);
1680 *(int *)data = tp->t_session->s_sid;
1683 struct proc *p = td->td_proc;
1685 /* XXX: This looks awful. */
1687 sx_xlock(&proctree_lock);
1690 if (!SESS_LEADER(p)) {
1691 /* Only the session leader may do this. */
1692 sx_xunlock(&proctree_lock);
1696 if (tp->t_session != NULL && tp->t_session == p->p_session) {
1697 /* This is already our controlling TTY. */
1698 sx_xunlock(&proctree_lock);
1702 if (p->p_session->s_ttyp != NULL ||
1703 (tp->t_session != NULL && tp->t_session->s_ttyvp != NULL &&
1704 tp->t_session->s_ttyvp->v_type != VBAD)) {
1706 * There is already a relation between a TTY and
1707 * a session, or the caller is not the session
1710 * Allow the TTY to be stolen when the vnode is
1711 * invalid, but the reference to the TTY is
1712 * still active. This allows immediate reuse of
1713 * TTYs of which the session leader has been
1714 * killed or the TTY revoked.
1716 sx_xunlock(&proctree_lock);
1720 /* Connect the session to the TTY. */
1721 tp->t_session = p->p_session;
1722 tp->t_session->s_ttyp = tp;
1724 sx_xunlock(&proctree_lock);
1726 /* Assign foreground process group. */
1727 tp->t_pgrp = p->p_pgrp;
1729 p->p_flag |= P_CONTROLT;
1738 * XXX: Temporarily unlock the TTY to locate the process
1739 * group. This code would be lot nicer if we would ever
1740 * decompose proctree_lock.
1743 sx_slock(&proctree_lock);
1744 pg = pgfind(*(int *)data);
1747 if (pg == NULL || pg->pg_session != td->td_proc->p_session) {
1748 sx_sunlock(&proctree_lock);
1755 * Determine if this TTY is the controlling TTY after
1756 * relocking the TTY.
1758 if (!tty_is_ctty(tp, td->td_proc)) {
1759 sx_sunlock(&proctree_lock);
1763 sx_sunlock(&proctree_lock);
1765 /* Wake up the background process groups. */
1766 cv_broadcast(&tp->t_bgwait);
1770 int flags = *(int *)data;
1773 flags = (FREAD|FWRITE);
1775 flags &= (FREAD|FWRITE);
1776 tty_flush(tp, flags);
1780 /* Drain TTY output. */
1781 return tty_drain(tp, 0);
1783 /* Set terminal as console TTY. */
1785 error = priv_check(td, PRIV_TTY_CONSOLE);
1790 * XXX: constty should really need to be locked!
1791 * XXX: allow disconnected constty's to be stolen!
1796 if (constty != NULL)
1802 } else if (constty == tp) {
1807 /* Obtain window size. */
1808 *(struct winsize*)data = tp->t_winsize;
1811 /* Set window size. */
1812 tty_set_winsize(tp, data);
1815 tp->t_flags |= TF_EXCLUDE;
1818 tp->t_flags &= ~TF_EXCLUDE;
1821 tp->t_flags |= TF_STOPPED;
1822 ttydevsw_pktnotify(tp, TIOCPKT_STOP);
1825 tp->t_flags &= ~TF_STOPPED;
1826 ttydevsw_outwakeup(tp);
1827 ttydevsw_pktnotify(tp, TIOCPKT_START);
1833 if ((fflag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1835 if (!tty_is_ctty(tp, td->td_proc) &&
1836 priv_check(td, PRIV_TTY_STI))
1838 ttydisc_rint(tp, *(char *)data, 0);
1839 ttydisc_rint_done(tp);
1844 return tty_ioctl_compat(tp, cmd, data, fflag, td);
1845 #else /* !COMPAT_43TTY */
1847 #endif /* COMPAT_43TTY */
1851 tty_ioctl(struct tty *tp, u_long cmd, void *data, int fflag, struct thread *td)
1855 tty_lock_assert(tp, MA_OWNED);
1860 error = ttydevsw_ioctl(tp, cmd, data, td);
1861 if (error == ENOIOCTL)
1862 error = tty_generic_ioctl(tp, cmd, data, fflag, td);
1868 tty_udev(struct tty *tp)
1872 return (dev2udev(tp->t_dev));
1878 tty_checkoutq(struct tty *tp)
1881 /* 256 bytes should be enough to print a log message. */
1882 return (ttyoutq_bytesleft(&tp->t_outq) >= 256);
1886 tty_hiwat_in_block(struct tty *tp)
1889 if ((tp->t_flags & TF_HIWAT_IN) == 0 &&
1890 tp->t_termios.c_iflag & IXOFF &&
1891 tp->t_termios.c_cc[VSTOP] != _POSIX_VDISABLE) {
1893 * Input flow control. Only enter the high watermark when we
1894 * can successfully store the VSTOP character.
1896 if (ttyoutq_write_nofrag(&tp->t_outq,
1897 &tp->t_termios.c_cc[VSTOP], 1) == 0)
1898 tp->t_flags |= TF_HIWAT_IN;
1900 /* No input flow control. */
1901 tp->t_flags |= TF_HIWAT_IN;
1906 tty_hiwat_in_unblock(struct tty *tp)
1909 if (tp->t_flags & TF_HIWAT_IN &&
1910 tp->t_termios.c_iflag & IXOFF &&
1911 tp->t_termios.c_cc[VSTART] != _POSIX_VDISABLE) {
1913 * Input flow control. Only leave the high watermark when we
1914 * can successfully store the VSTART character.
1916 if (ttyoutq_write_nofrag(&tp->t_outq,
1917 &tp->t_termios.c_cc[VSTART], 1) == 0)
1918 tp->t_flags &= ~TF_HIWAT_IN;
1920 /* No input flow control. */
1921 tp->t_flags &= ~TF_HIWAT_IN;
1925 ttydevsw_inwakeup(tp);
1929 * TTY hooks interface.
1933 ttyhook_defrint(struct tty *tp, char c, int flags)
1936 if (ttyhook_rint_bypass(tp, &c, 1) != 1)
1943 ttyhook_register(struct tty **rtp, struct proc *p, int fd, struct ttyhook *th,
1950 struct filedesc *fdp;
1951 cap_rights_t rights;
1954 /* Validate the file descriptor. */
1956 error = fget_unlocked(fdp, fd, cap_rights_init(&rights, CAP_TTYHOOK),
1960 if (fp->f_ops == &badfileops) {
1966 * Make sure the vnode is bound to a character device.
1967 * Unlocked check for the vnode type is ok there, because we
1968 * only shall prevent calling devvn_refthread on the file that
1969 * never has been opened over a character device.
1971 if (fp->f_type != DTYPE_VNODE || fp->f_vnode->v_type != VCHR) {
1976 /* Make sure it is a TTY. */
1977 cdp = devvn_refthread(fp->f_vnode, &dev, &ref);
1982 if (dev != fp->f_data) {
1986 if (cdp != &ttydev_cdevsw) {
1992 /* Try to attach the hook to the TTY. */
1995 MPASS((tp->t_hook == NULL) == ((tp->t_flags & TF_HOOK) == 0));
1996 if (tp->t_flags & TF_HOOK)
1999 tp->t_flags |= TF_HOOK;
2001 tp->t_hooksoftc = softc;
2005 /* Maybe we can switch into bypass mode now. */
2006 ttydisc_optimize(tp);
2008 /* Silently convert rint() calls to rint_bypass() when possible. */
2009 if (!ttyhook_hashook(tp, rint) && ttyhook_hashook(tp, rint_bypass))
2010 th->th_rint = ttyhook_defrint;
2012 done3: tty_unlock(tp);
2013 done2: dev_relthread(dev, ref);
2014 done1: fdrop(fp, curthread);
2019 ttyhook_unregister(struct tty *tp)
2022 tty_lock_assert(tp, MA_OWNED);
2023 MPASS(tp->t_flags & TF_HOOK);
2025 /* Disconnect the hook. */
2026 tp->t_flags &= ~TF_HOOK;
2029 /* Maybe we need to leave bypass mode. */
2030 ttydisc_optimize(tp);
2032 /* Maybe deallocate the TTY as well. */
2037 * /dev/console handling.
2041 ttyconsdev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
2045 /* System has no console device. */
2046 if (dev_console_filename == NULL)
2049 /* Look up corresponding TTY by device name. */
2050 sx_slock(&tty_list_sx);
2051 TAILQ_FOREACH(tp, &tty_list, t_list) {
2052 if (strcmp(dev_console_filename, tty_devname(tp)) == 0) {
2053 dev_console->si_drv1 = tp;
2057 sx_sunlock(&tty_list_sx);
2059 /* System console has no TTY associated. */
2060 if (dev_console->si_drv1 == NULL)
2063 return (ttydev_open(dev, oflags, devtype, td));
2067 ttyconsdev_write(struct cdev *dev, struct uio *uio, int ioflag)
2072 return (ttydev_write(dev, uio, ioflag));
2076 * /dev/console is a little different than normal TTY's. When opened,
2077 * it determines which TTY to use. When data gets written to it, it
2078 * will be logged in the kernel message buffer.
2080 static struct cdevsw ttyconsdev_cdevsw = {
2081 .d_version = D_VERSION,
2082 .d_open = ttyconsdev_open,
2083 .d_close = ttydev_close,
2084 .d_read = ttydev_read,
2085 .d_write = ttyconsdev_write,
2086 .d_ioctl = ttydev_ioctl,
2087 .d_kqfilter = ttydev_kqfilter,
2088 .d_poll = ttydev_poll,
2089 .d_mmap = ttydev_mmap,
2090 .d_name = "ttyconsdev",
2095 ttyconsdev_init(void *unused __unused)
2098 dev_console = make_dev_credf(MAKEDEV_ETERNAL, &ttyconsdev_cdevsw, 0,
2099 NULL, UID_ROOT, GID_WHEEL, 0600, "console");
2102 SYSINIT(tty, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyconsdev_init, NULL);
2105 ttyconsdev_select(const char *name)
2108 dev_console_filename = name;
2112 * Debugging routines.
2115 #include "opt_ddb.h"
2117 #include <ddb/ddb.h>
2118 #include <ddb/db_sym.h>
2120 static const struct {
2125 { TF_NOPREFIX, 'N' },
2127 { TF_INITLOCK, 'I' },
2128 { TF_CALLOUT, 'C' },
2130 /* Keep these together -> 'Oi' and 'Oo'. */
2132 { TF_OPENED_IN, 'i' },
2133 { TF_OPENED_OUT, 'o' },
2134 { TF_OPENED_CONS, 'c' },
2137 { TF_OPENCLOSE, 'B' },
2139 { TF_LITERAL, 'L' },
2141 /* Keep these together -> 'Hi' and 'Ho'. */
2143 { TF_HIWAT_IN, 'i' },
2144 { TF_HIWAT_OUT, 'o' },
2146 { TF_STOPPED, 'S' },
2147 { TF_EXCLUDE, 'X' },
2152 /* Keep these together -> 'bi' and 'bo'. */
2154 { TF_BUSY_IN, 'i' },
2155 { TF_BUSY_OUT, 'o' },
2160 #define TTY_FLAG_BITS \
2161 "\20\1NOPREFIX\2INITLOCK\3CALLOUT\4OPENED_IN" \
2162 "\5OPENED_OUT\6OPENED_CONS\7GONE\10OPENCLOSE" \
2163 "\11ASYNC\12LITERAL\13HIWAT_IN\14HIWAT_OUT" \
2164 "\15STOPPED\16EXCLUDE\17BYPASS\20ZOMBIE" \
2165 "\21HOOK\22BUSY_IN\23BUSY_OUT"
2167 #define DB_PRINTSYM(name, addr) \
2168 db_printf("%s " #name ": ", sep); \
2169 db_printsym((db_addr_t) addr, DB_STGY_ANY); \
2173 _db_show_devsw(const char *sep, const struct ttydevsw *tsw)
2176 db_printf("%sdevsw: ", sep);
2177 db_printsym((db_addr_t)tsw, DB_STGY_ANY);
2178 db_printf(" (%p)\n", tsw);
2179 DB_PRINTSYM(open, tsw->tsw_open);
2180 DB_PRINTSYM(close, tsw->tsw_close);
2181 DB_PRINTSYM(outwakeup, tsw->tsw_outwakeup);
2182 DB_PRINTSYM(inwakeup, tsw->tsw_inwakeup);
2183 DB_PRINTSYM(ioctl, tsw->tsw_ioctl);
2184 DB_PRINTSYM(param, tsw->tsw_param);
2185 DB_PRINTSYM(modem, tsw->tsw_modem);
2186 DB_PRINTSYM(mmap, tsw->tsw_mmap);
2187 DB_PRINTSYM(pktnotify, tsw->tsw_pktnotify);
2188 DB_PRINTSYM(free, tsw->tsw_free);
2192 _db_show_hooks(const char *sep, const struct ttyhook *th)
2195 db_printf("%shook: ", sep);
2196 db_printsym((db_addr_t)th, DB_STGY_ANY);
2197 db_printf(" (%p)\n", th);
2200 DB_PRINTSYM(rint, th->th_rint);
2201 DB_PRINTSYM(rint_bypass, th->th_rint_bypass);
2202 DB_PRINTSYM(rint_done, th->th_rint_done);
2203 DB_PRINTSYM(rint_poll, th->th_rint_poll);
2204 DB_PRINTSYM(getc_inject, th->th_getc_inject);
2205 DB_PRINTSYM(getc_capture, th->th_getc_capture);
2206 DB_PRINTSYM(getc_poll, th->th_getc_poll);
2207 DB_PRINTSYM(close, th->th_close);
2211 _db_show_termios(const char *name, const struct termios *t)
2214 db_printf("%s: iflag 0x%x oflag 0x%x cflag 0x%x "
2215 "lflag 0x%x ispeed %u ospeed %u\n", name,
2216 t->c_iflag, t->c_oflag, t->c_cflag, t->c_lflag,
2217 t->c_ispeed, t->c_ospeed);
2220 /* DDB command to show TTY statistics. */
2221 DB_SHOW_COMMAND(tty, db_show_tty)
2226 db_printf("usage: show tty <addr>\n");
2229 tp = (struct tty *)addr;
2231 db_printf("%p: %s\n", tp, tty_devname(tp));
2232 db_printf("\tmtx: %p\n", tp->t_mtx);
2233 db_printf("\tflags: 0x%b\n", tp->t_flags, TTY_FLAG_BITS);
2234 db_printf("\trevokecnt: %u\n", tp->t_revokecnt);
2236 /* Buffering mechanisms. */
2237 db_printf("\tinq: %p begin %u linestart %u reprint %u end %u "
2238 "nblocks %u quota %u\n", &tp->t_inq, tp->t_inq.ti_begin,
2239 tp->t_inq.ti_linestart, tp->t_inq.ti_reprint, tp->t_inq.ti_end,
2240 tp->t_inq.ti_nblocks, tp->t_inq.ti_quota);
2241 db_printf("\toutq: %p begin %u end %u nblocks %u quota %u\n",
2242 &tp->t_outq, tp->t_outq.to_begin, tp->t_outq.to_end,
2243 tp->t_outq.to_nblocks, tp->t_outq.to_quota);
2244 db_printf("\tinlow: %zu\n", tp->t_inlow);
2245 db_printf("\toutlow: %zu\n", tp->t_outlow);
2246 _db_show_termios("\ttermios", &tp->t_termios);
2247 db_printf("\twinsize: row %u col %u xpixel %u ypixel %u\n",
2248 tp->t_winsize.ws_row, tp->t_winsize.ws_col,
2249 tp->t_winsize.ws_xpixel, tp->t_winsize.ws_ypixel);
2250 db_printf("\tcolumn: %u\n", tp->t_column);
2251 db_printf("\twritepos: %u\n", tp->t_writepos);
2252 db_printf("\tcompatflags: 0x%x\n", tp->t_compatflags);
2254 /* Init/lock-state devices. */
2255 _db_show_termios("\ttermios_init_in", &tp->t_termios_init_in);
2256 _db_show_termios("\ttermios_init_out", &tp->t_termios_init_out);
2257 _db_show_termios("\ttermios_lock_in", &tp->t_termios_lock_in);
2258 _db_show_termios("\ttermios_lock_out", &tp->t_termios_lock_out);
2261 _db_show_devsw("\t", tp->t_devsw);
2262 _db_show_hooks("\t", tp->t_hook);
2265 db_printf("\tpgrp: %p gid %d jobc %d\n", tp->t_pgrp,
2266 tp->t_pgrp ? tp->t_pgrp->pg_id : 0,
2267 tp->t_pgrp ? tp->t_pgrp->pg_jobc : 0);
2268 db_printf("\tsession: %p", tp->t_session);
2269 if (tp->t_session != NULL)
2270 db_printf(" count %u leader %p tty %p sid %d login %s",
2271 tp->t_session->s_count, tp->t_session->s_leader,
2272 tp->t_session->s_ttyp, tp->t_session->s_sid,
2273 tp->t_session->s_login);
2275 db_printf("\tsessioncnt: %u\n", tp->t_sessioncnt);
2276 db_printf("\tdevswsoftc: %p\n", tp->t_devswsoftc);
2277 db_printf("\thooksoftc: %p\n", tp->t_hooksoftc);
2278 db_printf("\tdev: %p\n", tp->t_dev);
2281 /* DDB command to list TTYs. */
2282 DB_SHOW_ALL_COMMAND(ttys, db_show_all_ttys)
2288 /* Make the output look like `pstat -t'. */
2290 #if defined(__LP64__)
2293 db_printf(" LINE INQ CAN LIN LOW OUTQ USE LOW "
2294 "COL SESS PGID STATE\n");
2296 TAILQ_FOREACH(tp, &tty_list, t_list) {
2297 isiz = tp->t_inq.ti_nblocks * TTYINQ_DATASIZE;
2298 osiz = tp->t_outq.to_nblocks * TTYOUTQ_DATASIZE;
2300 db_printf("%p %10s %5zu %4u %4u %4zu %5zu %4u %4zu %5u %5d "
2301 "%5d ", tp, tty_devname(tp), isiz,
2302 tp->t_inq.ti_linestart - tp->t_inq.ti_begin,
2303 tp->t_inq.ti_end - tp->t_inq.ti_linestart,
2304 isiz - tp->t_inlow, osiz,
2305 tp->t_outq.to_end - tp->t_outq.to_begin,
2306 osiz - tp->t_outlow, MIN(tp->t_column, 99999),
2307 tp->t_session ? tp->t_session->s_sid : 0,
2308 tp->t_pgrp ? tp->t_pgrp->pg_id : 0);
2311 for (i = j = 0; ttystates[i].flag; i++)
2312 if (tp->t_flags & ttystates[i].flag) {
2313 db_printf("%c", ttystates[i].val);