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_compat.h"
35 #include <sys/param.h>
38 #include <sys/fcntl.h>
40 #include <sys/filedesc.h>
41 #include <sys/filio.h>
43 #include <sys/ioctl_compat.h>
44 #endif /* COMPAT_43TTY */
45 #include <sys/kernel.h>
46 #include <sys/limits.h>
47 #include <sys/malloc.h>
48 #include <sys/mount.h>
52 #include <sys/serial.h>
53 #include <sys/signal.h>
56 #include <sys/sysctl.h>
57 #include <sys/systm.h>
59 #include <sys/ttycom.h>
61 #include <sys/ttydefaults.h>
63 #include <sys/ucred.h>
64 #include <sys/vnode.h>
66 #include <machine/stdarg.h>
68 static MALLOC_DEFINE(M_TTY, "tty", "tty device");
70 static void tty_rel_free(struct tty *tp);
72 static TAILQ_HEAD(, tty) tty_list = TAILQ_HEAD_INITIALIZER(tty_list);
73 static struct sx tty_list_sx;
74 SX_SYSINIT(tty_list, &tty_list_sx, "tty list");
75 static unsigned int tty_list_count = 0;
77 /* Character device of /dev/console. */
78 static struct cdev *dev_console;
79 static const char *dev_console_filename;
82 * Flags that are supported and stored by this implementation.
84 #define TTYSUP_IFLAG (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK|ISTRIP|\
85 INLCR|IGNCR|ICRNL|IXON|IXOFF|IXANY|IMAXBEL)
86 #define TTYSUP_OFLAG (OPOST|ONLCR|TAB3|ONOEOT|OCRNL|ONOCR|ONLRET)
87 #define TTYSUP_LFLAG (ECHOKE|ECHOE|ECHOK|ECHO|ECHONL|ECHOPRT|\
88 ECHOCTL|ISIG|ICANON|ALTWERASE|IEXTEN|TOSTOP|\
89 FLUSHO|NOKERNINFO|NOFLSH)
90 #define TTYSUP_CFLAG (CIGNORE|CSIZE|CSTOPB|CREAD|PARENB|PARODD|\
91 HUPCL|CLOCAL|CCTS_OFLOW|CRTS_IFLOW|CDTR_IFLOW|\
92 CDSR_OFLOW|CCAR_OFLOW)
94 #define TTY_CALLOUT(tp,d) ((d) != (tp)->t_dev && (d) != dev_console)
97 * Set TTY buffer sizes.
100 #define TTYBUF_MAX 65536
103 tty_watermarks(struct tty *tp)
107 /* Provide an input buffer for 0.2 seconds of data. */
108 bs = MIN(tp->t_termios.c_ispeed / 5, TTYBUF_MAX);
109 ttyinq_setsize(&tp->t_inq, tp, bs);
111 /* Set low watermark at 10% (when 90% is available). */
112 tp->t_inlow = (ttyinq_getallocatedsize(&tp->t_inq) * 9) / 10;
114 /* Provide an ouput buffer for 0.2 seconds of data. */
115 bs = MIN(tp->t_termios.c_ospeed / 5, TTYBUF_MAX);
116 ttyoutq_setsize(&tp->t_outq, tp, bs);
118 /* Set low watermark at 10% (when 90% is available). */
119 tp->t_outlow = (ttyoutq_getallocatedsize(&tp->t_outq) * 9) / 10;
123 tty_drain(struct tty *tp)
127 if (ttyhook_hashook(tp, getc_inject))
128 /* buffer is inaccessible */
131 while (ttyoutq_bytesused(&tp->t_outq) > 0) {
132 ttydevsw_outwakeup(tp);
133 /* Could be handled synchronously. */
134 if (ttyoutq_bytesused(&tp->t_outq) == 0)
137 /* Wait for data to be drained. */
138 error = tty_wait(tp, &tp->t_outwait);
147 * Though ttydev_enter() and ttydev_leave() seem to be related, they
148 * don't have to be used together. ttydev_enter() is used by the cdev
149 * operations to prevent an actual operation from being processed when
150 * the TTY has been abandoned. ttydev_leave() is used by ttydev_open()
151 * and ttydev_close() to determine whether per-TTY data should be
156 ttydev_enter(struct tty *tp)
160 if (tty_gone(tp) || !tty_opened(tp)) {
161 /* Device is already gone. */
170 ttydev_leave(struct tty *tp)
172 tty_lock_assert(tp, MA_OWNED);
174 if (tty_opened(tp) || tp->t_flags & TF_OPENCLOSE) {
175 /* Device is still opened somewhere. */
180 tp->t_flags |= TF_OPENCLOSE;
182 /* Stop asynchronous I/O. */
183 funsetown(&tp->t_sigio);
185 /* Remove console TTY. */
189 /* Drain any output. */
190 MPASS((tp->t_flags & TF_STOPPED) == 0);
196 /* Destroy associated buffers already. */
197 ttyinq_free(&tp->t_inq);
199 ttyoutq_free(&tp->t_outq);
202 knlist_clear(&tp->t_inpoll.si_note, 1);
203 knlist_clear(&tp->t_outpoll.si_note, 1);
208 tp->t_flags &= ~TF_OPENCLOSE;
209 cv_broadcast(&tp->t_dcdwait);
214 * Operations that are exposed through the character device in /dev.
217 ttydev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
222 while ((tp = dev->si_drv1) == NULL) {
223 error = tsleep(&dev->si_drv1, PCATCH, "ttdrv1", 1);
224 if (error != EWOULDBLOCK)
230 /* Device is already gone. */
236 * Block when other processes are currently opening or closing
239 while (tp->t_flags & TF_OPENCLOSE) {
240 error = tty_wait(tp, &tp->t_dcdwait);
246 tp->t_flags |= TF_OPENCLOSE;
249 * Make sure the "tty" and "cua" device cannot be opened at the
252 if (TTY_CALLOUT(tp, dev)) {
253 if (tp->t_flags & TF_OPENED_IN) {
258 if (tp->t_flags & TF_OPENED_OUT) {
264 if (tp->t_flags & TF_EXCLUDE && priv_check(td, PRIV_TTY_EXCLUSIVE)) {
269 if (!tty_opened(tp)) {
270 /* Set proper termios flags. */
271 if (TTY_CALLOUT(tp, dev)) {
272 tp->t_termios = tp->t_termios_init_out;
274 tp->t_termios = tp->t_termios_init_in;
276 ttydevsw_param(tp, &tp->t_termios);
278 ttydevsw_modem(tp, SER_DTR|SER_RTS, 0);
280 error = ttydevsw_open(tp);
288 /* Wait for Carrier Detect. */
289 if (!TTY_CALLOUT(tp, dev) && (oflags & O_NONBLOCK) == 0 &&
290 (tp->t_termios.c_cflag & CLOCAL) == 0) {
291 while ((ttydevsw_modem(tp, 0, 0) & SER_DCD) == 0) {
292 error = tty_wait(tp, &tp->t_dcdwait);
298 if (dev == dev_console)
299 tp->t_flags |= TF_OPENED_CONS;
300 else if (TTY_CALLOUT(tp, dev))
301 tp->t_flags |= TF_OPENED_OUT;
303 tp->t_flags |= TF_OPENED_IN;
305 done: tp->t_flags &= ~TF_OPENCLOSE;
306 cv_broadcast(&tp->t_dcdwait);
313 ttydev_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
315 struct tty *tp = dev->si_drv1;
320 * Don't actually close the device if it is being used as the
323 MPASS((tp->t_flags & TF_OPENED) != TF_OPENED);
324 if (dev == dev_console)
325 tp->t_flags &= ~TF_OPENED_CONS;
327 tp->t_flags &= ~(TF_OPENED_IN|TF_OPENED_OUT);
329 if (tp->t_flags & TF_OPENED) {
335 * This can only be called once. The callin and the callout
336 * devices cannot be opened at the same time.
338 tp->t_flags &= ~(TF_EXCLUDE|TF_STOPPED);
340 /* Properly wake up threads that are stuck - revoke(). */
342 tty_wakeup(tp, FREAD|FWRITE);
343 cv_broadcast(&tp->t_bgwait);
344 cv_broadcast(&tp->t_dcdwait);
352 tty_is_ctty(struct tty *tp, struct proc *p)
354 tty_lock_assert(tp, MA_OWNED);
356 return (p->p_session == tp->t_session && p->p_flag & P_CONTROLT);
360 tty_wait_background(struct tty *tp, struct thread *td, int sig)
362 struct proc *p = td->td_proc;
367 MPASS(sig == SIGTTIN || sig == SIGTTOU);
368 tty_lock_assert(tp, MA_OWNED);
373 * The process should only sleep, when:
374 * - This terminal is the controling terminal
375 * - Its process group is not the foreground process
377 * - The parent process isn't waiting for the child to
379 * - the signal to send to the process isn't masked
381 if (!tty_is_ctty(tp, p) || p->p_pgrp == tp->t_pgrp) {
382 /* Allow the action to happen. */
387 if (SIGISMEMBER(p->p_sigacts->ps_sigignore, sig) ||
388 SIGISMEMBER(td->td_sigmask, sig)) {
389 /* Only allow them in write()/ioctl(). */
391 return (sig == SIGTTOU ? 0 : EIO);
395 if (p->p_flag & P_PPWAIT || pg->pg_jobc == 0) {
396 /* Don't allow the action to happen. */
403 * Send the signal and sleep until we're the new
404 * foreground process group.
408 ksi.ksi_code = SI_KERNEL;
413 pgsignal(pg, ksi.ksi_signo, 1, &ksi);
416 error = tty_wait(tp, &tp->t_bgwait);
423 ttydev_read(struct cdev *dev, struct uio *uio, int ioflag)
425 struct tty *tp = dev->si_drv1;
428 error = ttydev_enter(tp);
432 error = tty_wait_background(tp, curthread, SIGTTIN);
438 error = ttydisc_read(tp, uio, ioflag);
442 * The read() call should not throw an error when the device is
443 * being destroyed. Silently convert it to an EOF.
445 done: if (error == ENXIO)
451 ttydev_write(struct cdev *dev, struct uio *uio, int ioflag)
453 struct tty *tp = dev->si_drv1;
456 error = ttydev_enter(tp);
460 if (tp->t_termios.c_lflag & TOSTOP) {
461 error = tty_wait_background(tp, curthread, SIGTTOU);
466 if (ioflag & IO_NDELAY && tp->t_flags & TF_BUSY_OUT) {
467 /* Allow non-blocking writes to bypass serialization. */
468 error = ttydisc_write(tp, uio, ioflag);
470 /* Serialize write() calls. */
471 while (tp->t_flags & TF_BUSY_OUT) {
472 error = tty_wait(tp, &tp->t_outserwait);
477 tp->t_flags |= TF_BUSY_OUT;
478 error = ttydisc_write(tp, uio, ioflag);
479 tp->t_flags &= ~TF_BUSY_OUT;
480 cv_signal(&tp->t_outserwait);
483 done: tty_unlock(tp);
488 ttydev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
491 struct tty *tp = dev->si_drv1;
494 error = ttydev_enter(tp);
529 #endif /* COMPAT_43TTY */
531 * If the ioctl() causes the TTY to be modified, let it
532 * wait in the background.
534 error = tty_wait_background(tp, curthread, SIGTTOU);
539 if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
540 struct termios *old = &tp->t_termios;
541 struct termios *new = (struct termios *)data;
542 struct termios *lock = TTY_CALLOUT(tp, dev) ?
543 &tp->t_termios_lock_out : &tp->t_termios_lock_in;
547 * Lock state devices. Just overwrite the values of the
548 * commands that are currently in use.
550 new->c_iflag = (old->c_iflag & lock->c_iflag) |
551 (new->c_iflag & ~lock->c_iflag);
552 new->c_oflag = (old->c_oflag & lock->c_oflag) |
553 (new->c_oflag & ~lock->c_oflag);
554 new->c_cflag = (old->c_cflag & lock->c_cflag) |
555 (new->c_cflag & ~lock->c_cflag);
556 new->c_lflag = (old->c_lflag & lock->c_lflag) |
557 (new->c_lflag & ~lock->c_lflag);
558 for (cc = 0; cc < NCCS; ++cc)
560 new->c_cc[cc] = old->c_cc[cc];
562 new->c_ispeed = old->c_ispeed;
564 new->c_ospeed = old->c_ospeed;
567 error = tty_ioctl(tp, cmd, data, fflag, td);
568 done: tty_unlock(tp);
574 ttydev_poll(struct cdev *dev, int events, struct thread *td)
576 struct tty *tp = dev->si_drv1;
577 int error, revents = 0;
579 error = ttydev_enter(tp);
581 return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
583 if (events & (POLLIN|POLLRDNORM)) {
584 /* See if we can read something. */
585 if (ttydisc_read_poll(tp) > 0)
586 revents |= events & (POLLIN|POLLRDNORM);
589 if (tp->t_flags & TF_ZOMBIE) {
590 /* Hangup flag on zombie state. */
592 } else if (events & (POLLOUT|POLLWRNORM)) {
593 /* See if we can write something. */
594 if (ttydisc_write_poll(tp) > 0)
595 revents |= events & (POLLOUT|POLLWRNORM);
599 if (events & (POLLIN|POLLRDNORM))
600 selrecord(td, &tp->t_inpoll);
601 if (events & (POLLOUT|POLLWRNORM))
602 selrecord(td, &tp->t_outpoll);
611 ttydev_mmap(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, int nprot)
613 struct tty *tp = dev->si_drv1;
616 /* Handle mmap() through the driver. */
618 error = ttydev_enter(tp);
621 error = ttydevsw_mmap(tp, offset, paddr, nprot);
632 tty_kqops_read_detach(struct knote *kn)
634 struct tty *tp = kn->kn_hook;
636 knlist_remove(&tp->t_inpoll.si_note, kn, 0);
640 tty_kqops_read_event(struct knote *kn, long hint)
642 struct tty *tp = kn->kn_hook;
644 tty_lock_assert(tp, MA_OWNED);
646 if (tty_gone(tp) || tp->t_flags & TF_ZOMBIE) {
647 kn->kn_flags |= EV_EOF;
650 kn->kn_data = ttydisc_read_poll(tp);
651 return (kn->kn_data > 0);
656 tty_kqops_write_detach(struct knote *kn)
658 struct tty *tp = kn->kn_hook;
660 knlist_remove(&tp->t_outpoll.si_note, kn, 0);
664 tty_kqops_write_event(struct knote *kn, long hint)
666 struct tty *tp = kn->kn_hook;
668 tty_lock_assert(tp, MA_OWNED);
671 kn->kn_flags |= EV_EOF;
674 kn->kn_data = ttydisc_write_poll(tp);
675 return (kn->kn_data > 0);
679 static struct filterops tty_kqops_read =
680 { 1, NULL, tty_kqops_read_detach, tty_kqops_read_event };
681 static struct filterops tty_kqops_write =
682 { 1, NULL, tty_kqops_write_detach, tty_kqops_write_event };
685 ttydev_kqfilter(struct cdev *dev, struct knote *kn)
687 struct tty *tp = dev->si_drv1;
690 error = ttydev_enter(tp);
694 switch (kn->kn_filter) {
697 kn->kn_fop = &tty_kqops_read;
698 knlist_add(&tp->t_inpoll.si_note, kn, 1);
702 kn->kn_fop = &tty_kqops_write;
703 knlist_add(&tp->t_outpoll.si_note, kn, 1);
714 static struct cdevsw ttydev_cdevsw = {
715 .d_version = D_VERSION,
716 .d_open = ttydev_open,
717 .d_close = ttydev_close,
718 .d_read = ttydev_read,
719 .d_write = ttydev_write,
720 .d_ioctl = ttydev_ioctl,
721 .d_kqfilter = ttydev_kqfilter,
722 .d_poll = ttydev_poll,
723 .d_mmap = ttydev_mmap,
729 * Init/lock-state devices
733 ttyil_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
738 while ((tp = dev->si_drv1) == NULL) {
739 error = tsleep(&dev->si_drv1, PCATCH, "ttdrv1", 1);
740 if (error != EWOULDBLOCK)
752 ttyil_close(struct cdev *dev, int flag, int mode, struct thread *td)
758 ttyil_rdwr(struct cdev *dev, struct uio *uio, int ioflag)
764 ttyil_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
767 struct tty *tp = dev->si_drv1;
778 /* Obtain terminal flags through tcgetattr(). */
779 *(struct termios*)data = *(struct termios*)dev->si_drv2;
782 /* Set terminal flags through tcsetattr(). */
783 error = priv_check(td, PRIV_TTY_SETA);
786 *(struct termios*)dev->si_drv2 = *(struct termios*)data;
789 *(int *)data = TTYDISC;
792 bzero(data, sizeof(struct winsize));
798 done: tty_unlock(tp);
802 static struct cdevsw ttyil_cdevsw = {
803 .d_version = D_VERSION,
804 .d_open = ttyil_open,
805 .d_close = ttyil_close,
806 .d_read = ttyil_rdwr,
807 .d_write = ttyil_rdwr,
808 .d_ioctl = ttyil_ioctl,
814 tty_init_termios(struct tty *tp)
816 struct termios *t = &tp->t_termios_init_in;
818 t->c_cflag = TTYDEF_CFLAG;
819 t->c_iflag = TTYDEF_IFLAG;
820 t->c_lflag = TTYDEF_LFLAG;
821 t->c_oflag = TTYDEF_OFLAG;
822 t->c_ispeed = TTYDEF_SPEED;
823 t->c_ospeed = TTYDEF_SPEED;
824 memcpy(&t->c_cc, ttydefchars, sizeof ttydefchars);
826 tp->t_termios_init_out = *t;
830 tty_init_console(struct tty *tp, speed_t s)
832 struct termios *ti = &tp->t_termios_init_in;
833 struct termios *to = &tp->t_termios_init_out;
836 ti->c_ispeed = ti->c_ospeed = s;
837 to->c_ispeed = to->c_ospeed = s;
840 ti->c_cflag |= CLOCAL;
841 to->c_cflag |= CLOCAL;
845 * Standard device routine implementations, mostly meant for
846 * pseudo-terminal device drivers. When a driver creates a new terminal
847 * device class, missing routines are patched.
851 ttydevsw_defopen(struct tty *tp)
858 ttydevsw_defclose(struct tty *tp)
863 ttydevsw_defoutwakeup(struct tty *tp)
866 panic("Terminal device has output, while not implemented");
870 ttydevsw_definwakeup(struct tty *tp)
875 ttydevsw_defioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
882 ttydevsw_defparam(struct tty *tp, struct termios *t)
885 /* Use a fake baud rate, we're not a real device. */
886 t->c_ispeed = t->c_ospeed = TTYDEF_SPEED;
892 ttydevsw_defmodem(struct tty *tp, int sigon, int sigoff)
895 /* Simulate a carrier to make the TTY layer happy. */
900 ttydevsw_defmmap(struct tty *tp, vm_offset_t offset, vm_paddr_t *paddr,
908 ttydevsw_defpktnotify(struct tty *tp, char event)
913 ttydevsw_deffree(void *softc)
916 panic("Terminal device freed without a free-handler");
920 * TTY allocation and deallocation. TTY devices can be deallocated when
921 * the driver doesn't use it anymore, when the TTY isn't a session's
922 * controlling TTY and when the device node isn't opened through devfs.
926 tty_alloc(struct ttydevsw *tsw, void *sc)
929 return (tty_alloc_mutex(tsw, sc, NULL));
933 tty_alloc_mutex(struct ttydevsw *tsw, void *sc, struct mtx *mutex)
937 /* Make sure the driver defines all routines. */
938 #define PATCH_FUNC(x) do { \
939 if (tsw->tsw_ ## x == NULL) \
940 tsw->tsw_ ## x = ttydevsw_def ## x; \
944 PATCH_FUNC(outwakeup);
945 PATCH_FUNC(inwakeup);
950 PATCH_FUNC(pktnotify);
954 tp = malloc(sizeof(struct tty), M_TTY, M_WAITOK|M_ZERO);
956 tp->t_devswsoftc = sc;
957 tp->t_flags = tsw->tsw_flags;
959 tty_init_termios(tp);
961 cv_init(&tp->t_inwait, "ttyin");
962 cv_init(&tp->t_outwait, "ttyout");
963 cv_init(&tp->t_outserwait, "ttyosr");
964 cv_init(&tp->t_bgwait, "ttybg");
965 cv_init(&tp->t_dcdwait, "ttydcd");
967 /* Allow drivers to use a custom mutex to lock the TTY. */
971 tp->t_mtx = &tp->t_mtxobj;
972 mtx_init(&tp->t_mtxobj, "ttymtx", NULL, MTX_DEF);
975 knlist_init_mtx(&tp->t_inpoll.si_note, tp->t_mtx);
976 knlist_init_mtx(&tp->t_outpoll.si_note, tp->t_mtx);
978 sx_xlock(&tty_list_sx);
979 TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
981 sx_xunlock(&tty_list_sx);
987 tty_dealloc(void *arg)
989 struct tty *tp = arg;
991 sx_xlock(&tty_list_sx);
992 TAILQ_REMOVE(&tty_list, tp, t_list);
994 sx_xunlock(&tty_list_sx);
996 /* Make sure we haven't leaked buffers. */
997 MPASS(ttyinq_getsize(&tp->t_inq) == 0);
998 MPASS(ttyoutq_getsize(&tp->t_outq) == 0);
1000 seldrain(&tp->t_inpoll);
1001 seldrain(&tp->t_outpoll);
1002 knlist_destroy(&tp->t_inpoll.si_note);
1003 knlist_destroy(&tp->t_outpoll.si_note);
1005 cv_destroy(&tp->t_inwait);
1006 cv_destroy(&tp->t_outwait);
1007 cv_destroy(&tp->t_bgwait);
1008 cv_destroy(&tp->t_dcdwait);
1009 cv_destroy(&tp->t_outserwait);
1011 if (tp->t_mtx == &tp->t_mtxobj)
1012 mtx_destroy(&tp->t_mtxobj);
1018 tty_rel_free(struct tty *tp)
1022 tty_lock_assert(tp, MA_OWNED);
1024 #define TF_ACTIVITY (TF_GONE|TF_OPENED|TF_HOOK|TF_OPENCLOSE)
1025 if (tp->t_sessioncnt != 0 || (tp->t_flags & TF_ACTIVITY) != TF_GONE) {
1026 /* TTY is still in use. */
1031 /* TTY can be deallocated. */
1037 destroy_dev_sched_cb(dev, tty_dealloc, tp);
1041 tty_rel_pgrp(struct tty *tp, struct pgrp *pg)
1043 MPASS(tp->t_sessioncnt > 0);
1044 tty_lock_assert(tp, MA_OWNED);
1046 if (tp->t_pgrp == pg)
1053 tty_rel_sess(struct tty *tp, struct session *sess)
1055 MPASS(tp->t_sessioncnt > 0);
1057 /* Current session has left. */
1058 if (tp->t_session == sess) {
1059 tp->t_session = NULL;
1060 MPASS(tp->t_pgrp == NULL);
1067 tty_rel_gone(struct tty *tp)
1069 MPASS(!tty_gone(tp));
1071 /* Simulate carrier removal. */
1072 ttydisc_modem(tp, 0);
1074 /* Wake up all blocked threads. */
1075 tty_wakeup(tp, FREAD|FWRITE);
1076 cv_broadcast(&tp->t_bgwait);
1077 cv_broadcast(&tp->t_dcdwait);
1079 tp->t_flags |= TF_GONE;
1084 * Exposing information about current TTY's through sysctl
1088 tty_to_xtty(struct tty *tp, struct xtty *xt)
1090 tty_lock_assert(tp, MA_OWNED);
1092 xt->xt_size = sizeof(struct xtty);
1093 xt->xt_insize = ttyinq_getsize(&tp->t_inq);
1094 xt->xt_incc = ttyinq_bytescanonicalized(&tp->t_inq);
1095 xt->xt_inlc = ttyinq_bytesline(&tp->t_inq);
1096 xt->xt_inlow = tp->t_inlow;
1097 xt->xt_outsize = ttyoutq_getsize(&tp->t_outq);
1098 xt->xt_outcc = ttyoutq_bytesused(&tp->t_outq);
1099 xt->xt_outlow = tp->t_outlow;
1100 xt->xt_column = tp->t_column;
1101 xt->xt_pgid = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1102 xt->xt_sid = tp->t_session ? tp->t_session->s_sid : 0;
1103 xt->xt_flags = tp->t_flags;
1104 xt->xt_dev = tp->t_dev ? dev2udev(tp->t_dev) : NODEV;
1108 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
1110 unsigned long lsize;
1111 struct xtty *xtlist, *xt;
1115 sx_slock(&tty_list_sx);
1116 lsize = tty_list_count * sizeof(struct xtty);
1118 sx_sunlock(&tty_list_sx);
1122 xtlist = xt = malloc(lsize, M_TTY, M_WAITOK);
1124 TAILQ_FOREACH(tp, &tty_list, t_list) {
1126 tty_to_xtty(tp, xt);
1130 sx_sunlock(&tty_list_sx);
1132 error = SYSCTL_OUT(req, xtlist, lsize);
1133 free(xtlist, M_TTY);
1137 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
1138 0, 0, sysctl_kern_ttys, "S,xtty", "List of TTYs");
1141 * Device node creation. Device has been set up, now we can expose it to
1146 tty_makedev(struct tty *tp, struct ucred *cred, const char *fmt, ...)
1150 const char *prefix = "tty";
1151 char name[SPECNAMELEN - 3]; /* for "tty" and "cua". */
1156 /* Remove "tty" prefix from devices like PTY's. */
1157 if (tp->t_flags & TF_NOPREFIX)
1161 vsnrprintf(name, sizeof name, 32, fmt, ap);
1165 /* System device. */
1168 mode = S_IRUSR|S_IWUSR;
1171 uid = cred->cr_ruid;
1173 mode = S_IRUSR|S_IWUSR|S_IWGRP;
1176 /* Master call-in device. */
1177 dev = make_dev_cred(&ttydev_cdevsw, 0, cred,
1178 uid, gid, mode, "%s%s", prefix, name);
1180 wakeup(&dev->si_drv1);
1183 /* Slave call-in devices. */
1184 if (tp->t_flags & TF_INITLOCK) {
1185 dev = make_dev_cred(&ttyil_cdevsw, 0, cred,
1186 uid, gid, mode, "%s%s.init", prefix, name);
1187 dev_depends(tp->t_dev, dev);
1189 wakeup(&dev->si_drv1);
1190 dev->si_drv2 = &tp->t_termios_init_in;
1192 dev = make_dev_cred(&ttyil_cdevsw, 0, cred,
1193 uid, gid, mode, "%s%s.lock", prefix, name);
1194 dev_depends(tp->t_dev, dev);
1196 wakeup(&dev->si_drv1);
1197 dev->si_drv2 = &tp->t_termios_lock_in;
1200 /* Call-out devices. */
1201 if (tp->t_flags & TF_CALLOUT) {
1202 dev = make_dev_cred(&ttydev_cdevsw, 0, cred,
1203 UID_UUCP, GID_DIALER, 0660, "cua%s", name);
1204 dev_depends(tp->t_dev, dev);
1206 wakeup(&dev->si_drv1);
1208 /* Slave call-out devices. */
1209 if (tp->t_flags & TF_INITLOCK) {
1210 dev = make_dev_cred(&ttyil_cdevsw, 0, cred,
1211 UID_UUCP, GID_DIALER, 0660, "cua%s.init", name);
1212 dev_depends(tp->t_dev, dev);
1214 wakeup(&dev->si_drv1);
1215 dev->si_drv2 = &tp->t_termios_init_out;
1217 dev = make_dev_cred(&ttyil_cdevsw, 0, cred,
1218 UID_UUCP, GID_DIALER, 0660, "cua%s.lock", name);
1219 dev_depends(tp->t_dev, dev);
1221 wakeup(&dev->si_drv1);
1222 dev->si_drv2 = &tp->t_termios_lock_out;
1228 * Signalling processes.
1232 tty_signal_sessleader(struct tty *tp, int sig)
1236 tty_lock_assert(tp, MA_OWNED);
1237 MPASS(sig >= 1 && sig < NSIG);
1239 /* Make signals start output again. */
1240 tp->t_flags &= ~TF_STOPPED;
1242 if (tp->t_session != NULL && tp->t_session->s_leader != NULL) {
1243 p = tp->t_session->s_leader;
1251 tty_signal_pgrp(struct tty *tp, int sig)
1255 tty_lock_assert(tp, MA_OWNED);
1256 MPASS(sig >= 1 && sig < NSIG);
1258 /* Make signals start output again. */
1259 tp->t_flags &= ~TF_STOPPED;
1261 if (sig == SIGINFO && !(tp->t_termios.c_lflag & NOKERNINFO))
1263 if (tp->t_pgrp != NULL) {
1264 ksiginfo_init(&ksi);
1265 ksi.ksi_signo = sig;
1266 ksi.ksi_code = SI_KERNEL;
1267 PGRP_LOCK(tp->t_pgrp);
1268 pgsignal(tp->t_pgrp, sig, 1, &ksi);
1269 PGRP_UNLOCK(tp->t_pgrp);
1274 tty_wakeup(struct tty *tp, int flags)
1276 if (tp->t_flags & TF_ASYNC && tp->t_sigio != NULL)
1277 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
1279 if (flags & FWRITE) {
1280 cv_broadcast(&tp->t_outwait);
1281 selwakeup(&tp->t_outpoll);
1282 KNOTE_LOCKED(&tp->t_outpoll.si_note, 0);
1284 if (flags & FREAD) {
1285 cv_broadcast(&tp->t_inwait);
1286 selwakeup(&tp->t_inpoll);
1287 KNOTE_LOCKED(&tp->t_inpoll.si_note, 0);
1292 tty_wait(struct tty *tp, struct cv *cv)
1295 int revokecnt = tp->t_revokecnt;
1297 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1298 MPASS(!tty_gone(tp));
1300 error = cv_wait_sig(cv, tp->t_mtx);
1302 /* Restart the system call when we may have been revoked. */
1303 if (tp->t_revokecnt != revokecnt)
1306 /* Bail out when the device slipped away. */
1314 tty_timedwait(struct tty *tp, struct cv *cv, int hz)
1317 int revokecnt = tp->t_revokecnt;
1319 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1320 MPASS(!tty_gone(tp));
1322 error = cv_timedwait_sig(cv, tp->t_mtx, hz);
1324 /* Restart the system call when we may have been revoked. */
1325 if (tp->t_revokecnt != revokecnt)
1328 /* Bail out when the device slipped away. */
1336 tty_flush(struct tty *tp, int flags)
1338 if (flags & FWRITE) {
1339 tp->t_flags &= ~TF_HIWAT_OUT;
1340 ttyoutq_flush(&tp->t_outq);
1341 tty_wakeup(tp, FWRITE);
1342 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHWRITE);
1344 if (flags & FREAD) {
1345 tty_hiwat_in_unblock(tp);
1346 ttyinq_flush(&tp->t_inq);
1347 ttydevsw_inwakeup(tp);
1348 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHREAD);
1353 tty_generic_ioctl(struct tty *tp, u_long cmd, void *data, int fflag,
1361 * The SER_* and TIOCM_* flags are the same, but one bit
1362 * shifted. I don't know why.
1365 ttydevsw_modem(tp, SER_DTR, 0);
1368 ttydevsw_modem(tp, 0, SER_DTR);
1371 int bits = *(int *)data;
1373 (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1,
1374 ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1378 int bits = *(int *)data;
1379 ttydevsw_modem(tp, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1, 0);
1383 int bits = *(int *)data;
1384 ttydevsw_modem(tp, 0, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1388 *(int *)data = TIOCM_LE + (ttydevsw_modem(tp, 0, 0) << 1);
1393 tp->t_flags |= TF_ASYNC;
1395 tp->t_flags &= ~TF_ASYNC;
1398 /* This device supports non-blocking operation. */
1401 *(int *)data = ttyinq_bytescanonicalized(&tp->t_inq);
1405 *(int *)data = ttyoutq_bytesused(&tp->t_outq);
1408 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1409 /* Not allowed to set ownership. */
1412 /* Temporarily unlock the TTY to set ownership. */
1414 error = fsetown(*(int *)data, &tp->t_sigio);
1418 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1419 /* Not allowed to set ownership. */
1422 /* Get ownership. */
1423 *(int *)data = fgetown(&tp->t_sigio);
1426 /* Obtain terminal flags through tcgetattr(). */
1427 *(struct termios*)data = tp->t_termios;
1432 struct termios *t = data;
1435 * Who makes up these funny rules? According to POSIX,
1436 * input baud rate is set equal to the output baud rate
1439 if (t->c_ispeed == 0)
1440 t->c_ispeed = t->c_ospeed;
1442 /* Discard any unsupported bits. */
1443 t->c_iflag &= TTYSUP_IFLAG;
1444 t->c_oflag &= TTYSUP_OFLAG;
1445 t->c_lflag &= TTYSUP_LFLAG;
1446 t->c_cflag &= TTYSUP_CFLAG;
1448 /* Set terminal flags through tcsetattr(). */
1449 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1450 error = tty_drain(tp);
1453 if (cmd == TIOCSETAF)
1454 tty_flush(tp, FREAD);
1458 * Only call param() when the flags really change.
1460 if ((t->c_cflag & CIGNORE) == 0 &&
1461 (tp->t_termios.c_cflag != t->c_cflag ||
1462 tp->t_termios.c_ispeed != t->c_ispeed ||
1463 tp->t_termios.c_ospeed != t->c_ospeed)) {
1464 error = ttydevsw_param(tp, t);
1470 tp->t_termios.c_cflag = t->c_cflag & ~CIGNORE;
1471 tp->t_termios.c_ispeed = t->c_ispeed;
1472 tp->t_termios.c_ospeed = t->c_ospeed;
1474 /* Baud rate has changed - update watermarks. */
1478 /* Copy new non-device driver parameters. */
1479 tp->t_termios.c_iflag = t->c_iflag;
1480 tp->t_termios.c_oflag = t->c_oflag;
1481 tp->t_termios.c_lflag = t->c_lflag;
1482 memcpy(&tp->t_termios.c_cc, t->c_cc, sizeof t->c_cc);
1484 ttydisc_optimize(tp);
1486 if ((t->c_lflag & ICANON) == 0) {
1488 * When in non-canonical mode, wake up all
1489 * readers. Canonicalize any partial input. VMIN
1490 * and VTIME could also be adjusted.
1492 ttyinq_canonicalize(&tp->t_inq);
1493 tty_wakeup(tp, FREAD);
1497 * For packet mode: notify the PTY consumer that VSTOP
1498 * and VSTART may have been changed.
1500 if (tp->t_termios.c_iflag & IXON &&
1501 tp->t_termios.c_cc[VSTOP] == CTRL('S') &&
1502 tp->t_termios.c_cc[VSTART] == CTRL('Q'))
1503 ttydevsw_pktnotify(tp, TIOCPKT_DOSTOP);
1505 ttydevsw_pktnotify(tp, TIOCPKT_NOSTOP);
1509 /* For compatibility - we only support TTYDISC. */
1510 *(int *)data = TTYDISC;
1513 if (!tty_is_ctty(tp, td->td_proc))
1516 if (tp->t_pgrp != NULL)
1517 *(int *)data = tp->t_pgrp->pg_id;
1519 *(int *)data = NO_PID;
1522 if (!tty_is_ctty(tp, td->td_proc))
1525 MPASS(tp->t_session);
1526 *(int *)data = tp->t_session->s_sid;
1529 struct proc *p = td->td_proc;
1531 /* XXX: This looks awful. */
1533 sx_xlock(&proctree_lock);
1536 if (!SESS_LEADER(p)) {
1537 /* Only the session leader may do this. */
1538 sx_xunlock(&proctree_lock);
1542 if (tp->t_session != NULL && tp->t_session == p->p_session) {
1543 /* This is already our controlling TTY. */
1544 sx_xunlock(&proctree_lock);
1548 if (p->p_session->s_ttyp != NULL ||
1549 (tp->t_session != NULL && tp->t_session->s_ttyvp != NULL &&
1550 tp->t_session->s_ttyvp->v_type != VBAD)) {
1552 * There is already a relation between a TTY and
1553 * a session, or the caller is not the session
1556 * Allow the TTY to be stolen when the vnode is
1557 * invalid, but the reference to the TTY is
1558 * still active. This allows immediate reuse of
1559 * TTYs of which the session leader has been
1560 * killed or the TTY revoked.
1562 sx_xunlock(&proctree_lock);
1566 /* Connect the session to the TTY. */
1567 tp->t_session = p->p_session;
1568 tp->t_session->s_ttyp = tp;
1570 sx_xunlock(&proctree_lock);
1572 /* Assign foreground process group. */
1573 tp->t_pgrp = p->p_pgrp;
1575 p->p_flag |= P_CONTROLT;
1584 * XXX: Temporarily unlock the TTY to locate the process
1585 * group. This code would be lot nicer if we would ever
1586 * decompose proctree_lock.
1589 sx_slock(&proctree_lock);
1590 pg = pgfind(*(int *)data);
1593 if (pg == NULL || pg->pg_session != td->td_proc->p_session) {
1594 sx_sunlock(&proctree_lock);
1601 * Determine if this TTY is the controlling TTY after
1602 * relocking the TTY.
1604 if (!tty_is_ctty(tp, td->td_proc)) {
1605 sx_sunlock(&proctree_lock);
1609 sx_sunlock(&proctree_lock);
1611 /* Wake up the background process groups. */
1612 cv_broadcast(&tp->t_bgwait);
1616 int flags = *(int *)data;
1619 flags = (FREAD|FWRITE);
1621 flags &= (FREAD|FWRITE);
1622 tty_flush(tp, flags);
1626 /* Drain TTY output. */
1627 return tty_drain(tp);
1629 /* Set terminal as console TTY. */
1631 error = priv_check(td, PRIV_TTY_CONSOLE);
1636 * XXX: constty should really need to be locked!
1637 * XXX: allow disconnected constty's to be stolen!
1642 if (constty != NULL)
1648 } else if (constty == tp) {
1653 /* Obtain window size. */
1654 *(struct winsize*)data = tp->t_winsize;
1657 /* Set window size. */
1658 if (bcmp(&tp->t_winsize, data, sizeof(struct winsize)) == 0)
1660 tp->t_winsize = *(struct winsize*)data;
1661 tty_signal_pgrp(tp, SIGWINCH);
1664 tp->t_flags |= TF_EXCLUDE;
1667 tp->t_flags &= ~TF_EXCLUDE;
1670 tp->t_flags |= TF_STOPPED;
1671 ttydevsw_pktnotify(tp, TIOCPKT_STOP);
1674 tp->t_flags &= ~TF_STOPPED;
1675 ttydevsw_outwakeup(tp);
1676 ttydevsw_pktnotify(tp, TIOCPKT_START);
1682 if ((fflag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1684 if (!tty_is_ctty(tp, td->td_proc) &&
1685 priv_check(td, PRIV_TTY_STI))
1687 ttydisc_rint(tp, *(char *)data, 0);
1688 ttydisc_rint_done(tp);
1693 return tty_ioctl_compat(tp, cmd, data, fflag, td);
1694 #else /* !COMPAT_43TTY */
1696 #endif /* COMPAT_43TTY */
1700 tty_ioctl(struct tty *tp, u_long cmd, void *data, int fflag, struct thread *td)
1704 tty_lock_assert(tp, MA_OWNED);
1709 error = ttydevsw_ioctl(tp, cmd, data, td);
1710 if (error == ENOIOCTL)
1711 error = tty_generic_ioctl(tp, cmd, data, fflag, td);
1717 tty_udev(struct tty *tp)
1720 return dev2udev(tp->t_dev);
1726 tty_checkoutq(struct tty *tp)
1729 /* 256 bytes should be enough to print a log message. */
1730 return (ttyoutq_bytesleft(&tp->t_outq) >= 256);
1734 tty_hiwat_in_block(struct tty *tp)
1737 if ((tp->t_flags & TF_HIWAT_IN) == 0 &&
1738 tp->t_termios.c_iflag & IXOFF &&
1739 tp->t_termios.c_cc[VSTOP] != _POSIX_VDISABLE) {
1741 * Input flow control. Only enter the high watermark when we
1742 * can successfully store the VSTOP character.
1744 if (ttyoutq_write_nofrag(&tp->t_outq,
1745 &tp->t_termios.c_cc[VSTOP], 1) == 0)
1746 tp->t_flags |= TF_HIWAT_IN;
1748 /* No input flow control. */
1749 tp->t_flags |= TF_HIWAT_IN;
1754 tty_hiwat_in_unblock(struct tty *tp)
1757 if (tp->t_flags & TF_HIWAT_IN &&
1758 tp->t_termios.c_iflag & IXOFF &&
1759 tp->t_termios.c_cc[VSTART] != _POSIX_VDISABLE) {
1761 * Input flow control. Only leave the high watermark when we
1762 * can successfully store the VSTART character.
1764 if (ttyoutq_write_nofrag(&tp->t_outq,
1765 &tp->t_termios.c_cc[VSTART], 1) == 0)
1766 tp->t_flags &= ~TF_HIWAT_IN;
1768 /* No input flow control. */
1769 tp->t_flags &= ~TF_HIWAT_IN;
1773 ttydevsw_inwakeup(tp);
1777 * TTY hooks interface.
1781 ttyhook_defrint(struct tty *tp, char c, int flags)
1784 if (ttyhook_rint_bypass(tp, &c, 1) != 1)
1791 ttyhook_register(struct tty **rtp, struct proc *p, int fd,
1792 struct ttyhook *th, void *softc)
1798 struct filedesc *fdp;
1801 /* Validate the file descriptor. */
1802 if ((fdp = p->p_fd) == NULL)
1805 fp = fget_unlocked(fdp, fd);
1808 if (fp->f_ops == &badfileops) {
1814 * Make sure the vnode is bound to a character device.
1815 * Unlocked check for the vnode type is ok there, because we
1816 * only shall prevent calling devvn_refthread on the file that
1817 * never has been opened over a character device.
1819 if (fp->f_type != DTYPE_VNODE || fp->f_vnode->v_type != VCHR) {
1824 /* Make sure it is a TTY. */
1825 cdp = devvn_refthread(fp->f_vnode, &dev, &ref);
1830 if (dev != fp->f_data) {
1834 if (cdp != &ttydev_cdevsw) {
1840 /* Try to attach the hook to the TTY. */
1843 MPASS((tp->t_hook == NULL) == ((tp->t_flags & TF_HOOK) == 0));
1844 if (tp->t_flags & TF_HOOK)
1847 tp->t_flags |= TF_HOOK;
1849 tp->t_hooksoftc = softc;
1853 /* Maybe we can switch into bypass mode now. */
1854 ttydisc_optimize(tp);
1856 /* Silently convert rint() calls to rint_bypass() when possible. */
1857 if (!ttyhook_hashook(tp, rint) && ttyhook_hashook(tp, rint_bypass))
1858 th->th_rint = ttyhook_defrint;
1860 done3: tty_unlock(tp);
1861 done2: dev_relthread(dev, ref);
1862 done1: fdrop(fp, curthread);
1867 ttyhook_unregister(struct tty *tp)
1870 tty_lock_assert(tp, MA_OWNED);
1871 MPASS(tp->t_flags & TF_HOOK);
1873 /* Disconnect the hook. */
1874 tp->t_flags &= ~TF_HOOK;
1877 /* Maybe we need to leave bypass mode. */
1878 ttydisc_optimize(tp);
1880 /* Maybe deallocate the TTY as well. */
1885 * /dev/console handling.
1889 ttyconsdev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
1893 /* System has no console device. */
1894 if (dev_console_filename == NULL)
1897 /* Look up corresponding TTY by device name. */
1898 sx_slock(&tty_list_sx);
1899 TAILQ_FOREACH(tp, &tty_list, t_list) {
1900 if (strcmp(dev_console_filename, tty_devname(tp)) == 0) {
1901 dev_console->si_drv1 = tp;
1905 sx_sunlock(&tty_list_sx);
1907 /* System console has no TTY associated. */
1908 if (dev_console->si_drv1 == NULL)
1911 return (ttydev_open(dev, oflags, devtype, td));
1915 ttyconsdev_write(struct cdev *dev, struct uio *uio, int ioflag)
1920 return (ttydev_write(dev, uio, ioflag));
1924 * /dev/console is a little different than normal TTY's. When opened,
1925 * it determines which TTY to use. When data gets written to it, it
1926 * will be logged in the kernel message buffer.
1928 static struct cdevsw ttyconsdev_cdevsw = {
1929 .d_version = D_VERSION,
1930 .d_open = ttyconsdev_open,
1931 .d_close = ttydev_close,
1932 .d_read = ttydev_read,
1933 .d_write = ttyconsdev_write,
1934 .d_ioctl = ttydev_ioctl,
1935 .d_kqfilter = ttydev_kqfilter,
1936 .d_poll = ttydev_poll,
1937 .d_mmap = ttydev_mmap,
1938 .d_name = "ttyconsdev",
1943 ttyconsdev_init(void *unused)
1946 dev_console = make_dev_credf(MAKEDEV_ETERNAL, &ttyconsdev_cdevsw, 0,
1947 NULL, UID_ROOT, GID_WHEEL, 0600, "console");
1950 SYSINIT(tty, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyconsdev_init, NULL);
1953 ttyconsdev_select(const char *name)
1956 dev_console_filename = name;
1960 * Debugging routines.
1963 #include "opt_ddb.h"
1965 #include <ddb/ddb.h>
1966 #include <ddb/db_sym.h>
1973 { TF_NOPREFIX, 'N' },
1975 { TF_INITLOCK, 'I' },
1976 { TF_CALLOUT, 'C' },
1978 /* Keep these together -> 'Oi' and 'Oo'. */
1980 { TF_OPENED_IN, 'i' },
1981 { TF_OPENED_OUT, 'o' },
1982 { TF_OPENED_CONS, 'c' },
1985 { TF_OPENCLOSE, 'B' },
1987 { TF_LITERAL, 'L' },
1989 /* Keep these together -> 'Hi' and 'Ho'. */
1991 { TF_HIWAT_IN, 'i' },
1992 { TF_HIWAT_OUT, 'o' },
1994 { TF_STOPPED, 'S' },
1995 { TF_EXCLUDE, 'X' },
2000 /* Keep these together -> 'bi' and 'bo'. */
2002 { TF_BUSY_IN, 'i' },
2003 { TF_BUSY_OUT, 'o' },
2008 #define TTY_FLAG_BITS \
2009 "\20\1NOPREFIX\2INITLOCK\3CALLOUT\4OPENED_IN\5OPENED_OUT\6GONE" \
2010 "\7OPENCLOSE\10ASYNC\11LITERAL\12HIWAT_IN\13HIWAT_OUT\14STOPPED" \
2011 "\15EXCLUDE\16BYPASS\17ZOMBIE\20HOOK"
2013 #define DB_PRINTSYM(name, addr) \
2014 db_printf("%s " #name ": ", sep); \
2015 db_printsym((db_addr_t) addr, DB_STGY_ANY); \
2019 _db_show_devsw(const char *sep, const struct ttydevsw *tsw)
2021 db_printf("%sdevsw: ", sep);
2022 db_printsym((db_addr_t)tsw, DB_STGY_ANY);
2023 db_printf(" (%p)\n", tsw);
2024 DB_PRINTSYM(open, tsw->tsw_open);
2025 DB_PRINTSYM(close, tsw->tsw_close);
2026 DB_PRINTSYM(outwakeup, tsw->tsw_outwakeup);
2027 DB_PRINTSYM(inwakeup, tsw->tsw_inwakeup);
2028 DB_PRINTSYM(ioctl, tsw->tsw_ioctl);
2029 DB_PRINTSYM(param, tsw->tsw_param);
2030 DB_PRINTSYM(modem, tsw->tsw_modem);
2031 DB_PRINTSYM(mmap, tsw->tsw_mmap);
2032 DB_PRINTSYM(pktnotify, tsw->tsw_pktnotify);
2033 DB_PRINTSYM(free, tsw->tsw_free);
2036 _db_show_hooks(const char *sep, const struct ttyhook *th)
2038 db_printf("%shook: ", sep);
2039 db_printsym((db_addr_t)th, DB_STGY_ANY);
2040 db_printf(" (%p)\n", th);
2043 DB_PRINTSYM(rint, th->th_rint);
2044 DB_PRINTSYM(rint_bypass, th->th_rint_bypass);
2045 DB_PRINTSYM(rint_done, th->th_rint_done);
2046 DB_PRINTSYM(rint_poll, th->th_rint_poll);
2047 DB_PRINTSYM(getc_inject, th->th_getc_inject);
2048 DB_PRINTSYM(getc_capture, th->th_getc_capture);
2049 DB_PRINTSYM(getc_poll, th->th_getc_poll);
2050 DB_PRINTSYM(close, th->th_close);
2054 _db_show_termios(const char *name, const struct termios *t)
2057 db_printf("%s: iflag 0x%x oflag 0x%x cflag 0x%x "
2058 "lflag 0x%x ispeed %u ospeed %u\n", name,
2059 t->c_iflag, t->c_oflag, t->c_cflag, t->c_lflag,
2060 t->c_ispeed, t->c_ospeed);
2063 /* DDB command to show TTY statistics. */
2064 DB_SHOW_COMMAND(tty, db_show_tty)
2069 db_printf("usage: show tty <addr>\n");
2072 tp = (struct tty *)addr;
2074 db_printf("0x%p: %s\n", tp, tty_devname(tp));
2075 db_printf("\tmtx: %p\n", tp->t_mtx);
2076 db_printf("\tflags: %b\n", tp->t_flags, TTY_FLAG_BITS);
2077 db_printf("\trevokecnt: %u\n", tp->t_revokecnt);
2079 /* Buffering mechanisms. */
2080 db_printf("\tinq: %p begin %u linestart %u reprint %u end %u "
2081 "nblocks %u quota %u\n", &tp->t_inq, tp->t_inq.ti_begin,
2082 tp->t_inq.ti_linestart, tp->t_inq.ti_reprint, tp->t_inq.ti_end,
2083 tp->t_inq.ti_nblocks, tp->t_inq.ti_quota);
2084 db_printf("\toutq: %p begin %u end %u nblocks %u quota %u\n",
2085 &tp->t_outq, tp->t_outq.to_begin, tp->t_outq.to_end,
2086 tp->t_outq.to_nblocks, tp->t_outq.to_quota);
2087 db_printf("\tinlow: %zu\n", tp->t_inlow);
2088 db_printf("\toutlow: %zu\n", tp->t_outlow);
2089 _db_show_termios("\ttermios", &tp->t_termios);
2090 db_printf("\twinsize: row %u col %u xpixel %u ypixel %u\n",
2091 tp->t_winsize.ws_row, tp->t_winsize.ws_col,
2092 tp->t_winsize.ws_xpixel, tp->t_winsize.ws_ypixel);
2093 db_printf("\tcolumn: %u\n", tp->t_column);
2094 db_printf("\twritepos: %u\n", tp->t_writepos);
2095 db_printf("\tcompatflags: 0x%x\n", tp->t_compatflags);
2097 /* Init/lock-state devices. */
2098 _db_show_termios("\ttermios_init_in", &tp->t_termios_init_in);
2099 _db_show_termios("\ttermios_init_out", &tp->t_termios_init_out);
2100 _db_show_termios("\ttermios_lock_in", &tp->t_termios_lock_in);
2101 _db_show_termios("\ttermios_lock_out", &tp->t_termios_lock_out);
2104 _db_show_devsw("\t", tp->t_devsw);
2105 _db_show_hooks("\t", tp->t_hook);
2108 db_printf("\tpgrp: %p gid %d jobc %d\n", tp->t_pgrp,
2109 tp->t_pgrp ? tp->t_pgrp->pg_id : 0,
2110 tp->t_pgrp ? tp->t_pgrp->pg_jobc : 0);
2111 db_printf("\tsession: %p", tp->t_session);
2112 if (tp->t_session != NULL)
2113 db_printf(" count %u leader %p tty %p sid %d login %s",
2114 tp->t_session->s_count, tp->t_session->s_leader,
2115 tp->t_session->s_ttyp, tp->t_session->s_sid,
2116 tp->t_session->s_login);
2118 db_printf("\tsessioncnt: %u\n", tp->t_sessioncnt);
2119 db_printf("\tdevswsoftc: %p\n", tp->t_devswsoftc);
2120 db_printf("\thooksoftc: %p\n", tp->t_hooksoftc);
2121 db_printf("\tdev: %p\n", tp->t_dev);
2124 /* DDB command to list TTYs. */
2125 DB_SHOW_ALL_COMMAND(ttys, db_show_all_ttys)
2131 /* Make the output look like `pstat -t'. */
2133 #if defined(__LP64__)
2136 db_printf(" LINE INQ CAN LIN LOW OUTQ USE LOW "
2137 "COL SESS PGID STATE\n");
2139 TAILQ_FOREACH(tp, &tty_list, t_list) {
2140 isiz = tp->t_inq.ti_nblocks * TTYINQ_DATASIZE;
2141 osiz = tp->t_outq.to_nblocks * TTYOUTQ_DATASIZE;
2143 db_printf("%p %10s %5zu %4u %4u %4zu %5zu %4u %4zu %5u %5d %5d ",
2147 tp->t_inq.ti_linestart - tp->t_inq.ti_begin,
2148 tp->t_inq.ti_end - tp->t_inq.ti_linestart,
2151 tp->t_outq.to_end - tp->t_outq.to_begin,
2152 osiz - tp->t_outlow,
2153 MIN(tp->t_column, 99999),
2154 tp->t_session ? tp->t_session->s_sid : 0,
2155 tp->t_pgrp ? tp->t_pgrp->pg_id : 0);
2158 for (i = j = 0; ttystates[i].flag; i++)
2159 if (tp->t_flags & ttystates[i].flag) {
2160 db_printf("%c", ttystates[i].val);