2 * Copyright (c) 1982, 1986, 1990, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)tty.c 8.8 (Berkeley) 1/21/94
39 * $FreeBSD: src/sys/kern/tty.c,v 1.129.2.5 2002/03/11 01:32:31 dd Exp $
40 * $DragonFly: src/sys/kern/tty.c,v 1.12 2004/09/13 16:22:36 dillon Exp $
45 * o Fix races for sending the start char in ttyflush().
46 * o Handle inter-byte timeout for "MIN > 0, TIME > 0" in ttyselect().
47 * With luck, there will be MIN chars before select() returns().
48 * o Handle CLOCAL consistently for ptys. Perhaps disallow setting it.
49 * o Don't allow input in TS_ZOMBIE case. It would be visible through
51 * o Do the new sio locking stuff here and use it to avoid special
54 * o Move EXTPROC and/or PENDIN to t_state?
55 * o Wrap most of ttioctl in spltty/splx.
56 * o Implement TIOCNOTTY or remove it from <sys/ioctl.h>.
57 * o Send STOP if IXOFF is toggled off while TS_TBLOCK is set.
58 * o Don't allow certain termios flags to affect disciplines other
59 * than TTYDISC. Cancel their effects before switch disciplines
60 * and ignore them if they are set while we are in another
62 * o Now that historical speed conversions are handled here, don't
64 * o Check for TS_CARR_ON being set while everything is closed and not
65 * waiting for carrier. TS_CARR_ON isn't cleared if nothing is open,
66 * so it would live until the next open even if carrier drops.
67 * o Restore TS_WOPEN since it is useful in pstat. It must be cleared
68 * only when _all_ openers leave open().
71 #include "opt_compat.h"
72 #include "opt_uconsole.h"
74 #include <sys/param.h>
75 #include <sys/systm.h>
76 #include <sys/filio.h>
77 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
78 #include <sys/ioctl_compat.h>
84 #include <sys/fcntl.h>
86 #include <sys/dkstat.h>
88 #include <sys/kernel.h>
89 #include <sys/vnode.h>
90 #include <sys/signalvar.h>
91 #include <sys/resourcevar.h>
92 #include <sys/malloc.h>
93 #include <sys/filedesc.h>
94 #include <sys/sysctl.h>
95 #include <sys/thread2.h>
100 #include <vm/vm_map.h>
102 MALLOC_DEFINE(M_TTYS, "ttys", "tty data structures");
104 static int proc_compare (struct proc *p1, struct proc *p2);
105 static int ttnread (struct tty *tp);
106 static void ttyecho (int c, struct tty *tp);
107 static int ttyoutput (int c, struct tty *tp);
108 static void ttypend (struct tty *tp);
109 static void ttyretype (struct tty *tp);
110 static void ttyrub (int c, struct tty *tp);
111 static void ttyrubo (struct tty *tp, int cnt);
112 static void ttyunblock (struct tty *tp);
113 static int ttywflush (struct tty *tp);
114 static int filt_ttyread (struct knote *kn, long hint);
115 static void filt_ttyrdetach (struct knote *kn);
116 static int filt_ttywrite (struct knote *kn, long hint);
117 static void filt_ttywdetach (struct knote *kn);
120 * Table with character classes and parity. The 8th bit indicates parity,
121 * the 7th bit indicates the character is an alphameric or underscore (for
122 * ALTWERASE), and the low 6 bits indicate delay type. If the low 6 bits
123 * are 0 then the character needs no special processing on output; classes
124 * other than 0 might be translated or (not currently) require delays.
126 #define E 0x00 /* Even parity. */
127 #define O 0x80 /* Odd parity. */
128 #define PARITY(c) (char_type[c] & O)
130 #define ALPHA 0x40 /* Alpha or underscore. */
131 #define ISALPHA(c) (char_type[(c) & TTY_CHARMASK] & ALPHA)
133 #define CCLASSMASK 0x3f
134 #define CCLASS(c) (char_type[c] & CCLASSMASK)
139 #define NA ORDINARY | ALPHA
145 static u_char const char_type[] = {
146 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* nul - bel */
147 O|BS, E|TB, E|NL, O|CC, E|VT, O|CR, O|CC, E|CC, /* bs - si */
148 O|CC, E|CC, E|CC, O|CC, E|CC, O|CC, O|CC, E|CC, /* dle - etb */
149 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* can - us */
150 O|NO, E|NO, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* sp - ' */
151 E|NO, O|NO, O|NO, E|NO, O|NO, E|NO, E|NO, O|NO, /* ( - / */
152 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* 0 - 7 */
153 O|NA, E|NA, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* 8 - ? */
154 O|NO, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* @ - G */
155 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* H - O */
156 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* P - W */
157 O|NA, E|NA, E|NA, O|NO, E|NO, O|NO, O|NO, O|NA, /* X - _ */
158 E|NO, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* ` - g */
159 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* h - o */
160 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* p - w */
161 E|NA, O|NA, O|NA, E|NO, O|NO, E|NO, E|NO, O|CC, /* x - del */
163 * Meta chars; should be settable per character set;
164 * for now, treat them all as normal characters.
166 NA, NA, NA, NA, NA, NA, NA, NA,
167 NA, NA, NA, NA, NA, NA, NA, NA,
168 NA, NA, NA, NA, NA, NA, NA, NA,
169 NA, NA, NA, NA, NA, NA, NA, NA,
170 NA, NA, NA, NA, NA, NA, NA, NA,
171 NA, NA, NA, NA, NA, NA, NA, NA,
172 NA, NA, NA, NA, NA, NA, NA, NA,
173 NA, NA, NA, NA, NA, NA, NA, NA,
174 NA, NA, NA, NA, NA, NA, NA, NA,
175 NA, NA, NA, NA, NA, NA, NA, NA,
176 NA, NA, NA, NA, NA, NA, NA, NA,
177 NA, NA, NA, NA, NA, NA, NA, NA,
178 NA, NA, NA, NA, NA, NA, NA, NA,
179 NA, NA, NA, NA, NA, NA, NA, NA,
180 NA, NA, NA, NA, NA, NA, NA, NA,
181 NA, NA, NA, NA, NA, NA, NA, NA,
192 /* Macros to clear/set/test flags. */
193 #define SET(t, f) (t) |= (f)
194 #define CLR(t, f) (t) &= ~(f)
195 #define ISSET(t, f) ((t) & (f))
197 #undef MAX_INPUT /* XXX wrong in <sys/syslimits.h> */
198 #define MAX_INPUT TTYHOG /* XXX limit is usually larger for !ICANON */
201 * list of struct tty where pstat(8) can pick it up with sysctl
203 static SLIST_HEAD(, tty) tty_list;
206 * Initial open of tty, or (re)entry to standard tty line discipline.
217 if (!ISSET(tp->t_state, TS_ISOPEN)) {
218 SET(tp->t_state, TS_ISOPEN);
219 if (ISSET(tp->t_cflag, CLOCAL))
220 SET(tp->t_state, TS_CONNECTED);
221 bzero(&tp->t_winsize, sizeof(tp->t_winsize));
229 * Handle close() on a tty line: flush and set to initial state,
230 * bumping generation number so that pending read/write calls
231 * can detect recycling of the tty.
233 * XXX our caller should have done `spltty(); l_close(); ttyclose();'
234 * and l_close() should have flushed, but we repeat the spltty() and
235 * the flush in case there are buggy callers.
243 funsetown(tp->t_sigio);
248 ttyflush(tp, FREAD | FWRITE);
249 clist_free_cblocks(&tp->t_canq);
250 clist_free_cblocks(&tp->t_outq);
251 clist_free_cblocks(&tp->t_rawq);
254 tp->t_line = TTYDISC;
262 * Disassociate the tty from its session. Traditionally this has only been
263 * a half-close, meaning that the session was still allowed to point at the
264 * tty (resulting in the tty in the ps command showing something like 'p0-'),
265 * even though the tty is no longer pointing at the session.
267 * The half close seems to be useful only for 'ps' output but there is as
268 * yet no reason to remove the feature. The full-close code is currently
269 * #if 0'd out. See also sess_rele() in kern/kern_proc.c.
272 ttyclearsession(struct tty *tp)
277 if ((sp = tp->t_session) != NULL) {
278 tp->t_session = NULL;
279 #ifdef TTY_DO_FULL_CLOSE
280 /* FULL CLOSE (not yet) */
281 if (sp->s_ttyp == tp) {
284 printf("ttyclearsession: warning: sp->s_ttyp != tp "
285 "%p/%p\n", sp->s_ttyp, tp);
291 #define FLUSHQ(q) { \
293 ndflush(q, (q)->c_cc); \
296 /* Is 'c' a line delimiter ("break" character)? */
297 #define TTBREAKC(c, lflag) \
298 ((c) == '\n' || (((c) == cc[VEOF] || \
299 (c) == cc[VEOL] || ((c) == cc[VEOL2] && lflag & IEXTEN)) && \
300 (c) != _POSIX_VDISABLE))
303 * Process input of a single character received on a tty.
310 tcflag_t iflag, lflag;
315 * If input is pending take it first.
318 if (ISSET(lflag, PENDIN))
323 if (ISSET(lflag, ICANON)) {
333 * Block further input iff:
334 * current input > threshold AND input is available to user program
335 * AND input flow control is enabled and not yet invoked.
336 * The 3 is slop for PARMRK.
339 if (tp->t_rawq.c_cc + tp->t_canq.c_cc > tp->t_ihiwat - 3 &&
340 (!ISSET(lflag, ICANON) || tp->t_canq.c_cc != 0) &&
341 (ISSET(tp->t_cflag, CRTS_IFLOW) || ISSET(iflag, IXOFF)) &&
342 !ISSET(tp->t_state, TS_TBLOCK))
345 /* Handle exceptional conditions (break, parity, framing). */
347 err = (ISSET(c, TTY_ERRORMASK));
349 CLR(c, TTY_ERRORMASK);
350 if (ISSET(err, TTY_BI)) {
351 if (ISSET(iflag, IGNBRK))
353 if (ISSET(iflag, BRKINT)) {
354 ttyflush(tp, FREAD | FWRITE);
355 pgsignal(tp->t_pgrp, SIGINT, 1);
358 if (ISSET(iflag, PARMRK))
360 } else if ((ISSET(err, TTY_PE) && ISSET(iflag, INPCK))
361 || ISSET(err, TTY_FE)) {
362 if (ISSET(iflag, IGNPAR))
364 else if (ISSET(iflag, PARMRK)) {
366 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >
369 (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
370 (void)putc(0 | TTY_QUOTE, &tp->t_rawq);
371 (void)putc(c | TTY_QUOTE, &tp->t_rawq);
378 if (!ISSET(tp->t_state, TS_TYPEN) && ISSET(iflag, ISTRIP))
380 if (!ISSET(lflag, EXTPROC)) {
382 * Check for literal nexting very first
384 if (ISSET(tp->t_state, TS_LNCH)) {
386 CLR(tp->t_state, TS_LNCH);
389 * Scan for special characters. This code
390 * is really just a big case statement with
391 * non-constant cases. The bottom of the
392 * case statement is labeled ``endcase'', so goto
393 * it after a case match, or similar.
397 * Control chars which aren't controlled
398 * by ICANON, ISIG, or IXON.
400 if (ISSET(lflag, IEXTEN)) {
401 if (CCEQ(cc[VLNEXT], c)) {
402 if (ISSET(lflag, ECHO)) {
403 if (ISSET(lflag, ECHOE)) {
404 (void)ttyoutput('^', tp);
405 (void)ttyoutput('\b', tp);
409 SET(tp->t_state, TS_LNCH);
412 if (CCEQ(cc[VDISCARD], c)) {
413 if (ISSET(lflag, FLUSHO))
414 CLR(tp->t_lflag, FLUSHO);
416 ttyflush(tp, FWRITE);
418 if (tp->t_rawq.c_cc + tp->t_canq.c_cc)
420 SET(tp->t_lflag, FLUSHO);
428 if (ISSET(lflag, ISIG)) {
429 if (CCEQ(cc[VINTR], c) || CCEQ(cc[VQUIT], c)) {
430 if (!ISSET(lflag, NOFLSH))
431 ttyflush(tp, FREAD | FWRITE);
434 CCEQ(cc[VINTR], c) ? SIGINT : SIGQUIT, 1);
437 if (CCEQ(cc[VSUSP], c)) {
438 if (!ISSET(lflag, NOFLSH))
441 pgsignal(tp->t_pgrp, SIGTSTP, 1);
446 * Handle start/stop characters.
448 if (ISSET(iflag, IXON)) {
449 if (CCEQ(cc[VSTOP], c)) {
450 if (!ISSET(tp->t_state, TS_TTSTOP)) {
451 SET(tp->t_state, TS_TTSTOP);
452 (*tp->t_stop)(tp, 0);
455 if (!CCEQ(cc[VSTART], c))
458 * if VSTART == VSTOP then toggle
462 if (CCEQ(cc[VSTART], c))
466 * IGNCR, ICRNL, & INLCR
469 if (ISSET(iflag, IGNCR))
471 else if (ISSET(iflag, ICRNL))
473 } else if (c == '\n' && ISSET(iflag, INLCR))
476 if (!ISSET(tp->t_lflag, EXTPROC) && ISSET(lflag, ICANON)) {
478 * From here on down canonical mode character
479 * processing takes place.
482 * erase or erase2 (^H / ^?)
484 if (CCEQ(cc[VERASE], c) || CCEQ(cc[VERASE2], c) ) {
486 ttyrub(unputc(&tp->t_rawq), tp);
492 if (CCEQ(cc[VKILL], c)) {
493 if (ISSET(lflag, ECHOKE) &&
494 tp->t_rawq.c_cc == tp->t_rocount &&
495 !ISSET(lflag, ECHOPRT))
496 while (tp->t_rawq.c_cc)
497 ttyrub(unputc(&tp->t_rawq), tp);
500 if (ISSET(lflag, ECHOK) ||
501 ISSET(lflag, ECHOKE))
506 CLR(tp->t_state, TS_LOCAL);
512 if (CCEQ(cc[VWERASE], c) && ISSET(lflag, IEXTEN)) {
518 while ((c = unputc(&tp->t_rawq)) == ' ' || c == '\t')
523 * erase last char of word and remember the
524 * next chars type (for ALTWERASE)
527 c = unputc(&tp->t_rawq);
530 if (c == ' ' || c == '\t') {
531 (void)putc(c, &tp->t_rawq);
540 c = unputc(&tp->t_rawq);
543 } while (c != ' ' && c != '\t' &&
544 (!ISSET(lflag, ALTWERASE) || ISALPHA(c) == ctype));
545 (void)putc(c, &tp->t_rawq);
551 if (CCEQ(cc[VREPRINT], c) && ISSET(lflag, IEXTEN)) {
556 * ^T - kernel info and generate SIGINFO
558 if (CCEQ(cc[VSTATUS], c) && ISSET(lflag, IEXTEN)) {
559 if (ISSET(lflag, ISIG))
560 pgsignal(tp->t_pgrp, SIGINFO, 1);
561 if (!ISSET(lflag, NOKERNINFO))
565 if (CCEQ(cc[VCHECKPT], c) && ISSET(lflag, IEXTEN)) {
566 if (ISSET(lflag, ISIG))
567 pgsignal(tp->t_pgrp, SIGCKPT, 1);
572 * Check for input buffer overflow
574 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >= MAX_INPUT) {
576 if (ISSET(iflag, IMAXBEL)) {
577 if (tp->t_outq.c_cc < tp->t_ohiwat)
578 (void)ttyoutput(CTRL('g'), tp);
583 if ( c == 0377 && ISSET(iflag, PARMRK) && !ISSET(iflag, ISTRIP)
584 && ISSET(iflag, IGNBRK|IGNPAR) != (IGNBRK|IGNPAR))
585 (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
588 * Put data char in q for user and
589 * wakeup on seeing a line delimiter.
591 if (putc(c, &tp->t_rawq) >= 0) {
592 if (!ISSET(lflag, ICANON)) {
597 if (TTBREAKC(c, lflag)) {
599 catq(&tp->t_rawq, &tp->t_canq);
601 } else if (tp->t_rocount++ == 0)
602 tp->t_rocol = tp->t_column;
603 if (ISSET(tp->t_state, TS_ERASE)) {
605 * end of prterase \.../
607 CLR(tp->t_state, TS_ERASE);
608 (void)ttyoutput('/', tp);
612 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ECHO)) {
614 * Place the cursor over the '^' of the ^D.
616 i = imin(2, tp->t_column - i);
618 (void)ttyoutput('\b', tp);
625 * IXANY means allow any character to restart output.
627 if (ISSET(tp->t_state, TS_TTSTOP) &&
628 !ISSET(iflag, IXANY) && cc[VSTART] != cc[VSTOP])
631 CLR(tp->t_lflag, FLUSHO);
632 CLR(tp->t_state, TS_TTSTOP);
634 return (ttstart(tp));
638 * Output a single character on a tty, doing output processing
639 * as needed (expanding tabs, newline processing, etc.).
640 * Returns < 0 if succeeds, otherwise returns char to resend.
652 if (!ISSET(oflag, OPOST)) {
653 if (ISSET(tp->t_lflag, FLUSHO))
655 if (putc(c, &tp->t_outq))
662 * Do tab expansion if OXTABS is set. Special case if we external
663 * processing, we don't do the tab expansion because we'll probably
664 * get it wrong. If tab expansion needs to be done, let it happen
667 CLR(c, ~TTY_CHARMASK);
669 ISSET(oflag, OXTABS) && !ISSET(tp->t_lflag, EXTPROC)) {
670 c = 8 - (tp->t_column & 7);
671 if (!ISSET(tp->t_lflag, FLUSHO)) {
672 s = spltty(); /* Don't interrupt tabs. */
673 c -= b_to_q(" ", c, &tp->t_outq);
679 return (c ? -1 : '\t');
681 if (c == CEOT && ISSET(oflag, ONOEOT))
685 * Newline translation: if ONLCR is set,
686 * translate newline into "\r\n".
688 if (c == '\n' && ISSET(tp->t_oflag, ONLCR)) {
691 if (!ISSET(tp->t_lflag, FLUSHO) && putc('\r', &tp->t_outq))
694 /* If OCRNL is set, translate "\r" into "\n". */
695 else if (c == '\r' && ISSET(tp->t_oflag, OCRNL))
697 /* If ONOCR is set, don't transmit CRs when on column 0. */
698 else if (c == '\r' && ISSET(tp->t_oflag, ONOCR) && tp->t_column == 0)
703 if (!ISSET(tp->t_lflag, FLUSHO) && putc(c, &tp->t_outq))
715 if (ISSET(tp->t_oflag, ONLCR | ONLRET))
725 col = (col + 8) & ~7;
733 * Ioctls for all tty devices. Called after line-discipline specific ioctl
734 * has been called to do discipline-specific functions and/or reject any
735 * of these ioctl commands.
739 ttioctl(struct tty *tp, u_long cmd, void *data, int flag)
741 struct thread *td = curthread;
742 struct proc *p = td->td_proc;
747 /* If the ioctl involves modification, hang if in the background. */
771 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
781 while (isbackground(p, tp) && !(p->p_flag & P_PPWAIT) &&
782 !SIGISMEMBER(p->p_sigignore, SIGTTOU) &&
783 !SIGISMEMBER(p->p_sigmask, SIGTTOU)) {
784 if (p->p_pgrp->pg_jobc == 0)
786 pgsignal(p->p_pgrp, SIGTTOU, 1);
787 error = ttysleep(tp, &lbolt, PCATCH, "ttybg1",
795 switch (cmd) { /* Process the ioctl. */
796 case FIOASYNC: /* set/clear async i/o */
799 SET(tp->t_state, TS_ASYNC);
801 CLR(tp->t_state, TS_ASYNC);
804 case FIONBIO: /* set/clear non-blocking i/o */
805 break; /* XXX: delete. */
806 case FIONREAD: /* get # bytes to read */
808 *(int *)data = ttnread(tp);
814 * Policy -- Don't allow FIOSETOWN on someone else's
817 if (tp->t_session != NULL && !isctty(p, tp))
820 error = fsetown(*(int *)data, &tp->t_sigio);
825 if (tp->t_session != NULL && !isctty(p, tp))
827 *(int *)data = fgetown(tp->t_sigio);
830 case TIOCEXCL: /* set exclusive use of tty */
832 SET(tp->t_state, TS_XCLUDE);
835 case TIOCFLUSH: { /* flush buffers */
836 int flags = *(int *)data;
839 flags = FREAD | FWRITE;
841 flags &= FREAD | FWRITE;
845 case TIOCCONS: /* become virtual console */
847 if (constty && constty != tp &&
848 ISSET(constty->t_state, TS_CONNECTED))
851 if ((error = suser(td)) != 0)
855 } else if (tp == constty)
858 case TIOCDRAIN: /* wait till output drained */
863 case TIOCGETA: { /* get termios struct */
864 struct termios *t = (struct termios *)data;
866 bcopy(&tp->t_termios, t, sizeof(struct termios));
869 case TIOCGETD: /* get line discipline */
870 *(int *)data = tp->t_line;
872 case TIOCGWINSZ: /* get window size */
873 *(struct winsize *)data = tp->t_winsize;
875 case TIOCGPGRP: /* get pgrp of tty */
878 *(int *)data = tp->t_pgrp ? tp->t_pgrp->pg_id : NO_PID;
881 case TIOCHPCL: /* hang up on last close */
883 SET(tp->t_cflag, HUPCL);
887 case TIOCNXCL: /* reset exclusive use of tty */
889 CLR(tp->t_state, TS_XCLUDE);
892 case TIOCOUTQ: /* output queue size */
893 *(int *)data = tp->t_outq.c_cc;
895 case TIOCSETA: /* set termios struct */
896 case TIOCSETAW: /* drain output, set */
897 case TIOCSETAF: { /* drn out, fls in, set */
898 struct termios *t = (struct termios *)data;
900 if (t->c_ispeed == 0)
901 t->c_ispeed = t->c_ospeed;
902 if (t->c_ispeed == 0)
903 t->c_ispeed = tp->t_ospeed;
904 if (t->c_ispeed == 0)
907 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
913 if (cmd == TIOCSETAF)
916 if (!ISSET(t->c_cflag, CIGNORE)) {
918 * Set device hardware.
920 if (tp->t_param && (error = (*tp->t_param)(tp, t))) {
924 if (ISSET(t->c_cflag, CLOCAL) &&
925 !ISSET(tp->t_cflag, CLOCAL)) {
927 * XXX disconnections would be too hard to
928 * get rid of without this kludge. The only
929 * way to get rid of controlling terminals
930 * is to exit from the session leader.
932 CLR(tp->t_state, TS_ZOMBIE);
934 wakeup(TSA_CARR_ON(tp));
938 if ((ISSET(tp->t_state, TS_CARR_ON) ||
939 ISSET(t->c_cflag, CLOCAL)) &&
940 !ISSET(tp->t_state, TS_ZOMBIE))
941 SET(tp->t_state, TS_CONNECTED);
943 CLR(tp->t_state, TS_CONNECTED);
944 tp->t_cflag = t->c_cflag;
945 tp->t_ispeed = t->c_ispeed;
946 if (t->c_ospeed != 0)
947 tp->t_ospeed = t->c_ospeed;
950 if (ISSET(t->c_lflag, ICANON) != ISSET(tp->t_lflag, ICANON) &&
952 if (ISSET(t->c_lflag, ICANON))
953 SET(tp->t_lflag, PENDIN);
956 * XXX we really shouldn't allow toggling
957 * ICANON while we're in a non-termios line
958 * discipline. Now we have to worry about
959 * panicing for a null queue.
961 if (tp->t_canq.c_cbreserved > 0 &&
962 tp->t_rawq.c_cbreserved > 0) {
963 catq(&tp->t_rawq, &tp->t_canq);
965 * XXX the queue limits may be
966 * different, so the old queue
967 * swapping method no longer works.
969 catq(&tp->t_canq, &tp->t_rawq);
971 CLR(tp->t_lflag, PENDIN);
975 tp->t_iflag = t->c_iflag;
976 tp->t_oflag = t->c_oflag;
978 * Make the EXTPROC bit read only.
980 if (ISSET(tp->t_lflag, EXTPROC))
981 SET(t->c_lflag, EXTPROC);
983 CLR(t->c_lflag, EXTPROC);
984 tp->t_lflag = t->c_lflag | ISSET(tp->t_lflag, PENDIN);
985 if (t->c_cc[VMIN] != tp->t_cc[VMIN] ||
986 t->c_cc[VTIME] != tp->t_cc[VTIME])
988 bcopy(t->c_cc, tp->t_cc, sizeof(t->c_cc));
992 case TIOCSETD: { /* set line discipline */
993 int t = *(int *)data;
994 dev_t device = tp->t_dev;
996 if ((u_int)t >= nlinesw)
998 if (t != tp->t_line) {
1000 (*linesw[tp->t_line].l_close)(tp, flag);
1001 error = (*linesw[t].l_open)(device, tp);
1003 (void)(*linesw[tp->t_line].l_open)(device, tp);
1012 case TIOCSTART: /* start output, like ^Q */
1014 if (ISSET(tp->t_state, TS_TTSTOP) ||
1015 ISSET(tp->t_lflag, FLUSHO)) {
1016 CLR(tp->t_lflag, FLUSHO);
1017 CLR(tp->t_state, TS_TTSTOP);
1022 case TIOCSTI: /* simulate terminal input */
1023 if ((flag & FREAD) == 0 && suser(td))
1025 if (!isctty(p, tp) && suser(td))
1028 (*linesw[tp->t_line].l_rint)(*(u_char *)data, tp);
1031 case TIOCSTOP: /* stop output, like ^S */
1033 if (!ISSET(tp->t_state, TS_TTSTOP)) {
1034 SET(tp->t_state, TS_TTSTOP);
1035 (*tp->t_stop)(tp, 0);
1039 case TIOCSCTTY: /* become controlling tty */
1040 /* Session ctty vnode pointer set in vnode layer. */
1041 if (!SESS_LEADER(p) ||
1042 ((p->p_session->s_ttyvp || tp->t_session) &&
1043 (tp->t_session != p->p_session)))
1045 tp->t_session = p->p_session;
1046 tp->t_pgrp = p->p_pgrp;
1047 p->p_session->s_ttyp = tp;
1048 p->p_flag |= P_CONTROLT;
1050 case TIOCSPGRP: { /* set pgrp of tty */
1051 struct pgrp *pgrp = pgfind(*(int *)data);
1055 else if (pgrp == NULL || pgrp->pg_session != p->p_session)
1060 case TIOCSTAT: /* simulate control-T */
1065 case TIOCSWINSZ: /* set window size */
1066 if (bcmp((caddr_t)&tp->t_winsize, data,
1067 sizeof (struct winsize))) {
1068 tp->t_winsize = *(struct winsize *)data;
1069 pgsignal(tp->t_pgrp, SIGWINCH, 1);
1072 case TIOCSDRAINWAIT:
1076 tp->t_timeout = *(int *)data * hz;
1077 wakeup(TSA_OCOMPLETE(tp));
1078 wakeup(TSA_OLOWAT(tp));
1080 case TIOCGDRAINWAIT:
1081 *(int *)data = tp->t_timeout / hz;
1084 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
1085 return (ttcompat(tp, cmd, data, flag));
1094 ttypoll(dev, events, td)
1104 if (tp == NULL) /* XXX used to return ENXIO, but that means true! */
1105 return ((events & (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM))
1109 if (events & (POLLIN | POLLRDNORM)) {
1110 if (ttnread(tp) > 0 || ISSET(tp->t_state, TS_ZOMBIE))
1111 revents |= events & (POLLIN | POLLRDNORM);
1113 selrecord(td, &tp->t_rsel);
1115 if (events & (POLLOUT | POLLWRNORM)) {
1116 if ((tp->t_outq.c_cc <= tp->t_olowat &&
1117 ISSET(tp->t_state, TS_CONNECTED))
1118 || ISSET(tp->t_state, TS_ZOMBIE))
1119 revents |= events & (POLLOUT | POLLWRNORM);
1121 selrecord(td, &tp->t_wsel);
1127 static struct filterops ttyread_filtops =
1128 { 1, NULL, filt_ttyrdetach, filt_ttyread };
1129 static struct filterops ttywrite_filtops =
1130 { 1, NULL, filt_ttywdetach, filt_ttywrite };
1133 ttykqfilter(dev, kn)
1137 struct tty *tp = dev->si_tty;
1138 struct klist *klist;
1141 switch (kn->kn_filter) {
1143 klist = &tp->t_rsel.si_note;
1144 kn->kn_fop = &ttyread_filtops;
1147 klist = &tp->t_wsel.si_note;
1148 kn->kn_fop = &ttywrite_filtops;
1154 kn->kn_hook = (caddr_t)dev;
1157 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
1164 filt_ttyrdetach(struct knote *kn)
1166 struct tty *tp = ((dev_t)kn->kn_hook)->si_tty;
1169 SLIST_REMOVE(&tp->t_rsel.si_note, kn, knote, kn_selnext);
1174 filt_ttyread(struct knote *kn, long hint)
1176 struct tty *tp = ((dev_t)kn->kn_hook)->si_tty;
1178 kn->kn_data = ttnread(tp);
1179 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1180 kn->kn_flags |= EV_EOF;
1183 return (kn->kn_data > 0);
1187 filt_ttywdetach(struct knote *kn)
1189 struct tty *tp = ((dev_t)kn->kn_hook)->si_tty;
1192 SLIST_REMOVE(&tp->t_wsel.si_note, kn, knote, kn_selnext);
1197 filt_ttywrite(kn, hint)
1201 struct tty *tp = ((dev_t)kn->kn_hook)->si_tty;
1203 kn->kn_data = tp->t_outq.c_cc;
1204 if (ISSET(tp->t_state, TS_ZOMBIE))
1206 return (kn->kn_data <= tp->t_olowat &&
1207 ISSET(tp->t_state, TS_CONNECTED));
1211 * Must be called at spltty().
1219 if (ISSET(tp->t_lflag, PENDIN))
1221 nread = tp->t_canq.c_cc;
1222 if (!ISSET(tp->t_lflag, ICANON)) {
1223 nread += tp->t_rawq.c_cc;
1224 if (nread < tp->t_cc[VMIN] && tp->t_cc[VTIME] == 0)
1231 * Wait for output to drain.
1241 while ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1242 ISSET(tp->t_state, TS_CONNECTED) && tp->t_oproc) {
1244 if ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1245 ISSET(tp->t_state, TS_CONNECTED)) {
1246 SET(tp->t_state, TS_SO_OCOMPLETE);
1247 error = ttysleep(tp, TSA_OCOMPLETE(tp),
1251 if (error == EWOULDBLOCK)
1258 if (!error && (tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)))
1265 * Flush if successfully wait.
1273 if ((error = ttywait(tp)) == 0)
1274 ttyflush(tp, FREAD);
1279 * Flush tty read and/or write queues, notifying anyone waiting.
1293 FLUSHQ(&tp->t_outq);
1294 CLR(tp->t_state, TS_TTSTOP);
1296 (*tp->t_stop)(tp, rw);
1298 FLUSHQ(&tp->t_canq);
1299 FLUSHQ(&tp->t_rawq);
1300 CLR(tp->t_lflag, PENDIN);
1303 CLR(tp->t_state, TS_LOCAL);
1305 if (ISSET(tp->t_state, TS_TBLOCK)) {
1307 FLUSHQ(&tp->t_outq);
1311 * Don't let leave any state that might clobber the
1312 * next line discipline (although we should do more
1313 * to send the START char). Not clearing the state
1314 * may have caused the "putc to a clist with no
1315 * reserved cblocks" panic/printf.
1317 CLR(tp->t_state, TS_TBLOCK);
1319 #if 0 /* forget it, sleeping isn't always safe and we don't know when it is */
1320 if (ISSET(tp->t_iflag, IXOFF)) {
1322 * XXX wait a bit in the hope that the stop
1323 * character (if any) will go out. Waiting
1324 * isn't good since it allows races. This
1325 * will be fixed when the stop character is
1326 * put in a special queue. Don't bother with
1327 * the checks in ttywait() since the timeout
1330 SET(tp->t_state, TS_SO_OCOMPLETE);
1331 ttysleep(tp, TSA_OCOMPLETE(tp), 0,
1334 * Don't try sending the stop character again.
1336 CLR(tp->t_state, TS_TBLOCK);
1343 FLUSHQ(&tp->t_outq);
1350 * Copy in the default termios characters.
1357 bcopy(ttydefchars, t->c_cc, sizeof t->c_cc);
1368 termioschars(&tp->t_termios);
1372 * Handle input high water. Send stop character for the IXOFF case. Turn
1373 * on our input flow control bit and propagate the changes to the driver.
1374 * XXX the stop character should be put in a special high priority queue.
1381 SET(tp->t_state, TS_TBLOCK);
1382 if (ISSET(tp->t_iflag, IXOFF) && tp->t_cc[VSTOP] != _POSIX_VDISABLE &&
1383 putc(tp->t_cc[VSTOP], &tp->t_outq) != 0)
1384 CLR(tp->t_state, TS_TBLOCK); /* try again later */
1389 * Handle input low water. Send start character for the IXOFF case. Turn
1390 * off our input flow control bit and propagate the changes to the driver.
1391 * XXX the start character should be put in a special high priority queue.
1398 CLR(tp->t_state, TS_TBLOCK);
1399 if (ISSET(tp->t_iflag, IXOFF) && tp->t_cc[VSTART] != _POSIX_VDISABLE &&
1400 putc(tp->t_cc[VSTART], &tp->t_outq) != 0)
1401 SET(tp->t_state, TS_TBLOCK); /* try again later */
1406 /* Not used by any current (i386) drivers. */
1408 * Restart after an inter-char delay.
1417 KASSERT(tp_arg != NULL, ("ttrstrt"));
1422 CLR(tp->t_state, TS_TIMEOUT);
1434 if (tp->t_oproc != NULL) /* XXX: Kludge for pty. */
1440 * "close" a line discipline
1448 if (flag & FNONBLOCK || ttywflush(tp))
1449 ttyflush(tp, FREAD | FWRITE);
1454 * Handle modem control transition on a tty.
1455 * Flag indicates new state of carrier.
1456 * Returns 0 if the line should be turned off, otherwise 1.
1464 if (ISSET(tp->t_state, TS_CARR_ON) && ISSET(tp->t_cflag, MDMBUF)) {
1466 * MDMBUF: do flow control according to carrier flag
1467 * XXX TS_CAR_OFLOW doesn't do anything yet. TS_TTSTOP
1468 * works if IXON and IXANY are clear.
1471 CLR(tp->t_state, TS_CAR_OFLOW);
1472 CLR(tp->t_state, TS_TTSTOP);
1474 } else if (!ISSET(tp->t_state, TS_CAR_OFLOW)) {
1475 SET(tp->t_state, TS_CAR_OFLOW);
1476 SET(tp->t_state, TS_TTSTOP);
1477 (*tp->t_stop)(tp, 0);
1479 } else if (flag == 0) {
1483 CLR(tp->t_state, TS_CARR_ON);
1484 if (ISSET(tp->t_state, TS_ISOPEN) &&
1485 !ISSET(tp->t_cflag, CLOCAL)) {
1486 SET(tp->t_state, TS_ZOMBIE);
1487 CLR(tp->t_state, TS_CONNECTED);
1488 if (tp->t_session && tp->t_session->s_leader)
1489 psignal(tp->t_session->s_leader, SIGHUP);
1490 ttyflush(tp, FREAD | FWRITE);
1497 SET(tp->t_state, TS_CARR_ON);
1498 if (!ISSET(tp->t_state, TS_ZOMBIE))
1499 SET(tp->t_state, TS_CONNECTED);
1500 wakeup(TSA_CARR_ON(tp));
1508 * Reinput pending characters after state switch
1518 CLR(tp->t_lflag, PENDIN);
1519 SET(tp->t_state, TS_TYPEN);
1521 * XXX this assumes too much about clist internals. It may even
1522 * fail if the cblock slush pool is empty. We can't allocate more
1523 * cblocks here because we are called from an interrupt handler
1524 * and clist_alloc_cblocks() can wait.
1527 bzero(&tp->t_rawq, sizeof tp->t_rawq);
1528 tp->t_rawq.c_cbmax = tq.c_cbmax;
1529 tp->t_rawq.c_cbreserved = tq.c_cbreserved;
1530 while ((c = getc(&tq)) >= 0)
1532 CLR(tp->t_state, TS_TYPEN);
1536 * Process a read call on a tty device.
1539 ttread(tp, uio, flag)
1547 cc_t *cc = tp->t_cc;
1548 struct proc *p = curproc;
1549 int s, first, error = 0;
1550 int has_stime = 0, last_cc = 0;
1551 long slp = 0; /* XXX this should be renamed `timo'. */
1552 struct timeval stime;
1556 lflag = tp->t_lflag;
1558 * take pending input first
1560 if (ISSET(lflag, PENDIN)) {
1562 splx(s); /* reduce latency */
1564 lflag = tp->t_lflag; /* XXX ttypend() clobbers it */
1568 * Hang process if it's in the background.
1570 if (isbackground(p, tp)) {
1572 if (SIGISMEMBER(p->p_sigignore, SIGTTIN) ||
1573 SIGISMEMBER(p->p_sigmask, SIGTTIN) ||
1574 (p->p_flag & P_PPWAIT) || p->p_pgrp->pg_jobc == 0)
1576 pgsignal(p->p_pgrp, SIGTTIN, 1);
1577 error = ttysleep(tp, &lbolt, PCATCH, "ttybg2", 0);
1583 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1585 return (0); /* EOF */
1589 * If canonical, use the canonical queue,
1590 * else use the raw queue.
1592 * (should get rid of clists...)
1594 qp = ISSET(lflag, ICANON) ? &tp->t_canq : &tp->t_rawq;
1596 if (flag & IO_NDELAY) {
1599 if (!ISSET(lflag, ICANON) && cc[VMIN] == 0) {
1604 return (EWOULDBLOCK);
1606 if (!ISSET(lflag, ICANON)) {
1609 struct timeval timecopy;
1612 * Check each of the four combinations.
1613 * (m > 0 && t == 0) is the normal read case.
1614 * It should be fairly efficient, so we check that and its
1615 * companion case (m == 0 && t == 0) first.
1616 * For the other two cases, we compute the target sleep time
1625 /* m, t and qp->c_cc are all 0. 0 is enough input. */
1629 t *= 100000; /* time in us */
1630 #define diff(t1, t2) (((t1).tv_sec - (t2).tv_sec) * 1000000 + \
1631 ((t1).tv_usec - (t2).tv_usec))
1637 getmicrotime(&timecopy);
1639 /* first character, start timer */
1643 } else if (qp->c_cc > last_cc) {
1644 /* got a character, restart timer */
1648 /* nothing, check expiration */
1649 slp = t - diff(timecopy, stime);
1654 } else { /* m == 0 */
1657 getmicrotime(&timecopy);
1663 slp = t - diff(timecopy, stime);
1665 /* Timed out, but 0 is enough input. */
1673 * Rounding down may make us wake up just short
1674 * of the target, so we round up.
1675 * The formula is ceiling(slp * hz/1000000).
1676 * 32-bit arithmetic is enough for hz < 169.
1677 * XXX see tvtohz() for how to avoid overflow if hz
1678 * is large (divide by `tick' and/or arrange to
1679 * use tvtohz() if hz is large).
1681 slp = (long) (((u_long)slp * hz) + 999999) / 1000000;
1684 if (qp->c_cc <= 0) {
1687 * There is no input, or not enough input and we can block.
1689 error = ttysleep(tp, TSA_HUP_OR_INPUT(tp), PCATCH,
1690 ISSET(tp->t_state, TS_CONNECTED) ?
1691 "ttyin" : "ttyhup", (int)slp);
1693 if (error == EWOULDBLOCK)
1698 * XXX what happens if another process eats some input
1699 * while we are asleep (not just here)? It would be
1700 * safest to detect changes and reset our state variables
1701 * (has_stime and last_cc).
1709 * Input present, check for input mapping and processing.
1712 if (ISSET(lflag, ICANON | ISIG))
1718 icc = imin(uio->uio_resid, IBUFSIZ);
1719 icc = q_to_b(qp, ibuf, icc);
1725 error = uiomove(ibuf, icc, uio);
1727 * XXX if there was an error then we should ungetc() the
1728 * unmoved chars and reduce icc here.
1732 if (uio->uio_resid == 0)
1746 * delayed suspend (^Y)
1748 if (CCEQ(cc[VDSUSP], c) &&
1749 ISSET(lflag, IEXTEN | ISIG) == (IEXTEN | ISIG)) {
1750 pgsignal(tp->t_pgrp, SIGTSTP, 1);
1752 error = ttysleep(tp, &lbolt, PCATCH,
1761 * Interpret EOF only in canonical mode.
1763 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ICANON))
1766 * Give user character.
1768 error = ureadc(c, uio);
1770 /* XXX should ungetc(c, qp). */
1772 if (uio->uio_resid == 0)
1775 * In canonical mode check for a "break character"
1776 * marking the end of a "line of input".
1778 if (ISSET(lflag, ICANON) && TTBREAKC(c, lflag))
1785 * Look to unblock input now that (presumably)
1786 * the input queue has gone down.
1789 if (ISSET(tp->t_state, TS_TBLOCK) &&
1790 tp->t_rawq.c_cc + tp->t_canq.c_cc <= tp->t_ilowat)
1798 * Check the output queue on tp for space for a kernel message (from uprintf
1799 * or tprintf). Allow some space over the normal hiwater mark so we don't
1800 * lose messages due to normal flow control, but don't let the tty run amok.
1801 * Sleeps here are not interruptible, but we return prematurely if new signals
1805 ttycheckoutq(tp, wait)
1812 hiwat = tp->t_ohiwat;
1813 SIGEMPTYSET(oldmask);
1816 oldmask = curproc->p_siglist;
1817 if (tp->t_outq.c_cc > hiwat + OBUFSIZ + 100)
1818 while (tp->t_outq.c_cc > hiwat) {
1820 if (tp->t_outq.c_cc <= hiwat)
1822 if (!(wait && SIGSETEQ(curproc->p_siglist, oldmask))) {
1826 SET(tp->t_state, TS_SO_OLOWAT);
1827 tsleep(TSA_OLOWAT(tp), 0, "ttoutq", hz);
1834 * Process a write call on a tty device.
1837 ttwrite(tp, uio, flag)
1845 int i, hiwat, cnt, error, s;
1848 hiwat = tp->t_ohiwat;
1849 cnt = uio->uio_resid;
1854 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1856 if (uio->uio_resid == cnt)
1860 if (!ISSET(tp->t_state, TS_CONNECTED)) {
1861 if (flag & IO_NDELAY) {
1863 error = EWOULDBLOCK;
1866 error = ttysleep(tp, TSA_CARR_ON(tp), PCATCH, "ttydcd", 0);
1874 * Hang the process if it's in the background.
1877 if (isbackground(p, tp) &&
1878 ISSET(tp->t_lflag, TOSTOP) && !(p->p_flag & P_PPWAIT) &&
1879 !SIGISMEMBER(p->p_sigignore, SIGTTOU) &&
1880 !SIGISMEMBER(p->p_sigmask, SIGTTOU)) {
1881 if (p->p_pgrp->pg_jobc == 0) {
1885 pgsignal(p->p_pgrp, SIGTTOU, 1);
1886 error = ttysleep(tp, &lbolt, PCATCH, "ttybg4", 0);
1892 * Process the user's data in at most OBUFSIZ chunks. Perform any
1893 * output translation. Keep track of high water mark, sleep on
1894 * overflow awaiting device aid in acquiring new space.
1896 while (uio->uio_resid > 0 || cc > 0) {
1897 if (ISSET(tp->t_lflag, FLUSHO)) {
1901 if (tp->t_outq.c_cc > hiwat)
1904 * Grab a hunk of data from the user, unless we have some
1905 * leftover from last time.
1908 cc = imin(uio->uio_resid, OBUFSIZ);
1910 error = uiomove(cp, cc, uio);
1917 * If nothing fancy need be done, grab those characters we
1918 * can handle without any of ttyoutput's processing and
1919 * just transfer them to the output q. For those chars
1920 * which require special processing (as indicated by the
1921 * bits in char_type), call ttyoutput. After processing
1922 * a hunk of data, look for FLUSHO so ^O's will take effect
1926 if (!ISSET(tp->t_oflag, OPOST))
1929 ce = cc - scanc((u_int)cc, (u_char *)cp,
1930 char_type, CCLASSMASK);
1932 * If ce is zero, then we're processing
1933 * a special character through ttyoutput.
1937 if (ttyoutput(*cp, tp) >= 0) {
1938 /* No Clists, wait a bit. */
1940 if (flag & IO_NDELAY) {
1941 error = EWOULDBLOCK;
1944 error = ttysleep(tp, &lbolt,
1953 if (ISSET(tp->t_lflag, FLUSHO) ||
1954 tp->t_outq.c_cc > hiwat)
1960 * A bunch of normal characters have been found.
1961 * Transfer them en masse to the output queue and
1962 * continue processing at the top of the loop.
1963 * If there are any further characters in this
1964 * <= OBUFSIZ chunk, the first should be a character
1965 * requiring special handling by ttyoutput.
1968 i = b_to_q(cp, ce, &tp->t_outq);
1971 cp += ce, cc -= ce, tk_nout += ce;
1974 /* No Clists, wait a bit. */
1976 if (flag & IO_NDELAY) {
1977 error = EWOULDBLOCK;
1980 error = ttysleep(tp, &lbolt, PCATCH,
1986 if (ISSET(tp->t_lflag, FLUSHO) ||
1987 tp->t_outq.c_cc > hiwat)
1994 * If cc is nonzero, we leave the uio structure inconsistent, as the
1995 * offset and iov pointers have moved forward, but it doesn't matter
1996 * (the call will either return short or restart with a new uio).
1998 uio->uio_resid += cc;
2005 * This can only occur if FLUSHO is set in t_lflag,
2006 * or if ttstart/oproc is synchronous (or very fast).
2008 if (tp->t_outq.c_cc <= hiwat) {
2012 if (flag & IO_NDELAY) {
2014 uio->uio_resid += cc;
2015 return (uio->uio_resid == cnt ? EWOULDBLOCK : 0);
2017 SET(tp->t_state, TS_SO_OLOWAT);
2018 error = ttysleep(tp, TSA_OLOWAT(tp), PCATCH, "ttywri", tp->t_timeout);
2020 if (error == EWOULDBLOCK)
2028 * Rubout one character from the rawq of tp
2029 * as cleanly as possible.
2040 if (!ISSET(tp->t_lflag, ECHO) || ISSET(tp->t_lflag, EXTPROC))
2042 CLR(tp->t_lflag, FLUSHO);
2043 if (ISSET(tp->t_lflag, ECHOE)) {
2044 if (tp->t_rocount == 0) {
2046 * Screwed by ttwrite; retype
2051 if (c == ('\t' | TTY_QUOTE) || c == ('\n' | TTY_QUOTE))
2054 CLR(c, ~TTY_CHARMASK);
2055 switch (CCLASS(c)) {
2064 if (ISSET(tp->t_lflag, ECHOCTL))
2068 if (tp->t_rocount < tp->t_rawq.c_cc) {
2073 savecol = tp->t_column;
2074 SET(tp->t_state, TS_CNTTB);
2075 SET(tp->t_lflag, FLUSHO);
2076 tp->t_column = tp->t_rocol;
2077 cp = tp->t_rawq.c_cf;
2079 tabc = *cp; /* XXX FIX NEXTC */
2080 for (; cp; cp = nextc(&tp->t_rawq, cp, &tabc))
2082 CLR(tp->t_lflag, FLUSHO);
2083 CLR(tp->t_state, TS_CNTTB);
2086 /* savecol will now be length of the tab. */
2087 savecol -= tp->t_column;
2088 tp->t_column += savecol;
2090 savecol = 8; /* overflow screw */
2091 while (--savecol >= 0)
2092 (void)ttyoutput('\b', tp);
2095 #define PANICSTR "ttyrub: would panic c = %d, val = %d\n"
2096 (void)printf(PANICSTR, c, CCLASS(c));
2098 panic(PANICSTR, c, CCLASS(c));
2102 } else if (ISSET(tp->t_lflag, ECHOPRT)) {
2103 if (!ISSET(tp->t_state, TS_ERASE)) {
2104 SET(tp->t_state, TS_ERASE);
2105 (void)ttyoutput('\\', tp);
2109 ttyecho(tp->t_cc[VERASE], tp);
2111 * This code may be executed not only when an ERASE key
2112 * is pressed, but also when ^U (KILL) or ^W (WERASE) are.
2113 * So, I didn't think it was worthwhile to pass the extra
2114 * information (which would need an extra parameter,
2115 * changing every call) needed to distinguish the ERASE2
2116 * case from the ERASE.
2123 * Back over cnt characters, erasing them.
2132 (void)ttyoutput('\b', tp);
2133 (void)ttyoutput(' ', tp);
2134 (void)ttyoutput('\b', tp);
2140 * Reprint the rawq line. Note, it is assumed that c_cc has already
2150 /* Echo the reprint character. */
2151 if (tp->t_cc[VREPRINT] != _POSIX_VDISABLE)
2152 ttyecho(tp->t_cc[VREPRINT], tp);
2154 (void)ttyoutput('\n', tp);
2158 * FIX: NEXTC IS BROKEN - DOESN'T CHECK QUOTE
2159 * BIT OF FIRST CHAR.
2162 for (cp = tp->t_canq.c_cf, c = (cp != NULL ? *cp : 0);
2163 cp != NULL; cp = nextc(&tp->t_canq, cp, &c))
2165 for (cp = tp->t_rawq.c_cf, c = (cp != NULL ? *cp : 0);
2166 cp != NULL; cp = nextc(&tp->t_rawq, cp, &c))
2168 CLR(tp->t_state, TS_ERASE);
2171 tp->t_rocount = tp->t_rawq.c_cc;
2176 * Echo a typed character to the terminal.
2184 if (!ISSET(tp->t_state, TS_CNTTB))
2185 CLR(tp->t_lflag, FLUSHO);
2186 if ((!ISSET(tp->t_lflag, ECHO) &&
2187 (c != '\n' || !ISSET(tp->t_lflag, ECHONL))) ||
2188 ISSET(tp->t_lflag, EXTPROC))
2190 if (ISSET(tp->t_lflag, ECHOCTL) &&
2191 ((ISSET(c, TTY_CHARMASK) <= 037 && c != '\t' && c != '\n') ||
2192 ISSET(c, TTY_CHARMASK) == 0177)) {
2193 (void)ttyoutput('^', tp);
2194 CLR(c, ~TTY_CHARMASK);
2200 (void)ttyoutput(c, tp);
2204 * Wake up any readers on a tty.
2211 if (tp->t_rsel.si_pid != 0)
2212 selwakeup(&tp->t_rsel);
2213 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
2214 pgsigio(tp->t_sigio, SIGIO, (tp->t_session != NULL));
2215 wakeup(TSA_HUP_OR_INPUT(tp));
2216 KNOTE(&tp->t_rsel.si_note, 0);
2220 * Wake up any writers on a tty.
2227 if (tp->t_wsel.si_pid != 0 && tp->t_outq.c_cc <= tp->t_olowat)
2228 selwakeup(&tp->t_wsel);
2229 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
2230 pgsigio(tp->t_sigio, SIGIO, (tp->t_session != NULL));
2231 if (ISSET(tp->t_state, TS_BUSY | TS_SO_OCOMPLETE) ==
2232 TS_SO_OCOMPLETE && tp->t_outq.c_cc == 0) {
2233 CLR(tp->t_state, TS_SO_OCOMPLETE);
2234 wakeup(TSA_OCOMPLETE(tp));
2236 if (ISSET(tp->t_state, TS_SO_OLOWAT) &&
2237 tp->t_outq.c_cc <= tp->t_olowat) {
2238 CLR(tp->t_state, TS_SO_OLOWAT);
2239 wakeup(TSA_OLOWAT(tp));
2241 KNOTE(&tp->t_wsel.si_note, 0);
2245 * Look up a code for a specified speed in a conversion table;
2246 * used by drivers to map software speed values to hardware parameters.
2249 ttspeedtab(speed, table)
2251 struct speedtab *table;
2254 for ( ; table->sp_speed != -1; table++)
2255 if (table->sp_speed == speed)
2256 return (table->sp_code);
2261 * Set input and output watermarks and buffer sizes. For input, the
2262 * high watermark is about one second's worth of input above empty, the
2263 * low watermark is slightly below high water, and the buffer size is a
2264 * driver-dependent amount above high water. For output, the watermarks
2265 * are near the ends of the buffer, with about 1 second's worth of input
2266 * between them. All this only applies to the standard line discipline.
2272 int cps, ttmaxhiwat, x;
2275 clist_alloc_cblocks(&tp->t_canq, TTYHOG, 512);
2276 switch (tp->t_ispeedwat) {
2278 cps = tp->t_ispeed / 10;
2282 * This case is for old drivers that don't know about
2283 * t_ispeedwat. Arrange for them to get the old buffer
2284 * sizes and watermarks.
2286 cps = TTYHOG - 2 * 256;
2287 tp->t_ififosize = 2 * 256;
2290 cps = tp->t_ispeedwat / 10;
2294 tp->t_ilowat = 7 * cps / 8;
2295 x = cps + tp->t_ififosize;
2296 clist_alloc_cblocks(&tp->t_rawq, x, x);
2299 switch (tp->t_ospeedwat) {
2301 cps = tp->t_ospeed / 10;
2302 ttmaxhiwat = 2 * TTMAXHIWAT;
2305 cps = tp->t_ospeed / 10;
2306 ttmaxhiwat = TTMAXHIWAT;
2309 cps = tp->t_ospeedwat / 10;
2310 ttmaxhiwat = 8 * TTMAXHIWAT;
2313 #define CLAMP(x, h, l) ((x) > h ? h : ((x) < l) ? l : (x))
2314 tp->t_olowat = x = CLAMP(cps / 2, TTMAXLOWAT, TTMINLOWAT);
2316 x = CLAMP(x, ttmaxhiwat, TTMINHIWAT); /* XXX clamps are too magic */
2317 tp->t_ohiwat = roundup(x, CBSIZE); /* XXX for compat */
2318 x = imax(tp->t_ohiwat, TTMAXHIWAT); /* XXX for compat/safety */
2320 clist_alloc_cblocks(&tp->t_outq, x, x);
2325 * Report on state of foreground process group.
2331 struct proc *p, *pick;
2332 struct timeval utime, stime;
2335 if (ttycheckoutq(tp,0) == 0)
2339 * We always print the load average, then figure out what else to
2340 * print based on the state of the current process group.
2342 tmp = (averunnable.ldavg[0] * 100 + FSCALE / 2) >> FSHIFT;
2343 ttyprintf(tp, "load: %d.%02d ", tmp / 100, tmp % 100);
2345 if (tp->t_session == NULL) {
2346 ttyprintf(tp, "not a controlling terminal\n");
2347 } else if (tp->t_pgrp == NULL) {
2348 ttyprintf(tp, "no foreground process group\n");
2349 } else if ((p = LIST_FIRST(&tp->t_pgrp->pg_members)) == 0) {
2350 ttyprintf(tp, "empty foreground process group\n");
2353 * Pick an interesting process. Note that certain elements,
2354 * in particular the wmesg, require a critical section for
2355 * safe access (YYY and we are still not MP safe).
2357 * NOTE: p_wmesg is p_thread->td_wmesg, and p_comm is
2358 * p_thread->td_comm.
2368 for (pick = NULL; p != 0; p = LIST_NEXT(p, p_pglist)) {
2369 if (proc_compare(pick, p))
2374 * Figure out what wait/process-state message, and command
2377 if (pick->p_thread == NULL)
2379 else if (pick->p_stat == SRUN)
2381 else if (pick->p_wmesg) /* p_thread must not be NULL */
2382 str = pick->p_wmesg;
2386 snprintf(buf, sizeof(buf), "cmd: %s %d [%s]",
2387 (pick->p_thread ? pick->p_comm : "?"),
2391 * Calculate cpu usage, percent cpu, and cmsz. Note that
2392 * 'pick' becomes invalid the moment we exit the critical
2395 if (pick->p_thread && (pick->p_flag & P_INMEM)) {
2396 calcru(pick, &utime, &stime, NULL);
2402 pctcpu = (pick->p_pctcpu * 10000 + FSCALE / 2) >> FSHIFT;
2404 if (pick->p_stat == SIDL || pick->p_stat == SZOMB)
2407 vmsz = pgtok(vmspace_resident_count(pick->p_vmspace));
2414 ttyprintf(tp, " %s ", buf);
2416 ttyprintf(tp, "%ld.%02ldu ",
2417 utime.tv_sec, utime.tv_usec / 10000);
2418 ttyprintf(tp, "%ld.%02lds ",
2419 stime.tv_sec, stime.tv_usec / 10000);
2421 ttyprintf(tp, "?.??u ?.??s ");
2423 ttyprintf(tp, "%d%% %ldk\n", pctcpu / 100, vmsz);
2425 tp->t_rocount = 0; /* so pending input will be retyped if BS */
2429 * Returns 1 if p2 is "better" than p1
2431 * The algorithm for picking the "interesting" process is thus:
2433 * 1) Only foreground processes are eligible - implied.
2434 * 2) Runnable processes are favored over anything else. The runner
2435 * with the highest cpu utilization is picked (p_estcpu). Ties are
2436 * broken by picking the highest pid.
2437 * 3) The sleeper with the shortest sleep time is next. With ties,
2438 * we pick out just "short-term" sleepers (P_SINTR == 0).
2439 * 4) Further ties are broken by picking the highest pid.
2441 #define ISRUN(p) (((p)->p_stat == SRUN) || ((p)->p_stat == SIDL))
2442 #define TESTAB(a, b) ((a)<<1 | (b))
2448 proc_compare(p1, p2)
2449 struct proc *p1, *p2;
2455 * see if at least one of them is runnable
2457 switch (TESTAB(ISRUN(p1), ISRUN(p2))) {
2464 * tie - favor one with highest recent cpu utilization
2466 if (p2->p_estcpu > p1->p_estcpu)
2468 if (p1->p_estcpu > p2->p_estcpu)
2470 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2475 switch (TESTAB(p1->p_stat == SZOMB, p2->p_stat == SZOMB)) {
2481 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2484 * pick the one with the smallest sleep time
2486 if (p2->p_slptime > p1->p_slptime)
2488 if (p1->p_slptime > p2->p_slptime)
2491 * favor one sleeping in a non-interruptible sleep
2493 if (p1->p_flag & P_SINTR && (p2->p_flag & P_SINTR) == 0)
2495 if (p2->p_flag & P_SINTR && (p1->p_flag & P_SINTR) == 0)
2497 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2501 * Output char to tty; console putchar style.
2511 if (!ISSET(tp->t_state, TS_CONNECTED)) {
2516 (void)ttyoutput('\r', tp);
2517 (void)ttyoutput(c, tp);
2524 * Sleep on chan, returning ERESTART if tty changed while we napped and
2525 * returning any errors (e.g. EINTR/EWOULDBLOCK) reported by tsleep. If
2526 * the tty is revoked, restarting a pending call will redo validation done
2527 * at the start of the call.
2530 ttysleep(tp, chan, slpflags, wmesg, timo)
2540 error = tsleep(chan, slpflags, wmesg, timo);
2543 return (tp->t_gen == gen ? 0 : ERESTART);
2547 * Allocate a tty struct. Clists in the struct will be allocated by
2557 tp = malloc(sizeof *tp, M_TTYS, M_WAITOK);
2558 bzero(tp, sizeof *tp);
2565 * Free a tty struct. Clists in the struct should have been freed by
2568 * XXX not yet usable: since we support a half-closed state and do not
2569 * ref count the tty reference from the session, it is possible for a
2570 * session to hold a ref on the tty. See TTY_DO_FULL_CLOSE.
2584 SLIST_INSERT_HEAD(&tty_list, tp, t_list);
2588 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
2592 SLIST_FOREACH(tp, &tty_list, t_list) {
2595 t.t_dev = (dev_t)dev2udev(t.t_dev);
2596 error = SYSCTL_OUT(req, (caddr_t)&t, sizeof(t));
2603 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD,
2604 0, 0, sysctl_kern_ttys, "S,tty", "All struct ttys");
2616 ttyread(dev, uio, flag)
2626 return ((*linesw[tp->t_line].l_read)(tp, uio, flag));
2630 ttywrite(dev, uio, flag)
2640 return ((*linesw[tp->t_line].l_write)(tp, uio, flag));