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 * Copyright (c) 2002 Networks Associates Technologies, Inc.
11 * All rights reserved.
13 * Portions of this software were developed for the FreeBSD Project by
14 * ThinkSec AS and NAI Labs, the Security Research Division of Network
15 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
16 * ("CBOSS"), as part of the DARPA CHATS research program.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in the
25 * documentation and/or other materials provided with the distribution.
26 * 4. Neither the name of the University nor the names of its contributors
27 * may be used to endorse or promote products derived from this software
28 * without specific prior written permission.
30 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 * @(#)tty.c 8.8 (Berkeley) 1/21/94
47 * o Fix races for sending the start char in ttyflush().
48 * o Handle inter-byte timeout for "MIN > 0, TIME > 0" in ttyselect().
49 * With luck, there will be MIN chars before select() returns().
50 * o Handle CLOCAL consistently for ptys. Perhaps disallow setting it.
51 * o Don't allow input in TS_ZOMBIE case. It would be visible through
53 * o Do the new sio locking stuff here and use it to avoid special
56 * o Move EXTPROC and/or PENDIN to t_state?
57 * o Wrap most of ttioctl in spltty/splx.
58 * o Implement TIOCNOTTY or remove it from <sys/ioctl.h>.
59 * o Send STOP if IXOFF is toggled off while TS_TBLOCK is set.
60 * o Don't allow certain termios flags to affect disciplines other
61 * than TTYDISC. Cancel their effects before switch disciplines
62 * and ignore them if they are set while we are in another
64 * o Now that historical speed conversions are handled here, don't
66 * o Check for TS_CARR_ON being set while everything is closed and not
67 * waiting for carrier. TS_CARR_ON isn't cleared if nothing is open,
68 * so it would live until the next open even if carrier drops.
69 * o Restore TS_WOPEN since it is useful in pstat. It must be cleared
70 * only when _all_ openers leave open().
73 #include <sys/cdefs.h>
74 __FBSDID("$FreeBSD$");
76 #include "opt_compat.h"
79 #include <sys/param.h>
80 #include <sys/systm.h>
81 #include <sys/filio.h>
83 #include <sys/mutex.h>
84 #include <sys/namei.h>
86 #if defined(COMPAT_43TTY)
87 #include <sys/ioctl_compat.h>
94 #include <sys/fcntl.h>
97 #include <sys/kernel.h>
98 #include <sys/vnode.h>
99 #include <sys/serial.h>
100 #include <sys/signalvar.h>
101 #include <sys/resourcevar.h>
102 #include <sys/malloc.h>
103 #include <sys/filedesc.h>
104 #include <sys/sched.h>
105 #include <sys/sysctl.h>
106 #include <sys/timepps.h>
108 #include <machine/stdarg.h>
112 #include <vm/vm_map.h>
114 MALLOC_DEFINE(M_TTYS, "ttys", "tty data structures");
121 static d_open_t ttysopen;
122 static d_close_t ttysclose;
123 static d_read_t ttysrdwr;
124 static d_ioctl_t ttysioctl;
125 static d_purge_t ttypurge;
127 /* Default cdevsw for common tty devices */
128 static struct cdevsw tty_cdevsw = {
129 .d_version = D_VERSION,
135 .d_flags = D_TTY | D_NEEDGIANT,
138 /* Cdevsw for slave tty devices */
139 static struct cdevsw ttys_cdevsw = {
140 .d_version = D_VERSION,
142 .d_close = ttysclose,
145 .d_ioctl = ttysioctl,
147 .d_flags = D_TTY | D_NEEDGIANT,
150 static int proc_sum(struct proc *, int *);
151 static int proc_compare(struct proc *, struct proc *);
152 static int thread_compare(struct thread *, struct thread *);
153 static int ttnread(struct tty *tp);
154 static void ttyecho(int c, struct tty *tp);
155 static int ttyoutput(int c, struct tty *tp);
156 static void ttypend(struct tty *tp);
157 static void ttyretype(struct tty *tp);
158 static void ttyrub(int c, struct tty *tp);
159 static void ttyrubo(struct tty *tp, int cnt);
160 static void ttyunblock(struct tty *tp);
161 static int ttywflush(struct tty *tp);
162 static int filt_ttyread(struct knote *kn, long hint);
163 static void filt_ttyrdetach(struct knote *kn);
164 static int filt_ttywrite(struct knote *kn, long hint);
165 static void filt_ttywdetach(struct knote *kn);
168 * Table with character classes and parity. The 8th bit indicates parity,
169 * the 7th bit indicates the character is an alphameric or underscore (for
170 * ALTWERASE), and the low 6 bits indicate delay type. If the low 6 bits
171 * are 0 then the character needs no special processing on output; classes
172 * other than 0 might be translated or (not currently) require delays.
174 #define E 0x00 /* Even parity. */
175 #define O 0x80 /* Odd parity. */
176 #define PARITY(c) (char_type[c] & O)
178 #define ALPHA 0x40 /* Alpha or underscore. */
179 #define ISALPHA(c) (char_type[(c) & TTY_CHARMASK] & ALPHA)
181 #define CCLASSMASK 0x3f
182 #define CCLASS(c) (char_type[c] & CCLASSMASK)
187 #define NA ORDINARY | ALPHA
193 static u_char const char_type[] = {
194 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* nul - bel */
195 O|BS, E|TB, E|NL, O|CC, E|VT, O|CR, O|CC, E|CC, /* bs - si */
196 O|CC, E|CC, E|CC, O|CC, E|CC, O|CC, O|CC, E|CC, /* dle - etb */
197 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* can - us */
198 O|NO, E|NO, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* sp - ' */
199 E|NO, O|NO, O|NO, E|NO, O|NO, E|NO, E|NO, O|NO, /* ( - / */
200 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* 0 - 7 */
201 O|NA, E|NA, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* 8 - ? */
202 O|NO, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* @ - G */
203 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* H - O */
204 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* P - W */
205 O|NA, E|NA, E|NA, O|NO, E|NO, O|NO, O|NO, O|NA, /* X - _ */
206 E|NO, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* ` - g */
207 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* h - o */
208 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* p - w */
209 E|NA, O|NA, O|NA, E|NO, O|NO, E|NO, E|NO, O|CC, /* x - del */
211 * Meta chars; should be settable per character set;
212 * for now, treat them all as normal characters.
214 NA, NA, NA, NA, NA, NA, NA, NA,
215 NA, NA, NA, NA, NA, NA, NA, NA,
216 NA, NA, NA, NA, NA, NA, NA, NA,
217 NA, NA, NA, NA, NA, NA, NA, NA,
218 NA, NA, NA, NA, NA, NA, NA, NA,
219 NA, NA, NA, NA, NA, NA, NA, NA,
220 NA, NA, NA, NA, NA, NA, NA, NA,
221 NA, NA, NA, NA, NA, NA, NA, NA,
222 NA, NA, NA, NA, NA, NA, NA, NA,
223 NA, NA, NA, NA, NA, NA, NA, NA,
224 NA, NA, NA, NA, NA, NA, NA, NA,
225 NA, NA, NA, NA, NA, NA, NA, NA,
226 NA, NA, NA, NA, NA, NA, NA, NA,
227 NA, NA, NA, NA, NA, NA, NA, NA,
228 NA, NA, NA, NA, NA, NA, NA, NA,
229 NA, NA, NA, NA, NA, NA, NA, NA,
240 /* Macros to clear/set/test flags. */
241 #define SET(t, f) (t) |= (f)
242 #define CLR(t, f) (t) &= ~(f)
243 #define ISSET(t, f) ((t) & (f))
245 #undef MAX_INPUT /* XXX wrong in <sys/syslimits.h> */
246 #define MAX_INPUT TTYHOG /* XXX limit is usually larger for !ICANON */
249 * list of struct tty where pstat(8) can pick it up with sysctl
251 * The lock order is to grab the list mutex before the tty mutex.
252 * Together with additions going on the tail of the list, this allows
253 * the sysctl to avoid doing retries.
255 static TAILQ_HEAD(, tty) tty_list = TAILQ_HEAD_INITIALIZER(tty_list);
256 static struct mtx tty_list_mutex;
257 MTX_SYSINIT(tty_list, &tty_list_mutex, "ttylist", MTX_DEF);
259 static struct unrhdr *tty_unit;
261 static int drainwait = 5*60;
262 SYSCTL_INT(_kern, OID_AUTO, drainwait, CTLFLAG_RW, &drainwait,
263 0, "Output drain timeout in seconds");
266 tty_gettp(struct cdev *dev)
271 csw = dev_refthread(dev);
272 KASSERT(csw != NULL, ("No cdevsw in ttycode (%s)", devtoname(dev)));
273 KASSERT(csw->d_flags & D_TTY,
274 ("non D_TTY (%s) in tty code", devtoname(dev)));
278 ("no tty pointer on (%s) in tty code", devtoname(dev)));
283 * Initial open of tty, or (re)entry to standard tty line discipline.
286 tty_open(struct cdev *device, struct tty *tp)
293 if (!ISSET(tp->t_state, TS_ISOPEN)) {
295 SET(tp->t_state, TS_ISOPEN);
296 if (ISSET(tp->t_cflag, CLOCAL))
297 SET(tp->t_state, TS_CONNECTED);
298 bzero(&tp->t_winsize, sizeof(tp->t_winsize));
300 /* XXX don't hang forever on output */
301 if (tp->t_timeout < 0)
302 tp->t_timeout = drainwait*hz;
309 * Handle close() on a tty line: flush and set to initial state,
310 * bumping generation number so that pending read/write calls
311 * can detect recycling of the tty.
312 * XXX our caller should have done `spltty(); l_close(); tty_close();'
313 * and l_close() should have flushed, but we repeat the spltty() and
314 * the flush in case there are buggy callers.
317 tty_close(struct tty *tp)
321 funsetown(&tp->t_sigio);
326 ttyflush(tp, FREAD | FWRITE);
327 clist_free_cblocks(&tp->t_canq);
328 clist_free_cblocks(&tp->t_outq);
329 clist_free_cblocks(&tp->t_rawq);
332 tp->t_line = TTYDISC;
335 tp->t_session = NULL;
336 ostate = tp->t_state;
338 knlist_clear(&tp->t_rsel.si_note, 0);
339 knlist_clear(&tp->t_wsel.si_note, 0);
341 * Both final close and revocation close might end up calling
342 * this method. Only the thread clearing TS_ISOPEN should
343 * release the reference to the tty.
345 if (ISSET(ostate, TS_ISOPEN))
351 #define FLUSHQ(q) { \
353 ndflush(q, (q)->c_cc); \
356 /* Is 'c' a line delimiter ("break" character)? */
357 #define TTBREAKC(c, lflag) \
358 ((c) == '\n' || (((c) == cc[VEOF] || \
359 (c) == cc[VEOL] || ((c) == cc[VEOL2] && lflag & IEXTEN)) && \
360 (c) != _POSIX_VDISABLE))
363 * Process input of a single character received on a tty.
366 ttyinput(int c, struct tty *tp)
368 tcflag_t iflag, lflag;
373 * If input is pending take it first.
376 if (ISSET(lflag, PENDIN))
381 if (ISSET(lflag, ICANON)) {
391 * Block further input iff:
392 * current input > threshold AND input is available to user program
393 * AND input flow control is enabled and not yet invoked.
394 * The 3 is slop for PARMRK.
397 if (tp->t_rawq.c_cc + tp->t_canq.c_cc > tp->t_ihiwat - 3 &&
398 (!ISSET(lflag, ICANON) || tp->t_canq.c_cc != 0) &&
399 (ISSET(tp->t_cflag, CRTS_IFLOW) || ISSET(iflag, IXOFF)) &&
400 !ISSET(tp->t_state, TS_TBLOCK))
403 /* Handle exceptional conditions (break, parity, framing). */
405 err = (ISSET(c, TTY_ERRORMASK));
407 CLR(c, TTY_ERRORMASK);
408 if (ISSET(err, TTY_BI)) {
409 if (ISSET(iflag, IGNBRK))
411 if (ISSET(iflag, BRKINT)) {
412 ttyflush(tp, FREAD | FWRITE);
413 if (tp->t_pgrp != NULL) {
414 PGRP_LOCK(tp->t_pgrp);
415 pgsignal(tp->t_pgrp, SIGINT, 1);
416 PGRP_UNLOCK(tp->t_pgrp);
420 if (ISSET(iflag, PARMRK))
422 } else if ((ISSET(err, TTY_PE) && ISSET(iflag, INPCK))
423 || ISSET(err, TTY_FE)) {
424 if (ISSET(iflag, IGNPAR))
426 else if (ISSET(iflag, PARMRK)) {
428 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >
431 (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
432 (void)putc(0 | TTY_QUOTE, &tp->t_rawq);
433 (void)putc(c | TTY_QUOTE, &tp->t_rawq);
440 if (!ISSET(tp->t_state, TS_TYPEN) && ISSET(iflag, ISTRIP))
442 if (!ISSET(lflag, EXTPROC)) {
444 * Check for literal nexting very first
446 if (ISSET(tp->t_state, TS_LNCH)) {
448 CLR(tp->t_state, TS_LNCH);
451 * Scan for special characters. This code
452 * is really just a big case statement with
453 * non-constant cases. The bottom of the
454 * case statement is labeled ``endcase'', so goto
455 * it after a case match, or similar.
459 * Control chars which aren't controlled
460 * by ICANON, ISIG, or IXON.
462 if (ISSET(lflag, IEXTEN)) {
463 if (CCEQ(cc[VLNEXT], c)) {
464 if (ISSET(lflag, ECHO)) {
465 if (ISSET(lflag, ECHOE)) {
466 (void)ttyoutput('^', tp);
467 (void)ttyoutput('\b', tp);
471 SET(tp->t_state, TS_LNCH);
474 if (CCEQ(cc[VDISCARD], c)) {
475 if (ISSET(lflag, FLUSHO))
476 CLR(tp->t_lflag, FLUSHO);
478 ttyflush(tp, FWRITE);
480 if (tp->t_rawq.c_cc + tp->t_canq.c_cc)
482 SET(tp->t_lflag, FLUSHO);
490 if (ISSET(lflag, ISIG)) {
491 if (CCEQ(cc[VINTR], c) || CCEQ(cc[VQUIT], c)) {
492 if (!ISSET(lflag, NOFLSH))
493 ttyflush(tp, FREAD | FWRITE);
495 if (tp->t_pgrp != NULL) {
496 PGRP_LOCK(tp->t_pgrp);
498 CCEQ(cc[VINTR], c) ? SIGINT : SIGQUIT, 1);
499 PGRP_UNLOCK(tp->t_pgrp);
503 if (CCEQ(cc[VSUSP], c)) {
504 if (!ISSET(lflag, NOFLSH))
507 if (tp->t_pgrp != NULL) {
508 PGRP_LOCK(tp->t_pgrp);
509 pgsignal(tp->t_pgrp, SIGTSTP, 1);
510 PGRP_UNLOCK(tp->t_pgrp);
516 * Handle start/stop characters.
518 if (ISSET(iflag, IXON)) {
519 if (CCEQ(cc[VSTOP], c)) {
520 if (!ISSET(tp->t_state, TS_TTSTOP)) {
521 SET(tp->t_state, TS_TTSTOP);
525 if (!CCEQ(cc[VSTART], c))
528 * if VSTART == VSTOP then toggle
532 if (CCEQ(cc[VSTART], c))
536 * IGNCR, ICRNL, & INLCR
539 if (ISSET(iflag, IGNCR))
541 else if (ISSET(iflag, ICRNL))
543 } else if (c == '\n' && ISSET(iflag, INLCR))
546 if (!ISSET(tp->t_lflag, EXTPROC) && ISSET(lflag, ICANON)) {
548 * From here on down canonical mode character
549 * processing takes place.
552 * erase or erase2 (^H / ^?)
554 if (CCEQ(cc[VERASE], c) || CCEQ(cc[VERASE2], c) ) {
556 ttyrub(unputc(&tp->t_rawq), tp);
562 if (CCEQ(cc[VKILL], c)) {
563 if (ISSET(lflag, ECHOKE) &&
564 tp->t_rawq.c_cc == tp->t_rocount &&
565 !ISSET(lflag, ECHOPRT))
566 while (tp->t_rawq.c_cc)
567 ttyrub(unputc(&tp->t_rawq), tp);
570 if (ISSET(lflag, ECHOK) ||
571 ISSET(lflag, ECHOKE))
576 CLR(tp->t_state, TS_LOCAL);
582 if (CCEQ(cc[VWERASE], c) && ISSET(lflag, IEXTEN)) {
588 while ((c = unputc(&tp->t_rawq)) == ' ' || c == '\t')
593 * erase last char of word and remember the
594 * next chars type (for ALTWERASE)
597 c = unputc(&tp->t_rawq);
600 if (c == ' ' || c == '\t') {
601 (void)putc(c, &tp->t_rawq);
610 c = unputc(&tp->t_rawq);
613 } while (c != ' ' && c != '\t' &&
614 (!ISSET(lflag, ALTWERASE) || ISALPHA(c) == ctype));
615 (void)putc(c, &tp->t_rawq);
621 if (CCEQ(cc[VREPRINT], c) && ISSET(lflag, IEXTEN)) {
626 * ^T - kernel info and generate SIGINFO
628 if (CCEQ(cc[VSTATUS], c) && ISSET(lflag, IEXTEN)) {
629 if (ISSET(lflag, ISIG) && tp->t_pgrp != NULL) {
630 PGRP_LOCK(tp->t_pgrp);
631 pgsignal(tp->t_pgrp, SIGINFO, 1);
632 PGRP_UNLOCK(tp->t_pgrp);
634 if (!ISSET(lflag, NOKERNINFO))
640 * Check for input buffer overflow
642 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >= MAX_INPUT) {
644 if (ISSET(iflag, IMAXBEL)) {
645 if (tp->t_outq.c_cc < tp->t_ohiwat)
646 (void)ttyoutput(CTRL('g'), tp);
651 if ( c == 0377 && ISSET(iflag, PARMRK) && !ISSET(iflag, ISTRIP)
652 && ISSET(iflag, IGNBRK|IGNPAR) != (IGNBRK|IGNPAR))
653 (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
656 * Put data char in q for user and
657 * wakeup on seeing a line delimiter.
659 if (putc(c, &tp->t_rawq) >= 0) {
660 if (!ISSET(lflag, ICANON)) {
665 if (TTBREAKC(c, lflag)) {
667 catq(&tp->t_rawq, &tp->t_canq);
669 } else if (tp->t_rocount++ == 0)
670 tp->t_rocol = tp->t_column;
671 if (ISSET(tp->t_state, TS_ERASE)) {
673 * end of prterase \.../
675 CLR(tp->t_state, TS_ERASE);
676 (void)ttyoutput('/', tp);
680 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ECHO)) {
682 * Place the cursor over the '^' of the ^D.
684 i = imin(2, tp->t_column - i);
686 (void)ttyoutput('\b', tp);
693 * IXANY means allow any character to restart output.
695 if (ISSET(tp->t_state, TS_TTSTOP) &&
696 !ISSET(iflag, IXANY) && cc[VSTART] != cc[VSTOP])
699 CLR(tp->t_lflag, FLUSHO);
700 CLR(tp->t_state, TS_TTSTOP);
702 return (ttstart(tp));
706 * Output a single character on a tty, doing output processing
707 * as needed (expanding tabs, newline processing, etc.).
708 * Returns < 0 if succeeds, otherwise returns char to resend.
712 ttyoutput(int c, struct tty *tp)
718 if (!ISSET(oflag, OPOST)) {
719 if (ISSET(tp->t_lflag, FLUSHO))
721 if (putc(c, &tp->t_outq))
728 * Do tab expansion if OXTABS is set. Special case if we external
729 * processing, we don't do the tab expansion because we'll probably
730 * get it wrong. If tab expansion needs to be done, let it happen
733 CLR(c, ~TTY_CHARMASK);
735 ISSET(oflag, OXTABS) && !ISSET(tp->t_lflag, EXTPROC)) {
736 c = 8 - (tp->t_column & 7);
737 if (!ISSET(tp->t_lflag, FLUSHO)) {
738 s = spltty(); /* Don't interrupt tabs. */
739 c -= b_to_q(" ", c, &tp->t_outq);
745 return (c ? -1 : '\t');
747 if (c == CEOT && ISSET(oflag, ONOEOT))
751 * Newline translation: if ONLCR is set,
752 * translate newline into "\r\n".
754 if (c == '\n' && ISSET(tp->t_oflag, ONLCR)) {
757 if (!ISSET(tp->t_lflag, FLUSHO) && putc('\r', &tp->t_outq))
760 /* If OCRNL is set, translate "\r" into "\n". */
761 else if (c == '\r' && ISSET(tp->t_oflag, OCRNL))
763 /* If ONOCR is set, don't transmit CRs when on column 0. */
764 else if (c == '\r' && ISSET(tp->t_oflag, ONOCR) && tp->t_column == 0)
769 if (!ISSET(tp->t_lflag, FLUSHO) && putc(c, &tp->t_outq))
781 if (ISSET(tp->t_oflag, ONLCR | ONLRET))
791 col = (col + 8) & ~7;
799 * Ioctls for all tty devices. Called after line-discipline specific ioctl
800 * has been called to do discipline-specific functions and/or reject any
801 * of these ioctl commands.
805 ttioctl(struct tty *tp, u_long cmd, void *data, int flag)
810 int s, error, bits, sig, sig2;
812 td = curthread; /* XXX */
815 /* If the ioctl involves modification, hang if in the background. */
839 #if defined(COMPAT_43TTY)
849 sx_slock(&proctree_lock);
851 while (isbackground(p, tp) && !(p->p_flag & P_PPWAIT) &&
852 !SIGISMEMBER(p->p_sigacts->ps_sigignore, SIGTTOU) &&
853 !SIGISMEMBER(td->td_sigmask, SIGTTOU)) {
856 if (pgrp->pg_jobc == 0) {
857 sx_sunlock(&proctree_lock);
861 sx_sunlock(&proctree_lock);
862 pgsignal(pgrp, SIGTTOU, 1);
864 error = ttysleep(tp, &lbolt, TTOPRI | PCATCH, "ttybg1",
868 sx_slock(&proctree_lock);
872 sx_sunlock(&proctree_lock);
877 if (tp->t_modem != NULL) {
880 tt_modem(tp, SER_DTR, 0);
883 tt_modem(tp, 0, SER_DTR);
887 sig = (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1;
888 sig2 = ((~bits) & (TIOCM_DTR | TIOCM_RTS)) >> 1;
889 tt_modem(tp, sig, sig2);
893 sig = (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1;
894 tt_modem(tp, sig, 0);
898 sig = (bits & (TIOCM_DTR | TIOCM_RTS)) >> 1;
899 tt_modem(tp, 0, sig);
902 sig = tt_modem(tp, 0, 0);
903 /* See <sys/serial.h. for the "<< 1" stuff */
904 bits = TIOCM_LE + (sig << 1);
912 if (tp->t_pps != NULL) {
913 error = pps_ioctl(cmd, data, tp->t_pps);
914 if (error != ENOIOCTL)
918 switch (cmd) { /* Process the ioctl. */
919 case FIOASYNC: /* set/clear async i/o */
922 SET(tp->t_state, TS_ASYNC);
924 CLR(tp->t_state, TS_ASYNC);
927 case FIONBIO: /* set/clear non-blocking i/o */
928 break; /* XXX: delete. */
929 case FIONREAD: /* get # bytes to read */
931 *(int *)data = ttnread(tp);
937 * Policy -- Don't allow FIOSETOWN on someone else's
940 if (tp->t_session != NULL && !isctty(p, tp))
943 error = fsetown(*(int *)data, &tp->t_sigio);
948 if (tp->t_session != NULL && !isctty(p, tp))
950 *(int *)data = fgetown(&tp->t_sigio);
953 case TIOCEXCL: /* set exclusive use of tty */
955 SET(tp->t_state, TS_XCLUDE);
958 case TIOCFLUSH: { /* flush buffers */
959 int flags = *(int *)data;
962 flags = FREAD | FWRITE;
964 flags &= FREAD | FWRITE;
968 case TIOCCONS: /* become virtual console */
970 struct nameidata nid;
972 if (constty && constty != tp &&
973 ISSET(constty->t_state, TS_CONNECTED))
976 /* Ensure user can open the real console. */
977 NDINIT(&nid, LOOKUP, LOCKLEAF | FOLLOW, UIO_SYSSPACE,
979 if ((error = namei(&nid)) != 0)
981 NDFREE(&nid, NDF_ONLY_PNBUF);
982 error = VOP_ACCESS(nid.ni_vp, VREAD, td->td_ucred, td);
988 } else if (tp == constty)
991 case TIOCDRAIN: /* wait till output drained */
996 case TIOCGETA: { /* get termios struct */
997 struct termios *t = (struct termios *)data;
999 bcopy(&tp->t_termios, t, sizeof(struct termios));
1002 case TIOCGETD: /* get line discipline */
1003 *(int *)data = tp->t_line;
1005 case TIOCGWINSZ: /* get window size */
1006 *(struct winsize *)data = tp->t_winsize;
1008 case TIOCGPGRP: /* get pgrp of tty */
1011 *(int *)data = tp->t_pgrp ? tp->t_pgrp->pg_id : NO_PID;
1013 case TIOCGSID: /* get sid of tty */
1016 *(int *)data = tp->t_session->s_sid;
1019 case TIOCHPCL: /* hang up on last close */
1021 SET(tp->t_cflag, HUPCL);
1026 *(int *)data = tp->t_dtr_wait * 100 / hz;
1029 /* must be root since the wait applies to following logins */
1030 error = priv_check(td, PRIV_TTY_DTRWAIT);
1033 tp->t_dtr_wait = *(int *)data * hz / 100;
1035 case TIOCNXCL: /* reset exclusive use of tty */
1037 CLR(tp->t_state, TS_XCLUDE);
1040 case TIOCOUTQ: /* output queue size */
1041 *(int *)data = tp->t_outq.c_cc;
1043 case TIOCSETA: /* set termios struct */
1044 case TIOCSETAW: /* drain output, set */
1045 case TIOCSETAF: { /* drn out, fls in, set */
1046 struct termios *t = (struct termios *)data;
1048 if (t->c_ispeed == 0)
1049 t->c_ispeed = t->c_ospeed;
1050 if (t->c_ispeed == 0)
1051 t->c_ispeed = tp->t_ospeed;
1052 if (t->c_ispeed == 0)
1055 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
1056 error = ttywait(tp);
1061 if (cmd == TIOCSETAF)
1062 ttyflush(tp, FREAD);
1064 if (!ISSET(t->c_cflag, CIGNORE)) {
1066 * Set device hardware.
1068 error = tt_param(tp, t);
1073 if (ISSET(t->c_cflag, CLOCAL) &&
1074 !ISSET(tp->t_cflag, CLOCAL)) {
1076 * XXX disconnections would be too hard to
1077 * get rid of without this kludge. The only
1078 * way to get rid of controlling terminals
1079 * is to exit from the session leader.
1081 CLR(tp->t_state, TS_ZOMBIE);
1083 wakeup(TSA_CARR_ON(tp));
1087 if ((ISSET(tp->t_state, TS_CARR_ON) ||
1088 ISSET(t->c_cflag, CLOCAL)) &&
1089 !ISSET(tp->t_state, TS_ZOMBIE))
1090 SET(tp->t_state, TS_CONNECTED);
1092 CLR(tp->t_state, TS_CONNECTED);
1093 tp->t_cflag = t->c_cflag;
1094 tp->t_ispeed = t->c_ispeed;
1095 if (t->c_ospeed != 0)
1096 tp->t_ospeed = t->c_ospeed;
1099 if (ISSET(t->c_lflag, ICANON) != ISSET(tp->t_lflag, ICANON) &&
1101 if (ISSET(t->c_lflag, ICANON))
1102 SET(tp->t_lflag, PENDIN);
1105 * XXX we really shouldn't allow toggling
1106 * ICANON while we're in a non-termios line
1107 * discipline. Now we have to worry about
1108 * panicing for a null queue.
1110 if (tp->t_canq.c_cbreserved > 0 &&
1111 tp->t_rawq.c_cbreserved > 0) {
1112 catq(&tp->t_rawq, &tp->t_canq);
1114 * XXX the queue limits may be
1115 * different, so the old queue
1116 * swapping method no longer works.
1118 catq(&tp->t_canq, &tp->t_rawq);
1120 CLR(tp->t_lflag, PENDIN);
1124 tp->t_iflag = t->c_iflag;
1125 tp->t_oflag = t->c_oflag;
1127 * Make the EXTPROC bit read only.
1129 if (ISSET(tp->t_lflag, EXTPROC))
1130 SET(t->c_lflag, EXTPROC);
1132 CLR(t->c_lflag, EXTPROC);
1133 tp->t_lflag = t->c_lflag | ISSET(tp->t_lflag, PENDIN);
1134 if (t->c_cc[VMIN] != tp->t_cc[VMIN] ||
1135 t->c_cc[VTIME] != tp->t_cc[VTIME])
1137 bcopy(t->c_cc, tp->t_cc, sizeof(t->c_cc));
1141 case TIOCSETD: { /* set line discipline */
1142 int t = *(int *)data;
1144 if ((u_int)t >= nlinesw)
1146 if (t == tp->t_line)
1149 ttyld_close(tp, flag);
1151 /* XXX: we should use the correct cdev here */
1152 error = ttyld_open(tp, tp->t_dev);
1155 * If we fail to switch line discipline we cannot
1156 * fall back to the previous, because we can not
1157 * trust that ldisc to open successfully either.
1158 * Fall back to the default ldisc which we know
1159 * will allways succeed.
1161 tp->t_line = TTYDISC;
1162 (void)ttyld_open(tp, tp->t_dev);
1168 case TIOCSTART: /* start output, like ^Q */
1170 if (ISSET(tp->t_state, TS_TTSTOP) ||
1171 ISSET(tp->t_lflag, FLUSHO)) {
1172 CLR(tp->t_lflag, FLUSHO);
1173 CLR(tp->t_state, TS_TTSTOP);
1178 case TIOCSTI: /* simulate terminal input */
1179 if ((flag & FREAD) == 0 && priv_check(td, PRIV_TTY_STI))
1181 if (!isctty(p, tp) && priv_check(td, PRIV_TTY_STI))
1184 ttyld_rint(tp, *(u_char *)data);
1187 case TIOCSTOP: /* stop output, like ^S */
1189 if (!ISSET(tp->t_state, TS_TTSTOP)) {
1190 SET(tp->t_state, TS_TTSTOP);
1195 case TIOCSCTTY: /* become controlling tty */
1196 /* Session ctty vnode pointer set in vnode layer. */
1197 sx_slock(&proctree_lock);
1198 if (!SESS_LEADER(p) ||
1199 ((p->p_session->s_ttyvp || tp->t_session) &&
1200 (tp->t_session != p->p_session))) {
1201 sx_sunlock(&proctree_lock);
1204 tp->t_session = p->p_session;
1205 tp->t_pgrp = p->p_pgrp;
1206 SESS_LOCK(p->p_session);
1207 ttyref(tp); /* ttyrel(): kern_proc.c:pgdelete() */
1208 p->p_session->s_ttyp = tp;
1209 SESS_UNLOCK(p->p_session);
1211 p->p_flag |= P_CONTROLT;
1213 sx_sunlock(&proctree_lock);
1215 case TIOCSPGRP: { /* set pgrp of tty */
1216 sx_slock(&proctree_lock);
1217 pgrp = pgfind(*(int *)data);
1218 if (!isctty(p, tp)) {
1221 sx_sunlock(&proctree_lock);
1225 sx_sunlock(&proctree_lock);
1229 if (pgrp->pg_session != p->p_session) {
1230 sx_sunlock(&proctree_lock);
1233 sx_sunlock(&proctree_lock);
1237 case TIOCSTAT: /* simulate control-T */
1242 case TIOCSWINSZ: /* set window size */
1243 if (bcmp((caddr_t)&tp->t_winsize, data,
1244 sizeof (struct winsize))) {
1245 tp->t_winsize = *(struct winsize *)data;
1246 if (tp->t_pgrp != NULL) {
1247 PGRP_LOCK(tp->t_pgrp);
1248 pgsignal(tp->t_pgrp, SIGWINCH, 1);
1249 PGRP_UNLOCK(tp->t_pgrp);
1253 case TIOCSDRAINWAIT:
1254 error = priv_check(td, PRIV_TTY_DRAINWAIT);
1257 tp->t_timeout = *(int *)data * hz;
1258 wakeup(TSA_OCOMPLETE(tp));
1259 wakeup(TSA_OLOWAT(tp));
1261 case TIOCGDRAINWAIT:
1262 *(int *)data = tp->t_timeout / hz;
1265 return (tt_break(tp, 1));
1267 return (tt_break(tp, 0));
1269 #if defined(COMPAT_43TTY)
1270 return (ttcompat(tp, cmd, data, flag));
1279 ttypoll(struct cdev *dev, int events, struct thread *td)
1285 tp = tty_gettp(dev);
1287 if (tp == NULL) /* XXX used to return ENXIO, but that means true! */
1288 return ((events & (POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM))
1292 if (events & (POLLIN | POLLRDNORM)) {
1293 if (ISSET(tp->t_state, TS_ZOMBIE))
1294 revents |= (events & (POLLIN | POLLRDNORM)) |
1296 else if (ttnread(tp) > 0)
1297 revents |= events & (POLLIN | POLLRDNORM);
1299 selrecord(td, &tp->t_rsel);
1301 if (events & POLLOUT) {
1302 if (ISSET(tp->t_state, TS_ZOMBIE))
1304 else if (tp->t_outq.c_cc <= tp->t_olowat &&
1305 ISSET(tp->t_state, TS_CONNECTED))
1306 revents |= events & POLLOUT;
1308 selrecord(td, &tp->t_wsel);
1314 static struct filterops ttyread_filtops =
1315 { 1, NULL, filt_ttyrdetach, filt_ttyread };
1316 static struct filterops ttywrite_filtops =
1317 { 1, NULL, filt_ttywdetach, filt_ttywrite };
1320 ttykqfilter(struct cdev *dev, struct knote *kn)
1323 struct knlist *klist;
1326 tp = tty_gettp(dev);
1327 if (tp->t_state & TS_GONE)
1330 switch (kn->kn_filter) {
1332 klist = &tp->t_rsel.si_note;
1333 kn->kn_fop = &ttyread_filtops;
1336 klist = &tp->t_wsel.si_note;
1337 kn->kn_fop = &ttywrite_filtops;
1343 kn->kn_hook = (caddr_t)tp;
1346 knlist_add(klist, kn, 0);
1353 filt_ttyrdetach(struct knote *kn)
1355 struct tty *tp = (struct tty *)kn->kn_hook;
1358 knlist_remove(&tp->t_rsel.si_note, kn, 0);
1363 filt_ttyread(struct knote *kn, long hint)
1365 struct tty *tp = (struct tty *)kn->kn_hook;
1367 kn->kn_data = ttnread(tp);
1368 if ((tp->t_state & TS_GONE) || ISSET(tp->t_state, TS_ZOMBIE)) {
1369 kn->kn_flags |= EV_EOF;
1372 return (kn->kn_data > 0);
1376 filt_ttywdetach(struct knote *kn)
1378 struct tty *tp = (struct tty *)kn->kn_hook;
1381 knlist_remove(&tp->t_wsel.si_note, kn, 0);
1386 filt_ttywrite(struct knote *kn, long hint)
1388 struct tty *tp = (struct tty *)kn->kn_hook;
1390 kn->kn_data = tp->t_outq.c_cc;
1391 if ((tp->t_state & TS_GONE) || ISSET(tp->t_state, TS_ZOMBIE))
1393 return (kn->kn_data <= tp->t_olowat &&
1394 ISSET(tp->t_state, TS_CONNECTED));
1398 * Must be called at spltty().
1401 ttnread(struct tty *tp)
1405 if (ISSET(tp->t_lflag, PENDIN))
1407 nread = tp->t_canq.c_cc;
1408 if (!ISSET(tp->t_lflag, ICANON)) {
1409 nread += tp->t_rawq.c_cc;
1410 if (nread < tp->t_cc[VMIN] && tp->t_cc[VTIME] == 0)
1417 * Wait for output to drain.
1420 ttywait(struct tty *tp)
1426 while ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1427 ISSET(tp->t_state, TS_CONNECTED) && tp->t_oproc) {
1429 if ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1430 ISSET(tp->t_state, TS_CONNECTED)) {
1431 SET(tp->t_state, TS_SO_OCOMPLETE);
1432 error = ttysleep(tp, TSA_OCOMPLETE(tp),
1433 TTOPRI | PCATCH, "ttywai",
1436 if (error == EWOULDBLOCK)
1443 if (!error && (tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)))
1450 * Flush if successfully wait.
1453 ttywflush(struct tty *tp)
1457 if ((error = ttywait(tp)) == 0)
1458 ttyflush(tp, FREAD);
1463 * Flush tty read and/or write queues, notifying anyone waiting.
1466 ttyflush(struct tty *tp, int rw)
1475 FLUSHQ(&tp->t_outq);
1476 CLR(tp->t_state, TS_TTSTOP);
1480 FLUSHQ(&tp->t_canq);
1481 FLUSHQ(&tp->t_rawq);
1482 CLR(tp->t_lflag, PENDIN);
1485 CLR(tp->t_state, TS_LOCAL);
1487 if (ISSET(tp->t_state, TS_TBLOCK)) {
1489 FLUSHQ(&tp->t_outq);
1493 * Don't let leave any state that might clobber the
1494 * next line discipline (although we should do more
1495 * to send the START char). Not clearing the state
1496 * may have caused the "putc to a clist with no
1497 * reserved cblocks" panic/printf.
1499 CLR(tp->t_state, TS_TBLOCK);
1501 #if 0 /* forget it, sleeping isn't always safe and we don't know when it is */
1502 if (ISSET(tp->t_iflag, IXOFF)) {
1504 * XXX wait a bit in the hope that the stop
1505 * character (if any) will go out. Waiting
1506 * isn't good since it allows races. This
1507 * will be fixed when the stop character is
1508 * put in a special queue. Don't bother with
1509 * the checks in ttywait() since the timeout
1512 SET(tp->t_state, TS_SO_OCOMPLETE);
1513 ttysleep(tp, TSA_OCOMPLETE(tp), TTOPRI,
1516 * Don't try sending the stop character again.
1518 CLR(tp->t_state, TS_TBLOCK);
1525 FLUSHQ(&tp->t_outq);
1532 * Copy in the default termios characters.
1535 termioschars(struct termios *t)
1538 bcopy(ttydefchars, t->c_cc, sizeof t->c_cc);
1545 ttychars(struct tty *tp)
1548 termioschars(&tp->t_termios);
1552 * Handle input high water. Send stop character for the IXOFF case. Turn
1553 * on our input flow control bit and propagate the changes to the driver.
1554 * XXX the stop character should be put in a special high priority queue.
1557 ttyblock(struct tty *tp)
1560 SET(tp->t_state, TS_TBLOCK);
1561 if (ISSET(tp->t_iflag, IXOFF) && tp->t_cc[VSTOP] != _POSIX_VDISABLE &&
1562 putc(tp->t_cc[VSTOP], &tp->t_outq) != 0)
1563 CLR(tp->t_state, TS_TBLOCK); /* try again later */
1568 * Handle input low water. Send start character for the IXOFF case. Turn
1569 * off our input flow control bit and propagate the changes to the driver.
1570 * XXX the start character should be put in a special high priority queue.
1573 ttyunblock(struct tty *tp)
1576 CLR(tp->t_state, TS_TBLOCK);
1577 if (ISSET(tp->t_iflag, IXOFF) && tp->t_cc[VSTART] != _POSIX_VDISABLE &&
1578 putc(tp->t_cc[VSTART], &tp->t_outq) != 0)
1579 SET(tp->t_state, TS_TBLOCK); /* try again later */
1584 /* Not used by any current (i386) drivers. */
1586 * Restart after an inter-char delay.
1589 ttrstrt(void *tp_arg)
1594 KASSERT(tp_arg != NULL, ("ttrstrt"));
1599 CLR(tp->t_state, TS_TIMEOUT);
1607 ttstart(struct tty *tp)
1615 * "close" a line discipline
1618 ttylclose(struct tty *tp, int flag)
1621 if (flag & FNONBLOCK || ttywflush(tp))
1622 ttyflush(tp, FREAD | FWRITE);
1627 * Handle modem control transition on a tty.
1628 * Flag indicates new state of carrier.
1629 * Returns 0 if the line should be turned off, otherwise 1.
1632 ttymodem(struct tty *tp, int flag)
1635 if (ISSET(tp->t_state, TS_CARR_ON) && ISSET(tp->t_cflag, MDMBUF)) {
1637 * MDMBUF: do flow control according to carrier flag
1638 * XXX TS_CAR_OFLOW doesn't do anything yet. TS_TTSTOP
1639 * works if IXON and IXANY are clear.
1642 CLR(tp->t_state, TS_CAR_OFLOW);
1643 CLR(tp->t_state, TS_TTSTOP);
1645 } else if (!ISSET(tp->t_state, TS_CAR_OFLOW)) {
1646 SET(tp->t_state, TS_CAR_OFLOW);
1647 SET(tp->t_state, TS_TTSTOP);
1650 } else if (flag == 0) {
1654 CLR(tp->t_state, TS_CARR_ON);
1655 if (ISSET(tp->t_state, TS_ISOPEN) &&
1656 !ISSET(tp->t_cflag, CLOCAL)) {
1657 SET(tp->t_state, TS_ZOMBIE);
1658 CLR(tp->t_state, TS_CONNECTED);
1659 if (tp->t_session) {
1660 sx_slock(&proctree_lock);
1661 if (tp->t_session && tp->t_session->s_leader) {
1664 p = tp->t_session->s_leader;
1669 sx_sunlock(&proctree_lock);
1671 ttyflush(tp, FREAD | FWRITE);
1678 SET(tp->t_state, TS_CARR_ON);
1679 if (!ISSET(tp->t_state, TS_ZOMBIE))
1680 SET(tp->t_state, TS_CONNECTED);
1681 wakeup(TSA_CARR_ON(tp));
1689 * Reinput pending characters after state switch
1693 ttypend(struct tty *tp)
1698 CLR(tp->t_lflag, PENDIN);
1699 SET(tp->t_state, TS_TYPEN);
1701 * XXX this assumes too much about clist internals. It may even
1702 * fail if the cblock slush pool is empty. We can't allocate more
1703 * cblocks here because we are called from an interrupt handler
1704 * and clist_alloc_cblocks() can wait.
1707 bzero(&tp->t_rawq, sizeof tp->t_rawq);
1708 tp->t_rawq.c_cbmax = tq.c_cbmax;
1709 tp->t_rawq.c_cbreserved = tq.c_cbreserved;
1710 while ((c = getc(&tq)) >= 0)
1712 CLR(tp->t_state, TS_TYPEN);
1716 * Process a read call on a tty device.
1719 ttread(struct tty *tp, struct uio *uio, int flag)
1724 cc_t *cc = tp->t_cc;
1727 int s, first, error = 0;
1728 int has_stime = 0, last_cc = 0;
1729 long slp = 0; /* XXX this should be renamed `timo'. */
1730 struct timeval stime = { 0, 0 };
1737 lflag = tp->t_lflag;
1739 * take pending input first
1741 if (ISSET(lflag, PENDIN)) {
1743 splx(s); /* reduce latency */
1745 lflag = tp->t_lflag; /* XXX ttypend() clobbers it */
1749 * Hang process if it's in the background.
1751 if (isbackground(p, tp)) {
1753 sx_slock(&proctree_lock);
1755 if (SIGISMEMBER(p->p_sigacts->ps_sigignore, SIGTTIN) ||
1756 SIGISMEMBER(td->td_sigmask, SIGTTIN) ||
1757 (p->p_flag & P_PPWAIT) || p->p_pgrp->pg_jobc == 0) {
1759 sx_sunlock(&proctree_lock);
1765 sx_sunlock(&proctree_lock);
1766 pgsignal(pg, SIGTTIN, 1);
1768 error = ttysleep(tp, &lbolt, TTIPRI | PCATCH, "ttybg2", 0);
1774 if (ISSET(tp->t_state, TS_ZOMBIE)) {
1776 return (0); /* EOF */
1780 * If canonical, use the canonical queue,
1781 * else use the raw queue.
1783 * (should get rid of clists...)
1785 qp = ISSET(lflag, ICANON) ? &tp->t_canq : &tp->t_rawq;
1787 if (flag & IO_NDELAY) {
1790 if (!ISSET(lflag, ICANON) && cc[VMIN] == 0) {
1795 return (EWOULDBLOCK);
1797 if (!ISSET(lflag, ICANON)) {
1800 struct timeval timecopy;
1803 * Check each of the four combinations.
1804 * (m > 0 && t == 0) is the normal read case.
1805 * It should be fairly efficient, so we check that and its
1806 * companion case (m == 0 && t == 0) first.
1807 * For the other two cases, we compute the target sleep time
1816 /* m, t and qp->c_cc are all 0. 0 is enough input. */
1820 t *= 100000; /* time in us */
1821 #define diff(t1, t2) (((t1).tv_sec - (t2).tv_sec) * 1000000 + \
1822 ((t1).tv_usec - (t2).tv_usec))
1828 getmicrotime(&timecopy);
1830 /* first character, start timer */
1834 } else if (qp->c_cc > last_cc) {
1835 /* got a character, restart timer */
1839 /* nothing, check expiration */
1840 slp = t - diff(timecopy, stime);
1845 } else { /* m == 0 */
1848 getmicrotime(&timecopy);
1854 slp = t - diff(timecopy, stime);
1856 /* Timed out, but 0 is enough input. */
1864 struct timeval tv; /* XXX style bug. */
1866 tv.tv_sec = slp / 1000000;
1867 tv.tv_usec = slp % 1000000;
1870 * XXX bad variable names. slp was the timeout in
1871 * usec. Now it is the timeout in ticks.
1876 if (qp->c_cc <= 0) {
1879 * There is no input, or not enough input and we can block.
1881 error = ttysleep(tp, TSA_HUP_OR_INPUT(tp), TTIPRI | PCATCH,
1882 ISSET(tp->t_state, TS_CONNECTED) ?
1883 "ttyin" : "ttyhup", (int)slp);
1885 if (error == EWOULDBLOCK)
1890 * XXX what happens if another process eats some input
1891 * while we are asleep (not just here)? It would be
1892 * safest to detect changes and reset our state variables
1893 * (has_stime and last_cc).
1901 * Input present, check for input mapping and processing.
1904 if (ISSET(lflag, ICANON | ISIG))
1910 icc = imin(uio->uio_resid, IBUFSIZ);
1911 icc = q_to_b(qp, ibuf, icc);
1917 error = uiomove(ibuf, icc, uio);
1919 * XXX if there was an error then we should ungetc() the
1920 * unmoved chars and reduce icc here.
1924 if (uio->uio_resid == 0)
1938 * delayed suspend (^Y)
1940 if (CCEQ(cc[VDSUSP], c) &&
1941 ISSET(lflag, IEXTEN | ISIG) == (IEXTEN | ISIG)) {
1942 if (tp->t_pgrp != NULL) {
1943 PGRP_LOCK(tp->t_pgrp);
1944 pgsignal(tp->t_pgrp, SIGTSTP, 1);
1945 PGRP_UNLOCK(tp->t_pgrp);
1948 error = ttysleep(tp, &lbolt, TTIPRI | PCATCH,
1957 * Interpret EOF only in canonical mode.
1959 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ICANON))
1962 * Give user character.
1964 error = ureadc(c, uio);
1966 /* XXX should ungetc(c, qp). */
1968 if (uio->uio_resid == 0)
1971 * In canonical mode check for a "break character"
1972 * marking the end of a "line of input".
1974 if (ISSET(lflag, ICANON) && TTBREAKC(c, lflag))
1981 * Look to unblock input now that (presumably)
1982 * the input queue has gone down.
1985 if (ISSET(tp->t_state, TS_TBLOCK) &&
1986 tp->t_rawq.c_cc + tp->t_canq.c_cc <= tp->t_ilowat)
1994 * Check the output queue on tp for space for a kernel message (from uprintf
1995 * or tprintf). Allow some space over the normal hiwater mark so we don't
1996 * lose messages due to normal flow control, but don't let the tty run amok.
1997 * Sleeps here are not interruptible, but we return prematurely if new signals
2001 ttycheckoutq(struct tty *tp, int wait)
2010 hiwat = tp->t_ohiwat;
2011 SIGEMPTYSET(oldmask);
2015 oldmask = td->td_siglist;
2018 if (tp->t_outq.c_cc > hiwat + OBUFSIZ + 100)
2019 while (tp->t_outq.c_cc > hiwat) {
2021 if (tp->t_outq.c_cc <= hiwat)
2028 if (!SIGSETEQ(td->td_siglist, oldmask)) {
2034 SET(tp->t_state, TS_SO_OLOWAT);
2035 tsleep(TSA_OLOWAT(tp), PZERO - 1, "ttoutq", hz);
2042 * Process a write call on a tty device.
2045 ttwrite(struct tty *tp, struct uio *uio, int flag)
2051 int i, hiwat, cnt, error, s;
2054 hiwat = tp->t_ohiwat;
2055 cnt = uio->uio_resid;
2062 if (ISSET(tp->t_state, TS_ZOMBIE)) {
2064 if (uio->uio_resid == cnt)
2068 if (!ISSET(tp->t_state, TS_CONNECTED)) {
2069 if (flag & IO_NDELAY) {
2071 error = EWOULDBLOCK;
2074 error = ttysleep(tp, TSA_CARR_ON(tp), TTIPRI | PCATCH,
2083 * Hang the process if it's in the background.
2085 sx_slock(&proctree_lock);
2087 if (isbackground(p, tp) &&
2088 ISSET(tp->t_lflag, TOSTOP) && !(p->p_flag & P_PPWAIT) &&
2089 !SIGISMEMBER(p->p_sigacts->ps_sigignore, SIGTTOU) &&
2090 !SIGISMEMBER(td->td_sigmask, SIGTTOU)) {
2091 if (p->p_pgrp->pg_jobc == 0) {
2093 sx_sunlock(&proctree_lock);
2098 PGRP_LOCK(p->p_pgrp);
2099 sx_sunlock(&proctree_lock);
2100 pgsignal(p->p_pgrp, SIGTTOU, 1);
2101 PGRP_UNLOCK(p->p_pgrp);
2102 error = ttysleep(tp, &lbolt, TTIPRI | PCATCH, "ttybg4", 0);
2108 sx_sunlock(&proctree_lock);
2111 * Process the user's data in at most OBUFSIZ chunks. Perform any
2112 * output translation. Keep track of high water mark, sleep on
2113 * overflow awaiting device aid in acquiring new space.
2115 while (uio->uio_resid > 0 || cc > 0) {
2116 if (ISSET(tp->t_lflag, FLUSHO)) {
2120 if (tp->t_outq.c_cc > hiwat)
2123 * Grab a hunk of data from the user, unless we have some
2124 * leftover from last time.
2127 cc = imin(uio->uio_resid, OBUFSIZ);
2129 error = uiomove(cp, cc, uio);
2136 * If nothing fancy need be done, grab those characters we
2137 * can handle without any of ttyoutput's processing and
2138 * just transfer them to the output q. For those chars
2139 * which require special processing (as indicated by the
2140 * bits in char_type), call ttyoutput. After processing
2141 * a hunk of data, look for FLUSHO so ^O's will take effect
2145 if (!ISSET(tp->t_oflag, OPOST))
2148 ce = cc - scanc((u_int)cc, (u_char *)cp,
2149 char_type, CCLASSMASK);
2151 * If ce is zero, then we're processing
2152 * a special character through ttyoutput.
2156 if (ttyoutput(*cp, tp) >= 0) {
2157 /* No Clists, wait a bit. */
2159 if (flag & IO_NDELAY) {
2160 error = EWOULDBLOCK;
2163 error = ttysleep(tp, &lbolt,
2172 if (ISSET(tp->t_lflag, FLUSHO) ||
2173 tp->t_outq.c_cc > hiwat)
2179 * A bunch of normal characters have been found.
2180 * Transfer them en masse to the output queue and
2181 * continue processing at the top of the loop.
2182 * If there are any further characters in this
2183 * <= OBUFSIZ chunk, the first should be a character
2184 * requiring special handling by ttyoutput.
2187 i = b_to_q(cp, ce, &tp->t_outq);
2190 cp += ce, cc -= ce, tk_nout += ce;
2193 /* No Clists, wait a bit. */
2195 if (flag & IO_NDELAY) {
2196 error = EWOULDBLOCK;
2199 error = ttysleep(tp, &lbolt, TTOPRI | PCATCH,
2205 if (ISSET(tp->t_lflag, FLUSHO) ||
2206 tp->t_outq.c_cc > hiwat)
2213 * If cc is nonzero, we leave the uio structure inconsistent, as the
2214 * offset and iov pointers have moved forward, but it doesn't matter
2215 * (the call will either return short or restart with a new uio).
2217 uio->uio_resid += cc;
2224 * This can only occur if FLUSHO is set in t_lflag,
2225 * or if ttstart/oproc is synchronous (or very fast).
2227 if (tp->t_outq.c_cc <= hiwat) {
2231 if (flag & IO_NDELAY) {
2233 uio->uio_resid += cc;
2234 return (uio->uio_resid == cnt ? EWOULDBLOCK : 0);
2236 SET(tp->t_state, TS_SO_OLOWAT);
2237 error = ttysleep(tp, TSA_OLOWAT(tp), TTOPRI | PCATCH, "ttywri",
2240 if (error == EWOULDBLOCK)
2248 * Rubout one character from the rawq of tp
2249 * as cleanly as possible.
2252 ttyrub(int c, struct tty *tp)
2258 if (!ISSET(tp->t_lflag, ECHO) || ISSET(tp->t_lflag, EXTPROC))
2260 CLR(tp->t_lflag, FLUSHO);
2261 if (ISSET(tp->t_lflag, ECHOE)) {
2262 if (tp->t_rocount == 0) {
2264 * Screwed by ttwrite; retype
2269 if (c == ('\t' | TTY_QUOTE) || c == ('\n' | TTY_QUOTE))
2272 CLR(c, ~TTY_CHARMASK);
2273 switch (CCLASS(c)) {
2282 if (ISSET(tp->t_lflag, ECHOCTL))
2286 if (tp->t_rocount < tp->t_rawq.c_cc) {
2291 savecol = tp->t_column;
2292 SET(tp->t_state, TS_CNTTB);
2293 SET(tp->t_lflag, FLUSHO);
2294 tp->t_column = tp->t_rocol;
2295 cp = tp->t_rawq.c_cf;
2297 tabc = *cp; /* XXX FIX NEXTC */
2298 for (; cp; cp = nextc(&tp->t_rawq, cp, &tabc))
2300 CLR(tp->t_lflag, FLUSHO);
2301 CLR(tp->t_state, TS_CNTTB);
2304 /* savecol will now be length of the tab. */
2305 savecol -= tp->t_column;
2306 tp->t_column += savecol;
2308 savecol = 8; /* overflow screw */
2309 while (--savecol >= 0)
2310 (void)ttyoutput('\b', tp);
2313 #define PANICSTR "ttyrub: would panic c = %d, val = %d\n"
2314 (void)printf(PANICSTR, c, CCLASS(c));
2316 panic(PANICSTR, c, CCLASS(c));
2320 } else if (ISSET(tp->t_lflag, ECHOPRT)) {
2321 if (!ISSET(tp->t_state, TS_ERASE)) {
2322 SET(tp->t_state, TS_ERASE);
2323 (void)ttyoutput('\\', tp);
2327 ttyecho(tp->t_cc[VERASE], tp);
2329 * This code may be executed not only when an ERASE key
2330 * is pressed, but also when ^U (KILL) or ^W (WERASE) are.
2331 * So, I didn't think it was worthwhile to pass the extra
2332 * information (which would need an extra parameter,
2333 * changing every call) needed to distinguish the ERASE2
2334 * case from the ERASE.
2341 * Back over cnt characters, erasing them.
2344 ttyrubo(struct tty *tp, int cnt)
2348 (void)ttyoutput('\b', tp);
2349 (void)ttyoutput(' ', tp);
2350 (void)ttyoutput('\b', tp);
2356 * Reprint the rawq line. Note, it is assumed that c_cc has already
2360 ttyretype(struct tty *tp)
2365 /* Echo the reprint character. */
2366 if (tp->t_cc[VREPRINT] != _POSIX_VDISABLE)
2367 ttyecho(tp->t_cc[VREPRINT], tp);
2369 (void)ttyoutput('\n', tp);
2373 * FIX: NEXTC IS BROKEN - DOESN'T CHECK QUOTE
2374 * BIT OF FIRST CHAR.
2377 for (cp = tp->t_canq.c_cf, c = (cp != NULL ? *cp : 0);
2378 cp != NULL; cp = nextc(&tp->t_canq, cp, &c))
2380 for (cp = tp->t_rawq.c_cf, c = (cp != NULL ? *cp : 0);
2381 cp != NULL; cp = nextc(&tp->t_rawq, cp, &c))
2383 CLR(tp->t_state, TS_ERASE);
2386 tp->t_rocount = tp->t_rawq.c_cc;
2391 * Echo a typed character to the terminal.
2394 ttyecho(int c, struct tty *tp)
2397 if (!ISSET(tp->t_state, TS_CNTTB))
2398 CLR(tp->t_lflag, FLUSHO);
2399 if ((!ISSET(tp->t_lflag, ECHO) &&
2400 (c != '\n' || !ISSET(tp->t_lflag, ECHONL))) ||
2401 ISSET(tp->t_lflag, EXTPROC))
2403 if (ISSET(tp->t_lflag, ECHOCTL) &&
2404 ((ISSET(c, TTY_CHARMASK) <= 037 && c != '\t' && c != '\n') ||
2405 ISSET(c, TTY_CHARMASK) == 0177)) {
2406 (void)ttyoutput('^', tp);
2407 CLR(c, ~TTY_CHARMASK);
2413 (void)ttyoutput(c, tp);
2417 * Wake up any readers on a tty.
2420 ttwakeup(struct tty *tp)
2423 if (SEL_WAITING(&tp->t_rsel))
2424 selwakeuppri(&tp->t_rsel, TTIPRI);
2425 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
2426 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
2427 wakeup(TSA_HUP_OR_INPUT(tp));
2428 KNOTE_UNLOCKED(&tp->t_rsel.si_note, 0);
2432 * Wake up any writers on a tty.
2435 ttwwakeup(struct tty *tp)
2438 if (SEL_WAITING(&tp->t_wsel) && tp->t_outq.c_cc <= tp->t_olowat)
2439 selwakeuppri(&tp->t_wsel, TTOPRI);
2440 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
2441 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
2442 if (ISSET(tp->t_state, TS_BUSY | TS_SO_OCOMPLETE) ==
2443 TS_SO_OCOMPLETE && tp->t_outq.c_cc == 0) {
2444 CLR(tp->t_state, TS_SO_OCOMPLETE);
2445 wakeup(TSA_OCOMPLETE(tp));
2447 if (ISSET(tp->t_state, TS_SO_OLOWAT) &&
2448 tp->t_outq.c_cc <= tp->t_olowat) {
2449 CLR(tp->t_state, TS_SO_OLOWAT);
2450 wakeup(TSA_OLOWAT(tp));
2452 KNOTE_UNLOCKED(&tp->t_wsel.si_note, 0);
2456 * Look up a code for a specified speed in a conversion table;
2457 * used by drivers to map software speed values to hardware parameters.
2460 ttspeedtab(int speed, struct speedtab *table)
2463 for ( ; table->sp_speed != -1; table++)
2464 if (table->sp_speed == speed)
2465 return (table->sp_code);
2470 * Set input and output watermarks and buffer sizes. For input, the
2471 * high watermark is about one second's worth of input above empty, the
2472 * low watermark is slightly below high water, and the buffer size is a
2473 * driver-dependent amount above high water. For output, the watermarks
2474 * are near the ends of the buffer, with about 1 second's worth of input
2475 * between them. All this only applies to the standard line discipline.
2478 ttsetwater(struct tty *tp)
2480 int cps, ttmaxhiwat, x;
2483 clist_alloc_cblocks(&tp->t_canq, TTYHOG, 512);
2484 switch (tp->t_ispeedwat) {
2486 cps = tp->t_ispeed / 10;
2490 * This case is for old drivers that don't know about
2491 * t_ispeedwat. Arrange for them to get the old buffer
2492 * sizes and watermarks.
2494 cps = TTYHOG - 2 * 256;
2495 tp->t_ififosize = 2 * 256;
2498 cps = tp->t_ispeedwat / 10;
2502 tp->t_ilowat = 7 * cps / 8;
2503 x = cps + tp->t_ififosize;
2504 clist_alloc_cblocks(&tp->t_rawq, x, x);
2507 switch (tp->t_ospeedwat) {
2509 cps = tp->t_ospeed / 10;
2510 ttmaxhiwat = 2 * TTMAXHIWAT;
2513 cps = tp->t_ospeed / 10;
2514 ttmaxhiwat = TTMAXHIWAT;
2517 cps = tp->t_ospeedwat / 10;
2518 ttmaxhiwat = 8 * TTMAXHIWAT;
2521 #define CLAMP(x, h, l) ((x) > h ? h : ((x) < l) ? l : (x))
2522 tp->t_olowat = x = CLAMP(cps / 2, TTMAXLOWAT, TTMINLOWAT);
2524 x = CLAMP(x, ttmaxhiwat, TTMINHIWAT); /* XXX clamps are too magic */
2525 tp->t_ohiwat = roundup(x, CBSIZE); /* XXX for compat */
2526 x = imax(tp->t_ohiwat, TTMAXHIWAT); /* XXX for compat/safety */
2528 clist_alloc_cblocks(&tp->t_outq, x, x);
2533 * Report on state of foreground process group.
2536 ttyinfo(struct tty *tp)
2538 struct timeval utime, stime;
2539 struct proc *p, *pick;
2540 struct thread *td, *picktd;
2541 const char *stateprefix, *state;
2545 char comm[MAXCOMLEN + 1];
2548 if (ttycheckoutq(tp,0) == 0)
2551 /* Print load average. */
2552 load = (averunnable.ldavg[0] * 100 + FSCALE / 2) >> FSHIFT;
2553 ttyprintf(tp, "load: %d.%02d ", load / 100, load % 100);
2556 * On return following a ttyprintf(), we set tp->t_rocount to 0 so
2557 * that pending input will be retyped on BS.
2559 if (tp->t_session == NULL) {
2560 ttyprintf(tp, "not a controlling terminal\n");
2564 if (tp->t_pgrp == NULL) {
2565 ttyprintf(tp, "no foreground process group\n");
2569 PGRP_LOCK(tp->t_pgrp);
2570 if (LIST_EMPTY(&tp->t_pgrp->pg_members)) {
2571 PGRP_UNLOCK(tp->t_pgrp);
2572 ttyprintf(tp, "empty foreground process group\n");
2578 * Pick the most interesting process and copy some of its
2579 * state for printing later. This operation could rely on stale
2580 * data as we can't hold the proc slock or thread locks over the
2581 * whole list. However, we're guaranteed not to reference an exited
2582 * thread or proc since we hold the tty locked.
2585 LIST_FOREACH(p, &tp->t_pgrp->pg_members, p_pglist)
2586 if (proc_compare(pick, p))
2591 td = FIRST_THREAD_IN_PROC(pick);
2592 FOREACH_THREAD_IN_PROC(pick, td)
2593 if (thread_compare(picktd, td))
2598 if (TD_IS_RUNNING(td))
2600 else if (TD_ON_RUNQ(td) || TD_CAN_RUN(td))
2602 else if (TD_IS_SLEEPING(td)) {
2603 /* XXX: If we're sleeping, are we ever not in a queue? */
2604 if (TD_ON_SLEEPQ(td))
2605 state = td->td_wmesg;
2607 state = "sleeping without queue";
2608 } else if (TD_ON_LOCK(td)) {
2609 state = td->td_lockname;
2611 } else if (TD_IS_SUSPENDED(td))
2612 state = "suspended";
2613 else if (TD_AWAITING_INTR(td))
2617 pctcpu = (sched_pctcpu(td) * 10000 + FSCALE / 2) >> FSHIFT;
2619 if (pick->p_state == PRS_NEW || pick->p_state == PRS_ZOMBIE)
2622 rss = pgtok(vmspace_resident_count(pick->p_vmspace));
2625 PGRP_UNLOCK(tp->t_pgrp);
2626 rufetchcalc(pick, &ru, &utime, &stime);
2628 bcopy(pick->p_comm, comm, sizeof(comm));
2631 /* Print command, pid, state, utime, stime, %cpu, and rss. */
2633 " cmd: %s %d [%s%s] %ld.%02ldu %ld.%02lds %d%% %ldk\n",
2634 comm, pid, stateprefix, state,
2635 (long)utime.tv_sec, utime.tv_usec / 10000,
2636 (long)stime.tv_sec, stime.tv_usec / 10000,
2642 * Returns 1 if p2 is "better" than p1
2644 * The algorithm for picking the "interesting" process is thus:
2646 * 1) Only foreground processes are eligible - implied.
2647 * 2) Runnable processes are favored over anything else. The runner
2648 * with the highest cpu utilization is picked (p_estcpu). Ties are
2649 * broken by picking the highest pid.
2650 * 3) The sleeper with the shortest sleep time is next. With ties,
2651 * we pick out just "short-term" sleepers (P_SINTR == 0).
2652 * 4) Further ties are broken by picking the highest pid.
2655 #define TESTAB(a, b) ((a)<<1 | (b))
2661 proc_sum(struct proc *p, int *estcpup)
2669 FOREACH_THREAD_IN_PROC(p, td) {
2671 if (TD_ON_RUNQ(td) ||
2674 estcpu += sched_pctcpu(td);
2683 thread_compare(struct thread *td, struct thread *td2)
2693 * Fetch running stats, pctcpu usage, and interruptable flag.
2696 runa = TD_IS_RUNNING(td) | TD_ON_RUNQ(td);
2697 slpa = td->td_flags & TDF_SINTR;
2698 esta = sched_pctcpu(td);
2701 runb = TD_IS_RUNNING(td2) | TD_ON_RUNQ(td2);
2702 estb = sched_pctcpu(td2);
2703 slpb = td2->td_flags & TDF_SINTR;
2706 * see if at least one of them is runnable
2708 switch (TESTAB(runa, runb)) {
2717 * favor one with highest recent cpu utilization
2724 * favor one sleeping in a non-interruptible sleep
2726 switch (TESTAB(slpa, slpb)) {
2739 proc_compare(struct proc *p1, struct proc *p2)
2749 * Fetch various stats about these processes. After we drop the
2750 * lock the information could be stale but the race is unimportant.
2753 runa = proc_sum(p1, &esta);
2756 runb = proc_sum(p2, &estb);
2760 * see if at least one of them is runnable
2762 switch (TESTAB(runa, runb)) {
2771 * favor one with highest recent cpu utilization
2780 switch (TESTAB(p1->p_state == PRS_ZOMBIE, p2->p_state == PRS_ZOMBIE)) {
2789 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2793 * Output char to tty; console putchar style.
2796 tputchar(int c, struct tty *tp)
2801 if (!ISSET(tp->t_state, TS_CONNECTED)) {
2806 (void)ttyoutput('\r', tp);
2807 (void)ttyoutput(c, tp);
2814 * Sleep on chan, returning ERESTART if tty changed while we napped and
2815 * returning any errors (e.g. EINTR/EWOULDBLOCK) reported by tsleep. If
2816 * the tty is revoked, restarting a pending call will redo validation done
2817 * at the start of the call.
2820 ttysleep(struct tty *tp, void *chan, int pri, char *wmesg, int timo)
2826 error = tsleep(chan, pri, wmesg, timo);
2827 if (tp->t_state & TS_GONE)
2831 return (tp->t_gen == gen ? 0 : ERESTART);
2835 * Gain a reference to a TTY
2838 ttyref(struct tty *tp)
2842 mtx_lock(&tp->t_mtx);
2843 KASSERT(tp->t_refcnt > 0,
2844 ("ttyref(): tty refcnt is %d (%s)",
2845 tp->t_refcnt, tp->t_dev != NULL ? devtoname(tp->t_dev) : "??"));
2847 mtx_unlock(&tp->t_mtx);
2852 * Drop a reference to a TTY.
2853 * When reference count drops to zero, we free it.
2856 ttyrel(struct tty *tp)
2860 mtx_lock(&tty_list_mutex);
2861 mtx_lock(&tp->t_mtx);
2862 KASSERT(tp->t_refcnt > 0,
2863 ("ttyrel(): tty refcnt is %d (%s)",
2864 tp->t_refcnt, tp->t_dev != NULL ? devtoname(tp->t_dev) : "??"));
2867 mtx_unlock(&tp->t_mtx);
2868 mtx_unlock(&tty_list_mutex);
2871 TAILQ_REMOVE(&tty_list, tp, t_list);
2872 mtx_unlock(&tp->t_mtx);
2873 mtx_unlock(&tty_list_mutex);
2874 knlist_destroy(&tp->t_rsel.si_note);
2875 knlist_destroy(&tp->t_wsel.si_note);
2876 mtx_destroy(&tp->t_mtx);
2882 * Allocate a tty struct. Clists in the struct will be allocated by
2890 tp = malloc(sizeof *tp, M_TTYS, M_WAITOK | M_ZERO);
2891 mtx_init(&tp->t_mtx, "tty", NULL, MTX_DEF);
2894 * Set up the initial state
2898 tp->t_dtr_wait = 3 * hz;
2900 ttyinitmode(tp, 0, 0);
2901 bcopy(ttydefchars, tp->t_init_in.c_cc, sizeof tp->t_init_in.c_cc);
2903 /* Make callout the same as callin */
2904 tp->t_init_out = tp->t_init_in;
2906 mtx_lock(&tty_list_mutex);
2907 TAILQ_INSERT_TAIL(&tty_list, tp, t_list);
2908 mtx_unlock(&tty_list_mutex);
2909 knlist_init(&tp->t_rsel.si_note, &tp->t_mtx, NULL, NULL, NULL);
2910 knlist_init(&tp->t_wsel.si_note, &tp->t_mtx, NULL, NULL, NULL);
2915 ttypurge(struct cdev *dev)
2918 if (dev->si_tty == NULL)
2920 ttygone(dev->si_tty);
2926 * Create the device entries for this tty thereby opening it for business.
2928 * The flags argument controls if "cua" units are created.
2930 * The t_sc filed is copied to si_drv1 in the created cdevs. This
2931 * is particularly important for ->t_cioctl() users.
2933 * XXX: implement the init and lock devices by cloning.
2937 ttycreate(struct tty *tp, int flags, const char *fmt, ...)
2939 char namebuf[SPECNAMELEN - 3]; /* XXX space for "tty" */
2940 struct cdevsw *csw = NULL;
2944 int i, minor, sminor, sunit;
2946 mtx_assert(&Giant, MA_OWNED);
2948 if (tty_unit == NULL)
2949 tty_unit = new_unrhdr(0, 0xffff, NULL);
2951 sunit = alloc_unr(tty_unit);
2952 tp->t_devunit = sunit;
2958 KASSERT(csw->d_purge == NULL || csw->d_purge == ttypurge,
2959 ("tty should not have d_purge"));
2961 csw->d_purge = ttypurge;
2963 minor = unit2minor(unit);
2964 sminor = unit2minor(sunit);
2966 i = vsnrprintf(namebuf, sizeof namebuf, 32, fmt, ap);
2968 KASSERT(i < sizeof namebuf, ("Too long tty name (%s)", namebuf));
2970 cp = make_dev(csw, minor,
2971 UID_ROOT, GID_WHEEL, 0600, "tty%s", namebuf);
2975 cp->si_drv1 = tp->t_sc;
2977 cp = make_dev(&ttys_cdevsw, sminor | MINOR_INIT,
2978 UID_ROOT, GID_WHEEL, 0600, "tty%s.init", namebuf);
2979 dev_depends(tp->t_dev, cp);
2980 cp->si_drv1 = tp->t_sc;
2981 cp->si_drv2 = &tp->t_init_in;
2984 cp = make_dev(&ttys_cdevsw, sminor | MINOR_LOCK,
2985 UID_ROOT, GID_WHEEL, 0600, "tty%s.lock", namebuf);
2986 dev_depends(tp->t_dev, cp);
2987 cp->si_drv1 = tp->t_sc;
2988 cp->si_drv2 = &tp->t_lock_in;
2991 if (flags & TS_CALLOUT) {
2992 cp = make_dev(csw, minor | MINOR_CALLOUT,
2993 UID_UUCP, GID_DIALER, 0660, "cua%s", namebuf);
2994 dev_depends(tp->t_dev, cp);
2995 cp->si_drv1 = tp->t_sc;
2998 cp = make_dev(&ttys_cdevsw, sminor | MINOR_CALLOUT | MINOR_INIT,
2999 UID_UUCP, GID_DIALER, 0660, "cua%s.init", namebuf);
3000 dev_depends(tp->t_dev, cp);
3001 cp->si_drv1 = tp->t_sc;
3002 cp->si_drv2 = &tp->t_init_out;
3005 cp = make_dev(&ttys_cdevsw, sminor | MINOR_CALLOUT | MINOR_LOCK,
3006 UID_UUCP, GID_DIALER, 0660, "cua%s.lock", namebuf);
3007 dev_depends(tp->t_dev, cp);
3008 cp->si_drv1 = tp->t_sc;
3009 cp->si_drv2 = &tp->t_lock_out;
3017 * This function is called when the hardware disappears. We set a flag
3018 * and wake up stuff so all sleeping threads will notice.
3021 ttygone(struct tty *tp)
3024 tp->t_state |= TS_GONE;
3025 if (SEL_WAITING(&tp->t_rsel))
3026 selwakeuppri(&tp->t_rsel, TTIPRI);
3027 if (SEL_WAITING(&tp->t_wsel))
3028 selwakeuppri(&tp->t_wsel, TTOPRI);
3029 if (ISSET(tp->t_state, TS_ASYNC) && tp->t_sigio != NULL)
3030 pgsigio(&tp->t_sigio, SIGIO, (tp->t_session != NULL));
3031 wakeup(&tp->t_dtr_wait);
3032 wakeup(TSA_CARR_ON(tp));
3033 wakeup(TSA_HUP_OR_INPUT(tp));
3034 wakeup(TSA_OCOMPLETE(tp));
3035 wakeup(TSA_OLOWAT(tp));
3036 KNOTE_UNLOCKED(&tp->t_rsel.si_note, 0);
3037 KNOTE_UNLOCKED(&tp->t_wsel.si_note, 0);
3044 * Called when the driver is ready to free the tty structure.
3046 * XXX: This shall sleep until all threads have left the driver.
3049 ttyfree(struct tty *tp)
3054 mtx_assert(&Giant, MA_OWNED);
3056 unit = tp->t_devunit;
3061 free_unr(tty_unit, unit);
3065 sysctl_kern_ttys(SYSCTL_HANDLER_ARGS)
3067 struct tty *tp, *tp2;
3072 mtx_lock(&tty_list_mutex);
3073 tp = TAILQ_FIRST(&tty_list);
3076 while (tp != NULL) {
3077 bzero(&xt, sizeof xt);
3078 xt.xt_size = sizeof xt;
3079 #define XT_COPY(field) xt.xt_##field = tp->t_##field
3080 xt.xt_rawcc = tp->t_rawq.c_cc;
3081 xt.xt_cancc = tp->t_canq.c_cc;
3082 xt.xt_outcc = tp->t_outq.c_cc;
3086 * XXX: We hold the tty list lock while doing this to
3087 * work around a race with pty/pts tty destruction.
3088 * They set t_dev to NULL and then call ttyrel() to
3089 * free the structure which will block on the list
3090 * lock before they call destroy_dev() on the cdev
3093 * XXX: ttyfree() now does the same since it has been
3094 * fixed to not leak ttys.
3096 if (tp->t_dev != NULL)
3097 xt.xt_dev = dev2udev(tp->t_dev);
3101 if (tp->t_pgrp != NULL)
3102 xt.xt_pgid = tp->t_pgrp->pg_id;
3103 if (tp->t_session != NULL)
3104 xt.xt_sid = tp->t_session->s_sid;
3118 mtx_unlock(&tty_list_mutex);
3119 error = SYSCTL_OUT(req, &xt, sizeof xt);
3124 mtx_lock(&tty_list_mutex);
3125 tp2 = TAILQ_NEXT(tp, t_list);
3128 mtx_unlock(&tty_list_mutex);
3131 mtx_lock(&tty_list_mutex);
3133 mtx_unlock(&tty_list_mutex);
3137 SYSCTL_PROC(_kern, OID_AUTO, ttys, CTLTYPE_OPAQUE|CTLFLAG_RD,
3138 0, 0, sysctl_kern_ttys, "S,xtty", "All ttys");
3139 SYSCTL_LONG(_kern, OID_AUTO, tty_nin, CTLFLAG_RD,
3140 &tk_nin, 0, "Total TTY in characters");
3141 SYSCTL_LONG(_kern, OID_AUTO, tty_nout, CTLFLAG_RD,
3142 &tk_nout, 0, "Total TTY out characters");
3145 nottystop(struct tty *tp, int rw)
3152 ttyopen(struct cdev *dev, int flag, int mode, struct thread *td)
3162 * We jump to this label after all non-interrupted sleeps to pick
3163 * up any changes of the device state.
3166 if (tp->t_state & TS_GONE)
3168 error = ttydtrwaitsleep(tp);
3171 if (tp->t_state & TS_ISOPEN) {
3173 * The device is open, so everything has been initialized.
3176 if (ISCALLOUT(dev) && !tp->t_actout)
3178 if (tp->t_actout && !ISCALLOUT(dev)) {
3179 if (flag & O_NONBLOCK)
3181 error = tsleep(&tp->t_actout,
3182 TTIPRI | PCATCH, "ttybi", 0);
3183 if (error != 0 || (tp->t_flags & TS_GONE))
3187 if (tp->t_state & TS_XCLUDE && priv_check(td,
3188 PRIV_TTY_EXCLUSIVE))
3192 * The device isn't open, so there are no conflicts.
3193 * Initialize it. Initialization is done twice in many
3194 * cases: to preempt sleeping callin opens if we are
3195 * callout, and to complete a callin open after DCD rises.
3197 tp->t_termios = ISCALLOUT(dev) ? tp->t_init_out : tp->t_init_in;
3198 tp->t_cflag = tp->t_termios.c_cflag;
3199 if (tp->t_modem != NULL)
3200 tt_modem(tp, SER_DTR | SER_RTS, 0);
3202 error = tt_param(tp, &tp->t_termios);
3205 error = tt_open(tp, dev);
3208 if (ISCALLOUT(dev) || (tt_modem(tp, 0, 0) & SER_DCD))
3212 * Wait for DCD if necessary.
3214 if (!(tp->t_state & TS_CARR_ON) && !ISCALLOUT(dev)
3215 && !(tp->t_cflag & CLOCAL) && !(flag & O_NONBLOCK)) {
3217 error = tsleep(TSA_CARR_ON(tp), TTIPRI | PCATCH, "ttydcd", 0);
3219 if (error != 0 || (tp->t_state & TS_GONE))
3223 error = ttyld_open(tp, dev);
3225 if (tp->t_state & TS_ISOPEN && ISCALLOUT(dev))
3226 tp->t_actout = TRUE;
3229 if (!(tp->t_state & TS_ISOPEN) && tp->t_wopeners == 0)
3235 ttyclose(struct cdev *dev, int flag, int mode, struct thread *td)
3240 ttyld_close(tp, flag);
3243 tp->t_do_timestamp = 0;
3244 if (tp->t_pps != NULL)
3245 tp->t_pps->ppsparam.mode = 0;
3251 ttyread(struct cdev *dev, struct uio *uio, int flag)
3255 tp = tty_gettp(dev);
3257 if (tp->t_state & TS_GONE)
3259 return (ttyld_read(tp, uio, flag));
3263 ttywrite(struct cdev *dev, struct uio *uio, int flag)
3267 tp = tty_gettp(dev);
3269 if (tp->t_state & TS_GONE)
3271 return (ttyld_write(tp, uio, flag));
3275 ttyioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
3282 if (cmd == TIOCSETA || cmd == TIOCSETAW || cmd == TIOCSETAF) {
3284 struct termios *dt = (struct termios *)data;
3285 struct termios *lt =
3286 ISCALLOUT(dev) ? &tp->t_lock_out : &tp->t_lock_in;
3288 dt->c_iflag = (tp->t_iflag & lt->c_iflag)
3289 | (dt->c_iflag & ~lt->c_iflag);
3290 dt->c_oflag = (tp->t_oflag & lt->c_oflag)
3291 | (dt->c_oflag & ~lt->c_oflag);
3292 dt->c_cflag = (tp->t_cflag & lt->c_cflag)
3293 | (dt->c_cflag & ~lt->c_cflag);
3294 dt->c_lflag = (tp->t_lflag & lt->c_lflag)
3295 | (dt->c_lflag & ~lt->c_lflag);
3296 for (cc = 0; cc < NCCS; ++cc)
3297 if (lt->c_cc[cc] != 0)
3298 dt->c_cc[cc] = tp->t_cc[cc];
3299 if (lt->c_ispeed != 0)
3300 dt->c_ispeed = tp->t_ispeed;
3301 if (lt->c_ospeed != 0)
3302 dt->c_ospeed = tp->t_ospeed;
3305 error = ttyld_ioctl(tp, cmd, data, flag, td);
3306 if (error == ENOIOCTL)
3307 error = ttioctl(tp, cmd, data, flag);
3309 if (error != ENOIOCTL)
3315 ttyldoptim(struct tty *tp)
3320 if (!(t->c_iflag & (ICRNL | IGNCR | IMAXBEL | INLCR | ISTRIP | IXON))
3321 && (!(t->c_iflag & BRKINT) || (t->c_iflag & IGNBRK))
3322 && (!(t->c_iflag & PARMRK)
3323 || (t->c_iflag & (IGNPAR | IGNBRK)) == (IGNPAR | IGNBRK))
3324 && !(t->c_lflag & (ECHO | ICANON | IEXTEN | ISIG | PENDIN))
3325 && linesw[tp->t_line]->l_rint == ttyinput)
3326 tp->t_state |= TS_CAN_BYPASS_L_RINT;
3328 tp->t_state &= ~TS_CAN_BYPASS_L_RINT;
3332 ttydtrwaitwakeup(void *arg)
3337 tp->t_state &= ~TS_DTR_WAIT;
3338 wakeup(&tp->t_dtr_wait);
3343 ttydtrwaitstart(struct tty *tp)
3346 if (tp->t_dtr_wait == 0)
3348 if (tp->t_state & TS_DTR_WAIT)
3350 timeout(ttydtrwaitwakeup, tp, tp->t_dtr_wait);
3351 tp->t_state |= TS_DTR_WAIT;
3355 ttydtrwaitsleep(struct tty *tp)
3360 while (error == 0) {
3361 if (tp->t_state & TS_GONE)
3363 else if (!(tp->t_state & TS_DTR_WAIT))
3366 error = tsleep(&tp->t_dtr_wait, TTIPRI | PCATCH,
3373 ttysopen(struct cdev *dev, int flag, int mode, struct thread *td)
3379 ("ttysopen(): no tty pointer on device (%s)", devtoname(dev)));
3380 if (tp->t_state & TS_GONE)
3386 ttysclose(struct cdev *dev, int flag, int mode, struct thread *td)
3393 ttysrdwr(struct cdev *dev, struct uio *uio, int flag)
3400 ttysioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *td)
3408 ("ttysopen(): no tty pointer on device (%s)", devtoname(dev)));
3409 if (tp->t_state & TS_GONE)
3414 error = priv_check(td, PRIV_TTY_SETA);
3417 *ct = *(struct termios *)data;
3420 *(struct termios *)data = *ct;
3423 *(int *)data = TTYDISC;
3426 bzero(data, sizeof(struct winsize));
3429 if (tp->t_cioctl != NULL)
3430 return(tp->t_cioctl(dev, cmd, data, flag, td));
3436 * Initialize a tty to sane modes.
3439 ttyinitmode(struct tty *tp, int echo, int speed)
3443 speed = TTYDEF_SPEED;
3444 tp->t_init_in.c_iflag = TTYDEF_IFLAG;
3445 tp->t_init_in.c_oflag = TTYDEF_OFLAG;
3446 tp->t_init_in.c_cflag = TTYDEF_CFLAG;
3448 tp->t_init_in.c_lflag = TTYDEF_LFLAG_ECHO;
3450 tp->t_init_in.c_lflag = TTYDEF_LFLAG_NOECHO;
3452 tp->t_init_in.c_ispeed = tp->t_init_in.c_ospeed = speed;
3453 termioschars(&tp->t_init_in);
3454 tp->t_init_out = tp->t_init_in;
3455 tp->t_termios = tp->t_init_in;
3459 * Use more "normal" termios paramters for consoles.
3462 ttyconsolemode(struct tty *tp, int speed)
3466 speed = TTYDEF_SPEED;
3467 ttyinitmode(tp, 1, speed);
3468 tp->t_init_in.c_cflag |= CLOCAL;
3469 tp->t_lock_out.c_cflag = tp->t_lock_in.c_cflag = CLOCAL;
3470 tp->t_lock_out.c_ispeed = tp->t_lock_out.c_ospeed =
3471 tp->t_lock_in.c_ispeed = tp->t_lock_in.c_ospeed = speed;
3472 tp->t_init_out = tp->t_init_in;
3473 tp->t_termios = tp->t_init_in;
3478 * Record the relationship between the serial ports notion of modem control
3479 * signals and the one used in certain ioctls in a way the compiler can enforce
3480 * XXX: We should define TIOCM_* in terms of SER_ if we can limit the
3481 * XXX: consequences of the #include work that would take.
3483 CTASSERT(SER_DTR == TIOCM_DTR / 2);
3484 CTASSERT(SER_RTS == TIOCM_RTS / 2);
3485 CTASSERT(SER_STX == TIOCM_ST / 2);
3486 CTASSERT(SER_SRX == TIOCM_SR / 2);
3487 CTASSERT(SER_CTS == TIOCM_CTS / 2);
3488 CTASSERT(SER_DCD == TIOCM_DCD / 2);
3489 CTASSERT(SER_RI == TIOCM_RI / 2);
3490 CTASSERT(SER_DSR == TIOCM_DSR / 2);