2 * n_tty.c --- implements the N_TTY line discipline.
4 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
11 * to N_TTY if it can not switch to any other line discipline.
13 * Written by Theodore Ts'o, Copyright 1994.
15 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
18 * This file may be redistributed under the terms of the GNU General Public
21 * Reduced memory usage for older ARM systems - Russell King.
23 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
24 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
29 * Also fixed a bug in BLOCKING mode where write_chan returns
33 #include <linux/types.h>
34 #include <linux/major.h>
35 #include <linux/errno.h>
36 #include <linux/signal.h>
37 #include <linux/fcntl.h>
38 #include <linux/sched.h>
39 #include <linux/interrupt.h>
40 #include <linux/tty.h>
41 #include <linux/timer.h>
42 #include <linux/ctype.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/poll.h>
47 #include <linux/bitops.h>
48 #include <linux/audit.h>
49 #include <linux/file.h>
51 #include <asm/uaccess.h>
52 #include <asm/system.h>
54 /* number of characters left in xmit buffer before select has we have room */
55 #define WAKEUP_CHARS 256
58 * This defines the low- and high-watermarks for throttling and
59 * unthrottling the TTY driver. These watermarks are used for
60 * controlling the space in the read buffer.
62 #define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
63 #define TTY_THRESHOLD_UNTHROTTLE 128
65 static inline unsigned char *alloc_buf(void)
67 gfp_t prio = in_interrupt() ? GFP_ATOMIC : GFP_KERNEL;
69 if (PAGE_SIZE != N_TTY_BUF_SIZE)
70 return kmalloc(N_TTY_BUF_SIZE, prio);
72 return (unsigned char *)__get_free_page(prio);
75 static inline void free_buf(unsigned char *buf)
77 if (PAGE_SIZE != N_TTY_BUF_SIZE)
80 free_page((unsigned long) buf);
83 static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
84 unsigned char __user *ptr)
86 tty_audit_add_data(tty, &x, 1);
87 return put_user(x, ptr);
91 * n_tty_set__room - receive space
94 * Called by the driver to find out how much data it is
95 * permitted to feed to the line discipline without any being lost
96 * and thus to manage flow control. Not serialized. Answers for the
100 static void n_tty_set_room(struct tty_struct *tty)
102 int left = N_TTY_BUF_SIZE - tty->read_cnt - 1;
105 * If we are doing input canonicalization, and there are no
106 * pending newlines, let characters through without limit, so
107 * that erase characters will be handled. Other excess
108 * characters will be beeped.
111 left = tty->icanon && !tty->canon_data;
112 tty->receive_room = left;
115 static void put_tty_queue_nolock(unsigned char c, struct tty_struct *tty)
117 if (tty->read_cnt < N_TTY_BUF_SIZE) {
118 tty->read_buf[tty->read_head] = c;
119 tty->read_head = (tty->read_head + 1) & (N_TTY_BUF_SIZE-1);
124 static void put_tty_queue(unsigned char c, struct tty_struct *tty)
128 * The problem of stomping on the buffers ends here.
129 * Why didn't anyone see this one coming? --AJK
131 spin_lock_irqsave(&tty->read_lock, flags);
132 put_tty_queue_nolock(c, tty);
133 spin_unlock_irqrestore(&tty->read_lock, flags);
137 * check_unthrottle - allow new receive data
140 * Check whether to call the driver.unthrottle function.
141 * We test the TTY_THROTTLED bit first so that it always
142 * indicates the current state. The decision about whether
143 * it is worth allowing more input has been taken by the caller.
144 * Can sleep, may be called under the atomic_read_lock mutex but
145 * this is not guaranteed.
148 static void check_unthrottle(struct tty_struct *tty)
151 test_and_clear_bit(TTY_THROTTLED, &tty->flags) &&
152 tty->ops->unthrottle)
153 tty->ops->unthrottle(tty);
157 * reset_buffer_flags - reset buffer state
158 * @tty: terminal to reset
160 * Reset the read buffer counters, clear the flags,
161 * and make sure the driver is unthrottled. Called
162 * from n_tty_open() and n_tty_flush_buffer().
164 static void reset_buffer_flags(struct tty_struct *tty)
168 spin_lock_irqsave(&tty->read_lock, flags);
169 tty->read_head = tty->read_tail = tty->read_cnt = 0;
170 spin_unlock_irqrestore(&tty->read_lock, flags);
171 tty->canon_head = tty->canon_data = tty->erasing = 0;
172 memset(&tty->read_flags, 0, sizeof tty->read_flags);
174 check_unthrottle(tty);
178 * n_tty_flush_buffer - clean input queue
179 * @tty: terminal device
181 * Flush the input buffer. Called when the line discipline is
182 * being closed, when the tty layer wants the buffer flushed (eg
183 * at hangup) or when the N_TTY line discipline internally has to
184 * clean the pending queue (for example some signals).
189 static void n_tty_flush_buffer(struct tty_struct *tty)
192 /* clear everything and unthrottle the driver */
193 reset_buffer_flags(tty);
198 spin_lock_irqsave(&tty->ctrl_lock, flags);
199 if (tty->link->packet) {
200 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
201 wake_up_interruptible(&tty->link->read_wait);
203 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
207 * n_tty_chars_in_buffer - report available bytes
210 * Report the number of characters buffered to be delivered to user
211 * at this instant in time.
214 static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
219 spin_lock_irqsave(&tty->read_lock, flags);
222 } else if (tty->canon_data) {
223 n = (tty->canon_head > tty->read_tail) ?
224 tty->canon_head - tty->read_tail :
225 tty->canon_head + (N_TTY_BUF_SIZE - tty->read_tail);
227 spin_unlock_irqrestore(&tty->read_lock, flags);
232 * is_utf8_continuation - utf8 multibyte check
235 * Returns true if the utf8 character 'c' is a multibyte continuation
236 * character. We use this to correctly compute the on screen size
237 * of the character when printing
240 static inline int is_utf8_continuation(unsigned char c)
242 return (c & 0xc0) == 0x80;
246 * is_continuation - multibyte check
249 * Returns true if the utf8 character 'c' is a multibyte continuation
250 * character and the terminal is in unicode mode.
253 static inline int is_continuation(unsigned char c, struct tty_struct *tty)
255 return I_IUTF8(tty) && is_utf8_continuation(c);
259 * opost - output post processor
260 * @c: character (or partial unicode symbol)
261 * @tty: terminal device
263 * Perform OPOST processing. Returns -1 when the output device is
264 * full and the character must be retried. Note that Linux currently
265 * ignores TABDLY, CRDLY, VTDLY, FFDLY and NLDLY. They simply aren't
266 * relevant in the world today. If you ever need them, add them here.
268 * Called from both the receive and transmit sides and can be called
269 * re-entrantly. Relies on lock_kernel() for tty->column state.
272 static int opost(unsigned char c, struct tty_struct *tty)
276 space = tty_write_room(tty);
289 tty_put_char(tty, '\r');
292 tty->canon_column = tty->column;
295 if (O_ONOCR(tty) && tty->column == 0)
300 tty->canon_column = tty->column = 0;
303 tty->canon_column = tty->column = 0;
306 spaces = 8 - (tty->column & 7);
307 if (O_TABDLY(tty) == XTABS) {
310 tty->column += spaces;
311 tty->ops->write(tty, " ", spaces);
314 tty->column += spaces;
323 if (!iscntrl(c) && !is_continuation(c, tty))
328 tty_put_char(tty, c);
334 * opost_block - block postprocess
335 * @tty: terminal device
336 * @inbuf: user buffer
337 * @nr: number of bytes
339 * This path is used to speed up block console writes, among other
340 * things when processing blocks of output data. It handles only
341 * the simple cases normally found and helps to generate blocks of
342 * symbols for the console driver and thus improve performance.
344 * Called from write_chan under the tty layer write lock. Relies
345 * on lock_kernel for the tty->column state.
348 static ssize_t opost_block(struct tty_struct *tty,
349 const unsigned char *buf, unsigned int nr)
353 const unsigned char *cp;
355 space = tty_write_room(tty);
362 for (i = 0, cp = buf; i < nr; i++, cp++) {
369 tty->canon_column = tty->column;
372 if (O_ONOCR(tty) && tty->column == 0)
376 tty->canon_column = tty->column = 0;
393 if (tty->ops->flush_chars)
394 tty->ops->flush_chars(tty);
395 i = tty->ops->write(tty, buf, i);
402 * echo_char - echo characters
403 * @c: unicode byte to echo
404 * @tty: terminal device
406 * Echo user input back onto the screen. This must be called only when
407 * L_ECHO(tty) is true. Called from the driver receive_buf path.
410 static void echo_char(unsigned char c, struct tty_struct *tty)
412 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t') {
413 tty_put_char(tty, '^');
414 tty_put_char(tty, c ^ 0100);
420 static inline void finish_erasing(struct tty_struct *tty)
423 tty_put_char(tty, '/');
430 * eraser - handle erase function
431 * @c: character input
432 * @tty: terminal device
434 * Perform erase and necessary output when an erase character is
435 * present in the stream from the driver layer. Handles the complexities
436 * of UTF-8 multibyte symbols.
439 static void eraser(unsigned char c, struct tty_struct *tty)
441 enum { ERASE, WERASE, KILL } kill_type;
442 int head, seen_alnums, cnt;
445 if (tty->read_head == tty->canon_head) {
446 /* opost('\a', tty); */ /* what do you think? */
449 if (c == ERASE_CHAR(tty))
451 else if (c == WERASE_CHAR(tty))
455 spin_lock_irqsave(&tty->read_lock, flags);
456 tty->read_cnt -= ((tty->read_head - tty->canon_head) &
457 (N_TTY_BUF_SIZE - 1));
458 tty->read_head = tty->canon_head;
459 spin_unlock_irqrestore(&tty->read_lock, flags);
462 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
463 spin_lock_irqsave(&tty->read_lock, flags);
464 tty->read_cnt -= ((tty->read_head - tty->canon_head) &
465 (N_TTY_BUF_SIZE - 1));
466 tty->read_head = tty->canon_head;
467 spin_unlock_irqrestore(&tty->read_lock, flags);
469 echo_char(KILL_CHAR(tty), tty);
470 /* Add a newline if ECHOK is on and ECHOKE is off. */
479 while (tty->read_head != tty->canon_head) {
480 head = tty->read_head;
482 /* erase a single possibly multibyte character */
484 head = (head - 1) & (N_TTY_BUF_SIZE-1);
485 c = tty->read_buf[head];
486 } while (is_continuation(c, tty) && head != tty->canon_head);
488 /* do not partially erase */
489 if (is_continuation(c, tty))
492 if (kill_type == WERASE) {
493 /* Equivalent to BSD's ALTWERASE. */
494 if (isalnum(c) || c == '_')
496 else if (seen_alnums)
499 cnt = (tty->read_head - head) & (N_TTY_BUF_SIZE-1);
500 spin_lock_irqsave(&tty->read_lock, flags);
501 tty->read_head = head;
502 tty->read_cnt -= cnt;
503 spin_unlock_irqrestore(&tty->read_lock, flags);
505 if (L_ECHOPRT(tty)) {
507 tty_put_char(tty, '\\');
511 /* if cnt > 1, output a multi-byte character */
514 head = (head+1) & (N_TTY_BUF_SIZE-1);
515 tty_put_char(tty, tty->read_buf[head]);
517 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
518 echo_char(ERASE_CHAR(tty), tty);
519 } else if (c == '\t') {
520 unsigned int col = tty->canon_column;
521 unsigned long tail = tty->canon_head;
523 /* Find the column of the last char. */
524 while (tail != tty->read_head) {
525 c = tty->read_buf[tail];
528 else if (iscntrl(c)) {
531 } else if (!is_continuation(c, tty))
533 tail = (tail+1) & (N_TTY_BUF_SIZE-1);
536 /* should never happen */
537 if (tty->column > 0x80000000)
540 /* Now backup to that column. */
541 while (tty->column > col) {
542 /* Can't use opost here. */
543 tty_put_char(tty, '\b');
548 if (iscntrl(c) && L_ECHOCTL(tty)) {
549 tty_put_char(tty, '\b');
550 tty_put_char(tty, ' ');
551 tty_put_char(tty, '\b');
555 if (!iscntrl(c) || L_ECHOCTL(tty)) {
556 tty_put_char(tty, '\b');
557 tty_put_char(tty, ' ');
558 tty_put_char(tty, '\b');
564 if (kill_type == ERASE)
567 if (tty->read_head == tty->canon_head)
572 * isig - handle the ISIG optio
575 * @flush: force flush
577 * Called when a signal is being sent due to terminal input. This
578 * may caus terminal flushing to take place according to the termios
579 * settings and character used. Called from the driver receive_buf
580 * path so serialized.
583 static inline void isig(int sig, struct tty_struct *tty, int flush)
586 kill_pgrp(tty->pgrp, sig, 1);
587 if (flush || !L_NOFLSH(tty)) {
588 n_tty_flush_buffer(tty);
589 tty_driver_flush_buffer(tty);
594 * n_tty_receive_break - handle break
597 * An RS232 break event has been hit in the incoming bitstream. This
598 * can cause a variety of events depending upon the termios settings.
600 * Called from the receive_buf path so single threaded.
603 static inline void n_tty_receive_break(struct tty_struct *tty)
608 isig(SIGINT, tty, 1);
612 put_tty_queue('\377', tty);
613 put_tty_queue('\0', tty);
615 put_tty_queue('\0', tty);
616 wake_up_interruptible(&tty->read_wait);
620 * n_tty_receive_overrun - handle overrun reporting
623 * Data arrived faster than we could process it. While the tty
624 * driver has flagged this the bits that were missed are gone
627 * Called from the receive_buf path so single threaded. Does not
628 * need locking as num_overrun and overrun_time are function
632 static inline void n_tty_receive_overrun(struct tty_struct *tty)
637 if (time_before(tty->overrun_time, jiffies - HZ) ||
638 time_after(tty->overrun_time, jiffies)) {
639 printk(KERN_WARNING "%s: %d input overrun(s)\n",
642 tty->overrun_time = jiffies;
643 tty->num_overrun = 0;
648 * n_tty_receive_parity_error - error notifier
649 * @tty: terminal device
652 * Process a parity error and queue the right data to indicate
653 * the error case if necessary. Locking as per n_tty_receive_buf.
655 static inline void n_tty_receive_parity_error(struct tty_struct *tty,
661 put_tty_queue('\377', tty);
662 put_tty_queue('\0', tty);
663 put_tty_queue(c, tty);
664 } else if (I_INPCK(tty))
665 put_tty_queue('\0', tty);
667 put_tty_queue(c, tty);
668 wake_up_interruptible(&tty->read_wait);
672 * n_tty_receive_char - perform processing
673 * @tty: terminal device
676 * Process an individual character of input received from the driver.
677 * This is serialized with respect to itself by the rules for the
681 static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
686 put_tty_queue(c, tty);
692 if (I_IUCLC(tty) && L_IEXTEN(tty))
695 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) &&
696 ((I_IXANY(tty) && c != START_CHAR(tty) && c != STOP_CHAR(tty)) ||
697 c == INTR_CHAR(tty) || c == QUIT_CHAR(tty) || c == SUSP_CHAR(tty)))
702 if (c == START_CHAR(tty))
704 else if (c == STOP_CHAR(tty))
711 * If the previous character was LNEXT, or we know that this
712 * character is not one of the characters that we'll have to
713 * handle specially, do shortcut processing to speed things
716 if (!test_bit(c, tty->process_char_map) || tty->lnext) {
720 if (tty->read_cnt >= N_TTY_BUF_SIZE-1) {
721 tty_put_char(tty, '\a'); /* beep if no space */
724 /* Record the column of first canon char. */
725 if (tty->canon_head == tty->read_head)
726 tty->canon_column = tty->column;
729 if (I_PARMRK(tty) && c == (unsigned char) '\377')
730 put_tty_queue(c, tty);
731 put_tty_queue(c, tty);
736 if (c == START_CHAR(tty)) {
740 if (c == STOP_CHAR(tty)) {
749 if (c == INTR_CHAR(tty))
752 if (c == QUIT_CHAR(tty))
755 if (c == SUSP_CHAR(tty)) {
758 * Echo character, and then send the signal.
759 * Note that we do not use isig() here because we want
761 * 1) flush, 2) echo, 3) signal
763 if (!L_NOFLSH(tty)) {
764 n_tty_flush_buffer(tty);
765 tty_driver_flush_buffer(tty);
770 kill_pgrp(tty->pgrp, signal, 1);
780 } else if (c == '\n' && I_INLCR(tty))
784 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
785 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
789 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
793 if (L_ECHOCTL(tty)) {
794 tty_put_char(tty, '^');
795 tty_put_char(tty, '\b');
800 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) &&
802 unsigned long tail = tty->canon_head;
807 while (tail != tty->read_head) {
808 echo_char(tty->read_buf[tail], tty);
809 tail = (tail+1) & (N_TTY_BUF_SIZE-1);
814 if (L_ECHO(tty) || L_ECHONL(tty)) {
815 if (tty->read_cnt >= N_TTY_BUF_SIZE-1)
816 tty_put_char(tty, '\a');
821 if (c == EOF_CHAR(tty)) {
822 if (tty->canon_head != tty->read_head)
823 set_bit(TTY_PUSH, &tty->flags);
827 if ((c == EOL_CHAR(tty)) ||
828 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
830 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
833 if (tty->read_cnt >= N_TTY_BUF_SIZE-1)
834 tty_put_char(tty, '\a');
835 /* Record the column of first canon char. */
836 if (tty->canon_head == tty->read_head)
837 tty->canon_column = tty->column;
841 * XXX does PARMRK doubling happen for
842 * EOL_CHAR and EOL2_CHAR?
844 if (I_PARMRK(tty) && c == (unsigned char) '\377')
845 put_tty_queue(c, tty);
848 spin_lock_irqsave(&tty->read_lock, flags);
849 set_bit(tty->read_head, tty->read_flags);
850 put_tty_queue_nolock(c, tty);
851 tty->canon_head = tty->read_head;
853 spin_unlock_irqrestore(&tty->read_lock, flags);
854 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
855 if (waitqueue_active(&tty->read_wait))
856 wake_up_interruptible(&tty->read_wait);
863 if (tty->read_cnt >= N_TTY_BUF_SIZE-1) {
864 tty_put_char(tty, '\a'); /* beep if no space */
870 /* Record the column of first canon char. */
871 if (tty->canon_head == tty->read_head)
872 tty->canon_column = tty->column;
877 if (I_PARMRK(tty) && c == (unsigned char) '\377')
878 put_tty_queue(c, tty);
880 put_tty_queue(c, tty);
885 * n_tty_write_wakeup - asynchronous I/O notifier
888 * Required for the ptys, serial driver etc. since processes
889 * that attach themselves to the master and rely on ASYNC
890 * IO must be woken up
893 static void n_tty_write_wakeup(struct tty_struct *tty)
896 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
897 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
902 * n_tty_receive_buf - data receive
903 * @tty: terminal device
908 * Called by the terminal driver when a block of characters has
909 * been received. This function must be called from soft contexts
910 * not from interrupt context. The driver is responsible for making
911 * calls one at a time and in order (or using flush_to_ldisc)
914 static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
917 const unsigned char *p;
918 char *f, flags = TTY_NORMAL;
921 unsigned long cpuflags;
927 spin_lock_irqsave(&tty->read_lock, cpuflags);
928 i = min(N_TTY_BUF_SIZE - tty->read_cnt,
929 N_TTY_BUF_SIZE - tty->read_head);
931 memcpy(tty->read_buf + tty->read_head, cp, i);
932 tty->read_head = (tty->read_head + i) & (N_TTY_BUF_SIZE-1);
937 i = min(N_TTY_BUF_SIZE - tty->read_cnt,
938 N_TTY_BUF_SIZE - tty->read_head);
940 memcpy(tty->read_buf + tty->read_head, cp, i);
941 tty->read_head = (tty->read_head + i) & (N_TTY_BUF_SIZE-1);
943 spin_unlock_irqrestore(&tty->read_lock, cpuflags);
945 for (i = count, p = cp, f = fp; i; i--, p++) {
950 n_tty_receive_char(tty, *p);
953 n_tty_receive_break(tty);
957 n_tty_receive_parity_error(tty, *p);
960 n_tty_receive_overrun(tty);
963 printk(KERN_ERR "%s: unknown flag %d\n",
964 tty_name(tty, buf), flags);
968 if (tty->ops->flush_chars)
969 tty->ops->flush_chars(tty);
974 if (!tty->icanon && (tty->read_cnt >= tty->minimum_to_wake)) {
975 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
976 if (waitqueue_active(&tty->read_wait))
977 wake_up_interruptible(&tty->read_wait);
981 * Check the remaining room for the input canonicalization
982 * mode. We don't want to throttle the driver if we're in
983 * canonical mode and don't have a newline yet!
985 if (tty->receive_room < TTY_THRESHOLD_THROTTLE) {
986 /* check TTY_THROTTLED first so it indicates our state */
987 if (!test_and_set_bit(TTY_THROTTLED, &tty->flags) &&
989 tty->ops->throttle(tty);
993 int is_ignored(int sig)
995 return (sigismember(¤t->blocked, sig) ||
996 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
1000 * n_tty_set_termios - termios data changed
1002 * @old: previous data
1004 * Called by the tty layer when the user changes termios flags so
1005 * that the line discipline can plan ahead. This function cannot sleep
1006 * and is protected from re-entry by the tty layer. The user is
1007 * guaranteed that this function will not be re-entered or in progress
1008 * when the ldisc is closed.
1011 static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
1016 tty->icanon = (L_ICANON(tty) != 0);
1017 if (test_bit(TTY_HW_COOK_IN, &tty->flags)) {
1020 n_tty_set_room(tty);
1023 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1024 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1025 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1027 memset(tty->process_char_map, 0, 256/8);
1029 if (I_IGNCR(tty) || I_ICRNL(tty))
1030 set_bit('\r', tty->process_char_map);
1032 set_bit('\n', tty->process_char_map);
1034 if (L_ICANON(tty)) {
1035 set_bit(ERASE_CHAR(tty), tty->process_char_map);
1036 set_bit(KILL_CHAR(tty), tty->process_char_map);
1037 set_bit(EOF_CHAR(tty), tty->process_char_map);
1038 set_bit('\n', tty->process_char_map);
1039 set_bit(EOL_CHAR(tty), tty->process_char_map);
1040 if (L_IEXTEN(tty)) {
1041 set_bit(WERASE_CHAR(tty),
1042 tty->process_char_map);
1043 set_bit(LNEXT_CHAR(tty),
1044 tty->process_char_map);
1045 set_bit(EOL2_CHAR(tty),
1046 tty->process_char_map);
1048 set_bit(REPRINT_CHAR(tty),
1049 tty->process_char_map);
1053 set_bit(START_CHAR(tty), tty->process_char_map);
1054 set_bit(STOP_CHAR(tty), tty->process_char_map);
1057 set_bit(INTR_CHAR(tty), tty->process_char_map);
1058 set_bit(QUIT_CHAR(tty), tty->process_char_map);
1059 set_bit(SUSP_CHAR(tty), tty->process_char_map);
1061 clear_bit(__DISABLED_CHAR, tty->process_char_map);
1066 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1067 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1068 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
1073 n_tty_set_room(tty);
1074 /* The termios change make the tty ready for I/O */
1075 wake_up_interruptible(&tty->write_wait);
1076 wake_up_interruptible(&tty->read_wait);
1080 * n_tty_close - close the ldisc for this tty
1083 * Called from the terminal layer when this line discipline is
1084 * being shut down, either because of a close or becsuse of a
1085 * discipline change. The function will not be called while other
1086 * ldisc methods are in progress.
1089 static void n_tty_close(struct tty_struct *tty)
1091 n_tty_flush_buffer(tty);
1092 if (tty->read_buf) {
1093 free_buf(tty->read_buf);
1094 tty->read_buf = NULL;
1099 * n_tty_open - open an ldisc
1100 * @tty: terminal to open
1102 * Called when this line discipline is being attached to the
1103 * terminal device. Can sleep. Called serialized so that no
1104 * other events will occur in parallel. No further open will occur
1108 static int n_tty_open(struct tty_struct *tty)
1113 /* This one is ugly. Currently a malloc failure here can panic */
1114 if (!tty->read_buf) {
1115 tty->read_buf = alloc_buf();
1119 memset(tty->read_buf, 0, N_TTY_BUF_SIZE);
1120 reset_buffer_flags(tty);
1122 n_tty_set_termios(tty, NULL);
1123 tty->minimum_to_wake = 1;
1128 static inline int input_available_p(struct tty_struct *tty, int amt)
1131 if (tty->canon_data)
1133 } else if (tty->read_cnt >= (amt ? amt : 1))
1140 * copy_from_read_buf - copy read data directly
1141 * @tty: terminal device
1145 * Helper function to speed up read_chan. It is only called when
1146 * ICANON is off; it copies characters straight from the tty queue to
1147 * user space directly. It can be profitably called twice; once to
1148 * drain the space from the tail pointer to the (physical) end of the
1149 * buffer, and once to drain the space from the (physical) beginning of
1150 * the buffer to head pointer.
1152 * Called under the tty->atomic_read_lock sem
1156 static int copy_from_read_buf(struct tty_struct *tty,
1157 unsigned char __user **b,
1163 unsigned long flags;
1166 spin_lock_irqsave(&tty->read_lock, flags);
1167 n = min(tty->read_cnt, N_TTY_BUF_SIZE - tty->read_tail);
1169 spin_unlock_irqrestore(&tty->read_lock, flags);
1171 retval = copy_to_user(*b, &tty->read_buf[tty->read_tail], n);
1173 tty_audit_add_data(tty, &tty->read_buf[tty->read_tail], n);
1174 spin_lock_irqsave(&tty->read_lock, flags);
1175 tty->read_tail = (tty->read_tail + n) & (N_TTY_BUF_SIZE-1);
1177 spin_unlock_irqrestore(&tty->read_lock, flags);
1184 extern ssize_t redirected_tty_write(struct file *, const char __user *,
1188 * job_control - check job control
1190 * @file: file handle
1192 * Perform job control management checks on this file/tty descriptor
1193 * and if appropriate send any needed signals and return a negative
1194 * error code if action should be taken.
1197 * Locking: None - redirected write test is safe, testing
1198 * current->signal should possibly lock current->sighand
1202 static int job_control(struct tty_struct *tty, struct file *file)
1204 /* Job control check -- must be done at start and after
1205 every sleep (POSIX.1 7.1.1.4). */
1206 /* NOTE: not yet done after every sleep pending a thorough
1207 check of the logic of this change. -- jlc */
1208 /* don't stop on /dev/console */
1209 if (file->f_op->write != redirected_tty_write &&
1210 current->signal->tty == tty) {
1212 printk(KERN_ERR "read_chan: no tty->pgrp!\n");
1213 else if (task_pgrp(current) != tty->pgrp) {
1214 if (is_ignored(SIGTTIN) ||
1215 is_current_pgrp_orphaned())
1217 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
1218 set_thread_flag(TIF_SIGPENDING);
1219 return -ERESTARTSYS;
1227 * read_chan - read function for tty
1229 * @file: file object
1230 * @buf: userspace buffer pointer
1233 * Perform reads for the line discipline. We are guaranteed that the
1234 * line discipline will not be closed under us but we may get multiple
1235 * parallel readers and must handle this ourselves. We may also get
1236 * a hangup. Always called in user context, may sleep.
1238 * This code must be sure never to sleep through a hangup.
1241 static ssize_t read_chan(struct tty_struct *tty, struct file *file,
1242 unsigned char __user *buf, size_t nr)
1244 unsigned char __user *b = buf;
1245 DECLARE_WAITQUEUE(wait, current);
1251 unsigned long flags;
1256 if (!tty->read_buf) {
1257 printk(KERN_ERR "n_tty_read_chan: read_buf == NULL?!?\n");
1261 c = job_control(tty, file);
1266 timeout = MAX_SCHEDULE_TIMEOUT;
1268 time = (HZ / 10) * TIME_CHAR(tty);
1269 minimum = MIN_CHAR(tty);
1272 tty->minimum_to_wake = 1;
1273 else if (!waitqueue_active(&tty->read_wait) ||
1274 (tty->minimum_to_wake > minimum))
1275 tty->minimum_to_wake = minimum;
1282 tty->minimum_to_wake = minimum = 1;
1287 * Internal serialization of reads.
1289 if (file->f_flags & O_NONBLOCK) {
1290 if (!mutex_trylock(&tty->atomic_read_lock))
1293 if (mutex_lock_interruptible(&tty->atomic_read_lock))
1294 return -ERESTARTSYS;
1296 packet = tty->packet;
1298 add_wait_queue(&tty->read_wait, &wait);
1300 /* First test for status change. */
1301 if (packet && tty->link->ctrl_status) {
1305 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
1306 cs = tty->link->ctrl_status;
1307 tty->link->ctrl_status = 0;
1308 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
1309 if (tty_put_user(tty, cs, b++)) {
1317 /* This statement must be first before checking for input
1318 so that any interrupt will set the state back to
1320 set_current_state(TASK_INTERRUPTIBLE);
1322 if (((minimum - (b - buf)) < tty->minimum_to_wake) &&
1323 ((minimum - (b - buf)) >= 1))
1324 tty->minimum_to_wake = (minimum - (b - buf));
1326 if (!input_available_p(tty, 0)) {
1327 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
1331 if (tty_hung_up_p(file))
1335 if (file->f_flags & O_NONBLOCK) {
1339 if (signal_pending(current)) {
1340 retval = -ERESTARTSYS;
1343 /* FIXME: does n_tty_set_room need locking ? */
1344 n_tty_set_room(tty);
1345 timeout = schedule_timeout(timeout);
1348 __set_current_state(TASK_RUNNING);
1350 /* Deal with packet mode. */
1351 if (packet && b == buf) {
1352 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
1361 /* N.B. avoid overrun if nr == 0 */
1362 while (nr && tty->read_cnt) {
1365 eol = test_and_clear_bit(tty->read_tail,
1367 c = tty->read_buf[tty->read_tail];
1368 spin_lock_irqsave(&tty->read_lock, flags);
1369 tty->read_tail = ((tty->read_tail+1) &
1370 (N_TTY_BUF_SIZE-1));
1373 /* this test should be redundant:
1374 * we shouldn't be reading data if
1377 if (--tty->canon_data < 0)
1378 tty->canon_data = 0;
1380 spin_unlock_irqrestore(&tty->read_lock, flags);
1382 if (!eol || (c != __DISABLED_CHAR)) {
1383 if (tty_put_user(tty, c, b++)) {
1391 tty_audit_push(tty);
1399 /* The copy function takes the read lock and handles
1400 locking internally for this case */
1401 uncopied = copy_from_read_buf(tty, &b, &nr);
1402 uncopied += copy_from_read_buf(tty, &b, &nr);
1409 /* If there is enough space in the read buffer now, let the
1410 * low-level driver know. We use n_tty_chars_in_buffer() to
1411 * check the buffer, as it now knows about canonical mode.
1412 * Otherwise, if the driver is throttled and the line is
1413 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
1414 * we won't get any more characters.
1416 if (n_tty_chars_in_buffer(tty) <= TTY_THRESHOLD_UNTHROTTLE) {
1417 n_tty_set_room(tty);
1418 check_unthrottle(tty);
1421 if (b - buf >= minimum)
1426 mutex_unlock(&tty->atomic_read_lock);
1427 remove_wait_queue(&tty->read_wait, &wait);
1429 if (!waitqueue_active(&tty->read_wait))
1430 tty->minimum_to_wake = minimum;
1432 __set_current_state(TASK_RUNNING);
1437 clear_bit(TTY_PUSH, &tty->flags);
1438 } else if (test_and_clear_bit(TTY_PUSH, &tty->flags))
1441 n_tty_set_room(tty);
1446 * write_chan - write function for tty
1448 * @file: file object
1449 * @buf: userspace buffer pointer
1452 * Write function of the terminal device. This is serialized with
1453 * respect to other write callers but not to termios changes, reads
1454 * and other such events. We must be careful with N_TTY as the receive
1455 * code will echo characters, thus calling driver write methods.
1457 * This code must be sure never to sleep through a hangup.
1460 static ssize_t write_chan(struct tty_struct *tty, struct file *file,
1461 const unsigned char *buf, size_t nr)
1463 const unsigned char *b = buf;
1464 DECLARE_WAITQUEUE(wait, current);
1468 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
1469 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
1470 retval = tty_check_change(tty);
1475 add_wait_queue(&tty->write_wait, &wait);
1477 set_current_state(TASK_INTERRUPTIBLE);
1478 if (signal_pending(current)) {
1479 retval = -ERESTARTSYS;
1482 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
1486 if (O_OPOST(tty) && !(test_bit(TTY_HW_COOK_OUT, &tty->flags))) {
1488 ssize_t num = opost_block(tty, b, nr);
1500 if (opost(c, tty) < 0)
1504 if (tty->ops->flush_chars)
1505 tty->ops->flush_chars(tty);
1508 c = tty->ops->write(tty, b, nr);
1521 if (file->f_flags & O_NONBLOCK) {
1528 __set_current_state(TASK_RUNNING);
1529 remove_wait_queue(&tty->write_wait, &wait);
1530 return (b - buf) ? b - buf : retval;
1534 * normal_poll - poll method for N_TTY
1535 * @tty: terminal device
1536 * @file: file accessing it
1539 * Called when the line discipline is asked to poll() for data or
1540 * for special events. This code is not serialized with respect to
1541 * other events save open/close.
1543 * This code must be sure never to sleep through a hangup.
1544 * Called without the kernel lock held - fine
1547 static unsigned int normal_poll(struct tty_struct *tty, struct file *file,
1550 unsigned int mask = 0;
1552 poll_wait(file, &tty->read_wait, wait);
1553 poll_wait(file, &tty->write_wait, wait);
1554 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
1555 mask |= POLLIN | POLLRDNORM;
1556 if (tty->packet && tty->link->ctrl_status)
1557 mask |= POLLPRI | POLLIN | POLLRDNORM;
1558 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
1560 if (tty_hung_up_p(file))
1562 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
1563 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
1564 tty->minimum_to_wake = MIN_CHAR(tty);
1566 tty->minimum_to_wake = 1;
1568 if (tty->ops->write && !tty_is_writelocked(tty) &&
1569 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
1570 tty_write_room(tty) > 0)
1571 mask |= POLLOUT | POLLWRNORM;
1575 struct tty_ldisc tty_ldisc_N_TTY = {
1576 .magic = TTY_LDISC_MAGIC,
1579 .close = n_tty_close,
1580 .flush_buffer = n_tty_flush_buffer,
1581 .chars_in_buffer = n_tty_chars_in_buffer,
1583 .write = write_chan,
1584 .ioctl = n_tty_ioctl,
1585 .set_termios = n_tty_set_termios,
1586 .poll = normal_poll,
1587 .receive_buf = n_tty_receive_buf,
1588 .write_wakeup = n_tty_write_wakeup