2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008 Ed Schouten <ed@FreeBSD.org>
7 * Portions of this software were developed under sponsorship from Snow
8 * B.V., the Netherlands.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/fcntl.h>
37 #include <sys/filio.h>
38 #include <sys/kernel.h>
39 #include <sys/signal.h>
40 #include <sys/sysctl.h>
41 #include <sys/systm.h>
43 #include <sys/ttycom.h>
44 #include <sys/ttydefaults.h>
46 #include <sys/vnode.h>
49 * Standard TTYDISC `termios' line discipline.
53 static unsigned long tty_nin = 0;
54 SYSCTL_ULONG(_kern, OID_AUTO, tty_nin, CTLFLAG_RD,
55 &tty_nin, 0, "Total amount of bytes received");
56 static unsigned long tty_nout = 0;
57 SYSCTL_ULONG(_kern, OID_AUTO, tty_nout, CTLFLAG_RD,
58 &tty_nout, 0, "Total amount of bytes transmitted");
60 /* termios comparison macro's. */
61 #define CMP_CC(v,c) (tp->t_termios.c_cc[v] != _POSIX_VDISABLE && \
62 tp->t_termios.c_cc[v] == (c))
63 #define CMP_FLAG(field,opt) (tp->t_termios.c_ ## field ## flag & (opt))
65 /* Characters that cannot be modified through c_cc. */
70 /* Character is a control character. */
71 #define CTL_VALID(c) ((c) == 0x7f || (unsigned char)(c) < 0x20)
72 /* Control character should be processed on echo. */
73 #define CTL_ECHO(c,q) (!(q) && ((c) == CERASE2 || (c) == CTAB || \
74 (c) == CNL || (c) == CCR))
75 /* Control character should be printed using ^X notation. */
76 #define CTL_PRINT(c,q) ((c) == 0x7f || ((unsigned char)(c) < 0x20 && \
77 ((q) || ((c) != CTAB && (c) != CNL))))
78 /* Character is whitespace. */
79 #define CTL_WHITE(c) ((c) == ' ' || (c) == CTAB)
80 /* Character is alphanumeric. */
81 #define CTL_ALNUM(c) (((c) >= '0' && (c) <= '9') || \
82 ((c) >= 'a' && (c) <= 'z') || ((c) >= 'A' && (c) <= 'Z'))
84 #define TTY_STACKBUF 256
87 ttydisc_open(struct tty *tp)
93 ttydisc_close(struct tty *tp)
96 /* Clean up our flags when leaving the discipline. */
97 tp->t_flags &= ~(TF_STOPPED|TF_HIWAT|TF_ZOMBIE);
98 tp->t_termios.c_lflag &= ~FLUSHO;
101 * POSIX states that we must drain output and flush input on
102 * last close. Draining has already been done if possible.
104 tty_flush(tp, FREAD | FWRITE);
106 if (ttyhook_hashook(tp, close))
111 ttydisc_read_canonical(struct tty *tp, struct uio *uio, int ioflag)
113 char breakc[4] = { CNL }; /* enough to hold \n, VEOF and VEOL. */
115 size_t clen, flen = 0, n = 1;
116 unsigned char lastc = _POSIX_VDISABLE;
118 #define BREAK_ADD(c) do { \
119 if (tp->t_termios.c_cc[c] != _POSIX_VDISABLE) \
120 breakc[n++] = tp->t_termios.c_cc[c]; \
122 /* Determine which characters we should trigger on. */
129 error = tty_wait_background(tp, curthread, SIGTTIN);
134 * Quite a tricky case: unlike the old TTY
135 * implementation, this implementation copies data back
136 * to userspace in large chunks. Unfortunately, we can't
137 * calculate the line length on beforehand if it crosses
138 * ttyinq_block boundaries, because multiple reads could
139 * then make this code read beyond the newline.
141 * This is why we limit the read to:
142 * - The size the user has requested
143 * - The blocksize (done in tty_inq.c)
144 * - The amount of bytes until the newline
146 * This causes the line length to be recalculated after
147 * each block has been copied to userspace. This will
148 * cause the TTY layer to return data in chunks using
149 * the blocksize (except the first and last blocks).
151 clen = ttyinq_findchar(&tp->t_inq, breakc, uio->uio_resid,
156 if (tp->t_flags & TF_ZOMBIE)
158 else if (ioflag & IO_NDELAY)
159 return (EWOULDBLOCK);
161 error = tty_wait(tp, &tp->t_inwait);
167 /* Don't send the EOF char back to userspace. */
168 if (CMP_CC(VEOF, lastc))
173 /* Read and throw away the EOF character. */
174 error = ttyinq_read_uio(&tp->t_inq, tp, uio, clen, flen);
178 } while (uio->uio_resid > 0 && lastc == _POSIX_VDISABLE);
184 ttydisc_read_raw_no_timer(struct tty *tp, struct uio *uio, int ioflag)
186 size_t vmin = tp->t_termios.c_cc[VMIN];
187 ssize_t oresid = uio->uio_resid;
190 MPASS(tp->t_termios.c_cc[VTIME] == 0);
193 * This routine implements the easy cases of read()s while in
194 * non-canonical mode, namely case B and D, where we don't have
199 error = tty_wait_background(tp, curthread, SIGTTIN);
203 error = ttyinq_read_uio(&tp->t_inq, tp, uio,
207 if (uio->uio_resid == 0 || (oresid - uio->uio_resid) >= vmin)
210 /* We have to wait for more. */
211 if (tp->t_flags & TF_ZOMBIE)
213 else if (ioflag & IO_NDELAY)
214 return (EWOULDBLOCK);
216 error = tty_wait(tp, &tp->t_inwait);
223 ttydisc_read_raw_read_timer(struct tty *tp, struct uio *uio, int ioflag,
226 size_t vmin = MAX(tp->t_termios.c_cc[VMIN], 1);
227 unsigned int vtime = tp->t_termios.c_cc[VTIME];
228 struct timeval end, now, left;
231 MPASS(tp->t_termios.c_cc[VTIME] != 0);
233 /* Determine when the read should be expired. */
234 end.tv_sec = vtime / 10;
235 end.tv_usec = (vtime % 10) * 100000;
237 timevaladd(&end, &now);
240 error = tty_wait_background(tp, curthread, SIGTTIN);
244 error = ttyinq_read_uio(&tp->t_inq, tp, uio,
248 if (uio->uio_resid == 0 || (oresid - uio->uio_resid) >= vmin)
251 /* Calculate how long we should wait. */
253 if (timevalcmp(&now, &end, >))
256 timevalsub(&left, &now);
260 * We have to wait for more. If the timer expires, we
261 * should return a 0-byte read.
263 if (tp->t_flags & TF_ZOMBIE)
265 else if (ioflag & IO_NDELAY)
266 return (EWOULDBLOCK);
268 error = tty_timedwait(tp, &tp->t_inwait, hz);
270 return (error == EWOULDBLOCK ? 0 : error);
277 ttydisc_read_raw_interbyte_timer(struct tty *tp, struct uio *uio, int ioflag)
279 size_t vmin = tp->t_termios.c_cc[VMIN];
280 ssize_t oresid = uio->uio_resid;
283 MPASS(tp->t_termios.c_cc[VMIN] != 0);
284 MPASS(tp->t_termios.c_cc[VTIME] != 0);
287 * When using the interbyte timer, the timer should be started
288 * after the first byte has been received. We just call into the
289 * generic read timer code after we've received the first byte.
293 error = tty_wait_background(tp, curthread, SIGTTIN);
297 error = ttyinq_read_uio(&tp->t_inq, tp, uio,
301 if (uio->uio_resid == 0 || (oresid - uio->uio_resid) >= vmin)
305 * Not enough data, but we did receive some, which means
306 * we'll now start using the interbyte timer.
308 if (oresid != uio->uio_resid)
311 /* We have to wait for more. */
312 if (tp->t_flags & TF_ZOMBIE)
314 else if (ioflag & IO_NDELAY)
315 return (EWOULDBLOCK);
317 error = tty_wait(tp, &tp->t_inwait);
322 return ttydisc_read_raw_read_timer(tp, uio, ioflag, oresid);
326 ttydisc_read(struct tty *tp, struct uio *uio, int ioflag)
330 tty_assert_locked(tp);
332 if (uio->uio_resid == 0)
335 if (CMP_FLAG(l, ICANON))
336 error = ttydisc_read_canonical(tp, uio, ioflag);
337 else if (tp->t_termios.c_cc[VTIME] == 0)
338 error = ttydisc_read_raw_no_timer(tp, uio, ioflag);
339 else if (tp->t_termios.c_cc[VMIN] == 0)
340 error = ttydisc_read_raw_read_timer(tp, uio, ioflag,
343 error = ttydisc_read_raw_interbyte_timer(tp, uio, ioflag);
345 if (ttyinq_bytesleft(&tp->t_inq) >= tp->t_inlow ||
346 ttyinq_bytescanonicalized(&tp->t_inq) == 0) {
347 /* Unset the input watermark when we've got enough space. */
348 tty_hiwat_in_unblock(tp);
354 static __inline unsigned int
355 ttydisc_findchar(const char *obstart, unsigned int oblen)
357 const char *c = obstart;
365 return (c - obstart);
369 ttydisc_write_oproc(struct tty *tp, char c)
371 unsigned int scnt, error;
373 MPASS(CMP_FLAG(o, OPOST));
376 #define PRINT_NORMAL() ttyoutq_write_nofrag(&tp->t_outq, &c, 1)
379 /* End-of-text dropping. */
380 if (CMP_FLAG(o, ONOEOT))
382 return PRINT_NORMAL();
385 /* Handle backspace to fix tab expansion. */
386 if (PRINT_NORMAL() != 0)
388 if (tp->t_column > 0)
394 scnt = 8 - (tp->t_column & 7);
395 if (CMP_FLAG(o, TAB3)) {
396 error = ttyoutq_write_nofrag(&tp->t_outq,
399 error = PRINT_NORMAL();
404 tp->t_column += scnt;
405 MPASS((tp->t_column % 8) == 0);
409 /* Newline conversion. */
410 if (CMP_FLAG(o, ONLCR)) {
411 /* Convert \n to \r\n. */
412 error = ttyoutq_write_nofrag(&tp->t_outq, "\r\n", 2);
414 error = PRINT_NORMAL();
419 if (CMP_FLAG(o, ONLCR|ONLRET)) {
420 tp->t_column = tp->t_writepos = 0;
421 ttyinq_reprintpos_set(&tp->t_inq);
426 /* Carriage return to newline conversion. */
427 if (CMP_FLAG(o, OCRNL))
429 /* Omit carriage returns on column 0. */
430 if (CMP_FLAG(o, ONOCR) && tp->t_column == 0)
432 if (PRINT_NORMAL() != 0)
435 tp->t_column = tp->t_writepos = 0;
436 ttyinq_reprintpos_set(&tp->t_inq);
441 * Invisible control character. Print it, but don't
442 * increase the column count.
444 return PRINT_NORMAL();
449 * Just like the old TTY implementation, we need to copy data in chunks
450 * into a temporary buffer. One of the reasons why we need to do this,
451 * is because output processing (only TAB3 though) may allow the buffer
452 * to grow eight times.
455 ttydisc_write(struct tty *tp, struct uio *uio, int ioflag)
457 char ob[TTY_STACKBUF];
460 unsigned int oblen = 0;
462 tty_assert_locked(tp);
464 if (tp->t_flags & TF_ZOMBIE)
468 * We don't need to check whether the process is the foreground
469 * process group or if we have a carrier. This is already done
473 while (uio->uio_resid > 0) {
478 if (CMP_FLAG(l, FLUSHO)) {
479 uio->uio_offset += uio->uio_resid;
484 /* Step 1: read data. */
486 nlen = MIN(uio->uio_resid, sizeof ob);
488 error = uiomove(ob, nlen, uio);
501 /* Step 2: process data. */
503 unsigned int plen, wlen;
505 if (CMP_FLAG(l, FLUSHO)) {
506 uio->uio_offset += uio->uio_resid;
511 /* Search for special characters for post processing. */
512 if (CMP_FLAG(o, OPOST)) {
513 plen = ttydisc_findchar(obstart, oblen);
520 * We're going to process a character
521 * that needs processing
523 if (ttydisc_write_oproc(tp, *obstart) == 0) {
527 tp->t_writepos = tp->t_column;
528 ttyinq_reprintpos_set(&tp->t_inq);
532 /* We're going to write regular data. */
533 wlen = ttyoutq_write(&tp->t_outq, obstart, plen);
536 tp->t_column += wlen;
538 tp->t_writepos = tp->t_column;
539 ttyinq_reprintpos_set(&tp->t_inq);
545 /* Watermark reached. Try to sleep. */
546 tp->t_flags |= TF_HIWAT_OUT;
548 if (ioflag & IO_NDELAY) {
554 * The driver may write back the data
555 * synchronously. Be sure to check the high
556 * water mark before going to sleep.
558 ttydevsw_outwakeup(tp);
559 if ((tp->t_flags & TF_HIWAT_OUT) == 0)
562 error = tty_wait(tp, &tp->t_outwait);
566 if (tp->t_flags & TF_ZOMBIE) {
575 ttydevsw_outwakeup(tp);
578 * Add the amount of bytes that we didn't process back to the
579 * uio counters. We need to do this to make sure write() doesn't
580 * count the bytes we didn't store in the queue.
582 uio->uio_resid += oblen;
587 ttydisc_optimize(struct tty *tp)
589 tty_assert_locked(tp);
591 if (ttyhook_hashook(tp, rint_bypass)) {
592 tp->t_flags |= TF_BYPASS;
593 } else if (ttyhook_hashook(tp, rint)) {
594 tp->t_flags &= ~TF_BYPASS;
595 } else if (!CMP_FLAG(i, ICRNL|IGNCR|IMAXBEL|INLCR|ISTRIP|IXON) &&
596 (!CMP_FLAG(i, BRKINT) || CMP_FLAG(i, IGNBRK)) &&
597 (!CMP_FLAG(i, PARMRK) ||
598 CMP_FLAG(i, IGNPAR|IGNBRK) == (IGNPAR|IGNBRK)) &&
599 !CMP_FLAG(l, ECHO|ICANON|IEXTEN|ISIG|PENDIN)) {
600 tp->t_flags |= TF_BYPASS;
602 tp->t_flags &= ~TF_BYPASS;
607 ttydisc_modem(struct tty *tp, int open)
610 tty_assert_locked(tp);
613 cv_broadcast(&tp->t_dcdwait);
616 * Ignore modem status lines when CLOCAL is turned on, but don't
617 * enter the zombie state when the TTY isn't opened, because
618 * that would cause the TTY to be in zombie state after being
621 if (!tty_opened(tp) || CMP_FLAG(c, CLOCAL))
628 tp->t_flags |= TF_ZOMBIE;
630 tty_signal_sessleader(tp, SIGHUP);
631 tty_flush(tp, FREAD|FWRITE);
634 * Carrier is back again.
637 /* XXX: what should we do here? */
642 ttydisc_echo_force(struct tty *tp, char c, int quote)
645 if (CMP_FLAG(l, FLUSHO))
648 if (CMP_FLAG(o, OPOST) && CTL_ECHO(c, quote)) {
650 * Only perform postprocessing when OPOST is turned on
651 * and the character is an unquoted BS/TB/NL/CR.
653 return ttydisc_write_oproc(tp, c);
654 } else if (CMP_FLAG(l, ECHOCTL) && CTL_PRINT(c, quote)) {
656 * Only use ^X notation when ECHOCTL is turned on and
657 * we've got an quoted control character.
659 * Print backspaces when echoing an end-of-file.
661 char ob[4] = "^?\b\b";
663 /* Print ^X notation. */
667 if (!quote && CMP_CC(VEOF, c)) {
668 return ttyoutq_write_nofrag(&tp->t_outq, ob, 4);
671 return ttyoutq_write_nofrag(&tp->t_outq, ob, 2);
674 /* Can just be printed. */
676 return ttyoutq_write_nofrag(&tp->t_outq, &c, 1);
681 ttydisc_echo(struct tty *tp, char c, int quote)
685 * Only echo characters when ECHO is turned on, or ECHONL when
686 * the character is an unquoted newline.
688 if (!CMP_FLAG(l, ECHO) &&
689 (!CMP_FLAG(l, ECHONL) || c != CNL || quote))
692 return ttydisc_echo_force(tp, c, quote);
696 ttydisc_reprint_char(void *d, char c, int quote)
700 ttydisc_echo(tp, c, quote);
704 ttydisc_reprint(struct tty *tp)
708 /* Print ^R\n, followed by the line. */
709 c = tp->t_termios.c_cc[VREPRINT];
710 if (c != _POSIX_VDISABLE)
711 ttydisc_echo(tp, c, 0);
712 ttydisc_echo(tp, CNL, 0);
713 ttyinq_reprintpos_reset(&tp->t_inq);
715 ttyinq_line_iterate_from_linestart(&tp->t_inq, ttydisc_reprint_char, tp);
718 struct ttydisc_recalc_length {
724 ttydisc_recalc_charlength(void *d, char c, int quote)
726 struct ttydisc_recalc_length *data = d;
727 struct tty *tp = data->tp;
729 if (CTL_PRINT(c, quote)) {
730 if (CMP_FLAG(l, ECHOCTL))
732 } else if (c == CTAB) {
733 data->curlen += 8 - (data->curlen & 7);
740 ttydisc_recalc_linelength(struct tty *tp)
742 struct ttydisc_recalc_length data = { tp, tp->t_writepos };
744 ttyinq_line_iterate_from_reprintpos(&tp->t_inq,
745 ttydisc_recalc_charlength, &data);
746 return (data.curlen);
750 ttydisc_rubchar(struct tty *tp)
754 unsigned int prevpos, tablen;
756 if (ttyinq_peekchar(&tp->t_inq, &c, "e) != 0)
758 ttyinq_unputchar(&tp->t_inq);
760 if (CMP_FLAG(l, ECHO)) {
762 * Remove the character from the screen. This is even
763 * safe for characters that span multiple characters
764 * (tabs, quoted, etc).
766 if (tp->t_writepos >= tp->t_column) {
767 /* Retype the sentence. */
769 } else if (CMP_FLAG(l, ECHOE)) {
770 if (CTL_PRINT(c, quote)) {
771 /* Remove ^X formatted chars. */
772 if (CMP_FLAG(l, ECHOCTL)) {
774 ttyoutq_write_nofrag(&tp->t_outq,
777 } else if (c == ' ') {
778 /* Space character needs no rubbing. */
780 ttyoutq_write_nofrag(&tp->t_outq, "\b", 1);
781 } else if (c == CTAB) {
783 * Making backspace work with tabs is
784 * quite hard. Recalculate the length of
785 * this character and remove it.
787 * Because terminal settings could be
788 * changed while the line is being
789 * inserted, the calculations don't have
790 * to be correct. Make sure we keep the
791 * tab length within proper bounds.
793 prevpos = ttydisc_recalc_linelength(tp);
794 if (prevpos >= tp->t_column)
797 tablen = tp->t_column - prevpos;
801 tp->t_column = prevpos;
802 ttyoutq_write_nofrag(&tp->t_outq,
803 "\b\b\b\b\b\b\b\b", tablen);
807 * Remove a regular character by
808 * punching a space over it.
811 ttyoutq_write_nofrag(&tp->t_outq, "\b \b", 3);
814 /* Don't print spaces. */
815 ttydisc_echo(tp, tp->t_termios.c_cc[VERASE], 0);
823 ttydisc_rubword(struct tty *tp)
828 /* Strip whitespace first. */
830 if (ttyinq_peekchar(&tp->t_inq, &c, "e) != 0)
838 * Record whether the last character from the previous iteration
839 * was alphanumeric or not. We need this to implement ALTWERASE.
841 alnum = CTL_ALNUM(c);
845 if (ttyinq_peekchar(&tp->t_inq, &c, "e) != 0)
849 if (CMP_FLAG(l, ALTWERASE) && CTL_ALNUM(c) != alnum)
855 ttydisc_rint(struct tty *tp, char c, int flags)
857 int signal, quote = 0;
858 char ob[3] = { 0xff, 0x00 };
861 tty_assert_locked(tp);
863 atomic_add_long(&tty_nin, 1);
865 if (ttyhook_hashook(tp, rint))
866 return ttyhook_rint(tp, c, flags);
868 if (tp->t_flags & TF_BYPASS)
872 if (flags & TRE_BREAK) {
873 if (CMP_FLAG(i, IGNBRK)) {
874 /* Ignore break characters. */
876 } else if (CMP_FLAG(i, BRKINT)) {
877 /* Generate SIGINT on break. */
878 tty_flush(tp, FREAD|FWRITE);
879 tty_signal_pgrp(tp, SIGINT);
885 } else if (flags & TRE_FRAMING ||
886 (flags & TRE_PARITY && CMP_FLAG(i, INPCK))) {
887 if (CMP_FLAG(i, IGNPAR)) {
888 /* Ignore bad characters. */
897 /* Allow any character to perform a wakeup. */
898 if (CMP_FLAG(i, IXANY)) {
899 tp->t_flags &= ~TF_STOPPED;
900 tp->t_termios.c_lflag &= ~FLUSHO;
903 /* Remove the top bit. */
904 if (CMP_FLAG(i, ISTRIP))
907 /* Skip input processing when we want to print it literally. */
908 if (tp->t_flags & TF_LITERAL) {
909 tp->t_flags &= ~TF_LITERAL;
914 /* Special control characters that are implementation dependent. */
915 if (CMP_FLAG(l, IEXTEN)) {
916 /* Accept the next character as literal. */
917 if (CMP_CC(VLNEXT, c)) {
918 if (CMP_FLAG(l, ECHO)) {
919 if (CMP_FLAG(l, ECHOE))
920 ttyoutq_write_nofrag(&tp->t_outq, "^\b", 2);
922 ttydisc_echo(tp, c, 0);
924 tp->t_flags |= TF_LITERAL;
927 /* Discard processing */
928 if (CMP_CC(VDISCARD, c)) {
929 if (CMP_FLAG(l, FLUSHO)) {
930 tp->t_termios.c_lflag &= ~FLUSHO;
932 tty_flush(tp, FWRITE);
933 ttydisc_echo(tp, c, 0);
934 if (tp->t_inq.ti_end > 0)
936 tp->t_termios.c_lflag |= FLUSHO;
942 * Handle signal processing.
944 if (CMP_FLAG(l, ISIG)) {
945 if (CMP_FLAG(l, ICANON|IEXTEN) == (ICANON|IEXTEN)) {
946 if (CMP_CC(VSTATUS, c)) {
947 tty_signal_pgrp(tp, SIGINFO);
953 * When compared to the old implementation, this
954 * implementation also flushes the output queue. POSIX
955 * is really brief about this, but does makes us assume
959 if (CMP_CC(VINTR, c)) {
961 } else if (CMP_CC(VQUIT, c)) {
963 } else if (CMP_CC(VSUSP, c)) {
969 * Echo the character before signalling the
972 if (!CMP_FLAG(l, NOFLSH))
973 tty_flush(tp, FREAD|FWRITE);
974 ttydisc_echo(tp, c, 0);
975 tty_signal_pgrp(tp, signal);
981 * Handle start/stop characters.
983 if (CMP_FLAG(i, IXON)) {
984 if (CMP_CC(VSTOP, c)) {
985 /* Stop it if we aren't stopped yet. */
986 if ((tp->t_flags & TF_STOPPED) == 0) {
987 tp->t_flags |= TF_STOPPED;
992 * When VSTART == VSTOP, we should make this key
995 if (!CMP_CC(VSTART, c))
998 if (CMP_CC(VSTART, c)) {
999 tp->t_flags &= ~TF_STOPPED;
1004 /* Conversion of CR and NL. */
1007 if (CMP_FLAG(i, IGNCR))
1009 if (CMP_FLAG(i, ICRNL))
1013 if (CMP_FLAG(i, INLCR))
1018 /* Canonical line editing. */
1019 if (CMP_FLAG(l, ICANON)) {
1020 if (CMP_CC(VERASE, c) || CMP_CC(VERASE2, c)) {
1021 ttydisc_rubchar(tp);
1023 } else if (CMP_CC(VKILL, c)) {
1024 while (ttydisc_rubchar(tp) == 0);
1026 } else if (CMP_FLAG(l, IEXTEN)) {
1027 if (CMP_CC(VWERASE, c)) {
1028 ttydisc_rubword(tp);
1030 } else if (CMP_CC(VREPRINT, c)) {
1031 ttydisc_reprint(tp);
1038 if (CMP_FLAG(i, PARMRK) && (unsigned char)c == 0xff) {
1039 /* Print 0xff 0xff. */
1051 if (CMP_FLAG(i, PARMRK)) {
1052 /* Prepend 0xff 0x00 0x.. */
1062 /* See if we can store this on the input queue. */
1063 if (ttyinq_write_nofrag(&tp->t_inq, ob, ol, quote) != 0) {
1064 if (CMP_FLAG(i, IMAXBEL))
1065 ttyoutq_write_nofrag(&tp->t_outq, "\a", 1);
1068 * Prevent a deadlock here. It may be possible that a
1069 * user has entered so much data, there is no data
1070 * available to read(), but the buffers are full anyway.
1072 * Only enter the high watermark if the device driver
1073 * can actually transmit something.
1075 if (ttyinq_bytescanonicalized(&tp->t_inq) == 0)
1078 tty_hiwat_in_block(tp);
1083 * In raw mode, we canonicalize after receiving a single
1084 * character. Otherwise, we canonicalize when we receive a
1085 * newline, VEOL or VEOF, but only when it isn't quoted.
1087 if (!CMP_FLAG(l, ICANON) ||
1088 (!quote && (c == CNL || CMP_CC(VEOL, c) || CMP_CC(VEOF, c)))) {
1089 ttyinq_canonicalize(&tp->t_inq);
1092 ttydisc_echo(tp, c, quote);
1098 ttydisc_rint_simple(struct tty *tp, const void *buf, size_t len)
1102 if (ttydisc_can_bypass(tp))
1103 return (ttydisc_rint_bypass(tp, buf, len));
1105 for (cbuf = buf; len-- > 0; cbuf++) {
1106 if (ttydisc_rint(tp, *cbuf, 0) != 0)
1110 return (cbuf - (const char *)buf);
1114 ttydisc_rint_bypass(struct tty *tp, const void *buf, size_t len)
1118 tty_assert_locked(tp);
1120 MPASS(tp->t_flags & TF_BYPASS);
1122 atomic_add_long(&tty_nin, len);
1124 if (ttyhook_hashook(tp, rint_bypass))
1125 return ttyhook_rint_bypass(tp, buf, len);
1127 ret = ttyinq_write(&tp->t_inq, buf, len, 0);
1128 ttyinq_canonicalize(&tp->t_inq);
1130 tty_hiwat_in_block(tp);
1136 ttydisc_rint_done(struct tty *tp)
1139 tty_assert_locked(tp);
1141 if (ttyhook_hashook(tp, rint_done))
1142 ttyhook_rint_done(tp);
1144 /* Wake up readers. */
1145 tty_wakeup(tp, FREAD);
1146 /* Wake up driver for echo. */
1147 ttydevsw_outwakeup(tp);
1151 ttydisc_rint_poll(struct tty *tp)
1155 tty_assert_locked(tp);
1157 if (ttyhook_hashook(tp, rint_poll))
1158 return ttyhook_rint_poll(tp);
1161 * XXX: Still allow character input when there's no space in the
1162 * buffers, but we haven't entered the high watermark. This is
1163 * to allow backspace characters to be inserted when in
1166 l = ttyinq_bytesleft(&tp->t_inq);
1167 if (l == 0 && (tp->t_flags & TF_HIWAT_IN) == 0)
1174 ttydisc_wakeup_watermark(struct tty *tp)
1178 c = ttyoutq_bytesleft(&tp->t_outq);
1179 if (tp->t_flags & TF_HIWAT_OUT) {
1180 /* Only allow us to run when we're below the watermark. */
1181 if (c < tp->t_outlow)
1184 /* Reset the watermark. */
1185 tp->t_flags &= ~TF_HIWAT_OUT;
1187 /* Only run when we have data at all. */
1191 tty_wakeup(tp, FWRITE);
1195 ttydisc_getc(struct tty *tp, void *buf, size_t len)
1198 tty_assert_locked(tp);
1200 if (tp->t_flags & TF_STOPPED)
1203 if (ttyhook_hashook(tp, getc_inject))
1204 return ttyhook_getc_inject(tp, buf, len);
1206 len = ttyoutq_read(&tp->t_outq, buf, len);
1208 if (ttyhook_hashook(tp, getc_capture))
1209 ttyhook_getc_capture(tp, buf, len);
1211 ttydisc_wakeup_watermark(tp);
1212 atomic_add_long(&tty_nout, len);
1218 ttydisc_getc_uio(struct tty *tp, struct uio *uio)
1221 ssize_t obytes = uio->uio_resid;
1223 char buf[TTY_STACKBUF];
1225 tty_assert_locked(tp);
1227 if (tp->t_flags & TF_STOPPED)
1231 * When a TTY hook is attached, we cannot perform unbuffered
1232 * copying to userspace. Just call ttydisc_getc() and
1233 * temporarily store data in a shadow buffer.
1235 if (ttyhook_hashook(tp, getc_capture) ||
1236 ttyhook_hashook(tp, getc_inject)) {
1237 while (uio->uio_resid > 0) {
1238 /* Read to shadow buffer. */
1239 len = ttydisc_getc(tp, buf,
1240 MIN(uio->uio_resid, sizeof buf));
1244 /* Copy to userspace. */
1246 error = uiomove(buf, len, uio);
1253 error = ttyoutq_read_uio(&tp->t_outq, tp, uio);
1255 ttydisc_wakeup_watermark(tp);
1256 atomic_add_long(&tty_nout, obytes - uio->uio_resid);
1263 ttydisc_getc_poll(struct tty *tp)
1266 tty_assert_locked(tp);
1268 if (tp->t_flags & TF_STOPPED)
1271 if (ttyhook_hashook(tp, getc_poll))
1272 return ttyhook_getc_poll(tp);
1274 return ttyoutq_bytesused(&tp->t_outq);
1278 * XXX: not really related to the TTYDISC, but we'd better put
1279 * tty_putchar() here, because we need to perform proper output
1284 tty_putstrn(struct tty *tp, const char *p, size_t n)
1288 tty_assert_locked(tp);
1293 for (i = 0; i < n; i++)
1294 ttydisc_echo_force(tp, p[i], 0);
1296 tp->t_writepos = tp->t_column;
1297 ttyinq_reprintpos_set(&tp->t_inq);
1299 ttydevsw_outwakeup(tp);
1304 tty_putchar(struct tty *tp, char c)
1306 return (tty_putstrn(tp, &c, 1));