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)
180 if (tty_gone(tp) || !tty_opened(tp)) {
181 /* Device is already gone. */
190 ttydev_leave(struct tty *tp)
192 tty_lock_assert(tp, MA_OWNED);
194 if (tty_opened(tp) || tp->t_flags & TF_OPENCLOSE) {
195 /* Device is still opened somewhere. */
200 tp->t_flags |= TF_OPENCLOSE;
202 /* Stop asynchronous I/O. */
203 funsetown(&tp->t_sigio);
205 /* Remove console TTY. */
209 /* Drain any output. */
210 MPASS((tp->t_flags & TF_STOPPED) == 0);
216 /* Destroy associated buffers already. */
217 ttyinq_free(&tp->t_inq);
219 ttyoutq_free(&tp->t_outq);
222 knlist_clear(&tp->t_inpoll.si_note, 1);
223 knlist_clear(&tp->t_outpoll.si_note, 1);
228 tp->t_flags &= ~TF_OPENCLOSE;
229 cv_broadcast(&tp->t_dcdwait);
234 * Operations that are exposed through the character device in /dev.
237 ttydev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
246 /* Device is already gone. */
252 * Block when other processes are currently opening or closing
255 while (tp->t_flags & TF_OPENCLOSE) {
256 error = tty_wait(tp, &tp->t_dcdwait);
262 tp->t_flags |= TF_OPENCLOSE;
265 * Make sure the "tty" and "cua" device cannot be opened at the
268 if (TTY_CALLOUT(tp, dev)) {
269 if (tp->t_flags & TF_OPENED_IN) {
274 if (tp->t_flags & TF_OPENED_OUT) {
280 if (tp->t_flags & TF_EXCLUDE && priv_check(td, PRIV_TTY_EXCLUSIVE)) {
285 if (!tty_opened(tp)) {
286 /* Set proper termios flags. */
287 if (TTY_CALLOUT(tp, dev))
288 tp->t_termios = tp->t_termios_init_out;
290 tp->t_termios = tp->t_termios_init_in;
291 ttydevsw_param(tp, &tp->t_termios);
292 /* Prevent modem control on callout devices and /dev/console. */
293 if (TTY_CALLOUT(tp, dev) || dev == dev_console)
294 tp->t_termios.c_cflag |= CLOCAL;
296 ttydevsw_modem(tp, SER_DTR|SER_RTS, 0);
298 error = ttydevsw_open(tp);
303 tty_watermarks(tp); /* XXXGL: drops lock */
306 /* Wait for Carrier Detect. */
307 if ((oflags & O_NONBLOCK) == 0 &&
308 (tp->t_termios.c_cflag & CLOCAL) == 0) {
309 while ((ttydevsw_modem(tp, 0, 0) & SER_DCD) == 0) {
310 error = tty_wait(tp, &tp->t_dcdwait);
316 if (dev == dev_console)
317 tp->t_flags |= TF_OPENED_CONS;
318 else if (TTY_CALLOUT(tp, dev))
319 tp->t_flags |= TF_OPENED_OUT;
321 tp->t_flags |= TF_OPENED_IN;
323 done: tp->t_flags &= ~TF_OPENCLOSE;
324 cv_broadcast(&tp->t_dcdwait);
331 ttydev_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
333 struct tty *tp = dev->si_drv1;
338 * Don't actually close the device if it is being used as the
341 MPASS((tp->t_flags & TF_OPENED) != TF_OPENED);
342 if (dev == dev_console)
343 tp->t_flags &= ~TF_OPENED_CONS;
345 tp->t_flags &= ~(TF_OPENED_IN|TF_OPENED_OUT);
347 if (tp->t_flags & TF_OPENED) {
353 * This can only be called once. The callin and the callout
354 * devices cannot be opened at the same time.
356 tp->t_flags &= ~(TF_EXCLUDE|TF_STOPPED);
358 /* Properly wake up threads that are stuck - revoke(). */
360 tty_wakeup(tp, FREAD|FWRITE);
361 cv_broadcast(&tp->t_bgwait);
362 cv_broadcast(&tp->t_dcdwait);
370 tty_is_ctty(struct tty *tp, struct proc *p)
372 tty_lock_assert(tp, MA_OWNED);
374 return (p->p_session == tp->t_session && p->p_flag & P_CONTROLT);
378 tty_wait_background(struct tty *tp, struct thread *td, int sig)
380 struct proc *p = td->td_proc;
385 MPASS(sig == SIGTTIN || sig == SIGTTOU);
386 tty_lock_assert(tp, MA_OWNED);
391 * The process should only sleep, when:
392 * - This terminal is the controling terminal
393 * - Its process group is not the foreground process
395 * - The parent process isn't waiting for the child to
397 * - the signal to send to the process isn't masked
399 if (!tty_is_ctty(tp, p) || p->p_pgrp == tp->t_pgrp) {
400 /* Allow the action to happen. */
405 if (SIGISMEMBER(p->p_sigacts->ps_sigignore, sig) ||
406 SIGISMEMBER(td->td_sigmask, sig)) {
407 /* Only allow them in write()/ioctl(). */
409 return (sig == SIGTTOU ? 0 : EIO);
413 if (p->p_flag & P_PPWAIT || pg->pg_jobc == 0) {
414 /* Don't allow the action to happen. */
421 * Send the signal and sleep until we're the new
422 * foreground process group.
426 ksi.ksi_code = SI_KERNEL;
431 pgsignal(pg, ksi.ksi_signo, 1, &ksi);
434 error = tty_wait(tp, &tp->t_bgwait);
441 ttydev_read(struct cdev *dev, struct uio *uio, int ioflag)
443 struct tty *tp = dev->si_drv1;
446 error = ttydev_enter(tp);
449 error = ttydisc_read(tp, uio, ioflag);
453 * The read() call should not throw an error when the device is
454 * being destroyed. Silently convert it to an EOF.
456 done: if (error == ENXIO)
462 ttydev_write(struct cdev *dev, struct uio *uio, int ioflag)
464 struct tty *tp = dev->si_drv1;
467 error = ttydev_enter(tp);
471 if (tp->t_termios.c_lflag & TOSTOP) {
472 error = tty_wait_background(tp, curthread, SIGTTOU);
477 if (ioflag & IO_NDELAY && tp->t_flags & TF_BUSY_OUT) {
478 /* Allow non-blocking writes to bypass serialization. */
479 error = ttydisc_write(tp, uio, ioflag);
481 /* Serialize write() calls. */
482 while (tp->t_flags & TF_BUSY_OUT) {
483 error = tty_wait(tp, &tp->t_outserwait);
488 tp->t_flags |= TF_BUSY_OUT;
489 error = ttydisc_write(tp, uio, ioflag);
490 tp->t_flags &= ~TF_BUSY_OUT;
491 cv_signal(&tp->t_outserwait);
494 done: tty_unlock(tp);
499 ttydev_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
502 struct tty *tp = dev->si_drv1;
505 error = ttydev_enter(tp);
540 #endif /* COMPAT_43TTY */
542 * If the ioctl() causes the TTY to be modified, let it
543 * wait in the background.
545 error = tty_wait_background(tp, curthread, SIGTTOU);
550 if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
551 struct termios *old = &tp->t_termios;
552 struct termios *new = (struct termios *)data;
553 struct termios *lock = TTY_CALLOUT(tp, dev) ?
554 &tp->t_termios_lock_out : &tp->t_termios_lock_in;
558 * Lock state devices. Just overwrite the values of the
559 * commands that are currently in use.
561 new->c_iflag = (old->c_iflag & lock->c_iflag) |
562 (new->c_iflag & ~lock->c_iflag);
563 new->c_oflag = (old->c_oflag & lock->c_oflag) |
564 (new->c_oflag & ~lock->c_oflag);
565 new->c_cflag = (old->c_cflag & lock->c_cflag) |
566 (new->c_cflag & ~lock->c_cflag);
567 new->c_lflag = (old->c_lflag & lock->c_lflag) |
568 (new->c_lflag & ~lock->c_lflag);
569 for (cc = 0; cc < NCCS; ++cc)
571 new->c_cc[cc] = old->c_cc[cc];
573 new->c_ispeed = old->c_ispeed;
575 new->c_ospeed = old->c_ospeed;
578 error = tty_ioctl(tp, cmd, data, fflag, td);
579 done: tty_unlock(tp);
585 ttydev_poll(struct cdev *dev, int events, struct thread *td)
587 struct tty *tp = dev->si_drv1;
588 int error, revents = 0;
590 error = ttydev_enter(tp);
592 return ((events & (POLLIN|POLLRDNORM)) | POLLHUP);
594 if (events & (POLLIN|POLLRDNORM)) {
595 /* See if we can read something. */
596 if (ttydisc_read_poll(tp) > 0)
597 revents |= events & (POLLIN|POLLRDNORM);
600 if (tp->t_flags & TF_ZOMBIE) {
601 /* Hangup flag on zombie state. */
603 } else if (events & (POLLOUT|POLLWRNORM)) {
604 /* See if we can write something. */
605 if (ttydisc_write_poll(tp) > 0)
606 revents |= events & (POLLOUT|POLLWRNORM);
610 if (events & (POLLIN|POLLRDNORM))
611 selrecord(td, &tp->t_inpoll);
612 if (events & (POLLOUT|POLLWRNORM))
613 selrecord(td, &tp->t_outpoll);
622 ttydev_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
623 int nprot, vm_memattr_t *memattr)
625 struct tty *tp = dev->si_drv1;
628 /* Handle mmap() through the driver. */
630 error = ttydev_enter(tp);
633 error = ttydevsw_mmap(tp, offset, paddr, nprot, memattr);
644 tty_kqops_read_detach(struct knote *kn)
646 struct tty *tp = kn->kn_hook;
648 knlist_remove(&tp->t_inpoll.si_note, kn, 0);
652 tty_kqops_read_event(struct knote *kn, long hint)
654 struct tty *tp = kn->kn_hook;
656 tty_lock_assert(tp, MA_OWNED);
658 if (tty_gone(tp) || tp->t_flags & TF_ZOMBIE) {
659 kn->kn_flags |= EV_EOF;
662 kn->kn_data = ttydisc_read_poll(tp);
663 return (kn->kn_data > 0);
668 tty_kqops_write_detach(struct knote *kn)
670 struct tty *tp = kn->kn_hook;
672 knlist_remove(&tp->t_outpoll.si_note, kn, 0);
676 tty_kqops_write_event(struct knote *kn, long hint)
678 struct tty *tp = kn->kn_hook;
680 tty_lock_assert(tp, MA_OWNED);
683 kn->kn_flags |= EV_EOF;
686 kn->kn_data = ttydisc_write_poll(tp);
687 return (kn->kn_data > 0);
691 static struct filterops tty_kqops_read = {
693 .f_detach = tty_kqops_read_detach,
694 .f_event = tty_kqops_read_event,
696 static struct filterops tty_kqops_write = {
698 .f_detach = tty_kqops_write_detach,
699 .f_event = tty_kqops_write_event,
703 ttydev_kqfilter(struct cdev *dev, struct knote *kn)
705 struct tty *tp = dev->si_drv1;
708 error = ttydev_enter(tp);
712 switch (kn->kn_filter) {
715 kn->kn_fop = &tty_kqops_read;
716 knlist_add(&tp->t_inpoll.si_note, kn, 1);
720 kn->kn_fop = &tty_kqops_write;
721 knlist_add(&tp->t_outpoll.si_note, kn, 1);
732 static struct cdevsw ttydev_cdevsw = {
733 .d_version = D_VERSION,
734 .d_open = ttydev_open,
735 .d_close = ttydev_close,
736 .d_read = ttydev_read,
737 .d_write = ttydev_write,
738 .d_ioctl = ttydev_ioctl,
739 .d_kqfilter = ttydev_kqfilter,
740 .d_poll = ttydev_poll,
741 .d_mmap = ttydev_mmap,
747 * Init/lock-state devices
751 ttyil_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
767 ttyil_close(struct cdev *dev, int flag, int mode, struct thread *td)
773 ttyil_rdwr(struct cdev *dev, struct uio *uio, int ioflag)
779 ttyil_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag,
782 struct tty *tp = dev->si_drv1;
791 error = ttydevsw_cioctl(tp, dev2unit(dev), cmd, data, td);
792 if (error != ENOIOCTL)
798 /* Obtain terminal flags through tcgetattr(). */
799 *(struct termios*)data = *(struct termios*)dev->si_drv2;
802 /* Set terminal flags through tcsetattr(). */
803 error = priv_check(td, PRIV_TTY_SETA);
806 *(struct termios*)dev->si_drv2 = *(struct termios*)data;
809 *(int *)data = TTYDISC;
812 bzero(data, sizeof(struct winsize));
818 done: tty_unlock(tp);
822 static struct cdevsw ttyil_cdevsw = {
823 .d_version = D_VERSION,
824 .d_open = ttyil_open,
825 .d_close = ttyil_close,
826 .d_read = ttyil_rdwr,
827 .d_write = ttyil_rdwr,
828 .d_ioctl = ttyil_ioctl,
834 tty_init_termios(struct tty *tp)
836 struct termios *t = &tp->t_termios_init_in;
838 t->c_cflag = TTYDEF_CFLAG;
839 t->c_iflag = TTYDEF_IFLAG;
840 t->c_lflag = TTYDEF_LFLAG;
841 t->c_oflag = TTYDEF_OFLAG;
842 t->c_ispeed = TTYDEF_SPEED;
843 t->c_ospeed = TTYDEF_SPEED;
844 memcpy(&t->c_cc, ttydefchars, sizeof ttydefchars);
846 tp->t_termios_init_out = *t;
850 tty_init_console(struct tty *tp, speed_t s)
852 struct termios *ti = &tp->t_termios_init_in;
853 struct termios *to = &tp->t_termios_init_out;
856 ti->c_ispeed = ti->c_ospeed = s;
857 to->c_ispeed = to->c_ospeed = s;
860 ti->c_cflag |= CLOCAL;
861 to->c_cflag |= CLOCAL;
865 * Standard device routine implementations, mostly meant for
866 * pseudo-terminal device drivers. When a driver creates a new terminal
867 * device class, missing routines are patched.
871 ttydevsw_defopen(struct tty *tp)
878 ttydevsw_defclose(struct tty *tp)
883 ttydevsw_defoutwakeup(struct tty *tp)
886 panic("Terminal device has output, while not implemented");
890 ttydevsw_definwakeup(struct tty *tp)
895 ttydevsw_defioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
902 ttydevsw_defcioctl(struct tty *tp, int unit, u_long cmd, caddr_t data, struct thread *td)
909 ttydevsw_defparam(struct tty *tp, struct termios *t)
913 * Allow the baud rate to be adjusted for pseudo-devices, but at
914 * least restrict it to 115200 to prevent excessive buffer
915 * usage. Also disallow 0, to prevent foot shooting.
917 if (t->c_ispeed < B50)
919 else if (t->c_ispeed > B115200)
920 t->c_ispeed = B115200;
921 if (t->c_ospeed < B50)
923 else if (t->c_ospeed > B115200)
924 t->c_ospeed = B115200;
931 ttydevsw_defmodem(struct tty *tp, int sigon, int sigoff)
934 /* Simulate a carrier to make the TTY layer happy. */
939 ttydevsw_defmmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t *paddr,
940 int nprot, vm_memattr_t *memattr)
947 ttydevsw_defpktnotify(struct tty *tp, char event)
952 ttydevsw_deffree(void *softc)
955 panic("Terminal device freed without a free-handler");
959 ttydevsw_defbusy(struct tty *tp __unused)
966 * TTY allocation and deallocation. TTY devices can be deallocated when
967 * the driver doesn't use it anymore, when the TTY isn't a session's
968 * controlling TTY and when the device node isn't opened through devfs.
972 tty_alloc(struct ttydevsw *tsw, void *sc)
975 return (tty_alloc_mutex(tsw, sc, NULL));
979 tty_alloc_mutex(struct ttydevsw *tsw, void *sc, struct mtx *mutex)
983 /* Make sure the driver defines all routines. */
984 #define PATCH_FUNC(x) do { \
985 if (tsw->tsw_ ## x == NULL) \
986 tsw->tsw_ ## x = ttydevsw_def ## x; \
990 PATCH_FUNC(outwakeup);
991 PATCH_FUNC(inwakeup);
997 PATCH_FUNC(pktnotify);
1002 tp = malloc(sizeof(struct tty), M_TTY, M_WAITOK|M_ZERO);
1004 tp->t_devswsoftc = sc;
1005 tp->t_flags = tsw->tsw_flags;
1007 tty_init_termios(tp);
1009 cv_init(&tp->t_inwait, "ttyin");
1010 cv_init(&tp->t_outwait, "ttyout");
1011 cv_init(&tp->t_outserwait, "ttyosr");
1012 cv_init(&tp->t_bgwait, "ttybg");
1013 cv_init(&tp->t_dcdwait, "ttydcd");
1015 /* Allow drivers to use a custom mutex to lock the TTY. */
1016 if (mutex != NULL) {
1019 tp->t_mtx = &tp->t_mtxobj;
1020 mtx_init(&tp->t_mtxobj, "ttymtx", NULL, MTX_DEF);
1023 knlist_init_mtx(&tp->t_inpoll.si_note, tp->t_mtx);
1024 knlist_init_mtx(&tp->t_outpoll.si_note, tp->t_mtx);
1030 tty_dealloc(void *arg)
1032 struct tty *tp = arg;
1034 /* Make sure we haven't leaked buffers. */
1035 MPASS(ttyinq_getsize(&tp->t_inq) == 0);
1036 MPASS(ttyoutq_getsize(&tp->t_outq) == 0);
1038 seldrain(&tp->t_inpoll);
1039 seldrain(&tp->t_outpoll);
1040 knlist_destroy(&tp->t_inpoll.si_note);
1041 knlist_destroy(&tp->t_outpoll.si_note);
1043 cv_destroy(&tp->t_inwait);
1044 cv_destroy(&tp->t_outwait);
1045 cv_destroy(&tp->t_bgwait);
1046 cv_destroy(&tp->t_dcdwait);
1047 cv_destroy(&tp->t_outserwait);
1049 if (tp->t_mtx == &tp->t_mtxobj)
1050 mtx_destroy(&tp->t_mtxobj);
1056 tty_rel_free(struct tty *tp)
1060 tty_lock_assert(tp, MA_OWNED);
1062 #define TF_ACTIVITY (TF_GONE|TF_OPENED|TF_HOOK|TF_OPENCLOSE)
1063 if (tp->t_sessioncnt != 0 || (tp->t_flags & TF_ACTIVITY) != TF_GONE) {
1064 /* TTY is still in use. */
1069 /* TTY can be deallocated. */
1075 sx_xlock(&tty_list_sx);
1076 TAILQ_REMOVE(&tty_list, tp, t_list);
1078 sx_xunlock(&tty_list_sx);
1079 destroy_dev_sched_cb(dev, tty_dealloc, tp);
1084 tty_rel_pgrp(struct tty *tp, struct pgrp *pg)
1086 MPASS(tp->t_sessioncnt > 0);
1087 tty_lock_assert(tp, MA_OWNED);
1089 if (tp->t_pgrp == pg)
1096 tty_rel_sess(struct tty *tp, struct session *sess)
1098 MPASS(tp->t_sessioncnt > 0);
1100 /* Current session has left. */
1101 if (tp->t_session == sess) {
1102 tp->t_session = NULL;
1103 MPASS(tp->t_pgrp == NULL);
1110 tty_rel_gone(struct tty *tp)
1112 MPASS(!tty_gone(tp));
1114 /* Simulate carrier removal. */
1115 ttydisc_modem(tp, 0);
1117 /* Wake up all blocked threads. */
1118 tty_wakeup(tp, FREAD|FWRITE);
1119 cv_broadcast(&tp->t_bgwait);
1120 cv_broadcast(&tp->t_dcdwait);
1122 tp->t_flags |= TF_GONE;
1127 * Exposing information about current TTY's through sysctl
1131 tty_to_xtty(struct tty *tp, struct xtty *xt)
1133 tty_lock_assert(tp, MA_OWNED);
1135 xt->xt_size = sizeof(struct xtty);
1136 xt->xt_insize = ttyinq_getsize(&tp->t_inq);
1137 xt->xt_incc = ttyinq_bytescanonicalized(&tp->t_inq);
1138 xt->xt_inlc = ttyinq_bytesline(&tp->t_inq);
1139 xt->xt_inlow = tp->t_inlow;
1140 xt->xt_outsize = ttyoutq_getsize(&tp->t_outq);
1141 xt->xt_outcc = ttyoutq_bytesused(&tp->t_outq);
1142 xt->xt_outlow = tp->t_outlow;
1143 xt->xt_column = tp->t_column;
1144 xt->xt_pgid = tp->t_pgrp ? tp->t_pgrp->pg_id : 0;
1145 xt->xt_sid = tp->t_session ? tp->t_session->s_sid : 0;
1146 xt->xt_flags = tp->t_flags;
1147 xt->xt_dev = tp->t_dev ? dev2udev(tp->t_dev) : NODEV;
1151 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
1153 unsigned long lsize;
1154 struct xtty *xtlist, *xt;
1158 sx_slock(&tty_list_sx);
1159 lsize = tty_list_count * sizeof(struct xtty);
1161 sx_sunlock(&tty_list_sx);
1165 xtlist = xt = malloc(lsize, M_TTY, M_WAITOK);
1167 TAILQ_FOREACH(tp, &tty_list, t_list) {
1169 tty_to_xtty(tp, xt);
1173 sx_sunlock(&tty_list_sx);
1175 error = SYSCTL_OUT(req, xtlist, lsize);
1176 free(xtlist, M_TTY);
1180 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD|CTLFLAG_MPSAFE,
1181 0, 0, sysctl_kern_ttys, "S,xtty", "List of TTYs");
1184 * Device node creation. Device has been set up, now we can expose it to
1189 tty_makedevf(struct tty *tp, struct ucred *cred, int flags,
1190 const char *fmt, ...)
1193 struct make_dev_args args;
1194 struct cdev *dev, *init, *lock, *cua, *cinit, *clock;
1195 const char *prefix = "tty";
1196 char name[SPECNAMELEN - 3]; /* for "tty" and "cua". */
1202 /* Remove "tty" prefix from devices like PTY's. */
1203 if (tp->t_flags & TF_NOPREFIX)
1207 vsnrprintf(name, sizeof name, 32, fmt, ap);
1211 /* System device. */
1214 mode = S_IRUSR|S_IWUSR;
1217 uid = cred->cr_ruid;
1219 mode = S_IRUSR|S_IWUSR|S_IWGRP;
1222 flags = flags & TTYMK_CLONING ? MAKEDEV_REF : 0;
1223 flags |= MAKEDEV_CHECKNAME;
1225 /* Master call-in device. */
1226 make_dev_args_init(&args);
1227 args.mda_flags = flags;
1228 args.mda_devsw = &ttydev_cdevsw;
1232 args.mda_mode = mode;
1233 args.mda_si_drv1 = tp;
1234 error = make_dev_s(&args, &dev, "%s%s", prefix, name);
1239 init = lock = cua = cinit = clock = NULL;
1241 /* Slave call-in devices. */
1242 if (tp->t_flags & TF_INITLOCK) {
1243 args.mda_devsw = &ttyil_cdevsw;
1244 args.mda_unit = TTYUNIT_INIT;
1245 args.mda_si_drv1 = tp;
1246 args.mda_si_drv2 = &tp->t_termios_init_in;
1247 error = make_dev_s(&args, &init, "%s%s.init", prefix, name);
1250 dev_depends(dev, init);
1252 args.mda_unit = TTYUNIT_LOCK;
1253 args.mda_si_drv2 = &tp->t_termios_lock_in;
1254 error = make_dev_s(&args, &lock, "%s%s.lock", prefix, name);
1257 dev_depends(dev, lock);
1260 /* Call-out devices. */
1261 if (tp->t_flags & TF_CALLOUT) {
1262 make_dev_args_init(&args);
1263 args.mda_flags = flags;
1264 args.mda_devsw = &ttydev_cdevsw;
1266 args.mda_uid = UID_UUCP;
1267 args.mda_gid = GID_DIALER;
1268 args.mda_mode = 0660;
1269 args.mda_unit = TTYUNIT_CALLOUT;
1270 args.mda_si_drv1 = tp;
1271 error = make_dev_s(&args, &cua, "cua%s", name);
1274 dev_depends(dev, cua);
1276 /* Slave call-out devices. */
1277 if (tp->t_flags & TF_INITLOCK) {
1278 args.mda_devsw = &ttyil_cdevsw;
1279 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_INIT;
1280 args.mda_si_drv2 = &tp->t_termios_init_out;
1281 error = make_dev_s(&args, &cinit, "cua%s.init", name);
1284 dev_depends(dev, cinit);
1286 args.mda_unit = TTYUNIT_CALLOUT | TTYUNIT_LOCK;
1287 args.mda_si_drv2 = &tp->t_termios_lock_out;
1288 error = make_dev_s(&args, &clock, "cua%s.lock", name);
1291 dev_depends(dev, clock);
1295 sx_xlock(&tty_list_sx);
1296 TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
1298 sx_xunlock(&tty_list_sx);
1317 * Signalling processes.
1321 tty_signal_sessleader(struct tty *tp, int sig)
1325 tty_lock_assert(tp, MA_OWNED);
1326 MPASS(sig >= 1 && sig < NSIG);
1328 /* Make signals start output again. */
1329 tp->t_flags &= ~TF_STOPPED;
1331 if (tp->t_session != NULL && tp->t_session->s_leader != NULL) {
1332 p = tp->t_session->s_leader;
1334 kern_psignal(p, sig);
1340 tty_signal_pgrp(struct tty *tp, int sig)
1344 tty_lock_assert(tp, MA_OWNED);
1345 MPASS(sig >= 1 && sig < NSIG);
1347 /* Make signals start output again. */
1348 tp->t_flags &= ~TF_STOPPED;
1350 if (sig == SIGINFO && !(tp->t_termios.c_lflag & NOKERNINFO))
1352 if (tp->t_pgrp != NULL) {
1353 ksiginfo_init(&ksi);
1354 ksi.ksi_signo = sig;
1355 ksi.ksi_code = SI_KERNEL;
1356 PGRP_LOCK(tp->t_pgrp);
1357 pgsignal(tp->t_pgrp, sig, 1, &ksi);
1358 PGRP_UNLOCK(tp->t_pgrp);
1363 tty_wakeup(struct tty *tp, int flags)
1365 if (tp->t_flags & TF_ASYNC && tp->t_sigio != NULL)
1366 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
1368 if (flags & FWRITE) {
1369 cv_broadcast(&tp->t_outwait);
1370 selwakeup(&tp->t_outpoll);
1371 KNOTE_LOCKED(&tp->t_outpoll.si_note, 0);
1373 if (flags & FREAD) {
1374 cv_broadcast(&tp->t_inwait);
1375 selwakeup(&tp->t_inpoll);
1376 KNOTE_LOCKED(&tp->t_inpoll.si_note, 0);
1381 tty_wait(struct tty *tp, struct cv *cv)
1384 int revokecnt = tp->t_revokecnt;
1386 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1387 MPASS(!tty_gone(tp));
1389 error = cv_wait_sig(cv, tp->t_mtx);
1391 /* Bail out when the device slipped away. */
1395 /* Restart the system call when we may have been revoked. */
1396 if (tp->t_revokecnt != revokecnt)
1403 tty_timedwait(struct tty *tp, struct cv *cv, int hz)
1406 int revokecnt = tp->t_revokecnt;
1408 tty_lock_assert(tp, MA_OWNED|MA_NOTRECURSED);
1409 MPASS(!tty_gone(tp));
1411 error = cv_timedwait_sig(cv, tp->t_mtx, hz);
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_flush(struct tty *tp, int flags)
1427 if (flags & FWRITE) {
1428 tp->t_flags &= ~TF_HIWAT_OUT;
1429 ttyoutq_flush(&tp->t_outq);
1430 tty_wakeup(tp, FWRITE);
1431 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHWRITE);
1433 if (flags & FREAD) {
1434 tty_hiwat_in_unblock(tp);
1435 ttyinq_flush(&tp->t_inq);
1436 ttydevsw_inwakeup(tp);
1437 ttydevsw_pktnotify(tp, TIOCPKT_FLUSHREAD);
1442 tty_set_winsize(struct tty *tp, const struct winsize *wsz)
1445 if (memcmp(&tp->t_winsize, wsz, sizeof(*wsz)) == 0)
1447 tp->t_winsize = *wsz;
1448 tty_signal_pgrp(tp, SIGWINCH);
1452 tty_generic_ioctl(struct tty *tp, u_long cmd, void *data, int fflag,
1460 * The SER_* and TIOCM_* flags are the same, but one bit
1461 * shifted. I don't know why.
1464 ttydevsw_modem(tp, SER_DTR, 0);
1467 ttydevsw_modem(tp, 0, SER_DTR);
1470 int bits = *(int *)data;
1472 (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1,
1473 ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1477 int bits = *(int *)data;
1478 ttydevsw_modem(tp, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1, 0);
1482 int bits = *(int *)data;
1483 ttydevsw_modem(tp, 0, (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1);
1487 *(int *)data = TIOCM_LE + (ttydevsw_modem(tp, 0, 0) << 1);
1492 tp->t_flags |= TF_ASYNC;
1494 tp->t_flags &= ~TF_ASYNC;
1497 /* This device supports non-blocking operation. */
1500 *(int *)data = ttyinq_bytescanonicalized(&tp->t_inq);
1504 *(int *)data = ttyoutq_bytesused(&tp->t_outq);
1507 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1508 /* Not allowed to set ownership. */
1511 /* Temporarily unlock the TTY to set ownership. */
1513 error = fsetown(*(int *)data, &tp->t_sigio);
1517 if (tp->t_session != NULL && !tty_is_ctty(tp, td->td_proc))
1518 /* Not allowed to set ownership. */
1521 /* Get ownership. */
1522 *(int *)data = fgetown(&tp->t_sigio);
1525 /* Obtain terminal flags through tcgetattr(). */
1526 *(struct termios*)data = tp->t_termios;
1531 struct termios *t = data;
1534 * Who makes up these funny rules? According to POSIX,
1535 * input baud rate is set equal to the output baud rate
1538 if (t->c_ispeed == 0)
1539 t->c_ispeed = t->c_ospeed;
1541 /* Discard any unsupported bits. */
1542 t->c_iflag &= TTYSUP_IFLAG;
1543 t->c_oflag &= TTYSUP_OFLAG;
1544 t->c_lflag &= TTYSUP_LFLAG;
1545 t->c_cflag &= TTYSUP_CFLAG;
1547 /* Set terminal flags through tcsetattr(). */
1548 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1549 error = tty_drain(tp, 0);
1552 if (cmd == TIOCSETAF)
1553 tty_flush(tp, FREAD);
1557 * Only call param() when the flags really change.
1559 if ((t->c_cflag & CIGNORE) == 0 &&
1560 (tp->t_termios.c_cflag != t->c_cflag ||
1561 ((tp->t_termios.c_iflag ^ t->c_iflag) &
1562 (IXON|IXOFF|IXANY)) ||
1563 tp->t_termios.c_ispeed != t->c_ispeed ||
1564 tp->t_termios.c_ospeed != t->c_ospeed)) {
1565 error = ttydevsw_param(tp, t);
1571 tp->t_termios.c_cflag = t->c_cflag & ~CIGNORE;
1572 tp->t_termios.c_ispeed = t->c_ispeed;
1573 tp->t_termios.c_ospeed = t->c_ospeed;
1575 /* Baud rate has changed - update watermarks. */
1579 /* Copy new non-device driver parameters. */
1580 tp->t_termios.c_iflag = t->c_iflag;
1581 tp->t_termios.c_oflag = t->c_oflag;
1582 tp->t_termios.c_lflag = t->c_lflag;
1583 memcpy(&tp->t_termios.c_cc, t->c_cc, sizeof t->c_cc);
1585 ttydisc_optimize(tp);
1587 if ((t->c_lflag & ICANON) == 0) {
1589 * When in non-canonical mode, wake up all
1590 * readers. Canonicalize any partial input. VMIN
1591 * and VTIME could also be adjusted.
1593 ttyinq_canonicalize(&tp->t_inq);
1594 tty_wakeup(tp, FREAD);
1598 * For packet mode: notify the PTY consumer that VSTOP
1599 * and VSTART may have been changed.
1601 if (tp->t_termios.c_iflag & IXON &&
1602 tp->t_termios.c_cc[VSTOP] == CTRL('S') &&
1603 tp->t_termios.c_cc[VSTART] == CTRL('Q'))
1604 ttydevsw_pktnotify(tp, TIOCPKT_DOSTOP);
1606 ttydevsw_pktnotify(tp, TIOCPKT_NOSTOP);
1610 /* For compatibility - we only support TTYDISC. */
1611 *(int *)data = TTYDISC;
1614 if (!tty_is_ctty(tp, td->td_proc))
1617 if (tp->t_pgrp != NULL)
1618 *(int *)data = tp->t_pgrp->pg_id;
1620 *(int *)data = NO_PID;
1623 if (!tty_is_ctty(tp, td->td_proc))
1626 MPASS(tp->t_session);
1627 *(int *)data = tp->t_session->s_sid;
1630 struct proc *p = td->td_proc;
1632 /* XXX: This looks awful. */
1634 sx_xlock(&proctree_lock);
1637 if (!SESS_LEADER(p)) {
1638 /* Only the session leader may do this. */
1639 sx_xunlock(&proctree_lock);
1643 if (tp->t_session != NULL && tp->t_session == p->p_session) {
1644 /* This is already our controlling TTY. */
1645 sx_xunlock(&proctree_lock);
1649 if (p->p_session->s_ttyp != NULL ||
1650 (tp->t_session != NULL && tp->t_session->s_ttyvp != NULL &&
1651 tp->t_session->s_ttyvp->v_type != VBAD)) {
1653 * There is already a relation between a TTY and
1654 * a session, or the caller is not the session
1657 * Allow the TTY to be stolen when the vnode is
1658 * invalid, but the reference to the TTY is
1659 * still active. This allows immediate reuse of
1660 * TTYs of which the session leader has been
1661 * killed or the TTY revoked.
1663 sx_xunlock(&proctree_lock);
1667 /* Connect the session to the TTY. */
1668 tp->t_session = p->p_session;
1669 tp->t_session->s_ttyp = tp;
1671 sx_xunlock(&proctree_lock);
1673 /* Assign foreground process group. */
1674 tp->t_pgrp = p->p_pgrp;
1676 p->p_flag |= P_CONTROLT;
1685 * XXX: Temporarily unlock the TTY to locate the process
1686 * group. This code would be lot nicer if we would ever
1687 * decompose proctree_lock.
1690 sx_slock(&proctree_lock);
1691 pg = pgfind(*(int *)data);
1694 if (pg == NULL || pg->pg_session != td->td_proc->p_session) {
1695 sx_sunlock(&proctree_lock);
1702 * Determine if this TTY is the controlling TTY after
1703 * relocking the TTY.
1705 if (!tty_is_ctty(tp, td->td_proc)) {
1706 sx_sunlock(&proctree_lock);
1710 sx_sunlock(&proctree_lock);
1712 /* Wake up the background process groups. */
1713 cv_broadcast(&tp->t_bgwait);
1717 int flags = *(int *)data;
1720 flags = (FREAD|FWRITE);
1722 flags &= (FREAD|FWRITE);
1723 tty_flush(tp, flags);
1727 /* Drain TTY output. */
1728 return tty_drain(tp, 0);
1730 /* Set terminal as console TTY. */
1732 error = priv_check(td, PRIV_TTY_CONSOLE);
1737 * XXX: constty should really need to be locked!
1738 * XXX: allow disconnected constty's to be stolen!
1743 if (constty != NULL)
1749 } else if (constty == tp) {
1754 /* Obtain window size. */
1755 *(struct winsize*)data = tp->t_winsize;
1758 /* Set window size. */
1759 tty_set_winsize(tp, data);
1762 tp->t_flags |= TF_EXCLUDE;
1765 tp->t_flags &= ~TF_EXCLUDE;
1768 tp->t_flags |= TF_STOPPED;
1769 ttydevsw_pktnotify(tp, TIOCPKT_STOP);
1772 tp->t_flags &= ~TF_STOPPED;
1773 ttydevsw_outwakeup(tp);
1774 ttydevsw_pktnotify(tp, TIOCPKT_START);
1780 if ((fflag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1782 if (!tty_is_ctty(tp, td->td_proc) &&
1783 priv_check(td, PRIV_TTY_STI))
1785 ttydisc_rint(tp, *(char *)data, 0);
1786 ttydisc_rint_done(tp);
1791 return tty_ioctl_compat(tp, cmd, data, fflag, td);
1792 #else /* !COMPAT_43TTY */
1794 #endif /* COMPAT_43TTY */
1798 tty_ioctl(struct tty *tp, u_long cmd, void *data, int fflag, struct thread *td)
1802 tty_lock_assert(tp, MA_OWNED);
1807 error = ttydevsw_ioctl(tp, cmd, data, td);
1808 if (error == ENOIOCTL)
1809 error = tty_generic_ioctl(tp, cmd, data, fflag, td);
1815 tty_udev(struct tty *tp)
1818 return dev2udev(tp->t_dev);
1824 tty_checkoutq(struct tty *tp)
1827 /* 256 bytes should be enough to print a log message. */
1828 return (ttyoutq_bytesleft(&tp->t_outq) >= 256);
1832 tty_hiwat_in_block(struct tty *tp)
1835 if ((tp->t_flags & TF_HIWAT_IN) == 0 &&
1836 tp->t_termios.c_iflag & IXOFF &&
1837 tp->t_termios.c_cc[VSTOP] != _POSIX_VDISABLE) {
1839 * Input flow control. Only enter the high watermark when we
1840 * can successfully store the VSTOP character.
1842 if (ttyoutq_write_nofrag(&tp->t_outq,
1843 &tp->t_termios.c_cc[VSTOP], 1) == 0)
1844 tp->t_flags |= TF_HIWAT_IN;
1846 /* No input flow control. */
1847 tp->t_flags |= TF_HIWAT_IN;
1852 tty_hiwat_in_unblock(struct tty *tp)
1855 if (tp->t_flags & TF_HIWAT_IN &&
1856 tp->t_termios.c_iflag & IXOFF &&
1857 tp->t_termios.c_cc[VSTART] != _POSIX_VDISABLE) {
1859 * Input flow control. Only leave the high watermark when we
1860 * can successfully store the VSTART character.
1862 if (ttyoutq_write_nofrag(&tp->t_outq,
1863 &tp->t_termios.c_cc[VSTART], 1) == 0)
1864 tp->t_flags &= ~TF_HIWAT_IN;
1866 /* No input flow control. */
1867 tp->t_flags &= ~TF_HIWAT_IN;
1871 ttydevsw_inwakeup(tp);
1875 * TTY hooks interface.
1879 ttyhook_defrint(struct tty *tp, char c, int flags)
1882 if (ttyhook_rint_bypass(tp, &c, 1) != 1)
1889 ttyhook_register(struct tty **rtp, struct proc *p, int fd,
1890 struct ttyhook *th, void *softc)
1896 struct filedesc *fdp;
1897 cap_rights_t rights;
1900 /* Validate the file descriptor. */
1902 error = fget_unlocked(fdp, fd, cap_rights_init(&rights, CAP_TTYHOOK),
1906 if (fp->f_ops == &badfileops) {
1912 * Make sure the vnode is bound to a character device.
1913 * Unlocked check for the vnode type is ok there, because we
1914 * only shall prevent calling devvn_refthread on the file that
1915 * never has been opened over a character device.
1917 if (fp->f_type != DTYPE_VNODE || fp->f_vnode->v_type != VCHR) {
1922 /* Make sure it is a TTY. */
1923 cdp = devvn_refthread(fp->f_vnode, &dev, &ref);
1928 if (dev != fp->f_data) {
1932 if (cdp != &ttydev_cdevsw) {
1938 /* Try to attach the hook to the TTY. */
1941 MPASS((tp->t_hook == NULL) == ((tp->t_flags & TF_HOOK) == 0));
1942 if (tp->t_flags & TF_HOOK)
1945 tp->t_flags |= TF_HOOK;
1947 tp->t_hooksoftc = softc;
1951 /* Maybe we can switch into bypass mode now. */
1952 ttydisc_optimize(tp);
1954 /* Silently convert rint() calls to rint_bypass() when possible. */
1955 if (!ttyhook_hashook(tp, rint) && ttyhook_hashook(tp, rint_bypass))
1956 th->th_rint = ttyhook_defrint;
1958 done3: tty_unlock(tp);
1959 done2: dev_relthread(dev, ref);
1960 done1: fdrop(fp, curthread);
1965 ttyhook_unregister(struct tty *tp)
1968 tty_lock_assert(tp, MA_OWNED);
1969 MPASS(tp->t_flags & TF_HOOK);
1971 /* Disconnect the hook. */
1972 tp->t_flags &= ~TF_HOOK;
1975 /* Maybe we need to leave bypass mode. */
1976 ttydisc_optimize(tp);
1978 /* Maybe deallocate the TTY as well. */
1983 * /dev/console handling.
1987 ttyconsdev_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
1991 /* System has no console device. */
1992 if (dev_console_filename == NULL)
1995 /* Look up corresponding TTY by device name. */
1996 sx_slock(&tty_list_sx);
1997 TAILQ_FOREACH(tp, &tty_list, t_list) {
1998 if (strcmp(dev_console_filename, tty_devname(tp)) == 0) {
1999 dev_console->si_drv1 = tp;
2003 sx_sunlock(&tty_list_sx);
2005 /* System console has no TTY associated. */
2006 if (dev_console->si_drv1 == NULL)
2009 return (ttydev_open(dev, oflags, devtype, td));
2013 ttyconsdev_write(struct cdev *dev, struct uio *uio, int ioflag)
2018 return (ttydev_write(dev, uio, ioflag));
2022 * /dev/console is a little different than normal TTY's. When opened,
2023 * it determines which TTY to use. When data gets written to it, it
2024 * will be logged in the kernel message buffer.
2026 static struct cdevsw ttyconsdev_cdevsw = {
2027 .d_version = D_VERSION,
2028 .d_open = ttyconsdev_open,
2029 .d_close = ttydev_close,
2030 .d_read = ttydev_read,
2031 .d_write = ttyconsdev_write,
2032 .d_ioctl = ttydev_ioctl,
2033 .d_kqfilter = ttydev_kqfilter,
2034 .d_poll = ttydev_poll,
2035 .d_mmap = ttydev_mmap,
2036 .d_name = "ttyconsdev",
2041 ttyconsdev_init(void *unused)
2044 dev_console = make_dev_credf(MAKEDEV_ETERNAL, &ttyconsdev_cdevsw, 0,
2045 NULL, UID_ROOT, GID_WHEEL, 0600, "console");
2048 SYSINIT(tty, SI_SUB_DRIVERS, SI_ORDER_FIRST, ttyconsdev_init, NULL);
2051 ttyconsdev_select(const char *name)
2054 dev_console_filename = name;
2058 * Debugging routines.
2061 #include "opt_ddb.h"
2063 #include <ddb/ddb.h>
2064 #include <ddb/db_sym.h>
2071 { TF_NOPREFIX, 'N' },
2073 { TF_INITLOCK, 'I' },
2074 { TF_CALLOUT, 'C' },
2076 /* Keep these together -> 'Oi' and 'Oo'. */
2078 { TF_OPENED_IN, 'i' },
2079 { TF_OPENED_OUT, 'o' },
2080 { TF_OPENED_CONS, 'c' },
2083 { TF_OPENCLOSE, 'B' },
2085 { TF_LITERAL, 'L' },
2087 /* Keep these together -> 'Hi' and 'Ho'. */
2089 { TF_HIWAT_IN, 'i' },
2090 { TF_HIWAT_OUT, 'o' },
2092 { TF_STOPPED, 'S' },
2093 { TF_EXCLUDE, 'X' },
2098 /* Keep these together -> 'bi' and 'bo'. */
2100 { TF_BUSY_IN, 'i' },
2101 { TF_BUSY_OUT, 'o' },
2106 #define TTY_FLAG_BITS \
2107 "\20\1NOPREFIX\2INITLOCK\3CALLOUT\4OPENED_IN\5OPENED_OUT\6GONE" \
2108 "\7OPENCLOSE\10ASYNC\11LITERAL\12HIWAT_IN\13HIWAT_OUT\14STOPPED" \
2109 "\15EXCLUDE\16BYPASS\17ZOMBIE\20HOOK"
2111 #define DB_PRINTSYM(name, addr) \
2112 db_printf("%s " #name ": ", sep); \
2113 db_printsym((db_addr_t) addr, DB_STGY_ANY); \
2117 _db_show_devsw(const char *sep, const struct ttydevsw *tsw)
2119 db_printf("%sdevsw: ", sep);
2120 db_printsym((db_addr_t)tsw, DB_STGY_ANY);
2121 db_printf(" (%p)\n", tsw);
2122 DB_PRINTSYM(open, tsw->tsw_open);
2123 DB_PRINTSYM(close, tsw->tsw_close);
2124 DB_PRINTSYM(outwakeup, tsw->tsw_outwakeup);
2125 DB_PRINTSYM(inwakeup, tsw->tsw_inwakeup);
2126 DB_PRINTSYM(ioctl, tsw->tsw_ioctl);
2127 DB_PRINTSYM(param, tsw->tsw_param);
2128 DB_PRINTSYM(modem, tsw->tsw_modem);
2129 DB_PRINTSYM(mmap, tsw->tsw_mmap);
2130 DB_PRINTSYM(pktnotify, tsw->tsw_pktnotify);
2131 DB_PRINTSYM(free, tsw->tsw_free);
2134 _db_show_hooks(const char *sep, const struct ttyhook *th)
2136 db_printf("%shook: ", sep);
2137 db_printsym((db_addr_t)th, DB_STGY_ANY);
2138 db_printf(" (%p)\n", th);
2141 DB_PRINTSYM(rint, th->th_rint);
2142 DB_PRINTSYM(rint_bypass, th->th_rint_bypass);
2143 DB_PRINTSYM(rint_done, th->th_rint_done);
2144 DB_PRINTSYM(rint_poll, th->th_rint_poll);
2145 DB_PRINTSYM(getc_inject, th->th_getc_inject);
2146 DB_PRINTSYM(getc_capture, th->th_getc_capture);
2147 DB_PRINTSYM(getc_poll, th->th_getc_poll);
2148 DB_PRINTSYM(close, th->th_close);
2152 _db_show_termios(const char *name, const struct termios *t)
2155 db_printf("%s: iflag 0x%x oflag 0x%x cflag 0x%x "
2156 "lflag 0x%x ispeed %u ospeed %u\n", name,
2157 t->c_iflag, t->c_oflag, t->c_cflag, t->c_lflag,
2158 t->c_ispeed, t->c_ospeed);
2161 /* DDB command to show TTY statistics. */
2162 DB_SHOW_COMMAND(tty, db_show_tty)
2167 db_printf("usage: show tty <addr>\n");
2170 tp = (struct tty *)addr;
2172 db_printf("0x%p: %s\n", tp, tty_devname(tp));
2173 db_printf("\tmtx: %p\n", tp->t_mtx);
2174 db_printf("\tflags: %b\n", tp->t_flags, TTY_FLAG_BITS);
2175 db_printf("\trevokecnt: %u\n", tp->t_revokecnt);
2177 /* Buffering mechanisms. */
2178 db_printf("\tinq: %p begin %u linestart %u reprint %u end %u "
2179 "nblocks %u quota %u\n", &tp->t_inq, tp->t_inq.ti_begin,
2180 tp->t_inq.ti_linestart, tp->t_inq.ti_reprint, tp->t_inq.ti_end,
2181 tp->t_inq.ti_nblocks, tp->t_inq.ti_quota);
2182 db_printf("\toutq: %p begin %u end %u nblocks %u quota %u\n",
2183 &tp->t_outq, tp->t_outq.to_begin, tp->t_outq.to_end,
2184 tp->t_outq.to_nblocks, tp->t_outq.to_quota);
2185 db_printf("\tinlow: %zu\n", tp->t_inlow);
2186 db_printf("\toutlow: %zu\n", tp->t_outlow);
2187 _db_show_termios("\ttermios", &tp->t_termios);
2188 db_printf("\twinsize: row %u col %u xpixel %u ypixel %u\n",
2189 tp->t_winsize.ws_row, tp->t_winsize.ws_col,
2190 tp->t_winsize.ws_xpixel, tp->t_winsize.ws_ypixel);
2191 db_printf("\tcolumn: %u\n", tp->t_column);
2192 db_printf("\twritepos: %u\n", tp->t_writepos);
2193 db_printf("\tcompatflags: 0x%x\n", tp->t_compatflags);
2195 /* Init/lock-state devices. */
2196 _db_show_termios("\ttermios_init_in", &tp->t_termios_init_in);
2197 _db_show_termios("\ttermios_init_out", &tp->t_termios_init_out);
2198 _db_show_termios("\ttermios_lock_in", &tp->t_termios_lock_in);
2199 _db_show_termios("\ttermios_lock_out", &tp->t_termios_lock_out);
2202 _db_show_devsw("\t", tp->t_devsw);
2203 _db_show_hooks("\t", tp->t_hook);
2206 db_printf("\tpgrp: %p gid %d jobc %d\n", tp->t_pgrp,
2207 tp->t_pgrp ? tp->t_pgrp->pg_id : 0,
2208 tp->t_pgrp ? tp->t_pgrp->pg_jobc : 0);
2209 db_printf("\tsession: %p", tp->t_session);
2210 if (tp->t_session != NULL)
2211 db_printf(" count %u leader %p tty %p sid %d login %s",
2212 tp->t_session->s_count, tp->t_session->s_leader,
2213 tp->t_session->s_ttyp, tp->t_session->s_sid,
2214 tp->t_session->s_login);
2216 db_printf("\tsessioncnt: %u\n", tp->t_sessioncnt);
2217 db_printf("\tdevswsoftc: %p\n", tp->t_devswsoftc);
2218 db_printf("\thooksoftc: %p\n", tp->t_hooksoftc);
2219 db_printf("\tdev: %p\n", tp->t_dev);
2222 /* DDB command to list TTYs. */
2223 DB_SHOW_ALL_COMMAND(ttys, db_show_all_ttys)
2229 /* Make the output look like `pstat -t'. */
2231 #if defined(__LP64__)
2234 db_printf(" LINE INQ CAN LIN LOW OUTQ USE LOW "
2235 "COL SESS PGID STATE\n");
2237 TAILQ_FOREACH(tp, &tty_list, t_list) {
2238 isiz = tp->t_inq.ti_nblocks * TTYINQ_DATASIZE;
2239 osiz = tp->t_outq.to_nblocks * TTYOUTQ_DATASIZE;
2241 db_printf("%p %10s %5zu %4u %4u %4zu %5zu %4u %4zu %5u %5d %5d ",
2245 tp->t_inq.ti_linestart - tp->t_inq.ti_begin,
2246 tp->t_inq.ti_end - tp->t_inq.ti_linestart,
2249 tp->t_outq.to_end - tp->t_outq.to_begin,
2250 osiz - tp->t_outlow,
2251 MIN(tp->t_column, 99999),
2252 tp->t_session ? tp->t_session->s_sid : 0,
2253 tp->t_pgrp ? tp->t_pgrp->pg_id : 0);
2256 for (i = j = 0; ttystates[i].flag; i++)
2257 if (tp->t_flags & ttystates[i].flag) {
2258 db_printf("%c", ttystates[i].val);