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.46 2008/09/10 09:50:09 y0netan1 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/clist.h>
86 #include <sys/fcntl.h>
88 #include <sys/dkstat.h>
90 #include <sys/kernel.h>
91 #include <sys/vnode.h>
92 #include <sys/signalvar.h>
93 #include <sys/signal2.h>
94 #include <sys/resourcevar.h>
95 #include <sys/malloc.h>
96 #include <sys/filedesc.h>
97 #include <sys/sysctl.h>
98 #include <sys/thread2.h>
101 #include <sys/lock.h>
103 #include <vm/vm_map.h>
105 MALLOC_DEFINE(M_TTYS, "ttys", "tty data structures");
107 static int proc_compare (struct proc *p1, struct proc *p2);
108 static int ttnread (struct tty *tp);
109 static void ttyecho (int c, struct tty *tp);
110 static int ttyoutput (int c, struct tty *tp);
111 static void ttypend (struct tty *tp);
112 static void ttyretype (struct tty *tp);
113 static void ttyrub (int c, struct tty *tp);
114 static void ttyrubo (struct tty *tp, int cnt);
115 static void ttyunblock (struct tty *tp);
116 static int ttywflush (struct tty *tp);
117 static int filt_ttyread (struct knote *kn, long hint);
118 static void filt_ttyrdetach (struct knote *kn);
119 static int filt_ttywrite (struct knote *kn, long hint);
120 static void filt_ttywdetach (struct knote *kn);
123 * Table with character classes and parity. The 8th bit indicates parity,
124 * the 7th bit indicates the character is an alphameric or underscore (for
125 * ALTWERASE), and the low 6 bits indicate delay type. If the low 6 bits
126 * are 0 then the character needs no special processing on output; classes
127 * other than 0 might be translated or (not currently) require delays.
129 #define E 0x00 /* Even parity. */
130 #define O 0x80 /* Odd parity. */
131 #define PARITY(c) (char_type[c] & O)
133 #define ALPHA 0x40 /* Alpha or underscore. */
134 #define ISALPHA(c) (char_type[(c) & TTY_CHARMASK] & ALPHA)
136 #define CCLASSMASK 0x3f
137 #define CCLASS(c) (char_type[c] & CCLASSMASK)
142 #define NA ORDINARY | ALPHA
148 static u_char const char_type[] = {
149 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* nul - bel */
150 O|BS, E|TB, E|NL, O|CC, E|VT, O|CR, O|CC, E|CC, /* bs - si */
151 O|CC, E|CC, E|CC, O|CC, E|CC, O|CC, O|CC, E|CC, /* dle - etb */
152 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* can - us */
153 O|NO, E|NO, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* sp - ' */
154 E|NO, O|NO, O|NO, E|NO, O|NO, E|NO, E|NO, O|NO, /* ( - / */
155 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* 0 - 7 */
156 O|NA, E|NA, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* 8 - ? */
157 O|NO, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* @ - G */
158 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* H - O */
159 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* P - W */
160 O|NA, E|NA, E|NA, O|NO, E|NO, O|NO, O|NO, O|NA, /* X - _ */
161 E|NO, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* ` - g */
162 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* h - o */
163 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* p - w */
164 E|NA, O|NA, O|NA, E|NO, O|NO, E|NO, E|NO, O|CC, /* x - del */
166 * Meta chars; should be settable per character set;
167 * for now, treat them all as normal characters.
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,
182 NA, NA, NA, NA, NA, NA, NA, NA,
183 NA, NA, NA, NA, NA, NA, NA, NA,
184 NA, NA, NA, NA, NA, NA, NA, NA,
195 /* Macros to clear/set/test flags. */
196 #define SET(t, f) (t) |= (f)
197 #define CLR(t, f) (t) &= ~(f)
198 #define ISSET(t, f) ((t) & (f))
200 #undef MAX_INPUT /* XXX wrong in <sys/syslimits.h> */
201 #define MAX_INPUT TTYHOG /* XXX limit is usually larger for !ICANON */
204 SYSCTL_OPAQUE(_kern, OID_AUTO, tk_nin, CTLFLAG_RD, &tk_nin, sizeof(tk_nin),
205 "LU", "TTY input statistic");
207 SYSCTL_OPAQUE(_kern, OID_AUTO, tk_nout, CTLFLAG_RD, &tk_nout, sizeof(tk_nout),
208 "LU", "TTY output statistic");
212 * list of struct tty where pstat(8) can pick it up with sysctl
214 static SLIST_HEAD(, tty) tty_list;
217 * Initial open of tty, or (re)entry to standard tty line discipline.
220 ttyopen(cdev_t device, struct tty *tp)
224 if (!ISSET(tp->t_state, TS_ISOPEN)) {
225 SET(tp->t_state, TS_ISOPEN);
226 if (ISSET(tp->t_cflag, CLOCAL)) {
227 SET(tp->t_state, TS_CONNECTED);
229 bzero(&tp->t_winsize, sizeof(tp->t_winsize));
237 * Handle close() on a tty line: flush and set to initial state,
238 * bumping generation number so that pending read/write calls
239 * can detect recycling of the tty.
241 * XXX our caller should have done `spltty(); l_close(); ttyclose();'
242 * and l_close() should have flushed, but we repeat the spltty() and
243 * the flush in case there are buggy callers.
246 ttyclose(struct tty *tp)
248 funsetown(tp->t_sigio);
253 ttyflush(tp, FREAD | FWRITE);
254 clist_free_cblocks(&tp->t_canq);
255 clist_free_cblocks(&tp->t_outq);
256 clist_free_cblocks(&tp->t_rawq);
259 tp->t_line = TTYDISC;
267 * Disassociate the tty from its session. Traditionally this has only been
268 * a half-close, meaning that the session was still allowed to point at the
269 * tty (resulting in the tty in the ps command showing something like 'p0-'),
270 * even though the tty is no longer pointing at the session.
272 * The half close seems to be useful only for 'ps' output but there is as
273 * yet no reason to remove the feature. The full-close code is currently
274 * #if 0'd out. See also sess_rele() in kern/kern_proc.c.
277 ttyclearsession(struct tty *tp)
282 if ((sp = tp->t_session) != NULL) {
283 tp->t_session = NULL;
284 #ifdef TTY_DO_FULL_CLOSE
285 /* FULL CLOSE (not yet) */
286 if (sp->s_ttyp == tp) {
289 kprintf("ttyclearsession: warning: sp->s_ttyp != tp "
290 "%p/%p\n", sp->s_ttyp, tp);
297 * Release the tty vnode association for a session. This is the
298 * 'other half' of the close. Because multiple opens of /dev/tty
299 * only generate a single open to the actual tty, the file modes
300 * are locked to FREAD|FWRITE.
302 * If dorevoke is non-zero, the session is also revoked. We have to
303 * close the vnode if VCTTYISOPEN is set.
306 ttyclosesession(struct session *sp, int dorevoke)
312 * There may not be a controlling terminal or it may have been closed
315 if ((vp = sp->s_ttyvp) == NULL)
319 * We need a lock if we have to close or revoke.
321 if ((vp->v_flag & VCTTYISOPEN) || dorevoke) {
323 if (vn_lock(vp, LK_EXCLUSIVE|LK_RETRY)) {
329 * Retry if the vnode was ripped out from under us
331 if (vp != sp->s_ttyvp) {
338 * Close and revoke as needed
341 if (vp->v_flag & VCTTYISOPEN) {
342 vclrflags(vp, VCTTYISOPEN);
343 VOP_CLOSE(vp, FREAD|FWRITE);
347 vrevoke(vp, proc0.p_ucred);
355 #define FLUSHQ(q) { \
357 ndflush(q, (q)->c_cc); \
360 /* Is 'c' a line delimiter ("break" character)? */
361 #define TTBREAKC(c, lflag) \
362 ((c) == '\n' || (((c) == cc[VEOF] || \
363 (c) == cc[VEOL] || ((c) == cc[VEOL2] && lflag & IEXTEN)) && \
364 (c) != _POSIX_VDISABLE))
367 * Process input of a single character received on a tty.
370 ttyinput(int c, struct tty *tp)
372 tcflag_t iflag, lflag;
377 * If input is pending take it first.
380 if (ISSET(lflag, PENDIN))
385 if (ISSET(lflag, ICANON))
392 * Block further input iff:
393 * current input > threshold AND input is available to user program
394 * AND input flow control is enabled and not yet invoked.
395 * The 3 is slop for PARMRK.
398 if (tp->t_rawq.c_cc + tp->t_canq.c_cc > tp->t_ihiwat - 3 &&
399 (!ISSET(lflag, ICANON) || tp->t_canq.c_cc != 0) &&
400 (ISSET(tp->t_cflag, CRTS_IFLOW) || ISSET(iflag, IXOFF)) &&
401 !ISSET(tp->t_state, TS_TBLOCK))
404 /* Handle exceptional conditions (break, parity, framing). */
406 err = (ISSET(c, TTY_ERRORMASK));
408 CLR(c, TTY_ERRORMASK);
409 if (ISSET(err, TTY_BI)) {
410 if (ISSET(iflag, IGNBRK))
412 if (ISSET(iflag, BRKINT)) {
413 ttyflush(tp, FREAD | FWRITE);
414 pgsignal(tp->t_pgrp, SIGINT, 1);
417 if (ISSET(iflag, PARMRK))
419 } else if ((ISSET(err, TTY_PE) && ISSET(iflag, INPCK))
420 || ISSET(err, TTY_FE)) {
421 if (ISSET(iflag, IGNPAR))
423 else if (ISSET(iflag, PARMRK)) {
425 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >
428 clist_putc(0377 | TTY_QUOTE, &tp->t_rawq);
429 clist_putc(0 | TTY_QUOTE, &tp->t_rawq);
430 clist_putc(c | TTY_QUOTE, &tp->t_rawq);
437 if (!ISSET(tp->t_state, TS_TYPEN) && ISSET(iflag, ISTRIP))
439 if (!ISSET(lflag, EXTPROC)) {
441 * Check for literal nexting very first
443 if (ISSET(tp->t_state, TS_LNCH)) {
445 CLR(tp->t_state, TS_LNCH);
448 * Scan for special characters. This code
449 * is really just a big case statement with
450 * non-constant cases. The bottom of the
451 * case statement is labeled ``endcase'', so goto
452 * it after a case match, or similar.
456 * Control chars which aren't controlled
457 * by ICANON, ISIG, or IXON.
459 if (ISSET(lflag, IEXTEN)) {
460 if (CCEQ(cc[VLNEXT], c)) {
461 if (ISSET(lflag, ECHO)) {
462 if (ISSET(lflag, ECHOE)) {
463 (void)ttyoutput('^', tp);
464 (void)ttyoutput('\b', tp);
468 SET(tp->t_state, TS_LNCH);
471 if (CCEQ(cc[VDISCARD], c)) {
472 if (ISSET(lflag, FLUSHO))
473 CLR(tp->t_lflag, FLUSHO);
475 ttyflush(tp, FWRITE);
477 if (tp->t_rawq.c_cc + tp->t_canq.c_cc)
479 SET(tp->t_lflag, FLUSHO);
487 if (ISSET(lflag, ISIG)) {
488 if (CCEQ(cc[VINTR], c) || CCEQ(cc[VQUIT], c)) {
489 if (!ISSET(lflag, NOFLSH))
490 ttyflush(tp, FREAD | FWRITE);
493 CCEQ(cc[VINTR], c) ? SIGINT : SIGQUIT, 1);
496 if (CCEQ(cc[VSUSP], c)) {
497 if (!ISSET(lflag, NOFLSH))
500 pgsignal(tp->t_pgrp, SIGTSTP, 1);
505 * Handle start/stop characters.
507 if (ISSET(iflag, IXON)) {
508 if (CCEQ(cc[VSTOP], c)) {
509 if (!ISSET(tp->t_state, TS_TTSTOP)) {
510 SET(tp->t_state, TS_TTSTOP);
511 (*tp->t_stop)(tp, 0);
514 if (!CCEQ(cc[VSTART], c))
517 * if VSTART == VSTOP then toggle
521 if (CCEQ(cc[VSTART], c))
525 * IGNCR, ICRNL, & INLCR
528 if (ISSET(iflag, IGNCR))
530 else if (ISSET(iflag, ICRNL))
532 } else if (c == '\n' && ISSET(iflag, INLCR))
535 if (!ISSET(tp->t_lflag, EXTPROC) && ISSET(lflag, ICANON)) {
537 * From here on down canonical mode character
538 * processing takes place.
541 * erase or erase2 (^H / ^?)
543 if (CCEQ(cc[VERASE], c) || CCEQ(cc[VERASE2], c) ) {
545 ttyrub(clist_unputc(&tp->t_rawq), tp);
551 if (CCEQ(cc[VKILL], c)) {
552 if (ISSET(lflag, ECHOKE) &&
553 tp->t_rawq.c_cc == tp->t_rocount &&
554 !ISSET(lflag, ECHOPRT))
555 while (tp->t_rawq.c_cc)
556 ttyrub(clist_unputc(&tp->t_rawq), tp);
559 if (ISSET(lflag, ECHOK) ||
560 ISSET(lflag, ECHOKE))
565 CLR(tp->t_state, TS_LOCAL);
571 if (CCEQ(cc[VWERASE], c) && ISSET(lflag, IEXTEN)) {
577 while ((c = clist_unputc(&tp->t_rawq)) == ' ' || c == '\t')
582 * erase last char of word and remember the
583 * next chars type (for ALTWERASE)
586 c = clist_unputc(&tp->t_rawq);
589 if (c == ' ' || c == '\t') {
590 clist_putc(c, &tp->t_rawq);
599 c = clist_unputc(&tp->t_rawq);
602 } while (c != ' ' && c != '\t' &&
603 (!ISSET(lflag, ALTWERASE) || ISALPHA(c) == ctype));
604 clist_putc(c, &tp->t_rawq);
610 if (CCEQ(cc[VREPRINT], c) && ISSET(lflag, IEXTEN)) {
615 * ^T - kernel info and generate SIGINFO
617 if (CCEQ(cc[VSTATUS], c) && ISSET(lflag, IEXTEN)) {
618 if (ISSET(lflag, ISIG))
619 pgsignal(tp->t_pgrp, SIGINFO, 1);
620 if (!ISSET(lflag, NOKERNINFO))
624 if (CCEQ(cc[VCHECKPT], c) && ISSET(lflag, IEXTEN)) {
625 if (ISSET(lflag, ISIG))
626 pgsignal(tp->t_pgrp, SIGCKPT, 1);
631 * Check for input buffer overflow
633 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >= MAX_INPUT) {
635 if (ISSET(iflag, IMAXBEL)) {
636 if (tp->t_outq.c_cc < tp->t_ohiwat)
637 (void)ttyoutput(CTRL('g'), tp);
642 if ( c == 0377 && ISSET(iflag, PARMRK) && !ISSET(iflag, ISTRIP)
643 && ISSET(iflag, IGNBRK|IGNPAR) != (IGNBRK|IGNPAR))
644 clist_putc(0377 | TTY_QUOTE, &tp->t_rawq);
647 * Put data char in q for user and
648 * wakeup on seeing a line delimiter.
650 if (clist_putc(c, &tp->t_rawq) >= 0) {
651 if (!ISSET(lflag, ICANON)) {
656 if (TTBREAKC(c, lflag)) {
658 catq(&tp->t_rawq, &tp->t_canq);
660 } else if (tp->t_rocount++ == 0)
661 tp->t_rocol = tp->t_column;
662 if (ISSET(tp->t_state, TS_ERASE)) {
664 * end of prterase \.../
666 CLR(tp->t_state, TS_ERASE);
667 (void)ttyoutput('/', tp);
671 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ECHO)) {
673 * Place the cursor over the '^' of the ^D.
675 i = imin(2, tp->t_column - i);
677 (void)ttyoutput('\b', tp);
684 * IXANY means allow any character to restart output.
686 if (ISSET(tp->t_state, TS_TTSTOP) &&
687 !ISSET(iflag, IXANY) && cc[VSTART] != cc[VSTOP])
690 CLR(tp->t_lflag, FLUSHO);
691 CLR(tp->t_state, TS_TTSTOP);
693 return (ttstart(tp));
697 * Output a single character on a tty, doing output processing
698 * as needed (expanding tabs, newline processing, etc.).
699 * Returns < 0 if succeeds, otherwise returns char to resend.
703 ttyoutput(int c, struct tty *tp)
709 if (!ISSET(oflag, OPOST)) {
710 if (ISSET(tp->t_lflag, FLUSHO))
712 if (clist_putc(c, &tp->t_outq))
719 * Do tab expansion if OXTABS is set. Special case if we external
720 * processing, we don't do the tab expansion because we'll probably
721 * get it wrong. If tab expansion needs to be done, let it happen
724 CLR(c, ~TTY_CHARMASK);
726 ISSET(oflag, OXTABS) && !ISSET(tp->t_lflag, EXTPROC)) {
727 c = 8 - (tp->t_column & 7);
728 if (!ISSET(tp->t_lflag, FLUSHO)) {
729 crit_enter(); /* Don't interrupt tabs. */
730 c -= b_to_q(" ", c, &tp->t_outq);
736 return (c ? -1 : '\t');
738 if (c == CEOT && ISSET(oflag, ONOEOT))
742 * Newline translation: if ONLCR is set,
743 * translate newline into "\r\n".
745 if (c == '\n' && ISSET(tp->t_oflag, ONLCR)) {
748 if (!ISSET(tp->t_lflag, FLUSHO) && clist_putc('\r', &tp->t_outq))
751 /* If OCRNL is set, translate "\r" into "\n". */
752 else if (c == '\r' && ISSET(tp->t_oflag, OCRNL))
754 /* If ONOCR is set, don't transmit CRs when on column 0. */
755 else if (c == '\r' && ISSET(tp->t_oflag, ONOCR) && tp->t_column == 0)
760 if (!ISSET(tp->t_lflag, FLUSHO) && clist_putc(c, &tp->t_outq))
772 if (ISSET(tp->t_oflag, ONLCR | ONLRET))
782 col = (col + 8) & ~7;
790 * Ioctls for all tty devices. Called after line-discipline specific ioctl
791 * has been called to do discipline-specific functions and/or reject any
792 * of these ioctl commands.
796 ttioctl(struct tty *tp, u_long cmd, void *data, int flag)
798 struct thread *td = curthread;
799 struct lwp *lp = td->td_lwp;
800 struct proc *p = td->td_proc;
805 /* If the ioctl involves modification, hang if in the background. */
829 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
839 while (isbackground(p, tp) && !(p->p_flag & P_PPWAIT) &&
840 !SIGISMEMBER(p->p_sigignore, SIGTTOU) &&
841 !SIGISMEMBER(lp->lwp_sigmask, SIGTTOU)) {
842 if (p->p_pgrp->pg_jobc == 0)
844 pgsignal(p->p_pgrp, SIGTTOU, 1);
845 error = ttysleep(tp, &lbolt, PCATCH, "ttybg1",
853 switch (cmd) { /* Process the ioctl. */
854 case FIOASYNC: /* set/clear async i/o */
857 SET(tp->t_state, TS_ASYNC);
859 CLR(tp->t_state, TS_ASYNC);
862 case FIONREAD: /* get # bytes to read */
864 *(int *)data = ttnread(tp);
870 * Policy -- Don't allow FIOSETOWN on someone else's
873 if (tp->t_session != NULL && !isctty(p, tp))
876 error = fsetown(*(int *)data, &tp->t_sigio);
881 if (tp->t_session != NULL && !isctty(p, tp))
883 *(int *)data = fgetown(tp->t_sigio);
886 case TIOCEXCL: /* set exclusive use of tty */
888 SET(tp->t_state, TS_XCLUDE);
891 case TIOCFLUSH: { /* flush buffers */
892 int flags = *(int *)data;
895 flags = FREAD | FWRITE;
897 flags &= FREAD | FWRITE;
901 case TIOCCONS: /* become virtual console */
903 if (constty && constty != tp &&
904 ISSET(constty->t_state, TS_CONNECTED))
907 if ((error = priv_check(td, PRIV_ROOT)) != 0)
911 } else if (tp == constty)
914 case TIOCDRAIN: /* wait till output drained */
919 case TIOCGETA: { /* get termios struct */
920 struct termios *t = (struct termios *)data;
922 bcopy(&tp->t_termios, t, sizeof(struct termios));
925 case TIOCGETD: /* get line discipline */
926 *(int *)data = tp->t_line;
928 case TIOCGWINSZ: /* get window size */
929 *(struct winsize *)data = tp->t_winsize;
931 case TIOCGPGRP: /* get pgrp of tty */
934 *(int *)data = tp->t_pgrp ? tp->t_pgrp->pg_id : NO_PID;
936 case TIOCGSID: /* get sid of tty */
939 *(int *)data = tp->t_session->s_sid;
942 case TIOCHPCL: /* hang up on last close */
944 SET(tp->t_cflag, HUPCL);
948 case TIOCNXCL: /* reset exclusive use of tty */
950 CLR(tp->t_state, TS_XCLUDE);
953 case TIOCOUTQ: /* output queue size */
954 *(int *)data = tp->t_outq.c_cc;
956 case TIOCSETA: /* set termios struct */
957 case TIOCSETAW: /* drain output, set */
958 case TIOCSETAF: { /* drn out, fls in, set */
959 struct termios *t = (struct termios *)data;
961 if (t->c_ispeed == 0)
962 t->c_ispeed = t->c_ospeed;
963 if (t->c_ispeed == 0)
964 t->c_ispeed = tp->t_ospeed;
965 if (t->c_ispeed == 0)
968 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
974 if (cmd == TIOCSETAF)
977 if (!ISSET(t->c_cflag, CIGNORE)) {
979 * Set device hardware.
981 if (tp->t_param && (error = (*tp->t_param)(tp, t))) {
985 if (ISSET(t->c_cflag, CLOCAL) &&
986 !ISSET(tp->t_cflag, CLOCAL)) {
988 * XXX disconnections would be too hard to
989 * get rid of without this kludge. The only
990 * way to get rid of controlling terminals
991 * is to exit from the session leader.
993 CLR(tp->t_state, TS_ZOMBIE);
995 wakeup(TSA_CARR_ON(tp));
999 if ((ISSET(tp->t_state, TS_CARR_ON) ||
1000 ISSET(t->c_cflag, CLOCAL)) &&
1001 !ISSET(tp->t_state, TS_ZOMBIE))
1002 SET(tp->t_state, TS_CONNECTED);
1004 CLR(tp->t_state, TS_CONNECTED);
1005 tp->t_cflag = t->c_cflag;
1006 tp->t_ispeed = t->c_ispeed;
1007 if (t->c_ospeed != 0)
1008 tp->t_ospeed = t->c_ospeed;
1011 if (ISSET(t->c_lflag, ICANON) != ISSET(tp->t_lflag, ICANON) &&
1013 if (ISSET(t->c_lflag, ICANON))
1014 SET(tp->t_lflag, PENDIN);
1017 * XXX we really shouldn't allow toggling
1018 * ICANON while we're in a non-termios line
1019 * discipline. Now we have to worry about
1020 * panicing for a null queue.
1022 if (tp->t_canq.c_cbreserved > 0 &&
1023 tp->t_rawq.c_cbreserved > 0) {
1024 catq(&tp->t_rawq, &tp->t_canq);
1026 * XXX the queue limits may be
1027 * different, so the old queue
1028 * swapping method no longer works.
1030 catq(&tp->t_canq, &tp->t_rawq);
1032 CLR(tp->t_lflag, PENDIN);
1036 tp->t_iflag = t->c_iflag;
1037 tp->t_oflag = t->c_oflag;
1039 * Make the EXTPROC bit read only.
1041 if (ISSET(tp->t_lflag, EXTPROC))
1042 SET(t->c_lflag, EXTPROC);
1044 CLR(t->c_lflag, EXTPROC);
1045 tp->t_lflag = t->c_lflag | ISSET(tp->t_lflag, PENDIN);
1046 if (t->c_cc[VMIN] != tp->t_cc[VMIN] ||
1047 t->c_cc[VTIME] != tp->t_cc[VTIME])
1049 bcopy(t->c_cc, tp->t_cc, sizeof(t->c_cc));
1053 case TIOCSETD: { /* set line discipline */
1054 int t = *(int *)data;
1055 cdev_t device = tp->t_dev;
1057 if ((u_int)t >= nlinesw)
1059 if (t != tp->t_line) {
1061 (*linesw[tp->t_line].l_close)(tp, flag);
1062 error = (*linesw[t].l_open)(device, tp);
1064 (void)(*linesw[tp->t_line].l_open)(device, tp);
1073 case TIOCSTART: /* start output, like ^Q */
1075 if (ISSET(tp->t_state, TS_TTSTOP) ||
1076 ISSET(tp->t_lflag, FLUSHO)) {
1077 CLR(tp->t_lflag, FLUSHO);
1078 CLR(tp->t_state, TS_TTSTOP);
1083 case TIOCSTI: /* simulate terminal input */
1084 if ((flag & FREAD) == 0 && priv_check(td, PRIV_ROOT))
1086 if (!isctty(p, tp) && priv_check(td, PRIV_ROOT))
1089 (*linesw[tp->t_line].l_rint)(*(u_char *)data, tp);
1092 case TIOCSTOP: /* stop output, like ^S */
1094 if (!ISSET(tp->t_state, TS_TTSTOP)) {
1095 SET(tp->t_state, TS_TTSTOP);
1096 (*tp->t_stop)(tp, 0);
1100 case TIOCSCTTY: /* become controlling tty */
1101 /* Session ctty vnode pointer set in vnode layer. */
1102 if (!SESS_LEADER(p) ||
1103 ((p->p_session->s_ttyvp || tp->t_session) &&
1104 (tp->t_session != p->p_session)))
1106 tp->t_session = p->p_session;
1107 tp->t_pgrp = p->p_pgrp;
1108 p->p_session->s_ttyp = tp;
1109 p->p_flag |= P_CONTROLT;
1111 case TIOCSPGRP: { /* set pgrp of tty */
1112 pid_t pgid = *(int *)data;
1116 else if (pgid < 1 || pgid > PID_MAX)
1119 struct pgrp *pgrp = pgfind(pgid);
1120 if (pgrp == NULL || pgrp->pg_session != p->p_session)
1127 case TIOCSTAT: /* simulate control-T */
1132 case TIOCSWINSZ: /* set window size */
1133 if (bcmp((caddr_t)&tp->t_winsize, data,
1134 sizeof (struct winsize))) {
1135 tp->t_winsize = *(struct winsize *)data;
1136 pgsignal(tp->t_pgrp, SIGWINCH, 1);
1139 case TIOCSDRAINWAIT:
1140 error = priv_check(td, PRIV_ROOT);
1143 tp->t_timeout = *(int *)data * hz;
1144 wakeup(TSA_OCOMPLETE(tp));
1145 wakeup(TSA_OLOWAT(tp));
1147 case TIOCGDRAINWAIT:
1148 *(int *)data = tp->t_timeout / hz;
1151 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
1152 return (ttcompat(tp, cmd, data, flag));
1161 ttypoll(struct dev_poll_args *ap)
1163 cdev_t dev = ap->a_head.a_dev;
1164 int events = ap->a_events;
1169 /* XXX used to return ENXIO, but that means true! */
1171 ap->a_events = (events & (POLLIN | POLLOUT | POLLRDNORM |
1172 POLLWRNORM)) | POLLHUP;
1177 if (events & (POLLIN | POLLRDNORM)) {
1178 if (ttnread(tp) > 0 || ISSET(tp->t_state, TS_ZOMBIE))
1179 revents |= events & (POLLIN | POLLRDNORM);
1181 selrecord(curthread, &tp->t_rsel);
1183 if (events & (POLLOUT | POLLWRNORM)) {
1184 if ((tp->t_outq.c_cc <= tp->t_olowat &&
1185 ISSET(tp->t_state, TS_CONNECTED))
1186 || ISSET(tp->t_state, TS_ZOMBIE))
1187 revents |= events & (POLLOUT | POLLWRNORM);
1189 selrecord(curthread, &tp->t_wsel);
1192 ap->a_events = revents;
1196 static struct filterops ttyread_filtops =
1197 { 1, NULL, filt_ttyrdetach, filt_ttyread };
1198 static struct filterops ttywrite_filtops =
1199 { 1, NULL, filt_ttywdetach, filt_ttywrite };
1202 ttykqfilter(struct dev_kqfilter_args *ap)
1204 cdev_t dev = ap->a_head.a_dev;
1205 struct knote *kn = ap->a_kn;
1206 struct tty *tp = dev->si_tty;
1207 struct klist *klist;
1210 switch (kn->kn_filter) {
1212 klist = &tp->t_rsel.si_note;
1213 kn->kn_fop = &ttyread_filtops;
1216 klist = &tp->t_wsel.si_note;
1217 kn->kn_fop = &ttywrite_filtops;
1224 kn->kn_hook = (caddr_t)dev;
1227 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
1234 filt_ttyrdetach(struct knote *kn)
1236 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
1239 SLIST_REMOVE(&tp->t_rsel.si_note, kn, knote, kn_selnext);
1244 filt_ttyread(struct knote *kn, long hint)
1246 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
1248 kn->kn_data = ttnread(tp);
1249 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1250 kn->kn_flags |= EV_EOF;
1253 return (kn->kn_data > 0);
1257 filt_ttywdetach(struct knote *kn)
1259 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
1262 SLIST_REMOVE(&tp->t_wsel.si_note, kn, knote, kn_selnext);
1267 filt_ttywrite(struct knote *kn, long hint)
1269 struct tty *tp = ((cdev_t)kn->kn_hook)->si_tty;
1271 kn->kn_data = tp->t_outq.c_cc;
1272 if (ISSET(tp->t_state, TS_ZOMBIE))
1274 return (kn->kn_data <= tp->t_olowat &&
1275 ISSET(tp->t_state, TS_CONNECTED));
1279 * Must be called while in a critical section.
1282 ttnread(struct tty *tp)
1286 if (ISSET(tp->t_lflag, PENDIN))
1288 nread = tp->t_canq.c_cc;
1289 if (!ISSET(tp->t_lflag, ICANON)) {
1290 nread += tp->t_rawq.c_cc;
1291 if (nread < tp->t_cc[VMIN] && tp->t_cc[VTIME] == 0)
1298 * Wait for output to drain.
1301 ttywait(struct tty *tp)
1307 while ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1308 ISSET(tp->t_state, TS_CONNECTED) && tp->t_oproc) {
1310 if ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1311 ISSET(tp->t_state, TS_CONNECTED)) {
1312 SET(tp->t_state, TS_SO_OCOMPLETE);
1313 error = ttysleep(tp, TSA_OCOMPLETE(tp),
1317 if (error == EWOULDBLOCK)
1324 if (!error && (tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)))
1331 * Flush if successfully wait.
1334 ttywflush(struct tty *tp)
1338 if ((error = ttywait(tp)) == 0)
1339 ttyflush(tp, FREAD);
1344 * Flush tty read and/or write queues, notifying anyone waiting.
1347 ttyflush(struct tty *tp, int rw)
1354 FLUSHQ(&tp->t_outq);
1355 CLR(tp->t_state, TS_TTSTOP);
1357 (*tp->t_stop)(tp, rw);
1359 FLUSHQ(&tp->t_canq);
1360 FLUSHQ(&tp->t_rawq);
1361 CLR(tp->t_lflag, PENDIN);
1364 CLR(tp->t_state, TS_LOCAL);
1366 if (ISSET(tp->t_state, TS_TBLOCK)) {
1368 FLUSHQ(&tp->t_outq);
1372 * Don't let leave any state that might clobber the
1373 * next line discipline (although we should do more
1374 * to send the START char). Not clearing the state
1375 * may have caused the "putc to a clist with no
1376 * reserved cblocks" panic/kprintf.
1378 CLR(tp->t_state, TS_TBLOCK);
1380 #if 0 /* forget it, sleeping isn't always safe and we don't know when it is */
1381 if (ISSET(tp->t_iflag, IXOFF)) {
1383 * XXX wait a bit in the hope that the stop
1384 * character (if any) will go out. Waiting
1385 * isn't good since it allows races. This
1386 * will be fixed when the stop character is
1387 * put in a special queue. Don't bother with
1388 * the checks in ttywait() since the timeout
1391 SET(tp->t_state, TS_SO_OCOMPLETE);
1392 ttysleep(tp, TSA_OCOMPLETE(tp), 0,
1395 * Don't try sending the stop character again.
1397 CLR(tp->t_state, TS_TBLOCK);
1404 FLUSHQ(&tp->t_outq);
1411 * Copy in the default termios characters.
1414 termioschars(struct termios *t)
1417 bcopy(ttydefchars, t->c_cc, sizeof t->c_cc);
1424 ttychars(struct tty *tp)
1427 termioschars(&tp->t_termios);
1431 * Handle input high water. Send stop character for the IXOFF case. Turn
1432 * on our input flow control bit and propagate the changes to the driver.
1433 * XXX the stop character should be put in a special high priority queue.
1436 ttyblock(struct tty *tp)
1439 SET(tp->t_state, TS_TBLOCK);
1440 if (ISSET(tp->t_iflag, IXOFF) && tp->t_cc[VSTOP] != _POSIX_VDISABLE &&
1441 clist_putc(tp->t_cc[VSTOP], &tp->t_outq) != 0)
1442 CLR(tp->t_state, TS_TBLOCK); /* try again later */
1447 * Handle input low water. Send start character for the IXOFF case. Turn
1448 * off our input flow control bit and propagate the changes to the driver.
1449 * XXX the start character should be put in a special high priority queue.
1452 ttyunblock(struct tty *tp)
1455 CLR(tp->t_state, TS_TBLOCK);
1456 if (ISSET(tp->t_iflag, IXOFF) && tp->t_cc[VSTART] != _POSIX_VDISABLE &&
1457 clist_putc(tp->t_cc[VSTART], &tp->t_outq) != 0)
1458 SET(tp->t_state, TS_TBLOCK); /* try again later */
1463 /* Not used by any current (i386) drivers. */
1465 * Restart after an inter-char delay.
1468 ttrstrt(void *tp_arg)
1472 KASSERT(tp_arg != NULL, ("ttrstrt"));
1476 CLR(tp->t_state, TS_TIMEOUT);
1483 ttstart(struct tty *tp)
1486 if (tp->t_oproc != NULL) /* XXX: Kludge for pty. */
1492 * "close" a line discipline
1495 ttylclose(struct tty *tp, int flag)
1498 if (flag & FNONBLOCK || ttywflush(tp))
1499 ttyflush(tp, FREAD | FWRITE);
1504 * Handle modem control transition on a tty.
1505 * Flag indicates new state of carrier.
1506 * Returns 0 if the line should be turned off, otherwise 1.
1509 ttymodem(struct tty *tp, int flag)
1512 if (ISSET(tp->t_state, TS_CARR_ON) && ISSET(tp->t_cflag, MDMBUF)) {
1514 * MDMBUF: do flow control according to carrier flag
1515 * XXX TS_CAR_OFLOW doesn't do anything yet. TS_TTSTOP
1516 * works if IXON and IXANY are clear.
1519 CLR(tp->t_state, TS_CAR_OFLOW);
1520 CLR(tp->t_state, TS_TTSTOP);
1522 } else if (!ISSET(tp->t_state, TS_CAR_OFLOW)) {
1523 SET(tp->t_state, TS_CAR_OFLOW);
1524 SET(tp->t_state, TS_TTSTOP);
1525 (*tp->t_stop)(tp, 0);
1527 } else if (flag == 0) {
1531 CLR(tp->t_state, TS_CARR_ON);
1532 if (ISSET(tp->t_state, TS_ISOPEN) &&
1533 !ISSET(tp->t_cflag, CLOCAL)) {
1534 SET(tp->t_state, TS_ZOMBIE);
1535 CLR(tp->t_state, TS_CONNECTED);
1536 if (tp->t_session && tp->t_session->s_leader)
1537 ksignal(tp->t_session->s_leader, SIGHUP);
1538 ttyflush(tp, FREAD | FWRITE);
1545 SET(tp->t_state, TS_CARR_ON);
1546 if (!ISSET(tp->t_state, TS_ZOMBIE))
1547 SET(tp->t_state, TS_CONNECTED);
1548 wakeup(TSA_CARR_ON(tp));
1556 * Reinput pending characters after state switch
1557 * call from a critical section.
1560 ttypend(struct tty *tp)
1565 CLR(tp->t_lflag, PENDIN);
1566 SET(tp->t_state, TS_TYPEN);
1568 * XXX this assumes too much about clist internals. It may even
1569 * fail if the cblock slush pool is empty. We can't allocate more
1570 * cblocks here because we are called from an interrupt handler
1571 * and clist_alloc_cblocks() can wait.
1574 bzero(&tp->t_rawq, sizeof tp->t_rawq);
1575 tp->t_rawq.c_cbmax = tq.c_cbmax;
1576 tp->t_rawq.c_cbreserved = tq.c_cbreserved;
1577 while ((c = clist_getc(&tq)) >= 0)
1579 CLR(tp->t_state, TS_TYPEN);
1583 * Process a read call on a tty device.
1586 ttread(struct tty *tp, struct uio *uio, int flag)
1591 cc_t *cc = tp->t_cc;
1594 int first, error = 0;
1595 int has_stime = 0, last_cc = 0;
1596 long slp = 0; /* XXX this should be renamed `timo'. */
1597 struct timeval stime;
1599 lp = curthread->td_lwp;
1600 stime.tv_sec = 0; /* fix compiler warnings */
1605 lflag = tp->t_lflag;
1607 * take pending input first
1609 if (ISSET(lflag, PENDIN)) {
1611 splz(); /* reduce latency */
1612 lflag = tp->t_lflag; /* XXX ttypend() clobbers it */
1616 * Hang process if it's in the background.
1618 if ((pp = curproc) && isbackground(pp, tp)) {
1620 if (SIGISMEMBER(pp->p_sigignore, SIGTTIN) ||
1621 SIGISMEMBER(lp->lwp_sigmask, SIGTTIN) ||
1622 (pp->p_flag & P_PPWAIT) || pp->p_pgrp->pg_jobc == 0)
1624 pgsignal(pp->p_pgrp, SIGTTIN, 1);
1625 error = ttysleep(tp, &lbolt, PCATCH, "ttybg2", 0);
1631 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1633 return (0); /* EOF */
1637 * If canonical, use the canonical queue,
1638 * else use the raw queue.
1640 * (should get rid of clists...)
1642 qp = ISSET(lflag, ICANON) ? &tp->t_canq : &tp->t_rawq;
1644 if (flag & IO_NDELAY) {
1647 if (!ISSET(lflag, ICANON) && cc[VMIN] == 0) {
1652 return (EWOULDBLOCK);
1654 if (!ISSET(lflag, ICANON)) {
1657 struct timeval timecopy;
1660 * Check each of the four combinations.
1661 * (m > 0 && t == 0) is the normal read case.
1662 * It should be fairly efficient, so we check that and its
1663 * companion case (m == 0 && t == 0) first.
1664 * For the other two cases, we compute the target sleep time
1673 /* m, t and qp->c_cc are all 0. 0 is enough input. */
1677 t *= 100000; /* time in us */
1678 #define diff(t1, t2) (((t1).tv_sec - (t2).tv_sec) * 1000000 + \
1679 ((t1).tv_usec - (t2).tv_usec))
1685 getmicrotime(&timecopy);
1686 if (has_stime == 0) {
1687 /* first character, start timer */
1691 } else if (qp->c_cc > last_cc) {
1692 /* got a character, restart timer */
1696 /* nothing, check expiration */
1697 slp = t - diff(timecopy, stime);
1702 } else { /* m == 0 */
1705 getmicrotime(&timecopy);
1706 if (has_stime == 0) {
1711 slp = t - diff(timecopy, stime);
1713 /* Timed out, but 0 is enough input. */
1721 * Rounding down may make us wake up just short
1722 * of the target, so we round up.
1723 * The formula is ceiling(slp * hz/1000000).
1724 * 32-bit arithmetic is enough for hz < 169.
1725 * XXX see tvtohz() for how to avoid overflow if hz
1726 * is large (divide by `tick' and/or arrange to
1727 * use tvtohz() if hz is large).
1729 slp = (long) (((u_long)slp * hz) + 999999) / 1000000;
1732 if (qp->c_cc <= 0) {
1735 * There is no input, or not enough input and we can block.
1737 error = ttysleep(tp, TSA_HUP_OR_INPUT(tp), PCATCH,
1738 ISSET(tp->t_state, TS_CONNECTED) ?
1739 "ttyin" : "ttyhup", (int)slp);
1741 if (error == EWOULDBLOCK)
1746 * XXX what happens if another process eats some input
1747 * while we are asleep (not just here)? It would be
1748 * safest to detect changes and reset our state variables
1749 * (has_stime and last_cc).
1757 * Input present, check for input mapping and processing.
1760 if (ISSET(lflag, ICANON | ISIG))
1766 icc = (int)szmin(uio->uio_resid, IBUFSIZ);
1767 icc = q_to_b(qp, ibuf, icc);
1773 error = uiomove(ibuf, (size_t)icc, uio);
1775 * XXX if there was an error then we should ungetc() the
1776 * unmoved chars and reduce icc here.
1780 if (uio->uio_resid == 0)
1794 * delayed suspend (^Y)
1796 if (CCEQ(cc[VDSUSP], c) &&
1797 ISSET(lflag, IEXTEN | ISIG) == (IEXTEN | ISIG)) {
1798 pgsignal(tp->t_pgrp, SIGTSTP, 1);
1800 error = ttysleep(tp, &lbolt, PCATCH,
1809 * Interpret EOF only in canonical mode.
1811 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ICANON))
1814 * Give user character.
1816 error = ureadc(c, uio);
1818 /* XXX should ungetc(c, qp). */
1820 if (uio->uio_resid == 0)
1823 * In canonical mode check for a "break character"
1824 * marking the end of a "line of input".
1826 if (ISSET(lflag, ICANON) && TTBREAKC(c, lflag))
1833 * Look to unblock input now that (presumably)
1834 * the input queue has gone down.
1837 if (ISSET(tp->t_state, TS_TBLOCK) &&
1838 tp->t_rawq.c_cc + tp->t_canq.c_cc <= tp->t_ilowat)
1846 * Check the output queue on tp for space for a kernel message (from uprintf
1847 * or tprintf). Allow some space over the normal hiwater mark so we don't
1848 * lose messages due to normal flow control, but don't let the tty run amok.
1849 * Sleeps here are not interruptible, but we return prematurely if new signals
1853 ttycheckoutq(struct tty *tp, int wait)
1855 struct lwp *lp = curthread->td_lwp;
1857 sigset_t oldset, newset;
1859 hiwat = tp->t_ohiwat;
1860 SIGEMPTYSET(oldset);
1861 SIGEMPTYSET(newset);
1864 oldset = lwp_sigpend(lp);
1865 if (tp->t_outq.c_cc > hiwat + OBUFSIZ + 100) {
1866 while (tp->t_outq.c_cc > hiwat) {
1868 if (tp->t_outq.c_cc <= hiwat)
1871 newset = lwp_sigpend(lp);
1872 if (!wait || SIGSETNEQ(oldset, newset)) {
1876 SET(tp->t_state, TS_SO_OLOWAT);
1877 tsleep(TSA_OLOWAT(tp), 0, "ttoutq", hz);
1885 * Process a write call on a tty device.
1888 ttwrite(struct tty *tp, struct uio *uio, int flag)
1894 int i, hiwat, error;
1899 lp = curthread->td_lwp;
1900 hiwat = tp->t_ohiwat;
1901 cnt = uio->uio_resid;
1906 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1908 if (uio->uio_resid == cnt)
1912 if (!ISSET(tp->t_state, TS_CONNECTED)) {
1913 if (flag & IO_NDELAY) {
1915 error = EWOULDBLOCK;
1918 error = ttysleep(tp, TSA_CARR_ON(tp), PCATCH, "ttydcd", 0);
1927 * Hang the process if it's in the background.
1929 if ((pp = curproc) && isbackground(pp, tp) &&
1930 ISSET(tp->t_lflag, TOSTOP) && !(pp->p_flag & P_PPWAIT) &&
1931 !SIGISMEMBER(pp->p_sigignore, SIGTTOU) &&
1932 !SIGISMEMBER(lp->lwp_sigmask, SIGTTOU)) {
1933 if (pp->p_pgrp->pg_jobc == 0) {
1937 pgsignal(pp->p_pgrp, SIGTTOU, 1);
1938 error = ttysleep(tp, &lbolt, PCATCH, "ttybg4", 0);
1944 * Process the user's data in at most OBUFSIZ chunks. Perform any
1945 * output translation. Keep track of high water mark, sleep on
1946 * overflow awaiting device aid in acquiring new space.
1948 while (uio->uio_resid > 0 || cc > 0) {
1949 if (ISSET(tp->t_lflag, FLUSHO)) {
1953 if (tp->t_outq.c_cc > hiwat)
1956 * Grab a hunk of data from the user, unless we have some
1957 * leftover from last time.
1960 cc = szmin(uio->uio_resid, OBUFSIZ);
1962 error = uiomove(cp, (size_t)cc, uio);
1969 * If nothing fancy need be done, grab those characters we
1970 * can handle without any of ttyoutput's processing and
1971 * just transfer them to the output q. For those chars
1972 * which require special processing (as indicated by the
1973 * bits in char_type), call ttyoutput. After processing
1974 * a hunk of data, look for FLUSHO so ^O's will take effect
1978 if (!ISSET(tp->t_oflag, OPOST))
1981 ce = cc - scanc((u_int)cc, (u_char *)cp,
1982 char_type, CCLASSMASK);
1984 * If ce is zero, then we're processing
1985 * a special character through ttyoutput.
1989 if (ttyoutput(*cp, tp) >= 0) {
1990 /* No Clists, wait a bit. */
1992 if (flag & IO_NDELAY) {
1993 error = EWOULDBLOCK;
1996 error = ttysleep(tp, &lbolt,
2005 if (ISSET(tp->t_lflag, FLUSHO) ||
2006 tp->t_outq.c_cc > hiwat)
2012 * A bunch of normal characters have been found.
2013 * Transfer them en masse to the output queue and
2014 * continue processing at the top of the loop.
2015 * If there are any further characters in this
2016 * <= OBUFSIZ chunk, the first should be a character
2017 * requiring special handling by ttyoutput.
2020 i = b_to_q(cp, ce, &tp->t_outq);
2023 cp += ce, cc -= ce, tk_nout += ce;
2026 /* No Clists, wait a bit. */
2028 if (flag & IO_NDELAY) {
2029 error = EWOULDBLOCK;
2032 error = ttysleep(tp, &lbolt, PCATCH,
2038 if (ISSET(tp->t_lflag, FLUSHO) ||
2039 tp->t_outq.c_cc > hiwat)
2046 * If cc is nonzero, we leave the uio structure inconsistent, as the
2047 * offset and iov pointers have moved forward, but it doesn't matter
2048 * (the call will either return short or restart with a new uio).
2050 uio->uio_resid += cc;
2057 * This can only occur if FLUSHO is set in t_lflag,
2058 * or if ttstart/oproc is synchronous (or very fast).
2060 if (tp->t_outq.c_cc <= hiwat) {
2064 if (flag & IO_NDELAY) {
2066 uio->uio_resid += cc;
2067 return (uio->uio_resid == cnt ? EWOULDBLOCK : 0);
2069 SET(tp->t_state, TS_SO_OLOWAT);
2070 error = ttysleep(tp, TSA_OLOWAT(tp), PCATCH, "ttywri", tp->t_timeout);
2072 if (error == EWOULDBLOCK)
2080 * Rubout one character from the rawq of tp
2081 * as cleanly as possible.
2084 ttyrub(int c, struct tty *tp)
2090 if (!ISSET(tp->t_lflag, ECHO) || ISSET(tp->t_lflag, EXTPROC))
2092 CLR(tp->t_lflag, FLUSHO);
2093 if (ISSET(tp->t_lflag, ECHOE)) {
2094 if (tp->t_rocount == 0) {
2096 * Screwed by ttwrite; retype
2101 if (c == ('\t' | TTY_QUOTE) || c == ('\n' | TTY_QUOTE))
2104 CLR(c, ~TTY_CHARMASK);
2105 switch (CCLASS(c)) {
2114 if (ISSET(tp->t_lflag, ECHOCTL))
2118 if (tp->t_rocount < tp->t_rawq.c_cc) {
2123 savecol = tp->t_column;
2124 SET(tp->t_state, TS_CNTTB);
2125 SET(tp->t_lflag, FLUSHO);
2126 tp->t_column = tp->t_rocol;
2127 cp = tp->t_rawq.c_cf;
2129 tabc = *cp; /* XXX FIX NEXTC */
2130 for (; cp; cp = nextc(&tp->t_rawq, cp, &tabc))
2132 CLR(tp->t_lflag, FLUSHO);
2133 CLR(tp->t_state, TS_CNTTB);
2136 /* savecol will now be length of the tab. */
2137 savecol -= tp->t_column;
2138 tp->t_column += savecol;
2140 savecol = 8; /* overflow screw */
2141 while (--savecol >= 0)
2142 (void)ttyoutput('\b', tp);
2145 #define PANICSTR "ttyrub: would panic c = %d, val = %d\n"
2146 (void)kprintf(PANICSTR, c, CCLASS(c));
2148 panic(PANICSTR, c, CCLASS(c));
2152 } else if (ISSET(tp->t_lflag, ECHOPRT)) {
2153 if (!ISSET(tp->t_state, TS_ERASE)) {
2154 SET(tp->t_state, TS_ERASE);
2155 (void)ttyoutput('\\', tp);
2159 ttyecho(tp->t_cc[VERASE], tp);
2161 * This code may be executed not only when an ERASE key
2162 * is pressed, but also when ^U (KILL) or ^W (WERASE) are.
2163 * So, I didn't think it was worthwhile to pass the extra
2164 * information (which would need an extra parameter,
2165 * changing every call) needed to distinguish the ERASE2
2166 * case from the ERASE.
2173 * Back over cnt characters, erasing them.
2176 ttyrubo(struct tty *tp, int cnt)
2180 (void)ttyoutput('\b', tp);
2181 (void)ttyoutput(' ', tp);
2182 (void)ttyoutput('\b', tp);
2188 * Reprint the rawq line. Note, it is assumed that c_cc has already
2192 ttyretype(struct tty *tp)
2197 /* Echo the reprint character. */
2198 if (tp->t_cc[VREPRINT] != _POSIX_VDISABLE)
2199 ttyecho(tp->t_cc[VREPRINT], tp);
2201 (void)ttyoutput('\n', tp);
2205 * FIX: NEXTC IS BROKEN - DOESN'T CHECK QUOTE
2206 * BIT OF FIRST CHAR.
2209 for (cp = tp->t_canq.c_cf, c = (cp != NULL ? *cp : 0);
2210 cp != NULL; cp = nextc(&tp->t_canq, cp, &c))
2212 for (cp = tp->t_rawq.c_cf, c = (cp != NULL ? *cp : 0);
2213 cp != NULL; cp = nextc(&tp->t_rawq, cp, &c))
2215 CLR(tp->t_state, TS_ERASE);
2218 tp->t_rocount = tp->t_rawq.c_cc;
2223 * Echo a typed character to the terminal.
2226 ttyecho(int c, struct tty *tp)
2229 if (!ISSET(tp->t_state, TS_CNTTB))
2230 CLR(tp->t_lflag, FLUSHO);
2231 if ((!ISSET(tp->t_lflag, ECHO) &&
2232 (c != '\n' || !ISSET(tp->t_lflag, ECHONL))) ||
2233 ISSET(tp->t_lflag, EXTPROC))
2235 if (ISSET(tp->t_lflag, ECHOCTL) &&
2236 ((ISSET(c, TTY_CHARMASK) <= 037 && c != '\t' && c != '\n') ||
2237 ISSET(c, TTY_CHARMASK) == 0177)) {
2238 (void)ttyoutput('^', tp);
2239 CLR(c, ~TTY_CHARMASK);
2245 (void)ttyoutput(c, tp);
2249 * Wake up any readers on a tty.
2252 ttwakeup(struct tty *tp)
2255 if (tp->t_rsel.si_pid != 0)
2256 selwakeup(&tp->t_rsel);
2257 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
2258 pgsigio(tp->t_sigio, SIGIO, (tp->t_session != NULL));
2259 wakeup(TSA_HUP_OR_INPUT(tp));
2260 KNOTE(&tp->t_rsel.si_note, 0);
2264 * Wake up any writers on a tty.
2267 ttwwakeup(struct tty *tp)
2270 if (tp->t_wsel.si_pid != 0 && tp->t_outq.c_cc <= tp->t_olowat)
2271 selwakeup(&tp->t_wsel);
2272 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
2273 pgsigio(tp->t_sigio, SIGIO, (tp->t_session != NULL));
2274 if (ISSET(tp->t_state, TS_BUSY | TS_SO_OCOMPLETE) ==
2275 TS_SO_OCOMPLETE && tp->t_outq.c_cc == 0) {
2276 CLR(tp->t_state, TS_SO_OCOMPLETE);
2277 wakeup(TSA_OCOMPLETE(tp));
2279 if (ISSET(tp->t_state, TS_SO_OLOWAT) &&
2280 tp->t_outq.c_cc <= tp->t_olowat) {
2281 CLR(tp->t_state, TS_SO_OLOWAT);
2282 wakeup(TSA_OLOWAT(tp));
2284 KNOTE(&tp->t_wsel.si_note, 0);
2288 * Look up a code for a specified speed in a conversion table;
2289 * used by drivers to map software speed values to hardware parameters.
2292 ttspeedtab(int speed, struct speedtab *table)
2295 for ( ; table->sp_speed != -1; table++)
2296 if (table->sp_speed == speed)
2297 return (table->sp_code);
2302 * Set input and output watermarks and buffer sizes. For input, the
2303 * high watermark is about one second's worth of input above empty, the
2304 * low watermark is slightly below high water, and the buffer size is a
2305 * driver-dependent amount above high water. For output, the watermarks
2306 * are near the ends of the buffer, with about 1 second's worth of input
2307 * between them. All this only applies to the standard line discipline.
2310 ttsetwater(struct tty *tp)
2312 int cps, ttmaxhiwat, x;
2315 clist_alloc_cblocks(&tp->t_canq, TTYHOG, 512);
2316 switch (tp->t_ispeedwat) {
2318 cps = tp->t_ispeed / 10;
2322 * This case is for old drivers that don't know about
2323 * t_ispeedwat. Arrange for them to get the old buffer
2324 * sizes and watermarks.
2326 cps = TTYHOG - 2 * 256;
2327 tp->t_ififosize = 2 * 2048;
2330 cps = tp->t_ispeedwat / 10;
2334 tp->t_ilowat = 7 * cps / 8;
2335 x = cps + tp->t_ififosize;
2336 clist_alloc_cblocks(&tp->t_rawq, x, x);
2339 switch (tp->t_ospeedwat) {
2341 cps = tp->t_ospeed / 10;
2342 ttmaxhiwat = 2 * TTMAXHIWAT;
2345 cps = tp->t_ospeed / 10;
2346 ttmaxhiwat = TTMAXHIWAT;
2349 cps = tp->t_ospeedwat / 10;
2350 ttmaxhiwat = 8 * TTMAXHIWAT;
2353 #define CLAMP(x, h, l) ((x) > h ? h : ((x) < l) ? l : (x))
2354 tp->t_olowat = x = CLAMP(cps / 2, TTMAXLOWAT, TTMINLOWAT);
2356 x = CLAMP(x, ttmaxhiwat, TTMINHIWAT); /* XXX clamps are too magic */
2357 tp->t_ohiwat = roundup(x, CBSIZE); /* XXX for compat */
2358 x = imax(tp->t_ohiwat, TTMAXHIWAT); /* XXX for compat/safety */
2360 clist_alloc_cblocks(&tp->t_outq, x, x);
2365 * Report on state of foreground process group.
2368 ttyinfo(struct tty *tp)
2370 struct proc *p, *pick;
2375 if (ttycheckoutq(tp,0) == 0)
2379 * We always print the load average, then figure out what else to
2380 * print based on the state of the current process group.
2382 tmp = (averunnable.ldavg[0] * 100 + FSCALE / 2) >> FSHIFT;
2383 ttyprintf(tp, "load: %d.%02d ", tmp / 100, tmp % 100);
2385 if (tp->t_session == NULL) {
2386 ttyprintf(tp, "not a controlling terminal\n");
2387 } else if (tp->t_pgrp == NULL) {
2388 ttyprintf(tp, "no foreground process group\n");
2389 } else if ((p = LIST_FIRST(&tp->t_pgrp->pg_members)) == 0) {
2390 ttyprintf(tp, "empty foreground process group\n");
2393 * Pick an interesting process. Note that certain elements,
2394 * in particular the wmesg, require a critical section for
2395 * safe access (YYY and we are still not MP safe).
2397 * NOTE: lwp_wmesg is lwp_thread->td_wmesg.
2406 /* XXX lwp should compare lwps */
2408 for (pick = NULL; p != 0; p = LIST_NEXT(p, p_pglist)) {
2409 if (proc_compare(pick, p))
2414 lp = FIRST_LWP_IN_PROC(pick);
2416 ttyprintf(tp, "foreground process without lwp\n");
2423 * Figure out what wait/process-state message, and command
2427 * XXX lwp This is a horrible mixture. We need to rework this
2428 * as soon as lwps have their own runnable status.
2430 if (pick->p_flag & P_WEXIT)
2432 else if (lp->lwp_stat == LSRUN)
2434 else if (pick->p_stat == SIDL)
2436 else if (lp->lwp_wmesg) /* lwp_thread must not be NULL */
2437 str = lp->lwp_wmesg;
2441 ksnprintf(buf, sizeof(buf), "cmd: %s %d [%s]",
2442 pick->p_comm, pick->p_pid, str);
2445 * Calculate cpu usage, percent cpu, and cmsz. Note that
2446 * 'pick' becomes invalid the moment we exit the critical
2449 if (lp->lwp_thread && (pick->p_flag & P_SWAPPEDOUT) == 0)
2450 calcru_proc(pick, &ru);
2452 pctcpu = (lp->lwp_pctcpu * 10000 + FSCALE / 2) >> FSHIFT;
2454 if (pick->p_stat == SIDL || pick->p_stat == SZOMB)
2457 vmsz = pgtok(vmspace_resident_count(pick->p_vmspace));
2464 ttyprintf(tp, " %s ", buf);
2465 ttyprintf(tp, "%ld.%02ldu ",
2466 ru.ru_utime.tv_sec, ru.ru_utime.tv_usec / 10000);
2467 ttyprintf(tp, "%ld.%02lds ",
2468 ru.ru_stime.tv_sec, ru.ru_stime.tv_usec / 10000);
2469 ttyprintf(tp, "%d%% %ldk\n", pctcpu / 100, vmsz);
2471 tp->t_rocount = 0; /* so pending input will be retyped if BS */
2475 * Returns 1 if p2 is "better" than p1
2477 * The algorithm for picking the "interesting" process is thus:
2479 * 1) Only foreground processes are eligible - implied.
2480 * 2) Runnable processes are favored over anything else. The runner
2481 * with the highest cpu utilization is picked (p_cpticks). Ties are
2482 * broken by picking the highest pid.
2483 * 3) The sleeper with the shortest sleep time is next. With ties,
2484 * we pick out just "short-term" sleepers (LWP_SINTR == 0).
2485 * 4) Further ties are broken by picking the highest pid.
2487 #define ISRUN(lp) ((lp)->lwp_stat == LSRUN)
2488 #define TESTAB(a, b) ((a)<<1 | (b))
2494 proc_compare(struct proc *p1, struct proc *p2)
2496 struct lwp *lp1, *lp2;
2503 switch (TESTAB(p1->p_stat == SZOMB, p2->p_stat == SZOMB)) {
2509 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2513 lp1 = FIRST_LWP_IN_PROC(p1);
2514 lp2 = FIRST_LWP_IN_PROC(p2);
2517 * see if at least one of them is runnable
2519 switch (TESTAB(ISRUN(lp1), ISRUN(lp2))) {
2526 * tie - favor one with highest recent cpu utilization
2528 if (lp2->lwp_cpticks > lp1->lwp_cpticks)
2530 if (lp1->lwp_cpticks > lp2->lwp_cpticks)
2532 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2535 * pick the one with the smallest sleep time
2537 if (lp2->lwp_slptime > lp1->lwp_slptime)
2539 if (lp1->lwp_slptime > lp2->lwp_slptime)
2542 * favor one sleeping in a non-interruptible sleep
2544 if (lp1->lwp_flag & LWP_SINTR && (lp2->lwp_flag & LWP_SINTR) == 0)
2546 if (lp2->lwp_flag & LWP_SINTR && (lp1->lwp_flag & LWP_SINTR) == 0)
2548 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2552 * Output char to tty; console putchar style.
2555 tputchar(int c, struct tty *tp)
2558 if (!ISSET(tp->t_state, TS_CONNECTED)) {
2563 (void)ttyoutput('\r', tp);
2564 (void)ttyoutput(c, tp);
2571 * Sleep on chan, returning ERESTART if tty changed while we napped and
2572 * returning any errors (e.g. EINTR/EWOULDBLOCK) reported by tsleep. If
2573 * the tty is revoked, restarting a pending call will redo validation done
2574 * at the start of the call.
2577 ttysleep(struct tty *tp, void *chan, int slpflags, char *wmesg, int timo)
2583 error = tsleep(chan, slpflags, wmesg, timo);
2586 return (tp->t_gen == gen ? 0 : ERESTART);
2592 * We bump the gen to force any ttysleep()'s to return with ERESTART
2593 * and flush the tty. The related fp's should already have been
2594 * replaced so the tty will close when the last references on the
2595 * original fp's go away.
2598 ttyrevoke(struct dev_revoke_args *ap)
2602 tp = ap->a_head.a_dev->si_tty;
2604 ttyflush(tp, FREAD | FWRITE);
2605 wakeup(TSA_CARR_ON(tp));
2612 * Allocate a tty struct. Clists in the struct will be allocated by
2616 ttymalloc(struct tty *tp)
2622 tp = kmalloc(sizeof *tp, M_TTYS, M_WAITOK|M_ZERO);
2629 * Free a tty struct. Clists in the struct should have been freed by
2632 * XXX not yet usable: since we support a half-closed state and do not
2633 * ref count the tty reference from the session, it is possible for a
2634 * session to hold a ref on the tty. See TTY_DO_FULL_CLOSE.
2637 ttyfree(struct tty *tp)
2644 ttyregister(struct tty *tp)
2646 SLIST_INSERT_HEAD(&tty_list, tp, t_list);
2650 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
2654 SLIST_FOREACH(tp, &tty_list, t_list) {
2657 t.t_dev = (cdev_t)(uintptr_t)dev2udev(t.t_dev);
2658 error = SYSCTL_OUT(req, (caddr_t)&t, sizeof(t));
2665 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD,
2666 0, 0, sysctl_kern_ttys, "S,tty", "All struct ttys");
2669 nottystop(struct tty *tp, int rw)
2676 ttyread(struct dev_read_args *ap)
2680 tp = ap->a_head.a_dev->si_tty;
2683 return ((*linesw[tp->t_line].l_read)(tp, ap->a_uio, ap->a_ioflag));
2687 ttywrite(struct dev_write_args *ap)
2691 tp = ap->a_head.a_dev->si_tty;
2694 return ((*linesw[tp->t_line].l_write)(tp, ap->a_uio, ap->a_ioflag));