tty.c revision 1.202 1 /* $NetBSD: tty.c,v 1.202 2007/11/14 01:15:31 ad Exp $ */
2
3 /*-
4 * Copyright (c) 1982, 1986, 1990, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)tty.c 8.13 (Berkeley) 1/9/95
37 */
38
39 #include <sys/cdefs.h>
40 __KERNEL_RCSID(0, "$NetBSD: tty.c,v 1.202 2007/11/14 01:15:31 ad Exp $");
41
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/ioctl.h>
45 #include <sys/proc.h>
46 #define TTYDEFCHARS
47 #include <sys/tty.h>
48 #undef TTYDEFCHARS
49 #include <sys/file.h>
50 #include <sys/conf.h>
51 #include <sys/dkstat.h>
52 #include <sys/uio.h>
53 #include <sys/kernel.h>
54 #include <sys/vnode.h>
55 #include <sys/syslog.h>
56 #include <sys/malloc.h>
57 #include <sys/pool.h>
58 #include <sys/signalvar.h>
59 #include <sys/resourcevar.h>
60 #include <sys/poll.h>
61 #include <sys/kprintf.h>
62 #include <sys/namei.h>
63 #include <sys/sysctl.h>
64 #include <sys/kauth.h>
65 #include <sys/intr.h>
66
67 #include <machine/stdarg.h>
68
69 static int ttnread(struct tty *);
70 static void ttyblock(struct tty *);
71 static void ttyecho(int, struct tty *);
72 static void ttyrubo(struct tty *, int);
73 static void ttyprintf_nolock(struct tty *, const char *fmt, ...)
74 __attribute__((__format__(__printf__,2,3)));
75 static int proc_compare(struct proc *, struct proc *);
76 static void ttysigintr(void *);
77
78 /* Symbolic sleep message strings. */
79 const char ttclos[] = "ttycls";
80 const char ttopen[] = "ttyopn";
81 const char ttybg[] = "ttybg";
82 const char ttyin[] = "ttyin";
83 const char ttyout[] = "ttyout";
84
85 /*
86 * Used to determine whether we still have a connection. This is true in
87 * one of 3 cases:
88 * 1) We have carrier.
89 * 2) It's a locally attached terminal, and we are therefore ignoring carrier.
90 * 3) We're using a flow control mechanism that overloads the carrier signal.
91 */
92 #define CONNECTED(tp) (ISSET(tp->t_state, TS_CARR_ON) || \
93 ISSET(tp->t_cflag, CLOCAL | MDMBUF))
94
95 /*
96 * Table with character classes and parity. The 8th bit indicates parity,
97 * the 7th bit indicates the character is an alphameric or underscore (for
98 * ALTWERASE), and the low 6 bits indicate delay type. If the low 6 bits
99 * are 0 then the character needs no special processing on output; classes
100 * other than 0 might be translated or (not currently) require delays.
101 */
102 #define E 0x00 /* Even parity. */
103 #define O 0x80 /* Odd parity. */
104 #define PARITY(c) (char_type[c] & O)
105
106 #define ALPHA 0x40 /* Alpha or underscore. */
107 #define ISALPHA(c) (char_type[(c) & TTY_CHARMASK] & ALPHA)
108
109 #define CCLASSMASK 0x3f
110 #define CCLASS(c) (char_type[c] & CCLASSMASK)
111
112 #define BS BACKSPACE
113 #define CC CONTROL
114 #define CR RETURN
115 #define NA ORDINARY | ALPHA
116 #define NL NEWLINE
117 #define NO ORDINARY
118 #define TB TAB
119 #define VT VTAB
120
121 unsigned char const char_type[] = {
122 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* nul - bel */
123 O|BS, E|TB, E|NL, O|CC, E|VT, O|CR, O|CC, E|CC, /* bs - si */
124 O|CC, E|CC, E|CC, O|CC, E|CC, O|CC, O|CC, E|CC, /* dle - etb */
125 E|CC, O|CC, O|CC, E|CC, O|CC, E|CC, E|CC, O|CC, /* can - us */
126 O|NO, E|NO, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* sp - ' */
127 E|NO, O|NO, O|NO, E|NO, O|NO, E|NO, E|NO, O|NO, /* ( - / */
128 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* 0 - 7 */
129 O|NA, E|NA, E|NO, O|NO, E|NO, O|NO, O|NO, E|NO, /* 8 - ? */
130 O|NO, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* @ - G */
131 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* H - O */
132 E|NA, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* P - W */
133 O|NA, E|NA, E|NA, O|NO, E|NO, O|NO, O|NO, O|NA, /* X - _ */
134 E|NO, O|NA, O|NA, E|NA, O|NA, E|NA, E|NA, O|NA, /* ` - g */
135 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* h - o */
136 O|NA, E|NA, E|NA, O|NA, E|NA, O|NA, O|NA, E|NA, /* p - w */
137 E|NA, O|NA, O|NA, E|NO, O|NO, E|NO, E|NO, O|CC, /* x - del */
138 /*
139 * Meta chars; should be settable per character set;
140 * for now, treat them all as normal characters.
141 */
142 NA, NA, NA, NA, NA, NA, NA, NA,
143 NA, NA, NA, NA, NA, NA, NA, NA,
144 NA, NA, NA, NA, NA, NA, NA, NA,
145 NA, NA, NA, NA, NA, NA, NA, NA,
146 NA, NA, NA, NA, NA, NA, NA, NA,
147 NA, NA, NA, NA, NA, NA, NA, NA,
148 NA, NA, NA, NA, NA, NA, NA, NA,
149 NA, NA, NA, NA, NA, NA, NA, NA,
150 NA, NA, NA, NA, NA, NA, NA, NA,
151 NA, NA, NA, NA, NA, NA, NA, NA,
152 NA, NA, NA, NA, NA, NA, NA, NA,
153 NA, NA, NA, NA, NA, NA, NA, NA,
154 NA, NA, NA, NA, NA, NA, NA, NA,
155 NA, NA, NA, NA, NA, NA, NA, NA,
156 NA, NA, NA, NA, NA, NA, NA, NA,
157 NA, NA, NA, NA, NA, NA, NA, NA,
158 };
159 #undef BS
160 #undef CC
161 #undef CR
162 #undef NA
163 #undef NL
164 #undef NO
165 #undef TB
166 #undef VT
167
168 static struct ttylist_head tty_sigqueue = TAILQ_HEAD_INITIALIZER(tty_sigqueue);
169 static void *tty_sigsih;
170
171 struct ttylist_head ttylist = TAILQ_HEAD_INITIALIZER(ttylist);
172 int tty_count;
173 kmutex_t tty_lock;
174
175 POOL_INIT(tty_pool, sizeof(struct tty), 0, 0, 0, "ttypl",
176 &pool_allocator_nointr, IPL_NONE);
177
178 uint64_t tk_cancc;
179 uint64_t tk_nin;
180 uint64_t tk_nout;
181 uint64_t tk_rawcc;
182
183 SYSCTL_SETUP(sysctl_kern_tkstat_setup, "sysctl kern.tkstat subtree setup")
184 {
185
186 sysctl_createv(clog, 0, NULL, NULL,
187 CTLFLAG_PERMANENT,
188 CTLTYPE_NODE, "kern", NULL,
189 NULL, 0, NULL, 0,
190 CTL_KERN, CTL_EOL);
191 sysctl_createv(clog, 0, NULL, NULL,
192 CTLFLAG_PERMANENT,
193 CTLTYPE_NODE, "tkstat",
194 SYSCTL_DESCR("Number of characters sent and and "
195 "received on ttys"),
196 NULL, 0, NULL, 0,
197 CTL_KERN, KERN_TKSTAT, CTL_EOL);
198
199 sysctl_createv(clog, 0, NULL, NULL,
200 CTLFLAG_PERMANENT,
201 CTLTYPE_QUAD, "nin",
202 SYSCTL_DESCR("Total number of tty input characters"),
203 NULL, 0, &tk_nin, 0,
204 CTL_KERN, KERN_TKSTAT, KERN_TKSTAT_NIN, CTL_EOL);
205 sysctl_createv(clog, 0, NULL, NULL,
206 CTLFLAG_PERMANENT,
207 CTLTYPE_QUAD, "nout",
208 SYSCTL_DESCR("Total number of tty output characters"),
209 NULL, 0, &tk_nout, 0,
210 CTL_KERN, KERN_TKSTAT, KERN_TKSTAT_NOUT, CTL_EOL);
211 sysctl_createv(clog, 0, NULL, NULL,
212 CTLFLAG_PERMANENT,
213 CTLTYPE_QUAD, "cancc",
214 SYSCTL_DESCR("Number of canonical tty input characters"),
215 NULL, 0, &tk_cancc, 0,
216 CTL_KERN, KERN_TKSTAT, KERN_TKSTAT_CANCC, CTL_EOL);
217 sysctl_createv(clog, 0, NULL, NULL,
218 CTLFLAG_PERMANENT,
219 CTLTYPE_QUAD, "rawcc",
220 SYSCTL_DESCR("Number of raw tty input characters"),
221 NULL, 0, &tk_rawcc, 0,
222 CTL_KERN, KERN_TKSTAT, KERN_TKSTAT_RAWCC, CTL_EOL);
223 }
224
225 int
226 ttyopen(struct tty *tp, int dialout, int nonblock)
227 {
228 int error;
229
230 error = 0;
231
232 mutex_spin_enter(&tty_lock);
233
234 if (dialout) {
235 /*
236 * If the device is already open for non-dialout, fail.
237 * Otherwise, set TS_DIALOUT to block any pending non-dialout
238 * opens.
239 */
240 if (ISSET(tp->t_state, TS_ISOPEN) &&
241 !ISSET(tp->t_state, TS_DIALOUT)) {
242 error = EBUSY;
243 goto out;
244 }
245 SET(tp->t_state, TS_DIALOUT);
246 } else {
247 if (!nonblock) {
248 /*
249 * Wait for carrier. Also wait for any dialout
250 * processes to close the tty first.
251 */
252 while (ISSET(tp->t_state, TS_DIALOUT) ||
253 !CONNECTED(tp)) {
254 tp->t_wopen++;
255 error = ttysleep(tp, &tp->t_rawq.c_cv, true, 0);
256 tp->t_wopen--;
257 if (error)
258 goto out;
259 }
260 } else {
261 /*
262 * Don't allow a non-blocking non-dialout open if the
263 * device is already open for dialout.
264 */
265 if (ISSET(tp->t_state, TS_DIALOUT)) {
266 error = EBUSY;
267 goto out;
268 }
269 }
270 }
271
272 out:
273 mutex_spin_exit(&tty_lock);
274 return (error);
275 }
276
277 /*
278 * Initial open of tty, or (re)entry to standard tty line discipline.
279 */
280 int
281 ttylopen(dev_t device, struct tty *tp)
282 {
283
284 mutex_spin_enter(&tty_lock);
285 tp->t_dev = device;
286 if (!ISSET(tp->t_state, TS_ISOPEN)) {
287 SET(tp->t_state, TS_ISOPEN);
288 memset(&tp->t_winsize, 0, sizeof(tp->t_winsize));
289 #ifdef COMPAT_OLDTTY
290 tp->t_flags = 0;
291 #endif
292 }
293 mutex_spin_exit(&tty_lock);
294 return (0);
295 }
296
297 /*
298 * Handle close() on a tty line: flush and set to initial state,
299 * bumping generation number so that pending read/write calls
300 * can detect recycling of the tty.
301 */
302 int
303 ttyclose(struct tty *tp)
304 {
305 extern struct tty *constty; /* Temporary virtual console. */
306 struct session *sess;
307
308 mutex_spin_enter(&tty_lock);
309
310 if (constty == tp)
311 constty = NULL;
312
313 ttyflush(tp, FREAD | FWRITE);
314
315 tp->t_gen++;
316 tp->t_pgrp = NULL;
317 tp->t_state = 0;
318
319 mutex_spin_exit(&tty_lock);
320
321 mutex_enter(&proclist_lock);
322 if ((sess = tp->t_session) != NULL) {
323 SESSRELE(tp->t_session);
324 tp->t_session = NULL;
325 }
326 mutex_exit(&proclist_lock);
327
328 return (0);
329 }
330
331 #define FLUSHQ(q) { \
332 if ((q)->c_cc) \
333 ndflush(q, (q)->c_cc); \
334 }
335
336 /*
337 * This macro is used in canonical mode input processing, where a read
338 * request shall not return unless a 'line delimiter' ('\n') or 'break'
339 * (EOF, EOL, EOL2) character (or a signal) has been received. As EOL2
340 * is an extension to the POSIX.1 defined set of special characters,
341 * recognize it only if IEXTEN is set in the set of local flags.
342 */
343 #define TTBREAKC(c, lflg) \
344 ((c) == '\n' || (((c) == cc[VEOF] || (c) == cc[VEOL] || \
345 ((c) == cc[VEOL2] && ISSET(lflg, IEXTEN))) && (c) != _POSIX_VDISABLE))
346
347
348
349 /*
350 * ttyinput() helper.
351 * Call with the tty lock held.
352 */
353 static int
354 ttyinput_wlock(int c, struct tty *tp)
355 {
356 int iflag, lflag, i, error;
357 u_char *cc;
358
359 KASSERT(mutex_owned(&tty_lock));
360
361 /*
362 * If input is pending take it first.
363 */
364 lflag = tp->t_lflag;
365 if (ISSET(lflag, PENDIN))
366 ttypend(tp);
367 /*
368 * Gather stats.
369 */
370 if (ISSET(lflag, ICANON)) {
371 ++tk_cancc;
372 ++tp->t_cancc;
373 } else {
374 ++tk_rawcc;
375 ++tp->t_rawcc;
376 }
377 ++tk_nin;
378
379 cc = tp->t_cc;
380
381 /*
382 * Handle exceptional conditions (break, parity, framing).
383 */
384 iflag = tp->t_iflag;
385 if ((error = (ISSET(c, TTY_ERRORMASK))) != 0) {
386 CLR(c, TTY_ERRORMASK);
387 if (ISSET(error, TTY_FE) && c == 0) { /* Break. */
388 if (ISSET(iflag, IGNBRK))
389 return (0);
390 else if (ISSET(iflag, BRKINT)) {
391 ttyflush(tp, FREAD | FWRITE);
392 ttysig(tp, TTYSIG_PG1, SIGINT);
393 return (0);
394 } else if (ISSET(iflag, PARMRK))
395 goto parmrk;
396 } else if ((ISSET(error, TTY_PE) && ISSET(iflag, INPCK)) ||
397 ISSET(error, TTY_FE)) {
398 if (ISSET(iflag, IGNPAR))
399 return (0);
400 else if (ISSET(iflag, PARMRK)) {
401 parmrk: (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
402 (void)putc(0 | TTY_QUOTE, &tp->t_rawq);
403 (void)putc(c | TTY_QUOTE, &tp->t_rawq);
404 return (0);
405 } else
406 c = 0;
407 }
408 } else if (c == 0377 &&
409 ISSET(iflag, ISTRIP|IGNPAR|INPCK|PARMRK) == (INPCK|PARMRK)) {
410 /* "Escape" a valid character of '\377'. */
411 (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
412 (void)putc(0377 | TTY_QUOTE, &tp->t_rawq);
413 goto endcase;
414 }
415
416 /*
417 * In tandem mode, check high water mark.
418 */
419 if (ISSET(iflag, IXOFF) || ISSET(tp->t_cflag, CHWFLOW))
420 ttyblock(tp);
421 if (!ISSET(tp->t_state, TS_TYPEN) && ISSET(iflag, ISTRIP))
422 CLR(c, 0x80);
423 if (!ISSET(lflag, EXTPROC)) {
424 /*
425 * Check for literal nexting very first
426 */
427 if (ISSET(tp->t_state, TS_LNCH)) {
428 SET(c, TTY_QUOTE);
429 CLR(tp->t_state, TS_LNCH);
430 }
431 /*
432 * Scan for special characters. This code
433 * is really just a big case statement with
434 * non-constant cases. The bottom of the
435 * case statement is labeled ``endcase'', so goto
436 * it after a case match, or similar.
437 */
438
439 /*
440 * Control chars which aren't controlled
441 * by ICANON, ISIG, or IXON.
442 */
443 if (ISSET(lflag, IEXTEN)) {
444 if (CCEQ(cc[VLNEXT], c)) {
445 if (ISSET(lflag, ECHO)) {
446 if (ISSET(lflag, ECHOE)) {
447 (void)ttyoutput('^', tp);
448 (void)ttyoutput('\b', tp);
449 } else
450 ttyecho(c, tp);
451 }
452 SET(tp->t_state, TS_LNCH);
453 goto endcase;
454 }
455 if (CCEQ(cc[VDISCARD], c)) {
456 if (ISSET(lflag, FLUSHO))
457 CLR(tp->t_lflag, FLUSHO);
458 else {
459 ttyflush(tp, FWRITE);
460 ttyecho(c, tp);
461 if (tp->t_rawq.c_cc + tp->t_canq.c_cc)
462 ttyretype(tp);
463 SET(tp->t_lflag, FLUSHO);
464 }
465 goto startoutput;
466 }
467 }
468 /*
469 * Signals.
470 */
471 if (ISSET(lflag, ISIG)) {
472 if (CCEQ(cc[VINTR], c) || CCEQ(cc[VQUIT], c)) {
473 if (!ISSET(lflag, NOFLSH))
474 ttyflush(tp, FREAD | FWRITE);
475 ttyecho(c, tp);
476 ttysig(tp, TTYSIG_PG1, CCEQ(cc[VINTR], c) ?
477 SIGINT : SIGQUIT);
478 goto endcase;
479 }
480 if (CCEQ(cc[VSUSP], c)) {
481 if (!ISSET(lflag, NOFLSH))
482 ttyflush(tp, FREAD);
483 ttyecho(c, tp);
484 ttysig(tp, TTYSIG_PG1, SIGTSTP);
485 goto endcase;
486 }
487 }
488 /*
489 * Handle start/stop characters.
490 */
491 if (ISSET(iflag, IXON)) {
492 if (CCEQ(cc[VSTOP], c)) {
493 if (!ISSET(tp->t_state, TS_TTSTOP)) {
494 SET(tp->t_state, TS_TTSTOP);
495 cdev_stop(tp, 0);
496 return (0);
497 }
498 if (!CCEQ(cc[VSTART], c))
499 return (0);
500 /*
501 * if VSTART == VSTOP then toggle
502 */
503 goto endcase;
504 }
505 if (CCEQ(cc[VSTART], c))
506 goto restartoutput;
507 }
508 /*
509 * IGNCR, ICRNL, & INLCR
510 */
511 if (c == '\r') {
512 if (ISSET(iflag, IGNCR))
513 goto endcase;
514 else if (ISSET(iflag, ICRNL))
515 c = '\n';
516 } else if (c == '\n' && ISSET(iflag, INLCR))
517 c = '\r';
518 }
519 if (!ISSET(lflag, EXTPROC) && ISSET(lflag, ICANON)) {
520 /*
521 * From here on down canonical mode character
522 * processing takes place.
523 */
524 /*
525 * erase (^H / ^?)
526 */
527 if (CCEQ(cc[VERASE], c)) {
528 if (tp->t_rawq.c_cc)
529 ttyrub(unputc(&tp->t_rawq), tp);
530 goto endcase;
531 }
532 /*
533 * kill (^U)
534 */
535 if (CCEQ(cc[VKILL], c)) {
536 if (ISSET(lflag, ECHOKE) &&
537 tp->t_rawq.c_cc == tp->t_rocount &&
538 !ISSET(lflag, ECHOPRT))
539 while (tp->t_rawq.c_cc)
540 ttyrub(unputc(&tp->t_rawq), tp);
541 else {
542 ttyecho(c, tp);
543 if (ISSET(lflag, ECHOK) ||
544 ISSET(lflag, ECHOKE))
545 ttyecho('\n', tp);
546 FLUSHQ(&tp->t_rawq);
547 tp->t_rocount = 0;
548 }
549 CLR(tp->t_state, TS_LOCAL);
550 goto endcase;
551 }
552 /*
553 * Extensions to the POSIX.1 GTI set of functions.
554 */
555 if (ISSET(lflag, IEXTEN)) {
556 /*
557 * word erase (^W)
558 */
559 if (CCEQ(cc[VWERASE], c)) {
560 int alt = ISSET(lflag, ALTWERASE);
561 int ctype;
562
563 /*
564 * erase whitespace
565 */
566 while ((c = unputc(&tp->t_rawq)) == ' ' ||
567 c == '\t')
568 ttyrub(c, tp);
569 if (c == -1)
570 goto endcase;
571 /*
572 * erase last char of word and remember the
573 * next chars type (for ALTWERASE)
574 */
575 ttyrub(c, tp);
576 c = unputc(&tp->t_rawq);
577 if (c == -1)
578 goto endcase;
579 if (c == ' ' || c == '\t') {
580 (void)putc(c, &tp->t_rawq);
581 goto endcase;
582 }
583 ctype = ISALPHA(c);
584 /*
585 * erase rest of word
586 */
587 do {
588 ttyrub(c, tp);
589 c = unputc(&tp->t_rawq);
590 if (c == -1)
591 goto endcase;
592 } while (c != ' ' && c != '\t' &&
593 (alt == 0 || ISALPHA(c) == ctype));
594 (void)putc(c, &tp->t_rawq);
595 goto endcase;
596 }
597 /*
598 * reprint line (^R)
599 */
600 if (CCEQ(cc[VREPRINT], c)) {
601 ttyretype(tp);
602 goto endcase;
603 }
604 /*
605 * ^T - kernel info and generate SIGINFO
606 */
607 if (CCEQ(cc[VSTATUS], c)) {
608 if (!ISSET(lflag, NOKERNINFO))
609 ttyinfo(tp, 1);
610 if (ISSET(lflag, ISIG))
611 ttysig(tp, TTYSIG_PG1, SIGINFO);
612 goto endcase;
613 }
614 }
615 }
616 /*
617 * Check for input buffer overflow
618 */
619 if (tp->t_rawq.c_cc + tp->t_canq.c_cc >= TTYHOG) {
620 if (ISSET(iflag, IMAXBEL)) {
621 if (tp->t_outq.c_cc < tp->t_hiwat)
622 (void)ttyoutput(CTRL('g'), tp);
623 } else
624 ttyflush(tp, FREAD | FWRITE);
625 goto endcase;
626 }
627 /*
628 * Put data char in q for user and
629 * wakeup on seeing a line delimiter.
630 */
631 if (putc(c, &tp->t_rawq) >= 0) {
632 if (!ISSET(lflag, ICANON)) {
633 ttwakeup(tp);
634 ttyecho(c, tp);
635 goto endcase;
636 }
637 if (TTBREAKC(c, lflag)) {
638 tp->t_rocount = 0;
639 catq(&tp->t_rawq, &tp->t_canq);
640 ttwakeup(tp);
641 } else if (tp->t_rocount++ == 0)
642 tp->t_rocol = tp->t_column;
643 if (ISSET(tp->t_state, TS_ERASE)) {
644 /*
645 * end of prterase \.../
646 */
647 CLR(tp->t_state, TS_ERASE);
648 (void)ttyoutput('/', tp);
649 }
650 i = tp->t_column;
651 ttyecho(c, tp);
652 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ECHO)) {
653 /*
654 * Place the cursor over the '^' of the ^D.
655 */
656 i = min(2, tp->t_column - i);
657 while (i > 0) {
658 (void)ttyoutput('\b', tp);
659 i--;
660 }
661 }
662 }
663 endcase:
664 /*
665 * IXANY means allow any character to restart output.
666 */
667 if (ISSET(tp->t_state, TS_TTSTOP) &&
668 !ISSET(iflag, IXANY) && cc[VSTART] != cc[VSTOP]) {
669 return (0);
670 }
671 restartoutput:
672 CLR(tp->t_lflag, FLUSHO);
673 CLR(tp->t_state, TS_TTSTOP);
674 startoutput:
675 return (ttstart(tp));
676 }
677
678 /*
679 * Process input of a single character received on a tty.
680 *
681 * XXX - this is a hack, all drivers must changed to acquire the
682 * lock before calling linesw->l_rint()
683 */
684 int
685 ttyinput(int c, struct tty *tp)
686 {
687 int error;
688
689 /*
690 * Unless the receiver is enabled, drop incoming data.
691 */
692 if (!ISSET(tp->t_cflag, CREAD))
693 return (0);
694
695 mutex_spin_enter(&tty_lock);
696 error = ttyinput_wlock(c, tp);
697 mutex_spin_exit(&tty_lock);
698
699 return (error);
700 }
701
702 /*
703 * Output a single character on a tty, doing output processing
704 * as needed (expanding tabs, newline processing, etc.).
705 * Returns < 0 if succeeds, otherwise returns char to resend.
706 * Must be recursive.
707 *
708 * Call with tty lock held.
709 */
710 int
711 ttyoutput(int c, struct tty *tp)
712 {
713 long oflag;
714 int col, notout;
715
716 KASSERT(mutex_owned(&tty_lock));
717
718 oflag = tp->t_oflag;
719 if (!ISSET(oflag, OPOST)) {
720 tk_nout++;
721 tp->t_outcc++;
722 if (!ISSET(tp->t_lflag, FLUSHO) && putc(c, &tp->t_outq))
723 return (c);
724 return (-1);
725 }
726 /*
727 * Do tab expansion if OXTABS is set. Special case if we do external
728 * processing, we don't do the tab expansion because we'll probably
729 * get it wrong. If tab expansion needs to be done, let it happen
730 * externally.
731 */
732 CLR(c, ~TTY_CHARMASK);
733 if (c == '\t' &&
734 ISSET(oflag, OXTABS) && !ISSET(tp->t_lflag, EXTPROC)) {
735 c = 8 - (tp->t_column & 7);
736 if (ISSET(tp->t_lflag, FLUSHO)) {
737 notout = 0;
738 } else {
739 notout = b_to_q(" ", c, &tp->t_outq);
740 c -= notout;
741 tk_nout += c;
742 tp->t_outcc += c;
743 }
744 tp->t_column += c;
745 return (notout ? '\t' : -1);
746 }
747 if (c == CEOT && ISSET(oflag, ONOEOT))
748 return (-1);
749
750 /*
751 * Newline translation: if ONLCR is set,
752 * translate newline into "\r\n".
753 */
754 if (c == '\n' && ISSET(tp->t_oflag, ONLCR)) {
755 tk_nout++;
756 tp->t_outcc++;
757 if (!ISSET(tp->t_lflag, FLUSHO) && putc('\r', &tp->t_outq))
758 return (c);
759 }
760 /* If OCRNL is set, translate "\r" into "\n". */
761 else if (c == '\r' && ISSET(tp->t_oflag, OCRNL))
762 c = '\n';
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)
765 return (-1);
766
767 tk_nout++;
768 tp->t_outcc++;
769 if (!ISSET(tp->t_lflag, FLUSHO) && putc(c, &tp->t_outq))
770 return (c);
771
772 col = tp->t_column;
773 switch (CCLASS(c)) {
774 case BACKSPACE:
775 if (col > 0)
776 --col;
777 break;
778 case CONTROL:
779 break;
780 case NEWLINE:
781 if (ISSET(tp->t_oflag, ONLCR | ONLRET))
782 col = 0;
783 break;
784 case RETURN:
785 col = 0;
786 break;
787 case ORDINARY:
788 ++col;
789 break;
790 case TAB:
791 col = (col + 8) & ~7;
792 break;
793 }
794 tp->t_column = col;
795 return (-1);
796 }
797
798 /*
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.
802 */
803 /* ARGSUSED */
804 int
805 ttioctl(struct tty *tp, u_long cmd, void *data, int flag, struct lwp *l)
806 {
807 extern struct tty *constty; /* Temporary virtual console. */
808 struct proc *p = l ? l->l_proc : NULL;
809 struct linesw *lp;
810 int s, error;
811 struct nameidata nd;
812
813 /* If the ioctl involves modification, hang if in the background. */
814 switch (cmd) {
815 case TIOCFLUSH:
816 case TIOCDRAIN:
817 case TIOCSBRK:
818 case TIOCCBRK:
819 case TIOCSTART:
820 case TIOCSETA:
821 case TIOCSETD:
822 case TIOCSLINED:
823 case TIOCSETAF:
824 case TIOCSETAW:
825 #ifdef notdef
826 case TIOCSPGRP:
827 case FIOSETOWN:
828 #endif
829 case TIOCSTAT:
830 case TIOCSTI:
831 case TIOCSWINSZ:
832 #ifdef COMPAT_OLDTTY
833 case TIOCLBIC:
834 case TIOCLBIS:
835 case TIOCLSET:
836 case TIOCSETC:
837 case OTIOCSETD:
838 case TIOCSETN:
839 case TIOCSETP:
840 case TIOCSLTC:
841 #endif
842 /* XXXSMP */
843 while (isbackground(curproc, tp) &&
844 p->p_pgrp->pg_jobc && (p->p_sflag & PS_PPWAIT) == 0 &&
845 !sigismasked(l, SIGTTOU)) {
846 mutex_spin_enter(&tty_lock);
847 ttysig(tp, TTYSIG_PG1, SIGTTOU);
848 error = ttysleep(tp, &lbolt, true, 0);
849 mutex_spin_exit(&tty_lock);
850 if (error) {
851 return (error);
852 }
853 }
854 break;
855 }
856
857 switch (cmd) { /* Process the ioctl. */
858 case FIOASYNC: /* set/clear async i/o */
859 mutex_spin_enter(&tty_lock);
860 if (*(int *)data)
861 SET(tp->t_state, TS_ASYNC);
862 else
863 CLR(tp->t_state, TS_ASYNC);
864 mutex_spin_exit(&tty_lock);
865 break;
866 case FIONBIO: /* set/clear non-blocking i/o */
867 break; /* XXX: delete. */
868 case FIONREAD: /* get # bytes to read */
869 mutex_spin_enter(&tty_lock);
870 *(int *)data = ttnread(tp);
871 mutex_spin_exit(&tty_lock);
872 break;
873 case FIONWRITE: /* get # bytes to written & unsent */
874 mutex_spin_enter(&tty_lock);
875 *(int *)data = tp->t_outq.c_cc;
876 mutex_spin_exit(&tty_lock);
877 break;
878 case FIONSPACE: /* get # bytes to written & unsent */
879 mutex_spin_enter(&tty_lock);
880 *(int *)data = tp->t_outq.c_cn - tp->t_outq.c_cc;
881 mutex_spin_exit(&tty_lock);
882 break;
883 case TIOCEXCL: /* set exclusive use of tty */
884 mutex_spin_enter(&tty_lock);
885 SET(tp->t_state, TS_XCLUDE);
886 mutex_spin_exit(&tty_lock);
887 break;
888 case TIOCFLUSH: { /* flush buffers */
889 int flags = *(int *)data;
890
891 if (flags == 0)
892 flags = FREAD | FWRITE;
893 else
894 flags &= FREAD | FWRITE;
895 mutex_spin_enter(&tty_lock);
896 ttyflush(tp, flags);
897 mutex_spin_exit(&tty_lock);
898 break;
899 }
900 case TIOCCONS: /* become virtual console */
901 if (*(int *)data) {
902 if (constty && constty != tp &&
903 ISSET(constty->t_state, TS_CARR_ON | TS_ISOPEN) ==
904 (TS_CARR_ON | TS_ISOPEN))
905 return EBUSY;
906
907 NDINIT(&nd, LOOKUP, FOLLOW | LOCKLEAF, UIO_SYSSPACE,
908 "/dev/console", l);
909 if ((error = namei(&nd)) != 0)
910 return error;
911 error = VOP_ACCESS(nd.ni_vp, VREAD, l->l_cred, l);
912 vput(nd.ni_vp);
913 if (error)
914 return error;
915
916 constty = tp;
917 } else if (tp == constty)
918 constty = NULL;
919 break;
920 case TIOCDRAIN: /* wait till output drained */
921 if ((error = ttywait(tp)) != 0)
922 return (error);
923 break;
924 case TIOCGETA: { /* get termios struct */
925 struct termios *t = (struct termios *)data;
926
927 memcpy(t, &tp->t_termios, sizeof(struct termios));
928 break;
929 }
930 case TIOCGETD: /* get line discipline (old) */
931 *(int *)data = tp->t_linesw->l_no;
932 break;
933 case TIOCGLINED: /* get line discipline (new) */
934 (void)strncpy((char *)data, tp->t_linesw->l_name,
935 TTLINEDNAMELEN - 1);
936 break;
937 case TIOCGWINSZ: /* get window size */
938 *(struct winsize *)data = tp->t_winsize;
939 break;
940 case FIOGETOWN:
941 if (tp->t_session != NULL && !isctty(p, tp))
942 return (ENOTTY);
943 *(int *)data = tp->t_pgrp ? -tp->t_pgrp->pg_id : 0;
944 break;
945 case TIOCGPGRP: /* get pgrp of tty */
946 if (!isctty(p, tp))
947 return (ENOTTY);
948 *(int *)data = tp->t_pgrp ? tp->t_pgrp->pg_id : NO_PGID;
949 break;
950 case TIOCGSID: /* get sid of tty */
951 if (!isctty(p, tp))
952 return (ENOTTY);
953 *(int *)data = tp->t_session->s_sid;
954 break;
955 #ifdef TIOCHPCL
956 case TIOCHPCL: /* hang up on last close */
957 mutex_spin_enter(&tty_lock);
958 SET(tp->t_cflag, HUPCL);
959 mutex_spin_exit(&tty_lock);
960 break;
961 #endif
962 case TIOCNXCL: /* reset exclusive use of tty */
963 mutex_spin_enter(&tty_lock);
964 CLR(tp->t_state, TS_XCLUDE);
965 mutex_spin_exit(&tty_lock);
966 break;
967 case TIOCOUTQ: /* output queue size */
968 *(int *)data = tp->t_outq.c_cc;
969 break;
970 case TIOCSETA: /* set termios struct */
971 case TIOCSETAW: /* drain output, set */
972 case TIOCSETAF: { /* drn out, fls in, set */
973 struct termios *t = (struct termios *)data;
974
975 if (cmd == TIOCSETAW || cmd == TIOCSETAF) {
976 if ((error = ttywait(tp)) != 0)
977 return (error);
978
979 if (cmd == TIOCSETAF) {
980 mutex_spin_enter(&tty_lock);
981 ttyflush(tp, FREAD);
982 mutex_spin_exit(&tty_lock);
983 }
984 }
985
986 s = spltty();
987 /*
988 * XXXSMP - some drivers call back on us from t_param(), so
989 * don't take the tty spin lock here.
990 * require t_param() to unlock upon callback?
991 */
992 /* wanted here: mutex_spin_enter(&tty_lock); */
993 if (!ISSET(t->c_cflag, CIGNORE)) {
994 /*
995 * Set device hardware.
996 */
997 if (tp->t_param && (error = (*tp->t_param)(tp, t))) {
998 /* wanted here: mutex_spin_exit(&tty_lock); */
999 splx(s);
1000 return (error);
1001 } else {
1002 tp->t_cflag = t->c_cflag;
1003 tp->t_ispeed = t->c_ispeed;
1004 tp->t_ospeed = t->c_ospeed;
1005 if (t->c_ospeed == 0)
1006 ttysig(tp, TTYSIG_LEADER, SIGHUP);
1007 }
1008 ttsetwater(tp);
1009 }
1010
1011 /* delayed lock acquiring */
1012 mutex_spin_enter(&tty_lock);
1013 if (cmd != TIOCSETAF) {
1014 if (ISSET(t->c_lflag, ICANON) !=
1015 ISSET(tp->t_lflag, ICANON)) {
1016 if (ISSET(t->c_lflag, ICANON)) {
1017 SET(tp->t_lflag, PENDIN);
1018 ttwakeup(tp);
1019 } else {
1020 struct clist tq;
1021
1022 catq(&tp->t_rawq, &tp->t_canq);
1023 tq = tp->t_rawq;
1024 tp->t_rawq = tp->t_canq;
1025 tp->t_canq = tq;
1026 CLR(tp->t_lflag, PENDIN);
1027 }
1028 }
1029 }
1030 tp->t_iflag = t->c_iflag;
1031 tp->t_oflag = t->c_oflag;
1032 /*
1033 * Make the EXTPROC bit read only.
1034 */
1035 if (ISSET(tp->t_lflag, EXTPROC))
1036 SET(t->c_lflag, EXTPROC);
1037 else
1038 CLR(t->c_lflag, EXTPROC);
1039 tp->t_lflag = t->c_lflag | ISSET(tp->t_lflag, PENDIN);
1040 memcpy(tp->t_cc, t->c_cc, sizeof(t->c_cc));
1041 mutex_spin_exit(&tty_lock);
1042 splx(s);
1043 break;
1044 }
1045 case TIOCSETD: /* set line discipline (old) */
1046 lp = ttyldisc_lookup_bynum(*(int *)data);
1047 goto setldisc;
1048
1049 case TIOCSLINED: { /* set line discipline (new) */
1050 char *name = (char *)data;
1051 dev_t device;
1052
1053 /* Null terminate to prevent buffer overflow */
1054 name[TTLINEDNAMELEN - 1] = '\0';
1055 lp = ttyldisc_lookup(name);
1056 setldisc:
1057 if (lp == NULL)
1058 return (ENXIO);
1059
1060 if (lp != tp->t_linesw) {
1061 device = tp->t_dev;
1062 s = spltty();
1063 (*tp->t_linesw->l_close)(tp, flag);
1064 error = (*lp->l_open)(device, tp);
1065 if (error) {
1066 (void)(*tp->t_linesw->l_open)(device, tp);
1067 splx(s);
1068 ttyldisc_release(lp);
1069 return (error);
1070 }
1071 ttyldisc_release(tp->t_linesw);
1072 tp->t_linesw = lp;
1073 splx(s);
1074 } else {
1075 /* Drop extra reference. */
1076 ttyldisc_release(lp);
1077 }
1078 break;
1079 }
1080 case TIOCSTART: /* start output, like ^Q */
1081 mutex_spin_enter(&tty_lock);
1082 if (ISSET(tp->t_state, TS_TTSTOP) ||
1083 ISSET(tp->t_lflag, FLUSHO)) {
1084 CLR(tp->t_lflag, FLUSHO);
1085 CLR(tp->t_state, TS_TTSTOP);
1086 ttstart(tp);
1087 }
1088 mutex_spin_exit(&tty_lock);
1089 break;
1090 case TIOCSTI: /* simulate terminal input */
1091 if (kauth_authorize_generic(l->l_cred, KAUTH_GENERIC_ISSUSER,
1092 NULL) != 0) {
1093 if (!ISSET(flag, FREAD))
1094 return (EPERM);
1095 if (!isctty(p, tp))
1096 return (EACCES);
1097 }
1098 (*tp->t_linesw->l_rint)(*(u_char *)data, tp);
1099 break;
1100 case TIOCSTOP: /* stop output, like ^S */
1101 {
1102 mutex_spin_enter(&tty_lock);
1103 if (!ISSET(tp->t_state, TS_TTSTOP)) {
1104 SET(tp->t_state, TS_TTSTOP);
1105 cdev_stop(tp, 0);
1106 }
1107 mutex_spin_exit(&tty_lock);
1108 break;
1109 }
1110 case TIOCSCTTY: /* become controlling tty */
1111 mutex_enter(&proclist_lock);
1112
1113 /* Session ctty vnode pointer set in vnode layer. */
1114 if (!SESS_LEADER(p) ||
1115 ((p->p_session->s_ttyvp || tp->t_session) &&
1116 (tp->t_session != p->p_session))) {
1117 mutex_exit(&proclist_lock);
1118 return (EPERM);
1119 }
1120
1121 /*
1122 * `p_session' acquires a reference.
1123 * But note that if `t_session' is set at this point,
1124 * it must equal `p_session', in which case the session
1125 * already has the correct reference count.
1126 */
1127 if (tp->t_session == NULL)
1128 SESSHOLD(p->p_session);
1129
1130 tp->t_session = p->p_session;
1131 tp->t_pgrp = p->p_pgrp;
1132 p->p_session->s_ttyp = tp;
1133 p->p_lflag |= PL_CONTROLT;
1134 mutex_exit(&proclist_lock);
1135 break;
1136 case FIOSETOWN: { /* set pgrp of tty */
1137 pid_t pgid = *(int *)data;
1138 struct pgrp *pgrp;
1139
1140 if (tp->t_session != NULL && !isctty(p, tp))
1141 return (ENOTTY);
1142
1143 mutex_enter(&proclist_lock);
1144
1145 if (pgid < 0) {
1146 pgrp = pg_find(-pgid, PFIND_LOCKED | PFIND_UNLOCK_FAIL);
1147 if (pgrp == NULL)
1148 return (EINVAL);
1149 } else {
1150 struct proc *p1;
1151 p1 = p_find(pgid, PFIND_LOCKED | PFIND_UNLOCK_FAIL);
1152 if (!p1)
1153 return (ESRCH);
1154 pgrp = p1->p_pgrp;
1155 }
1156
1157 if (pgrp->pg_session != p->p_session) {
1158 mutex_exit(&proclist_lock);
1159 return (EPERM);
1160 }
1161 tp->t_pgrp = pgrp;
1162 mutex_exit(&proclist_lock);
1163 break;
1164 }
1165 case TIOCSPGRP: { /* set pgrp of tty */
1166 struct pgrp *pgrp;
1167
1168 if (!isctty(p, tp))
1169 return (ENOTTY);
1170 mutex_enter(&proclist_lock);
1171 pgrp = pg_find(*(int *)data, PFIND_LOCKED | PFIND_UNLOCK_FAIL);
1172 if (pgrp == NULL)
1173 return (EINVAL);
1174 if (pgrp->pg_session != p->p_session) {
1175 mutex_exit(&proclist_lock);
1176 return (EPERM);
1177 }
1178 tp->t_pgrp = pgrp;
1179 mutex_exit(&proclist_lock);
1180 break;
1181 }
1182 case TIOCSTAT: /* get load avg stats */
1183 mutex_spin_enter(&tty_lock);
1184 ttyinfo(tp, 0);
1185 mutex_spin_exit(&tty_lock);
1186 break;
1187 case TIOCSWINSZ: /* set window size */
1188 mutex_spin_enter(&tty_lock);
1189 if (memcmp((void *)&tp->t_winsize, data,
1190 sizeof(struct winsize))) {
1191 tp->t_winsize = *(struct winsize *)data;
1192 ttysig(tp, TTYSIG_PG1, SIGWINCH);
1193 }
1194 mutex_spin_exit(&tty_lock);
1195 break;
1196 default:
1197 #ifdef COMPAT_OLDTTY
1198 return (ttcompat(tp, cmd, data, flag, l));
1199 #else
1200 return (EPASSTHROUGH);
1201 #endif
1202 }
1203 return (0);
1204 }
1205
1206 int
1207 ttpoll(struct tty *tp, int events, struct lwp *l)
1208 {
1209 int revents;
1210
1211 revents = 0;
1212 mutex_spin_enter(&tty_lock);
1213 if (events & (POLLIN | POLLRDNORM))
1214 if (ttnread(tp) > 0)
1215 revents |= events & (POLLIN | POLLRDNORM);
1216
1217 if (events & (POLLOUT | POLLWRNORM))
1218 if (tp->t_outq.c_cc <= tp->t_lowat)
1219 revents |= events & (POLLOUT | POLLWRNORM);
1220
1221 if (events & POLLHUP)
1222 if (!CONNECTED(tp))
1223 revents |= POLLHUP;
1224
1225 if (revents == 0) {
1226 if (events & (POLLIN | POLLHUP | POLLRDNORM))
1227 selrecord(l, &tp->t_rsel);
1228
1229 if (events & (POLLOUT | POLLWRNORM))
1230 selrecord(l, &tp->t_wsel);
1231 }
1232
1233 mutex_spin_exit(&tty_lock);
1234
1235 return (revents);
1236 }
1237
1238 static void
1239 filt_ttyrdetach(struct knote *kn)
1240 {
1241 struct tty *tp;
1242
1243 tp = kn->kn_hook;
1244 mutex_spin_enter(&tty_lock);
1245 SLIST_REMOVE(&tp->t_rsel.sel_klist, kn, knote, kn_selnext);
1246 mutex_spin_exit(&tty_lock);
1247 }
1248
1249 static int
1250 filt_ttyread(struct knote *kn, long hint)
1251 {
1252 struct tty *tp;
1253
1254 tp = kn->kn_hook;
1255 if ((hint & NOTE_SUBMIT) == 0)
1256 mutex_spin_enter(&tty_lock);
1257 kn->kn_data = ttnread(tp);
1258 if ((hint & NOTE_SUBMIT) == 0)
1259 mutex_spin_exit(&tty_lock);
1260 return (kn->kn_data > 0);
1261 }
1262
1263 static void
1264 filt_ttywdetach(struct knote *kn)
1265 {
1266 struct tty *tp;
1267
1268 tp = kn->kn_hook;
1269 mutex_spin_enter(&tty_lock);
1270 SLIST_REMOVE(&tp->t_wsel.sel_klist, kn, knote, kn_selnext);
1271 mutex_spin_exit(&tty_lock);
1272 }
1273
1274 static int
1275 filt_ttywrite(struct knote *kn, long hint)
1276 {
1277 struct tty *tp;
1278 int canwrite;
1279
1280 tp = kn->kn_hook;
1281 if ((hint & NOTE_SUBMIT) == 0)
1282 mutex_spin_enter(&tty_lock);
1283 kn->kn_data = tp->t_outq.c_cn - tp->t_outq.c_cc;
1284 canwrite = (tp->t_outq.c_cc <= tp->t_lowat) && CONNECTED(tp);
1285 if ((hint & NOTE_SUBMIT) == 0)
1286 mutex_spin_exit(&tty_lock);
1287 return (canwrite);
1288 }
1289
1290 static const struct filterops ttyread_filtops =
1291 { 1, NULL, filt_ttyrdetach, filt_ttyread };
1292 static const struct filterops ttywrite_filtops =
1293 { 1, NULL, filt_ttywdetach, filt_ttywrite };
1294
1295 int
1296 ttykqfilter(dev_t dev, struct knote *kn)
1297 {
1298 struct tty *tp;
1299 struct klist *klist;
1300
1301 if ((tp = cdev_tty(dev)) == NULL)
1302 return (ENXIO);
1303
1304 switch (kn->kn_filter) {
1305 case EVFILT_READ:
1306 klist = &tp->t_rsel.sel_klist;
1307 kn->kn_fop = &ttyread_filtops;
1308 break;
1309 case EVFILT_WRITE:
1310 klist = &tp->t_wsel.sel_klist;
1311 kn->kn_fop = &ttywrite_filtops;
1312 break;
1313 default:
1314 return EINVAL;
1315 }
1316
1317 kn->kn_hook = tp;
1318
1319 mutex_spin_enter(&tty_lock);
1320 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
1321 mutex_spin_exit(&tty_lock);
1322
1323 return (0);
1324 }
1325
1326 /*
1327 * Find the number of chars ready to be read from this tty.
1328 * Call with the tty lock held.
1329 */
1330 static int
1331 ttnread(struct tty *tp)
1332 {
1333 int nread;
1334
1335 KASSERT(mutex_owned(&tty_lock));
1336
1337 if (ISSET(tp->t_lflag, PENDIN))
1338 ttypend(tp);
1339 nread = tp->t_canq.c_cc;
1340 if (!ISSET(tp->t_lflag, ICANON)) {
1341 nread += tp->t_rawq.c_cc;
1342 if (nread < tp->t_cc[VMIN] && !tp->t_cc[VTIME])
1343 nread = 0;
1344 }
1345 return (nread);
1346 }
1347
1348 /*
1349 * Wait for output to drain.
1350 */
1351 int
1352 ttywait(struct tty *tp)
1353 {
1354 int error;
1355
1356 error = 0;
1357
1358 mutex_spin_enter(&tty_lock);
1359 while ((tp->t_outq.c_cc || ISSET(tp->t_state, TS_BUSY)) &&
1360 CONNECTED(tp) && tp->t_oproc) {
1361 (*tp->t_oproc)(tp);
1362 SET(tp->t_state, TS_ASLEEP);
1363 error = ttysleep(tp, &tp->t_outq.c_cv, true, 0);
1364 if (error)
1365 break;
1366 }
1367 mutex_spin_exit(&tty_lock);
1368
1369 return (error);
1370 }
1371
1372 /*
1373 * Flush if successfully wait.
1374 */
1375 int
1376 ttywflush(struct tty *tp)
1377 {
1378 int error;
1379
1380 if ((error = ttywait(tp)) == 0) {
1381 mutex_spin_enter(&tty_lock);
1382 ttyflush(tp, FREAD);
1383 mutex_spin_exit(&tty_lock);
1384 }
1385 return (error);
1386 }
1387
1388 /*
1389 * Flush tty read and/or write queues, notifying anyone waiting.
1390 * Call with the tty lock held.
1391 */
1392 void
1393 ttyflush(struct tty *tp, int rw)
1394 {
1395
1396 KASSERT(mutex_owned(&tty_lock));
1397
1398 if (rw & FREAD) {
1399 FLUSHQ(&tp->t_canq);
1400 FLUSHQ(&tp->t_rawq);
1401 tp->t_rocount = 0;
1402 tp->t_rocol = 0;
1403 CLR(tp->t_state, TS_LOCAL);
1404 ttwakeup(tp);
1405 }
1406 if (rw & FWRITE) {
1407 CLR(tp->t_state, TS_TTSTOP);
1408 cdev_stop(tp, rw);
1409 FLUSHQ(&tp->t_outq);
1410 cv_broadcast(&tp->t_outq.c_cv);
1411 selnotify(&tp->t_wsel, NOTE_SUBMIT);
1412 }
1413 }
1414
1415 /*
1416 * Copy in the default termios characters.
1417 */
1418 void
1419 ttychars(struct tty *tp)
1420 {
1421
1422 memcpy(tp->t_cc, ttydefchars, sizeof(ttydefchars));
1423 }
1424
1425 /*
1426 * Send stop character on input overflow.
1427 * Call withthe tty lock held.
1428 */
1429 static void
1430 ttyblock(struct tty *tp)
1431 {
1432 int total;
1433
1434 KASSERT(mutex_owned(&tty_lock));
1435
1436 total = tp->t_rawq.c_cc + tp->t_canq.c_cc;
1437 if (tp->t_rawq.c_cc > TTYHOG) {
1438 ttyflush(tp, FREAD | FWRITE);
1439 CLR(tp->t_state, TS_TBLOCK);
1440 }
1441 /*
1442 * Block further input iff: current input > threshold
1443 * AND input is available to user program.
1444 */
1445 if (total >= TTYHOG / 2 &&
1446 !ISSET(tp->t_state, TS_TBLOCK) &&
1447 (!ISSET(tp->t_lflag, ICANON) || tp->t_canq.c_cc > 0)) {
1448 if (ISSET(tp->t_iflag, IXOFF) &&
1449 tp->t_cc[VSTOP] != _POSIX_VDISABLE &&
1450 putc(tp->t_cc[VSTOP], &tp->t_outq) == 0) {
1451 SET(tp->t_state, TS_TBLOCK);
1452 ttstart(tp);
1453 }
1454 /* Try to block remote output via hardware flow control. */
1455 if (ISSET(tp->t_cflag, CHWFLOW) && tp->t_hwiflow &&
1456 (*tp->t_hwiflow)(tp, 1) != 0)
1457 SET(tp->t_state, TS_TBLOCK);
1458 }
1459 }
1460
1461 /*
1462 * Delayed line discipline output
1463 */
1464 void
1465 ttrstrt(void *tp_arg)
1466 {
1467 struct tty *tp;
1468
1469 #ifdef DIAGNOSTIC
1470 if (tp_arg == NULL)
1471 panic("ttrstrt");
1472 #endif
1473 tp = tp_arg;
1474 mutex_spin_enter(&tty_lock);
1475
1476 CLR(tp->t_state, TS_TIMEOUT);
1477 ttstart(tp); /* XXX - Shouldn't this be tp->l_start(tp)? */
1478
1479 mutex_spin_exit(&tty_lock);
1480 }
1481
1482 /*
1483 * start a line discipline
1484 * Always call with tty lock held?
1485 */
1486 int
1487 ttstart(struct tty *tp)
1488 {
1489
1490 if (tp->t_oproc != NULL) /* XXX: Kludge for pty. */
1491 (*tp->t_oproc)(tp);
1492 return (0);
1493 }
1494
1495 /*
1496 * "close" a line discipline
1497 */
1498 int
1499 ttylclose(struct tty *tp, int flag)
1500 {
1501
1502 if (flag & FNONBLOCK) {
1503 mutex_spin_enter(&tty_lock);
1504 ttyflush(tp, FREAD | FWRITE);
1505 mutex_spin_exit(&tty_lock);
1506 } else
1507 ttywflush(tp);
1508 return (0);
1509 }
1510
1511 /*
1512 * Handle modem control transition on a tty.
1513 * Flag indicates new state of carrier.
1514 * Returns 0 if the line should be turned off, otherwise 1.
1515 */
1516 int
1517 ttymodem(struct tty *tp, int flag)
1518 {
1519
1520 mutex_spin_enter(&tty_lock);
1521 if (flag == 0) {
1522 if (ISSET(tp->t_state, TS_CARR_ON)) {
1523 /*
1524 * Lost carrier.
1525 */
1526 CLR(tp->t_state, TS_CARR_ON);
1527 if (ISSET(tp->t_state, TS_ISOPEN) && !CONNECTED(tp)) {
1528 ttysig(tp, TTYSIG_LEADER, SIGHUP);
1529 ttyflush(tp, FREAD | FWRITE);
1530 mutex_spin_exit(&tty_lock);
1531 return (0);
1532 }
1533 }
1534 } else {
1535 if (!ISSET(tp->t_state, TS_CARR_ON)) {
1536 /*
1537 * Carrier now on.
1538 */
1539 SET(tp->t_state, TS_CARR_ON);
1540 ttwakeup(tp);
1541 }
1542 }
1543 mutex_spin_exit(&tty_lock);
1544
1545 return (1);
1546 }
1547
1548 /*
1549 * Default modem control routine (for other line disciplines).
1550 * Return argument flag, to turn off device on carrier drop.
1551 */
1552 int
1553 nullmodem(struct tty *tp, int flag)
1554 {
1555
1556 mutex_spin_enter(&tty_lock);
1557 if (flag)
1558 SET(tp->t_state, TS_CARR_ON);
1559 else {
1560 CLR(tp->t_state, TS_CARR_ON);
1561 if (!CONNECTED(tp)) {
1562 ttysig(tp, TTYSIG_LEADER, SIGHUP);
1563 mutex_spin_exit(&tty_lock);
1564 return (0);
1565 }
1566 }
1567 mutex_spin_exit(&tty_lock);
1568
1569 return (1);
1570 }
1571
1572 /*
1573 * Reinput pending characters after state switch.
1574 */
1575 void
1576 ttypend(struct tty *tp)
1577 {
1578 struct clist tq;
1579 int c;
1580
1581 KASSERT(mutex_owned(&tty_lock));
1582
1583 CLR(tp->t_lflag, PENDIN);
1584 SET(tp->t_state, TS_TYPEN);
1585 tq = tp->t_rawq;
1586 tp->t_rawq.c_cc = 0;
1587 tp->t_rawq.c_cf = tp->t_rawq.c_cl = 0;
1588 while ((c = getc(&tq)) >= 0)
1589 ttyinput_wlock(c, tp);
1590 CLR(tp->t_state, TS_TYPEN);
1591 }
1592
1593 /*
1594 * Process a read call on a tty device.
1595 */
1596 int
1597 ttread(struct tty *tp, struct uio *uio, int flag)
1598 {
1599 struct clist *qp;
1600 u_char *cc;
1601 struct proc *p;
1602 int c, first, error, has_stime, last_cc;
1603 long lflag, slp;
1604 struct timeval now, stime;
1605
1606 stime.tv_usec = 0; /* XXX gcc */
1607 stime.tv_sec = 0; /* XXX gcc */
1608
1609 cc = tp->t_cc;
1610 p = curproc;
1611 error = 0;
1612 has_stime = 0;
1613 last_cc = 0;
1614 slp = 0;
1615
1616 loop:
1617 mutex_spin_enter(&tty_lock);
1618 lflag = tp->t_lflag;
1619 /*
1620 * take pending input first
1621 */
1622 if (ISSET(lflag, PENDIN))
1623 ttypend(tp);
1624
1625 /*
1626 * Hang process if it's in the background. XXXSMP
1627 */
1628 if (isbackground(p, tp)) {
1629 if (sigismember(&p->p_sigctx.ps_sigignore, SIGTTIN) ||
1630 sigismember(&curlwp->l_sigmask, SIGTTIN) ||
1631 p->p_sflag & PS_PPWAIT || p->p_pgrp->pg_jobc == 0) {
1632 mutex_spin_exit(&tty_lock);
1633 return (EIO);
1634 }
1635 ttysig(tp, TTYSIG_PG1, SIGTTIN);
1636 error = ttysleep(tp, &lbolt, true, 0);
1637 mutex_spin_exit(&tty_lock);
1638 if (error)
1639 return (error);
1640 goto loop;
1641 }
1642
1643 if (!ISSET(lflag, ICANON)) {
1644 int m = cc[VMIN];
1645 long t = cc[VTIME];
1646
1647 qp = &tp->t_rawq;
1648 /*
1649 * Check each of the four combinations.
1650 * (m > 0 && t == 0) is the normal read case.
1651 * It should be fairly efficient, so we check that and its
1652 * companion case (m == 0 && t == 0) first.
1653 * For the other two cases, we compute the target sleep time
1654 * into slp.
1655 */
1656 if (t == 0) {
1657 if (qp->c_cc < m)
1658 goto sleep;
1659 goto read;
1660 }
1661 t *= hz; /* time in deca-ticks */
1662 /*
1663 * Time difference in deca-ticks, split division to avoid numeric overflow.
1664 * Ok for hz < ~200kHz
1665 */
1666 #define diff(t1, t2) (((t1).tv_sec - (t2).tv_sec) * 10 * hz + \
1667 ((t1).tv_usec - (t2).tv_usec) / 100 * hz / 1000)
1668 if (m > 0) {
1669 if (qp->c_cc <= 0)
1670 goto sleep;
1671 if (qp->c_cc >= m)
1672 goto read;
1673 if (!has_stime) {
1674 /* first character, start timer */
1675 has_stime = 1;
1676 getmicrotime(&stime);
1677 slp = t;
1678 } else if (qp->c_cc > last_cc) {
1679 /* got a character, restart timer */
1680 getmicrotime(&stime);
1681 slp = t;
1682 } else {
1683 /* nothing, check expiration */
1684 getmicrotime(&now);
1685 slp = t - diff(now, stime);
1686 }
1687 } else { /* m == 0 */
1688 if (qp->c_cc > 0)
1689 goto read;
1690 if (!has_stime) {
1691 has_stime = 1;
1692 getmicrotime(&stime);
1693 slp = t;
1694 } else {
1695 getmicrotime(&now);
1696 slp = t - diff(now, stime);
1697 }
1698 }
1699 last_cc = qp->c_cc;
1700 #undef diff
1701 if (slp > 0) {
1702 /*
1703 * Convert deca-ticks back to ticks.
1704 * Rounding down may make us wake up just short
1705 * of the target, so we round up.
1706 * Maybe we should do 'slp/10 + 1' because the
1707 * first tick maybe almost immediate.
1708 * However it is more useful for a program that sets
1709 * VTIME=10 to wakeup every second not every 1.01
1710 * seconds (if hz=100).
1711 */
1712 slp = (slp + 9)/ 10;
1713 goto sleep;
1714 }
1715 } else if ((qp = &tp->t_canq)->c_cc <= 0) {
1716 int carrier;
1717
1718 sleep:
1719 /*
1720 * If there is no input, sleep on rawq
1721 * awaiting hardware receipt and notification.
1722 * If we have data, we don't need to check for carrier.
1723 */
1724 carrier = CONNECTED(tp);
1725 if (!carrier && ISSET(tp->t_state, TS_ISOPEN)) {
1726 mutex_spin_exit(&tty_lock);
1727 return (0); /* EOF */
1728 }
1729 if (flag & IO_NDELAY) {
1730 mutex_spin_exit(&tty_lock);
1731 return (EWOULDBLOCK);
1732 }
1733 error = ttysleep(tp, &tp->t_rawq.c_cv, true, slp);
1734 mutex_spin_exit(&tty_lock);
1735 /* VMIN == 0: any quantity read satisfies */
1736 if (cc[VMIN] == 0 && error == EWOULDBLOCK)
1737 return (0);
1738 if (error && error != EWOULDBLOCK)
1739 return (error);
1740 goto loop;
1741 }
1742 read:
1743 mutex_spin_exit(&tty_lock);
1744
1745 /*
1746 * Input present, check for input mapping and processing.
1747 */
1748 first = 1;
1749 while ((c = getc(qp)) >= 0) {
1750 /*
1751 * delayed suspend (^Y)
1752 */
1753 if (CCEQ(cc[VDSUSP], c) &&
1754 ISSET(lflag, IEXTEN|ISIG) == (IEXTEN|ISIG)) {
1755 mutex_spin_enter(&tty_lock);
1756 ttysig(tp, TTYSIG_PG1, SIGTSTP);
1757 if (first) {
1758 error = ttysleep(tp, &lbolt, true, 0);
1759 mutex_spin_exit(&tty_lock);
1760 if (error)
1761 break;
1762 goto loop;
1763 } else
1764 mutex_spin_exit(&tty_lock);
1765 break;
1766 }
1767 /*
1768 * Interpret EOF only in canonical mode.
1769 */
1770 if (CCEQ(cc[VEOF], c) && ISSET(lflag, ICANON))
1771 break;
1772 /*
1773 * Give user character.
1774 */
1775 error = ureadc(c, uio);
1776 if (error)
1777 break;
1778 if (uio->uio_resid == 0)
1779 break;
1780 /*
1781 * In canonical mode check for a "break character"
1782 * marking the end of a "line of input".
1783 */
1784 if (ISSET(lflag, ICANON) && TTBREAKC(c, lflag))
1785 break;
1786 first = 0;
1787 }
1788 /*
1789 * Look to unblock output now that (presumably)
1790 * the input queue has gone down.
1791 */
1792 mutex_spin_enter(&tty_lock);
1793 if (ISSET(tp->t_state, TS_TBLOCK) && tp->t_rawq.c_cc < TTYHOG / 5) {
1794 if (ISSET(tp->t_iflag, IXOFF) &&
1795 cc[VSTART] != _POSIX_VDISABLE &&
1796 putc(cc[VSTART], &tp->t_outq) == 0) {
1797 CLR(tp->t_state, TS_TBLOCK);
1798 ttstart(tp);
1799 }
1800 /* Try to unblock remote output via hardware flow control. */
1801 if (ISSET(tp->t_cflag, CHWFLOW) && tp->t_hwiflow &&
1802 (*tp->t_hwiflow)(tp, 0) != 0)
1803 CLR(tp->t_state, TS_TBLOCK);
1804 }
1805 mutex_spin_exit(&tty_lock);
1806
1807 return (error);
1808 }
1809
1810 /*
1811 * Check the output queue on tp for space for a kernel message (from uprintf
1812 * or tprintf). Allow some space over the normal hiwater mark so we don't
1813 * lose messages due to normal flow control, but don't let the tty run amok.
1814 * Sleeps here are not interruptible, but we return prematurely if new signals
1815 * arrive.
1816 * Call with tty lock held.
1817 */
1818 static int
1819 ttycheckoutq_wlock(struct tty *tp, int wait)
1820 {
1821 int hiwat, error;
1822
1823 KASSERT(mutex_owned(&tty_lock));
1824
1825 hiwat = tp->t_hiwat;
1826 if (tp->t_outq.c_cc > hiwat + 200)
1827 while (tp->t_outq.c_cc > hiwat) {
1828 ttstart(tp);
1829 if (wait == 0)
1830 return (0);
1831 SET(tp->t_state, TS_ASLEEP);
1832 error = ttysleep(tp, &tp->t_outq.c_cv, true, hz);
1833 if (error == EINTR)
1834 wait = 0;
1835 }
1836
1837 return (1);
1838 }
1839
1840 int
1841 ttycheckoutq(struct tty *tp, int wait)
1842 {
1843 int r;
1844
1845 mutex_spin_enter(&tty_lock);
1846 r = ttycheckoutq_wlock(tp, wait);
1847 mutex_spin_exit(&tty_lock);
1848
1849 return (r);
1850 }
1851
1852 /*
1853 * Process a write call on a tty device.
1854 */
1855 int
1856 ttwrite(struct tty *tp, struct uio *uio, int flag)
1857 {
1858 u_char *cp;
1859 struct proc *p;
1860 int cc, ce, i, hiwat, error;
1861 size_t cnt;
1862 u_char obuf[OBUFSIZ];
1863
1864 cp = NULL;
1865 hiwat = tp->t_hiwat;
1866 cnt = uio->uio_resid;
1867 error = 0;
1868 cc = 0;
1869 loop:
1870 mutex_spin_enter(&tty_lock);
1871 if (!CONNECTED(tp)) {
1872 if (ISSET(tp->t_state, TS_ISOPEN)) {
1873 mutex_spin_exit(&tty_lock);
1874 return (EIO);
1875 } else if (flag & IO_NDELAY) {
1876 mutex_spin_exit(&tty_lock);
1877 error = EWOULDBLOCK;
1878 goto out;
1879 } else {
1880 /* Sleep awaiting carrier. */
1881 error = ttysleep(tp, &tp->t_rawq.c_cv, true, 0);
1882 mutex_spin_exit(&tty_lock);
1883 if (error)
1884 goto out;
1885 goto loop;
1886 }
1887 }
1888 mutex_spin_exit(&tty_lock);
1889 /*
1890 * Hang the process if it's in the background. XXXSMP
1891 */
1892 p = curproc;
1893 if (isbackground(p, tp) &&
1894 ISSET(tp->t_lflag, TOSTOP) && (p->p_sflag & PS_PPWAIT) == 0 &&
1895 !sigismember(&p->p_sigctx.ps_sigignore, SIGTTOU) &&
1896 !sigismember(&curlwp->l_sigmask, SIGTTOU)) {
1897 if (p->p_pgrp->pg_jobc == 0) {
1898 error = EIO;
1899 goto out;
1900 }
1901 mutex_spin_enter(&tty_lock);
1902 ttysig(tp, TTYSIG_PG1, SIGTTOU);
1903 error = ttysleep(tp, &lbolt, true, 0);
1904 mutex_spin_exit(&tty_lock);
1905 if (error)
1906 goto out;
1907 goto loop;
1908 }
1909 /*
1910 * Process the user's data in at most OBUFSIZ chunks. Perform any
1911 * output translation. Keep track of high water mark, sleep on
1912 * overflow awaiting device aid in acquiring new space.
1913 */
1914 while (uio->uio_resid > 0 || cc > 0) {
1915 if (ISSET(tp->t_lflag, FLUSHO)) {
1916 uio->uio_resid = 0;
1917 return (0);
1918 }
1919 if (tp->t_outq.c_cc > hiwat)
1920 goto ovhiwat;
1921 /*
1922 * Grab a hunk of data from the user, unless we have some
1923 * leftover from last time.
1924 */
1925 if (cc == 0) {
1926 cc = min(uio->uio_resid, OBUFSIZ);
1927 cp = obuf;
1928 error = uiomove(cp, cc, uio);
1929 if (error) {
1930 cc = 0;
1931 goto out;
1932 }
1933 }
1934 /*
1935 * If nothing fancy need be done, grab those characters we
1936 * can handle without any of ttyoutput's processing and
1937 * just transfer them to the output q. For those chars
1938 * which require special processing (as indicated by the
1939 * bits in char_type), call ttyoutput. After processing
1940 * a hunk of data, look for FLUSHO so ^O's will take effect
1941 * immediately.
1942 */
1943 mutex_spin_enter(&tty_lock);
1944 while (cc > 0) {
1945 if (!ISSET(tp->t_oflag, OPOST))
1946 ce = cc;
1947 else {
1948 ce = cc - scanc((u_int)cc, cp, char_type,
1949 CCLASSMASK);
1950 /*
1951 * If ce is zero, then we're processing
1952 * a special character through ttyoutput.
1953 */
1954 if (ce == 0) {
1955 tp->t_rocount = 0;
1956 if (ttyoutput(*cp, tp) >= 0) {
1957 /* out of space */
1958 mutex_spin_exit(&tty_lock);
1959 goto overfull;
1960 }
1961 cp++;
1962 cc--;
1963 if (ISSET(tp->t_lflag, FLUSHO) ||
1964 tp->t_outq.c_cc > hiwat) {
1965 mutex_spin_exit(&tty_lock);
1966 goto ovhiwat;
1967 }
1968 continue;
1969 }
1970 }
1971 /*
1972 * A bunch of normal characters have been found.
1973 * Transfer them en masse to the output queue and
1974 * continue processing at the top of the loop.
1975 * If there are any further characters in this
1976 * <= OBUFSIZ chunk, the first should be a character
1977 * requiring special handling by ttyoutput.
1978 */
1979 tp->t_rocount = 0;
1980 i = b_to_q(cp, ce, &tp->t_outq);
1981 ce -= i;
1982 tp->t_column += ce;
1983 cp += ce, cc -= ce, tk_nout += ce;
1984 tp->t_outcc += ce;
1985 if (i > 0) {
1986 /* out of space */
1987 mutex_spin_exit(&tty_lock);
1988 goto overfull;
1989 }
1990 if (ISSET(tp->t_lflag, FLUSHO) ||
1991 tp->t_outq.c_cc > hiwat)
1992 break;
1993 }
1994 mutex_spin_exit(&tty_lock);
1995 ttstart(tp);
1996 }
1997
1998 out:
1999 /*
2000 * If cc is nonzero, we leave the uio structure inconsistent, as the
2001 * offset and iov pointers have moved forward, but it doesn't matter
2002 * (the call will either return short or restart with a new uio).
2003 */
2004 uio->uio_resid += cc;
2005 return (error);
2006
2007 overfull:
2008 /*
2009 * Since we are using ring buffers, if we can't insert any more into
2010 * the output queue, we can assume the ring is full and that someone
2011 * forgot to set the high water mark correctly. We set it and then
2012 * proceed as normal.
2013 */
2014 hiwat = tp->t_outq.c_cc - 1;
2015
2016 ovhiwat:
2017 ttstart(tp);
2018 mutex_spin_enter(&tty_lock);
2019 /*
2020 * This can only occur if FLUSHO is set in t_lflag,
2021 * or if ttstart/oproc is synchronous (or very fast).
2022 */
2023 if (tp->t_outq.c_cc <= hiwat) {
2024 mutex_spin_exit(&tty_lock);
2025 goto loop;
2026 }
2027 if (flag & IO_NDELAY) {
2028 mutex_spin_exit(&tty_lock);
2029 error = EWOULDBLOCK;
2030 goto out;
2031 }
2032 SET(tp->t_state, TS_ASLEEP);
2033 error = ttysleep(tp, &tp->t_outq.c_cv, true, 0);
2034 mutex_spin_exit(&tty_lock);
2035 if (error)
2036 goto out;
2037 goto loop;
2038 }
2039
2040 /*
2041 * Rubout one character from the rawq of tp
2042 * as cleanly as possible.
2043 * Called with tty lock held.
2044 */
2045 void
2046 ttyrub(int c, struct tty *tp)
2047 {
2048 u_char *cp;
2049 int savecol, tabc;
2050
2051 KASSERT(mutex_owned(&tty_lock));
2052
2053 if (!ISSET(tp->t_lflag, ECHO) || ISSET(tp->t_lflag, EXTPROC))
2054 return;
2055 CLR(tp->t_lflag, FLUSHO);
2056 if (ISSET(tp->t_lflag, ECHOE)) {
2057 if (tp->t_rocount == 0) {
2058 /*
2059 * Screwed by ttwrite; retype
2060 */
2061 ttyretype(tp);
2062 return;
2063 }
2064 if (c == ('\t' | TTY_QUOTE) || c == ('\n' | TTY_QUOTE))
2065 ttyrubo(tp, 2);
2066 else {
2067 CLR(c, ~TTY_CHARMASK);
2068 switch (CCLASS(c)) {
2069 case ORDINARY:
2070 ttyrubo(tp, 1);
2071 break;
2072 case BACKSPACE:
2073 case CONTROL:
2074 case NEWLINE:
2075 case RETURN:
2076 case VTAB:
2077 if (ISSET(tp->t_lflag, ECHOCTL))
2078 ttyrubo(tp, 2);
2079 break;
2080 case TAB:
2081 if (tp->t_rocount < tp->t_rawq.c_cc) {
2082 ttyretype(tp);
2083 return;
2084 }
2085 savecol = tp->t_column;
2086 SET(tp->t_state, TS_CNTTB);
2087 SET(tp->t_lflag, FLUSHO);
2088 tp->t_column = tp->t_rocol;
2089 for (cp = firstc(&tp->t_rawq, &tabc); cp;
2090 cp = nextc(&tp->t_rawq, cp, &tabc))
2091 ttyecho(tabc, tp);
2092 CLR(tp->t_lflag, FLUSHO);
2093 CLR(tp->t_state, TS_CNTTB);
2094
2095 /* savecol will now be length of the tab. */
2096 savecol -= tp->t_column;
2097 tp->t_column += savecol;
2098 if (savecol > 8)
2099 savecol = 8; /* overflow screw */
2100 while (--savecol >= 0)
2101 (void)ttyoutput('\b', tp);
2102 break;
2103 default: /* XXX */
2104 (void)printf("ttyrub: would panic c = %d, "
2105 "val = %d\n", c, CCLASS(c));
2106 }
2107 }
2108 } else if (ISSET(tp->t_lflag, ECHOPRT)) {
2109 if (!ISSET(tp->t_state, TS_ERASE)) {
2110 SET(tp->t_state, TS_ERASE);
2111 (void)ttyoutput('\\', tp);
2112 }
2113 ttyecho(c, tp);
2114 } else
2115 ttyecho(tp->t_cc[VERASE], tp);
2116 --tp->t_rocount;
2117 }
2118
2119 /*
2120 * Back over cnt characters, erasing them.
2121 * Called with tty lock held.
2122 */
2123 static void
2124 ttyrubo(struct tty *tp, int cnt)
2125 {
2126
2127 KASSERT(mutex_owned(&tty_lock));
2128
2129 while (cnt-- > 0) {
2130 (void)ttyoutput('\b', tp);
2131 (void)ttyoutput(' ', tp);
2132 (void)ttyoutput('\b', tp);
2133 }
2134 }
2135
2136 /*
2137 * ttyretype --
2138 * Reprint the rawq line. Note, it is assumed that c_cc has already
2139 * been checked.
2140 *
2141 * Called with tty lock held.
2142 */
2143 void
2144 ttyretype(struct tty *tp)
2145 {
2146 u_char *cp;
2147 int c;
2148
2149 KASSERT(mutex_owned(&tty_lock));
2150
2151 /* Echo the reprint character. */
2152 if (tp->t_cc[VREPRINT] != _POSIX_VDISABLE)
2153 ttyecho(tp->t_cc[VREPRINT], tp);
2154
2155 (void)ttyoutput('\n', tp);
2156
2157 for (cp = firstc(&tp->t_canq, &c); cp; cp = nextc(&tp->t_canq, cp, &c))
2158 ttyecho(c, tp);
2159 for (cp = firstc(&tp->t_rawq, &c); cp; cp = nextc(&tp->t_rawq, cp, &c))
2160 ttyecho(c, tp);
2161 CLR(tp->t_state, TS_ERASE);
2162
2163 tp->t_rocount = tp->t_rawq.c_cc;
2164 tp->t_rocol = 0;
2165 }
2166
2167 /*
2168 * Echo a typed character to the terminal.
2169 * Called with tty lock held.
2170 */
2171 static void
2172 ttyecho(int c, struct tty *tp)
2173 {
2174
2175 KASSERT(mutex_owned(&tty_lock));
2176
2177 if (!ISSET(tp->t_state, TS_CNTTB))
2178 CLR(tp->t_lflag, FLUSHO);
2179 if ((!ISSET(tp->t_lflag, ECHO) &&
2180 (!ISSET(tp->t_lflag, ECHONL) || c != '\n')) ||
2181 ISSET(tp->t_lflag, EXTPROC))
2182 return;
2183 if (((ISSET(tp->t_lflag, ECHOCTL) &&
2184 (ISSET(c, TTY_CHARMASK) <= 037 && c != '\t' && c != '\n')) ||
2185 ISSET(c, TTY_CHARMASK) == 0177)) {
2186 (void)ttyoutput('^', tp);
2187 CLR(c, ~TTY_CHARMASK);
2188 if (c == 0177)
2189 c = '?';
2190 else
2191 c += 'A' - 1;
2192 }
2193 (void)ttyoutput(c, tp);
2194 }
2195
2196 /*
2197 * Wake up any readers on a tty.
2198 * Called with tty lock held.
2199 */
2200 void
2201 ttwakeup(struct tty *tp)
2202 {
2203
2204 KASSERT(mutex_owned(&tty_lock));
2205
2206 selnotify(&tp->t_rsel, NOTE_SUBMIT);
2207 if (ISSET(tp->t_state, TS_ASYNC))
2208 ttysig(tp, TTYSIG_PG2, SIGIO);
2209 cv_broadcast(&tp->t_rawq.c_cv);
2210 }
2211
2212 /*
2213 * Look up a code for a specified speed in a conversion table;
2214 * used by drivers to map software speed values to hardware parameters.
2215 */
2216 int
2217 ttspeedtab(int speed, const struct speedtab *table)
2218 {
2219
2220 for (; table->sp_speed != -1; table++)
2221 if (table->sp_speed == speed)
2222 return (table->sp_code);
2223 return (-1);
2224 }
2225
2226 /*
2227 * Set tty hi and low water marks.
2228 *
2229 * Try to arrange the dynamics so there's about one second
2230 * from hi to low water.
2231 */
2232 void
2233 ttsetwater(struct tty *tp)
2234 {
2235 int cps, x;
2236
2237 /* XXX not yet KASSERT(mutex_owned(&tty_lock)); */
2238
2239 #define CLAMP(x, h, l) ((x) > h ? h : ((x) < l) ? l : (x))
2240
2241 cps = tp->t_ospeed / 10;
2242 tp->t_lowat = x = CLAMP(cps / 2, TTMAXLOWAT, TTMINLOWAT);
2243 x += cps;
2244 x = CLAMP(x, TTMAXHIWAT, TTMINHIWAT);
2245 tp->t_hiwat = roundup(x, CBSIZE);
2246 #undef CLAMP
2247 }
2248
2249 /*
2250 * Report on state of foreground process group.
2251 * Call with tty lock held.
2252 * XXXSMP locking.
2253 */
2254 void
2255 ttyinfo(struct tty *tp, int fromsig)
2256 {
2257 struct lwp *l;
2258 struct proc *p, *pick = NULL;
2259 struct timeval utime, stime;
2260 int tmp;
2261 fixpt_t pctcpu = 0;
2262 const char *msg;
2263
2264 if (ttycheckoutq_wlock(tp, 0) == 0)
2265 return;
2266
2267 if (tp->t_session == NULL)
2268 msg = "not a controlling terminal\n";
2269 else if (tp->t_pgrp == NULL)
2270 msg = "no foreground process group\n";
2271 else if ((p = LIST_FIRST(&tp->t_pgrp->pg_members)) == NULL)
2272 msg = "empty foreground process group\n";
2273 else {
2274 /* Pick interesting process. */
2275 for (; p != NULL; p = LIST_NEXT(p, p_pglist))
2276 if (proc_compare(pick, p))
2277 pick = p;
2278 if (fromsig &&
2279 (SIGACTION_PS(pick->p_sigacts, SIGINFO).sa_flags &
2280 SA_NOKERNINFO))
2281 return;
2282 msg = NULL;
2283 }
2284
2285 /* Print load average. */
2286 tmp = (averunnable.ldavg[0] * 100 + FSCALE / 2) >> FSHIFT;
2287 ttyprintf_nolock(tp, "load: %d.%02d ", tmp / 100, tmp % 100);
2288
2289 if (pick == NULL) {
2290 ttyprintf_nolock(tp, msg);
2291 tp->t_rocount = 0; /* so pending input will be retyped if BS */
2292 return;
2293 }
2294
2295 ttyprintf_nolock(tp, " cmd: %s %d [", pick->p_comm, pick->p_pid);
2296 LIST_FOREACH(l, &pick->p_lwps, l_sibling) {
2297 ttyprintf_nolock(tp, "%s%s",
2298 l->l_stat == LSONPROC ? "running" :
2299 l->l_stat == LSRUN ? "runnable" :
2300 l->l_wmesg ? l->l_wmesg : "iowait",
2301 (LIST_NEXT(l, l_sibling) != NULL) ? " " : "] ");
2302 pctcpu += l->l_pctcpu;
2303 }
2304 pctcpu += pick->p_pctcpu;
2305
2306 mutex_enter(&pick->p_smutex);
2307 calcru(pick, &utime, &stime, NULL, NULL);
2308 mutex_exit(&pick->p_smutex);
2309
2310 /* Round up and print user time. */
2311 utime.tv_usec += 5000;
2312 if (utime.tv_usec >= 1000000) {
2313 utime.tv_sec += 1;
2314 utime.tv_usec -= 1000000;
2315 }
2316 ttyprintf_nolock(tp, "%ld.%02ldu ", (long int)utime.tv_sec,
2317 (long int)utime.tv_usec / 10000);
2318
2319 /* Round up and print system time. */
2320 stime.tv_usec += 5000;
2321 if (stime.tv_usec >= 1000000) {
2322 stime.tv_sec += 1;
2323 stime.tv_usec -= 1000000;
2324 }
2325 ttyprintf_nolock(tp, "%ld.%02lds ", (long int)stime.tv_sec,
2326 (long int)stime.tv_usec / 10000);
2327
2328 #define pgtok(a) (((u_long) ((a) * PAGE_SIZE) / 1024))
2329 /* Print percentage CPU. */
2330 tmp = (pctcpu * 10000 + FSCALE / 2) >> FSHIFT;
2331 ttyprintf_nolock(tp, "%d%% ", tmp / 100);
2332
2333 /* Print resident set size. */
2334 if (pick->p_stat == SIDL || P_ZOMBIE(pick))
2335 tmp = 0;
2336 else {
2337 struct vmspace *vm = pick->p_vmspace;
2338 tmp = pgtok(vm_resident_count(vm));
2339 }
2340 ttyprintf_nolock(tp, "%dk\n", tmp);
2341 tp->t_rocount = 0; /* so pending input will be retyped if BS */
2342 }
2343
2344 /*
2345 * Returns 1 if p2 is "better" than p1
2346 *
2347 * The algorithm for picking the "interesting" process is thus:
2348 *
2349 * 1) Only foreground processes are eligible - implied.
2350 * 2) Runnable processes are favored over anything else. The runner
2351 * with the highest CPU utilization is picked (l_pctcpu). Ties are
2352 * broken by picking the highest pid.
2353 * 3) The sleeper with the shortest sleep time is next. With ties,
2354 * we pick out just "short-term" sleepers (P_SINTR == 0).
2355 * 4) Further ties are broken by picking the highest pid.
2356 *
2357 * XXXSMP
2358 */
2359 #define ISRUN(p) ((p)->p_nrlwps > 0)
2360 #define TESTAB(a, b) ((a)<<1 | (b))
2361 #define ONLYA 2
2362 #define ONLYB 1
2363 #define BOTH 3
2364
2365 static int
2366 proc_compare(struct proc *p1, struct proc *p2)
2367 {
2368 lwp_t *l1, *l2;
2369
2370 if (p1 == NULL)
2371 return (1);
2372 /*
2373 * see if at least one of them is runnable
2374 */
2375 switch (TESTAB(ISRUN(p1), ISRUN(p2))) {
2376 case ONLYA:
2377 return (0);
2378 case ONLYB:
2379 return (1);
2380 case BOTH:
2381 /*
2382 * tie - favor one with highest recent CPU utilization
2383 */
2384 l1 = LIST_FIRST(&p1->p_lwps);
2385 l2 = LIST_FIRST(&p2->p_lwps);
2386 if (l2->l_pctcpu > l1->l_pctcpu)
2387 return (1);
2388 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2389 }
2390 /*
2391 * weed out zombies
2392 */
2393 switch (TESTAB(P_ZOMBIE(p1), P_ZOMBIE(p2))) {
2394 case ONLYA:
2395 return (1);
2396 case ONLYB:
2397 return (0);
2398 case BOTH:
2399 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2400 }
2401 #if 0 /* XXX NJWLWP */
2402 /*
2403 * pick the one with the smallest sleep time
2404 */
2405 if (p2->p_slptime > p1->p_slptime)
2406 return (0);
2407 if (p1->p_slptime > p2->p_slptime)
2408 return (1);
2409 /*
2410 * favor one sleeping in a non-interruptible sleep
2411 */
2412 if (p1->p_flag & P_SINTR && (p2->p_flag & P_SINTR) == 0)
2413 return (1);
2414 if (p2->p_flag & P_SINTR && (p1->p_flag & P_SINTR) == 0)
2415 return (0);
2416 #endif
2417 return (p2->p_pid > p1->p_pid); /* tie - return highest pid */
2418 }
2419
2420 /*
2421 * Output char to tty; console putchar style.
2422 * Can be called with tty lock held through kprintf() machinery..
2423 */
2424 int
2425 tputchar(int c, int flags, struct tty *tp)
2426 {
2427 int r = 0;
2428
2429 if ((flags & NOLOCK) == 0)
2430 mutex_spin_enter(&tty_lock);
2431 if (!CONNECTED(tp)) {
2432 r = -1;
2433 goto out;
2434 }
2435 if (c == '\n')
2436 (void)ttyoutput('\r', tp);
2437 (void)ttyoutput(c, tp);
2438 ttstart(tp);
2439 out:
2440 if ((flags & NOLOCK) == 0)
2441 mutex_spin_exit(&tty_lock);
2442 return (r);
2443 }
2444
2445 /*
2446 * Sleep on chan, returning ERESTART if tty changed while we napped and
2447 * returning any errors (e.g. EINTR/ETIMEDOUT) reported by tsleep. If
2448 * the tty is revoked, restarting a pending call will redo validation done
2449 * at the start of the call.
2450 *
2451 * Must be called with the tty lock held.
2452 */
2453 int
2454 ttysleep(struct tty *tp, kcondvar_t *cv, bool catch, int timo)
2455 {
2456 int error;
2457 short gen;
2458
2459 KASSERT(mutex_owned(&tty_lock));
2460
2461 gen = tp->t_gen;
2462 if (catch)
2463 error = cv_timedwait_sig(cv, &tty_lock, timo);
2464 else
2465 error = cv_timedwait(cv, &tty_lock, timo);
2466 if (error != 0)
2467 return (error);
2468 return (tp->t_gen == gen ? 0 : ERESTART);
2469 }
2470
2471 /*
2472 * Attach a tty to the tty list.
2473 *
2474 * This should be called ONLY once per real tty (including pty's).
2475 * eg, on the sparc, the keyboard and mouse have struct tty's that are
2476 * distinctly NOT usable as tty's, and thus should not be attached to
2477 * the ttylist. This is why this call is not done from ttymalloc().
2478 *
2479 * Device drivers should attach tty's at a similar time that they are
2480 * ttymalloc()'ed, or, for the case of statically allocated struct tty's
2481 * either in the attach or (first) open routine.
2482 */
2483 void
2484 tty_attach(struct tty *tp)
2485 {
2486
2487 mutex_spin_enter(&tty_lock);
2488 TAILQ_INSERT_TAIL(&ttylist, tp, tty_link);
2489 ++tty_count;
2490 mutex_spin_exit(&tty_lock);
2491 }
2492
2493 /*
2494 * Remove a tty from the tty list.
2495 */
2496 void
2497 tty_detach(struct tty *tp)
2498 {
2499
2500 mutex_spin_enter(&tty_lock);
2501 --tty_count;
2502 #ifdef DIAGNOSTIC
2503 if (tty_count < 0)
2504 panic("tty_detach: tty_count < 0");
2505 #endif
2506 TAILQ_REMOVE(&ttylist, tp, tty_link);
2507 mutex_spin_exit(&tty_lock);
2508 }
2509
2510 /*
2511 * Allocate a tty structure and its associated buffers.
2512 */
2513 struct tty *
2514 ttymalloc(void)
2515 {
2516 struct tty *tp;
2517 int i;
2518
2519 tp = pool_get(&tty_pool, PR_WAITOK);
2520 memset(tp, 0, sizeof(*tp));
2521 callout_init(&tp->t_rstrt_ch, 0);
2522 callout_setfunc(&tp->t_rstrt_ch, ttrstrt, tp);
2523 /* XXX: default to 1024 chars for now */
2524 clalloc(&tp->t_rawq, 1024, 1);
2525 clalloc(&tp->t_canq, 1024, 1);
2526 /* output queue doesn't need quoting */
2527 clalloc(&tp->t_outq, 1024, 0);
2528 /* Set default line discipline. */
2529 tp->t_linesw = ttyldisc_default();
2530 selinit(&tp->t_rsel);
2531 selinit(&tp->t_wsel);
2532 for (i = 0; i < TTYSIG_COUNT; i++)
2533 sigemptyset(&tp->t_sigs[i]);
2534 return (tp);
2535 }
2536
2537 /*
2538 * Free a tty structure and its buffers.
2539 *
2540 * Be sure to call tty_detach() for any tty that has been
2541 * tty_attach()ed.
2542 */
2543 void
2544 ttyfree(struct tty *tp)
2545 {
2546 int i;
2547
2548 mutex_enter(&tty_lock);
2549 for (i = 0; i < TTYSIG_COUNT; i++)
2550 sigemptyset(&tp->t_sigs[i]);
2551 if (tp->t_sigcount != 0)
2552 TAILQ_REMOVE(&tty_sigqueue, tp, t_sigqueue);
2553 mutex_exit(&tty_lock);
2554
2555 callout_stop(&tp->t_rstrt_ch);
2556 ttyldisc_release(tp->t_linesw);
2557 clfree(&tp->t_rawq);
2558 clfree(&tp->t_canq);
2559 clfree(&tp->t_outq);
2560 callout_destroy(&tp->t_rstrt_ch);
2561 seldestroy(&tp->t_rsel);
2562 seldestroy(&tp->t_wsel);
2563 pool_put(&tty_pool, tp);
2564 }
2565
2566 /*
2567 * ttyprintf_nolock: send a message to a specific tty, without locking.
2568 *
2569 * => should be used only by tty driver or anything that knows the
2570 * underlying tty will not be revoked(2)'d away. [otherwise,
2571 * use tprintf]
2572 */
2573 static void
2574 ttyprintf_nolock(struct tty *tp, const char *fmt, ...)
2575 {
2576 va_list ap;
2577
2578 /* No mutex needed; going to process TTY. */
2579 va_start(ap, fmt);
2580 kprintf(fmt, TOTTY|NOLOCK, tp, NULL, ap);
2581 va_end(ap);
2582 }
2583
2584 /*
2585 * Initialize the tty subsystem.
2586 */
2587 void
2588 tty_init(void)
2589 {
2590
2591 mutex_init(&tty_lock, MUTEX_DEFAULT, IPL_VM);
2592 tty_sigsih = softint_establish(SOFTINT_CLOCK, ttysigintr, NULL);
2593 KASSERT(tty_sigsih != NULL);
2594 }
2595
2596 /*
2597 * Send a signal from a tty to its process group or session leader.
2598 * Handoff to the target is deferred to a soft interrupt.
2599 */
2600 void
2601 ttysig(struct tty *tp, enum ttysigtype st, int sig)
2602 {
2603 sigset_t *sp;
2604
2605 /* XXXSMP not yet KASSERT(mutex_owned(&tty_lock)); */
2606
2607 sp = &tp->t_sigs[st];
2608 if (sigismember(sp, sig))
2609 return;
2610 sigaddset(sp, sig);
2611 if (tp->t_sigcount++ == 0)
2612 TAILQ_INSERT_TAIL(&tty_sigqueue, tp, t_sigqueue);
2613 softint_schedule(tty_sigsih);
2614 }
2615
2616 /*
2617 * Deliver deferred signals from ttys. Note that the process groups
2618 * and sessions associated with the ttys may have changed from when
2619 * the signal was originally sent, but in practice it should not matter.
2620 * For signals produced as a result of a syscall, the soft interrupt
2621 * will fire before the syscall returns to the user.
2622 */
2623 static void
2624 ttysigintr(void *cookie)
2625 {
2626 struct tty *tp;
2627 enum ttysigtype st;
2628 struct pgrp *pgrp;
2629 struct session *sess;
2630 int sig;
2631
2632 /* XXXSMP notyet mutex_enter(&proclist_lock); */
2633 for (;;) {
2634 mutex_spin_enter(&tty_lock);
2635 if ((tp = TAILQ_FIRST(&tty_sigqueue)) == NULL) {
2636 mutex_spin_exit(&tty_lock);
2637 break;
2638 }
2639 KASSERT(tp->t_sigcount > 0);
2640 for (st = 0; st < TTYSIG_COUNT; st++) {
2641 if ((sig = firstsig(&tp->t_sigs[st])) != 0)
2642 break;
2643 }
2644 KASSERT(st < TTYSIG_COUNT);
2645 sigdelset(&tp->t_sigs[st], sig);
2646 if (--tp->t_sigcount == 0)
2647 TAILQ_REMOVE(&tty_sigqueue, tp, t_sigqueue);
2648 pgrp = tp->t_pgrp;
2649 sess = tp->t_session;
2650 mutex_spin_exit(&tty_lock);
2651 if (sig == 0)
2652 panic("ttysigintr");
2653 mutex_enter(&proclist_mutex);
2654 switch (st) {
2655 case TTYSIG_PG1:
2656 if (pgrp != NULL)
2657 pgsignal(pgrp, sig, 1);
2658 break;
2659 case TTYSIG_PG2:
2660 if (pgrp != NULL && sess != NULL)
2661 pgsignal(pgrp, sig, 0);
2662 break;
2663 case TTYSIG_LEADER:
2664 if (sess != NULL && sess->s_leader != NULL)
2665 psignal(sess->s_leader, sig);
2666 break;
2667 default:
2668 /* NOTREACHED */
2669 break;
2670 }
2671 mutex_exit(&proclist_mutex);
2672 }
2673 /* XXXSMP notyet mutex_exit(&proclist_lock); */
2674 }
2675