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 n_tty_write 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>
50 #include <linux/uaccess.h>
51 #include <linux/module.h>
52 #include <linux/ratelimit.h>
55 /* number of characters left in xmit buffer before select has we have room */
56 #define WAKEUP_CHARS 256
59 * This defines the low- and high-watermarks for throttling and
60 * unthrottling the TTY driver. These watermarks are used for
61 * controlling the space in the read buffer.
63 #define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
64 #define TTY_THRESHOLD_UNTHROTTLE 128
67 * Special byte codes used in the echo buffer to represent operations
68 * or special handling of characters. Bytes in the echo buffer that
69 * are not part of such special blocks are treated as normal character
72 #define ECHO_OP_START 0xff
73 #define ECHO_OP_MOVE_BACK_COL 0x80
74 #define ECHO_OP_SET_CANON_COL 0x81
75 #define ECHO_OP_ERASE_TAB 0x82
79 unsigned long overrun_time;
82 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
83 unsigned char echo_overrun:1;
85 DECLARE_BITMAP(process_char_map, 256);
86 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
94 unsigned char *echo_buf;
95 unsigned int echo_pos;
96 unsigned int echo_cnt;
99 unsigned long canon_head;
100 unsigned int canon_column;
102 struct mutex atomic_read_lock;
103 struct mutex output_lock;
104 struct mutex echo_lock;
105 raw_spinlock_t read_lock;
108 static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
109 unsigned char __user *ptr)
111 struct n_tty_data *ldata = tty->disc_data;
113 tty_audit_add_data(tty, &x, 1, ldata->icanon);
114 return put_user(x, ptr);
118 * n_tty_set__room - receive space
121 * Called by the driver to find out how much data it is
122 * permitted to feed to the line discipline without any being lost
123 * and thus to manage flow control. Not serialized. Answers for the
127 static void n_tty_set_room(struct tty_struct *tty)
129 struct n_tty_data *ldata = tty->disc_data;
133 /* ldata->read_cnt is not read locked ? */
135 /* Multiply read_cnt by 3, since each byte might take up to
136 * three times as many spaces when PARMRK is set (depending on
137 * its flags, e.g. parity error). */
138 left = N_TTY_BUF_SIZE - ldata->read_cnt * 3 - 1;
140 left = N_TTY_BUF_SIZE - ldata->read_cnt - 1;
143 * If we are doing input canonicalization, and there are no
144 * pending newlines, let characters through without limit, so
145 * that erase characters will be handled. Other excess
146 * characters will be beeped.
149 left = ldata->icanon && !ldata->canon_data;
150 old_left = tty->receive_room;
151 tty->receive_room = left;
153 /* Did this open up the receive buffer? We may need to flip */
154 if (left && !old_left) {
155 WARN_RATELIMIT(tty->port->itty == NULL,
156 "scheduling with invalid itty\n");
157 /* see if ldisc has been killed - if so, this means that
158 * even though the ldisc has been halted and ->buf.work
159 * cancelled, ->buf.work is about to be rescheduled
161 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
162 "scheduling buffer work for halted ldisc\n");
163 schedule_work(&tty->port->buf.work);
167 static void put_tty_queue_nolock(unsigned char c, struct n_tty_data *ldata)
169 if (ldata->read_cnt < N_TTY_BUF_SIZE) {
170 ldata->read_buf[ldata->read_head] = c;
171 ldata->read_head = (ldata->read_head + 1) & (N_TTY_BUF_SIZE-1);
177 * put_tty_queue - add character to tty
181 * Add a character to the tty read_buf queue. This is done under the
182 * read_lock to serialize character addition and also to protect us
183 * against parallel reads or flushes
186 static void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
190 * The problem of stomping on the buffers ends here.
191 * Why didn't anyone see this one coming? --AJK
193 raw_spin_lock_irqsave(&ldata->read_lock, flags);
194 put_tty_queue_nolock(c, ldata);
195 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
199 * reset_buffer_flags - reset buffer state
200 * @tty: terminal to reset
202 * Reset the read buffer counters and clear the flags.
203 * Called from n_tty_open() and n_tty_flush_buffer().
205 * Locking: tty_read_lock for read fields.
208 static void reset_buffer_flags(struct n_tty_data *ldata)
212 raw_spin_lock_irqsave(&ldata->read_lock, flags);
213 ldata->read_head = ldata->read_tail = ldata->read_cnt = 0;
214 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
216 mutex_lock(&ldata->echo_lock);
217 ldata->echo_pos = ldata->echo_cnt = ldata->echo_overrun = 0;
218 mutex_unlock(&ldata->echo_lock);
220 ldata->canon_head = ldata->canon_data = ldata->erasing = 0;
221 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
224 static void n_tty_packet_mode_flush(struct tty_struct *tty)
228 spin_lock_irqsave(&tty->ctrl_lock, flags);
229 if (tty->link->packet) {
230 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
231 wake_up_interruptible(&tty->link->read_wait);
233 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
237 * n_tty_flush_buffer - clean input queue
238 * @tty: terminal device
240 * Flush the input buffer. Called when the tty layer wants the
241 * buffer flushed (eg at hangup) or when the N_TTY line discipline
242 * internally has to clean the pending queue (for example some signals).
244 * Locking: ctrl_lock, read_lock.
247 static void n_tty_flush_buffer(struct tty_struct *tty)
249 reset_buffer_flags(tty->disc_data);
253 n_tty_packet_mode_flush(tty);
257 * n_tty_chars_in_buffer - report available bytes
260 * Report the number of characters buffered to be delivered to user
261 * at this instant in time.
266 static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
268 struct n_tty_data *ldata = tty->disc_data;
272 raw_spin_lock_irqsave(&ldata->read_lock, flags);
273 if (!ldata->icanon) {
275 } else if (ldata->canon_data) {
276 n = (ldata->canon_head > ldata->read_tail) ?
277 ldata->canon_head - ldata->read_tail :
278 ldata->canon_head + (N_TTY_BUF_SIZE - ldata->read_tail);
280 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
285 * is_utf8_continuation - utf8 multibyte check
288 * Returns true if the utf8 character 'c' is a multibyte continuation
289 * character. We use this to correctly compute the on screen size
290 * of the character when printing
293 static inline int is_utf8_continuation(unsigned char c)
295 return (c & 0xc0) == 0x80;
299 * is_continuation - multibyte check
302 * Returns true if the utf8 character 'c' is a multibyte continuation
303 * character and the terminal is in unicode mode.
306 static inline int is_continuation(unsigned char c, struct tty_struct *tty)
308 return I_IUTF8(tty) && is_utf8_continuation(c);
312 * do_output_char - output one character
313 * @c: character (or partial unicode symbol)
314 * @tty: terminal device
315 * @space: space available in tty driver write buffer
317 * This is a helper function that handles one output character
318 * (including special characters like TAB, CR, LF, etc.),
319 * doing OPOST processing and putting the results in the
320 * tty driver's write buffer.
322 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
323 * and NLDLY. They simply aren't relevant in the world today.
324 * If you ever need them, add them here.
326 * Returns the number of bytes of buffer space used or -1 if
329 * Locking: should be called under the output_lock to protect
330 * the column state and space left in the buffer
333 static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
335 struct n_tty_data *ldata = tty->disc_data;
348 ldata->canon_column = ldata->column = 0;
349 tty->ops->write(tty, "\r\n", 2);
352 ldata->canon_column = ldata->column;
355 if (O_ONOCR(tty) && ldata->column == 0)
360 ldata->canon_column = ldata->column = 0;
363 ldata->canon_column = ldata->column = 0;
366 spaces = 8 - (ldata->column & 7);
367 if (O_TABDLY(tty) == XTABS) {
370 ldata->column += spaces;
371 tty->ops->write(tty, " ", spaces);
374 ldata->column += spaces;
377 if (ldata->column > 0)
384 if (!is_continuation(c, tty))
390 tty_put_char(tty, c);
395 * process_output - output post processor
396 * @c: character (or partial unicode symbol)
397 * @tty: terminal device
399 * Output one character with OPOST processing.
400 * Returns -1 when the output device is full and the character
403 * Locking: output_lock to protect column state and space left
404 * (also, this is called from n_tty_write under the
405 * tty layer write lock)
408 static int process_output(unsigned char c, struct tty_struct *tty)
410 struct n_tty_data *ldata = tty->disc_data;
413 mutex_lock(&ldata->output_lock);
415 space = tty_write_room(tty);
416 retval = do_output_char(c, tty, space);
418 mutex_unlock(&ldata->output_lock);
426 * process_output_block - block post processor
427 * @tty: terminal device
428 * @buf: character buffer
429 * @nr: number of bytes to output
431 * Output a block of characters with OPOST processing.
432 * Returns the number of characters output.
434 * This path is used to speed up block console writes, among other
435 * things when processing blocks of output data. It handles only
436 * the simple cases normally found and helps to generate blocks of
437 * symbols for the console driver and thus improve performance.
439 * Locking: output_lock to protect column state and space left
440 * (also, this is called from n_tty_write under the
441 * tty layer write lock)
444 static ssize_t process_output_block(struct tty_struct *tty,
445 const unsigned char *buf, unsigned int nr)
447 struct n_tty_data *ldata = tty->disc_data;
450 const unsigned char *cp;
452 mutex_lock(&ldata->output_lock);
454 space = tty_write_room(tty);
456 mutex_unlock(&ldata->output_lock);
462 for (i = 0, cp = buf; i < nr; i++, cp++) {
463 unsigned char c = *cp;
471 ldata->canon_column = ldata->column;
474 if (O_ONOCR(tty) && ldata->column == 0)
478 ldata->canon_column = ldata->column = 0;
483 if (ldata->column > 0)
490 if (!is_continuation(c, tty))
497 i = tty->ops->write(tty, buf, i);
499 mutex_unlock(&ldata->output_lock);
504 * process_echoes - write pending echo characters
505 * @tty: terminal device
507 * Write previously buffered echo (and other ldisc-generated)
508 * characters to the tty.
510 * Characters generated by the ldisc (including echoes) need to
511 * be buffered because the driver's write buffer can fill during
512 * heavy program output. Echoing straight to the driver will
513 * often fail under these conditions, causing lost characters and
514 * resulting mismatches of ldisc state information.
516 * Since the ldisc state must represent the characters actually sent
517 * to the driver at the time of the write, operations like certain
518 * changes in column state are also saved in the buffer and executed
521 * A circular fifo buffer is used so that the most recent characters
522 * are prioritized. Also, when control characters are echoed with a
523 * prefixed "^", the pair is treated atomically and thus not separated.
525 * Locking: output_lock to protect column state and space left,
526 * echo_lock to protect the echo buffer
529 static void process_echoes(struct tty_struct *tty)
531 struct n_tty_data *ldata = tty->disc_data;
534 unsigned char *cp, *buf_end;
536 if (!ldata->echo_cnt)
539 mutex_lock(&ldata->output_lock);
540 mutex_lock(&ldata->echo_lock);
542 space = tty_write_room(tty);
544 buf_end = ldata->echo_buf + N_TTY_BUF_SIZE;
545 cp = ldata->echo_buf + ldata->echo_pos;
546 nr = ldata->echo_cnt;
549 if (c == ECHO_OP_START) {
552 int no_space_left = 0;
555 * If the buffer byte is the start of a multi-byte
556 * operation, get the next byte, which is either the
557 * op code or a control character value.
561 opp -= N_TTY_BUF_SIZE;
565 unsigned int num_chars, num_bs;
567 case ECHO_OP_ERASE_TAB:
568 if (++opp == buf_end)
569 opp -= N_TTY_BUF_SIZE;
573 * Determine how many columns to go back
574 * in order to erase the tab.
575 * This depends on the number of columns
576 * used by other characters within the tab
577 * area. If this (modulo 8) count is from
578 * the start of input rather than from a
579 * previous tab, we offset by canon column.
580 * Otherwise, tab spacing is normal.
582 if (!(num_chars & 0x80))
583 num_chars += ldata->canon_column;
584 num_bs = 8 - (num_chars & 7);
586 if (num_bs > space) {
592 tty_put_char(tty, '\b');
593 if (ldata->column > 0)
600 case ECHO_OP_SET_CANON_COL:
601 ldata->canon_column = ldata->column;
606 case ECHO_OP_MOVE_BACK_COL:
607 if (ldata->column > 0)
614 /* This is an escaped echo op start code */
619 tty_put_char(tty, ECHO_OP_START);
628 * If the op is not a special byte code,
629 * it is a ctrl char tagged to be echoed
630 * as "^X" (where X is the letter
631 * representing the control char).
632 * Note that we must ensure there is
633 * enough space for the whole ctrl pair.
640 tty_put_char(tty, '^');
641 tty_put_char(tty, op ^ 0100);
652 int retval = do_output_char(c, tty, space);
659 tty_put_char(tty, c);
666 /* When end of circular buffer reached, wrap around */
668 cp -= N_TTY_BUF_SIZE;
674 ldata->echo_overrun = 0;
676 int num_processed = ldata->echo_cnt - nr;
677 ldata->echo_pos += num_processed;
678 ldata->echo_pos &= N_TTY_BUF_SIZE - 1;
679 ldata->echo_cnt = nr;
680 if (num_processed > 0)
681 ldata->echo_overrun = 0;
684 mutex_unlock(&ldata->echo_lock);
685 mutex_unlock(&ldata->output_lock);
687 if (tty->ops->flush_chars)
688 tty->ops->flush_chars(tty);
692 * add_echo_byte - add a byte to the echo buffer
693 * @c: unicode byte to echo
696 * Add a character or operation byte to the echo buffer.
698 * Should be called under the echo lock to protect the echo buffer.
701 static void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
705 if (ldata->echo_cnt == N_TTY_BUF_SIZE) {
706 /* Circular buffer is already at capacity */
707 new_byte_pos = ldata->echo_pos;
710 * Since the buffer start position needs to be advanced,
711 * be sure to step by a whole operation byte group.
713 if (ldata->echo_buf[ldata->echo_pos] == ECHO_OP_START) {
714 if (ldata->echo_buf[(ldata->echo_pos + 1) &
715 (N_TTY_BUF_SIZE - 1)] ==
717 ldata->echo_pos += 3;
718 ldata->echo_cnt -= 2;
720 ldata->echo_pos += 2;
721 ldata->echo_cnt -= 1;
726 ldata->echo_pos &= N_TTY_BUF_SIZE - 1;
728 ldata->echo_overrun = 1;
730 new_byte_pos = ldata->echo_pos + ldata->echo_cnt;
731 new_byte_pos &= N_TTY_BUF_SIZE - 1;
735 ldata->echo_buf[new_byte_pos] = c;
739 * echo_move_back_col - add operation to move back a column
742 * Add an operation to the echo buffer to move back one column.
744 * Locking: echo_lock to protect the echo buffer
747 static void echo_move_back_col(struct n_tty_data *ldata)
749 mutex_lock(&ldata->echo_lock);
750 add_echo_byte(ECHO_OP_START, ldata);
751 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
752 mutex_unlock(&ldata->echo_lock);
756 * echo_set_canon_col - add operation to set the canon column
759 * Add an operation to the echo buffer to set the canon column
760 * to the current column.
762 * Locking: echo_lock to protect the echo buffer
765 static void echo_set_canon_col(struct n_tty_data *ldata)
767 mutex_lock(&ldata->echo_lock);
768 add_echo_byte(ECHO_OP_START, ldata);
769 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
770 mutex_unlock(&ldata->echo_lock);
774 * echo_erase_tab - add operation to erase a tab
775 * @num_chars: number of character columns already used
776 * @after_tab: true if num_chars starts after a previous tab
779 * Add an operation to the echo buffer to erase a tab.
781 * Called by the eraser function, which knows how many character
782 * columns have been used since either a previous tab or the start
783 * of input. This information will be used later, along with
784 * canon column (if applicable), to go back the correct number
787 * Locking: echo_lock to protect the echo buffer
790 static void echo_erase_tab(unsigned int num_chars, int after_tab,
791 struct n_tty_data *ldata)
793 mutex_lock(&ldata->echo_lock);
795 add_echo_byte(ECHO_OP_START, ldata);
796 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
798 /* We only need to know this modulo 8 (tab spacing) */
801 /* Set the high bit as a flag if num_chars is after a previous tab */
805 add_echo_byte(num_chars, ldata);
807 mutex_unlock(&ldata->echo_lock);
811 * echo_char_raw - echo a character raw
812 * @c: unicode byte to echo
813 * @tty: terminal device
815 * Echo user input back onto the screen. This must be called only when
816 * L_ECHO(tty) is true. Called from the driver receive_buf path.
818 * This variant does not treat control characters specially.
820 * Locking: echo_lock to protect the echo buffer
823 static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
825 mutex_lock(&ldata->echo_lock);
826 if (c == ECHO_OP_START) {
827 add_echo_byte(ECHO_OP_START, ldata);
828 add_echo_byte(ECHO_OP_START, ldata);
830 add_echo_byte(c, ldata);
832 mutex_unlock(&ldata->echo_lock);
836 * echo_char - echo a character
837 * @c: unicode byte to echo
838 * @tty: terminal device
840 * Echo user input back onto the screen. This must be called only when
841 * L_ECHO(tty) is true. Called from the driver receive_buf path.
843 * This variant tags control characters to be echoed as "^X"
844 * (where X is the letter representing the control char).
846 * Locking: echo_lock to protect the echo buffer
849 static void echo_char(unsigned char c, struct tty_struct *tty)
851 struct n_tty_data *ldata = tty->disc_data;
853 mutex_lock(&ldata->echo_lock);
855 if (c == ECHO_OP_START) {
856 add_echo_byte(ECHO_OP_START, ldata);
857 add_echo_byte(ECHO_OP_START, ldata);
859 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
860 add_echo_byte(ECHO_OP_START, ldata);
861 add_echo_byte(c, ldata);
864 mutex_unlock(&ldata->echo_lock);
868 * finish_erasing - complete erase
872 static inline void finish_erasing(struct n_tty_data *ldata)
874 if (ldata->erasing) {
875 echo_char_raw('/', ldata);
881 * eraser - handle erase function
882 * @c: character input
883 * @tty: terminal device
885 * Perform erase and necessary output when an erase character is
886 * present in the stream from the driver layer. Handles the complexities
887 * of UTF-8 multibyte symbols.
889 * Locking: read_lock for tty buffers
892 static void eraser(unsigned char c, struct tty_struct *tty)
894 struct n_tty_data *ldata = tty->disc_data;
895 enum { ERASE, WERASE, KILL } kill_type;
896 int head, seen_alnums, cnt;
899 /* FIXME: locking needed ? */
900 if (ldata->read_head == ldata->canon_head) {
901 /* process_output('\a', tty); */ /* what do you think? */
904 if (c == ERASE_CHAR(tty))
906 else if (c == WERASE_CHAR(tty))
910 raw_spin_lock_irqsave(&ldata->read_lock, flags);
911 ldata->read_cnt -= ((ldata->read_head - ldata->canon_head) &
912 (N_TTY_BUF_SIZE - 1));
913 ldata->read_head = ldata->canon_head;
914 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
917 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
918 raw_spin_lock_irqsave(&ldata->read_lock, flags);
919 ldata->read_cnt -= ((ldata->read_head - ldata->canon_head) &
920 (N_TTY_BUF_SIZE - 1));
921 ldata->read_head = ldata->canon_head;
922 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
923 finish_erasing(ldata);
924 echo_char(KILL_CHAR(tty), tty);
925 /* Add a newline if ECHOK is on and ECHOKE is off. */
927 echo_char_raw('\n', ldata);
934 /* FIXME: Locking ?? */
935 while (ldata->read_head != ldata->canon_head) {
936 head = ldata->read_head;
938 /* erase a single possibly multibyte character */
940 head = (head - 1) & (N_TTY_BUF_SIZE-1);
941 c = ldata->read_buf[head];
942 } while (is_continuation(c, tty) && head != ldata->canon_head);
944 /* do not partially erase */
945 if (is_continuation(c, tty))
948 if (kill_type == WERASE) {
949 /* Equivalent to BSD's ALTWERASE. */
950 if (isalnum(c) || c == '_')
952 else if (seen_alnums)
955 cnt = (ldata->read_head - head) & (N_TTY_BUF_SIZE-1);
956 raw_spin_lock_irqsave(&ldata->read_lock, flags);
957 ldata->read_head = head;
958 ldata->read_cnt -= cnt;
959 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
961 if (L_ECHOPRT(tty)) {
962 if (!ldata->erasing) {
963 echo_char_raw('\\', ldata);
966 /* if cnt > 1, output a multi-byte character */
969 head = (head+1) & (N_TTY_BUF_SIZE-1);
970 echo_char_raw(ldata->read_buf[head],
972 echo_move_back_col(ldata);
974 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
975 echo_char(ERASE_CHAR(tty), tty);
976 } else if (c == '\t') {
977 unsigned int num_chars = 0;
979 unsigned long tail = ldata->read_head;
982 * Count the columns used for characters
983 * since the start of input or after a
985 * This info is used to go back the correct
988 while (tail != ldata->canon_head) {
989 tail = (tail-1) & (N_TTY_BUF_SIZE-1);
990 c = ldata->read_buf[tail];
994 } else if (iscntrl(c)) {
997 } else if (!is_continuation(c, tty)) {
1001 echo_erase_tab(num_chars, after_tab, ldata);
1003 if (iscntrl(c) && L_ECHOCTL(tty)) {
1004 echo_char_raw('\b', ldata);
1005 echo_char_raw(' ', ldata);
1006 echo_char_raw('\b', ldata);
1008 if (!iscntrl(c) || L_ECHOCTL(tty)) {
1009 echo_char_raw('\b', ldata);
1010 echo_char_raw(' ', ldata);
1011 echo_char_raw('\b', ldata);
1015 if (kill_type == ERASE)
1018 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
1019 finish_erasing(ldata);
1023 * isig - handle the ISIG optio
1027 * Called when a signal is being sent due to terminal input.
1028 * Called from the driver receive_buf path so serialized.
1030 * Locking: ctrl_lock
1033 static inline void isig(int sig, struct tty_struct *tty)
1035 struct pid *tty_pgrp = tty_get_pgrp(tty);
1037 kill_pgrp(tty_pgrp, sig, 1);
1043 * n_tty_receive_break - handle break
1046 * An RS232 break event has been hit in the incoming bitstream. This
1047 * can cause a variety of events depending upon the termios settings.
1049 * Called from the receive_buf path so single threaded.
1052 static inline void n_tty_receive_break(struct tty_struct *tty)
1054 struct n_tty_data *ldata = tty->disc_data;
1058 if (I_BRKINT(tty)) {
1060 if (!L_NOFLSH(tty)) {
1061 n_tty_flush_buffer(tty);
1062 tty_driver_flush_buffer(tty);
1066 if (I_PARMRK(tty)) {
1067 put_tty_queue('\377', ldata);
1068 put_tty_queue('\0', ldata);
1070 put_tty_queue('\0', ldata);
1071 wake_up_interruptible(&tty->read_wait);
1075 * n_tty_receive_overrun - handle overrun reporting
1078 * Data arrived faster than we could process it. While the tty
1079 * driver has flagged this the bits that were missed are gone
1082 * Called from the receive_buf path so single threaded. Does not
1083 * need locking as num_overrun and overrun_time are function
1087 static inline void n_tty_receive_overrun(struct tty_struct *tty)
1089 struct n_tty_data *ldata = tty->disc_data;
1092 ldata->num_overrun++;
1093 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1094 time_after(ldata->overrun_time, jiffies)) {
1095 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1097 ldata->num_overrun);
1098 ldata->overrun_time = jiffies;
1099 ldata->num_overrun = 0;
1104 * n_tty_receive_parity_error - error notifier
1105 * @tty: terminal device
1108 * Process a parity error and queue the right data to indicate
1109 * the error case if necessary. Locking as per n_tty_receive_buf.
1111 static inline void n_tty_receive_parity_error(struct tty_struct *tty,
1114 struct n_tty_data *ldata = tty->disc_data;
1118 if (I_PARMRK(tty)) {
1119 put_tty_queue('\377', ldata);
1120 put_tty_queue('\0', ldata);
1121 put_tty_queue(c, ldata);
1122 } else if (I_INPCK(tty))
1123 put_tty_queue('\0', ldata);
1125 put_tty_queue(c, ldata);
1126 wake_up_interruptible(&tty->read_wait);
1130 * n_tty_receive_char - perform processing
1131 * @tty: terminal device
1134 * Process an individual character of input received from the driver.
1135 * This is serialized with respect to itself by the rules for the
1139 static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1141 struct n_tty_data *ldata = tty->disc_data;
1142 unsigned long flags;
1146 put_tty_queue(c, ldata);
1152 if (I_IUCLC(tty) && L_IEXTEN(tty))
1155 if (L_EXTPROC(tty)) {
1156 put_tty_queue(c, ldata);
1160 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) &&
1161 I_IXANY(tty) && c != START_CHAR(tty) && c != STOP_CHAR(tty) &&
1162 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) && c != SUSP_CHAR(tty)) {
1164 process_echoes(tty);
1169 if (c == START_CHAR(tty)) {
1171 process_echoes(tty);
1172 } else if (c == STOP_CHAR(tty))
1179 * If the previous character was LNEXT, or we know that this
1180 * character is not one of the characters that we'll have to
1181 * handle specially, do shortcut processing to speed things
1184 if (!test_bit(c, ldata->process_char_map) || ldata->lnext) {
1186 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1187 if (ldata->read_cnt >= (N_TTY_BUF_SIZE - parmrk - 1)) {
1188 /* beep if no space */
1190 process_output('\a', tty);
1194 finish_erasing(ldata);
1195 /* Record the column of first canon char. */
1196 if (ldata->canon_head == ldata->read_head)
1197 echo_set_canon_col(ldata);
1199 process_echoes(tty);
1202 put_tty_queue(c, ldata);
1203 put_tty_queue(c, ldata);
1208 if (c == START_CHAR(tty)) {
1210 process_echoes(tty);
1213 if (c == STOP_CHAR(tty)) {
1222 if (c == INTR_CHAR(tty))
1225 if (c == QUIT_CHAR(tty))
1228 if (c == SUSP_CHAR(tty)) {
1230 if (!L_NOFLSH(tty)) {
1231 n_tty_flush_buffer(tty);
1232 tty_driver_flush_buffer(tty);
1238 process_echoes(tty);
1250 } else if (c == '\n' && I_INLCR(tty))
1253 if (ldata->icanon) {
1254 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1255 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1257 process_echoes(tty);
1260 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
1263 finish_erasing(ldata);
1264 if (L_ECHOCTL(tty)) {
1265 echo_char_raw('^', ldata);
1266 echo_char_raw('\b', ldata);
1267 process_echoes(tty);
1272 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) &&
1274 unsigned long tail = ldata->canon_head;
1276 finish_erasing(ldata);
1278 echo_char_raw('\n', ldata);
1279 while (tail != ldata->read_head) {
1280 echo_char(ldata->read_buf[tail], tty);
1281 tail = (tail+1) & (N_TTY_BUF_SIZE-1);
1283 process_echoes(tty);
1287 if (ldata->read_cnt >= N_TTY_BUF_SIZE) {
1289 process_output('\a', tty);
1292 if (L_ECHO(tty) || L_ECHONL(tty)) {
1293 echo_char_raw('\n', ldata);
1294 process_echoes(tty);
1296 goto handle_newline;
1298 if (c == EOF_CHAR(tty)) {
1299 if (ldata->read_cnt >= N_TTY_BUF_SIZE)
1301 if (ldata->canon_head != ldata->read_head)
1302 set_bit(TTY_PUSH, &tty->flags);
1303 c = __DISABLED_CHAR;
1304 goto handle_newline;
1306 if ((c == EOL_CHAR(tty)) ||
1307 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1308 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty))
1310 if (ldata->read_cnt >= (N_TTY_BUF_SIZE - parmrk)) {
1312 process_output('\a', tty);
1316 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1319 /* Record the column of first canon char. */
1320 if (ldata->canon_head == ldata->read_head)
1321 echo_set_canon_col(ldata);
1323 process_echoes(tty);
1326 * XXX does PARMRK doubling happen for
1327 * EOL_CHAR and EOL2_CHAR?
1330 put_tty_queue(c, ldata);
1333 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1334 set_bit(ldata->read_head, ldata->read_flags);
1335 put_tty_queue_nolock(c, ldata);
1336 ldata->canon_head = ldata->read_head;
1337 ldata->canon_data++;
1338 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
1339 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1340 if (waitqueue_active(&tty->read_wait))
1341 wake_up_interruptible(&tty->read_wait);
1346 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1347 if (ldata->read_cnt >= (N_TTY_BUF_SIZE - parmrk - 1)) {
1348 /* beep if no space */
1350 process_output('\a', tty);
1354 finish_erasing(ldata);
1356 echo_char_raw('\n', ldata);
1358 /* Record the column of first canon char. */
1359 if (ldata->canon_head == ldata->read_head)
1360 echo_set_canon_col(ldata);
1363 process_echoes(tty);
1367 put_tty_queue(c, ldata);
1369 put_tty_queue(c, ldata);
1374 * n_tty_write_wakeup - asynchronous I/O notifier
1377 * Required for the ptys, serial driver etc. since processes
1378 * that attach themselves to the master and rely on ASYNC
1379 * IO must be woken up
1382 static void n_tty_write_wakeup(struct tty_struct *tty)
1384 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
1385 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
1389 * n_tty_receive_buf - data receive
1390 * @tty: terminal device
1393 * @count: characters
1395 * Called by the terminal driver when a block of characters has
1396 * been received. This function must be called from soft contexts
1397 * not from interrupt context. The driver is responsible for making
1398 * calls one at a time and in order (or using flush_to_ldisc)
1401 static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1402 char *fp, int count)
1404 struct n_tty_data *ldata = tty->disc_data;
1405 const unsigned char *p;
1406 char *f, flags = TTY_NORMAL;
1409 unsigned long cpuflags;
1411 if (ldata->real_raw) {
1412 raw_spin_lock_irqsave(&ldata->read_lock, cpuflags);
1413 i = min(N_TTY_BUF_SIZE - ldata->read_cnt,
1414 N_TTY_BUF_SIZE - ldata->read_head);
1416 memcpy(ldata->read_buf + ldata->read_head, cp, i);
1417 ldata->read_head = (ldata->read_head + i) & (N_TTY_BUF_SIZE-1);
1418 ldata->read_cnt += i;
1422 i = min(N_TTY_BUF_SIZE - ldata->read_cnt,
1423 N_TTY_BUF_SIZE - ldata->read_head);
1425 memcpy(ldata->read_buf + ldata->read_head, cp, i);
1426 ldata->read_head = (ldata->read_head + i) & (N_TTY_BUF_SIZE-1);
1427 ldata->read_cnt += i;
1428 raw_spin_unlock_irqrestore(&ldata->read_lock, cpuflags);
1430 for (i = count, p = cp, f = fp; i; i--, p++) {
1435 n_tty_receive_char(tty, *p);
1438 n_tty_receive_break(tty);
1442 n_tty_receive_parity_error(tty, *p);
1445 n_tty_receive_overrun(tty);
1448 printk(KERN_ERR "%s: unknown flag %d\n",
1449 tty_name(tty, buf), flags);
1453 if (tty->ops->flush_chars)
1454 tty->ops->flush_chars(tty);
1457 n_tty_set_room(tty);
1459 if ((!ldata->icanon && (ldata->read_cnt >= ldata->minimum_to_wake)) ||
1461 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1462 if (waitqueue_active(&tty->read_wait))
1463 wake_up_interruptible(&tty->read_wait);
1467 * Check the remaining room for the input canonicalization
1468 * mode. We don't want to throttle the driver if we're in
1469 * canonical mode and don't have a newline yet!
1472 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
1473 if (tty->receive_room >= TTY_THRESHOLD_THROTTLE)
1475 if (!tty_throttle_safe(tty))
1478 __tty_set_flow_change(tty, 0);
1481 int is_ignored(int sig)
1483 return (sigismember(¤t->blocked, sig) ||
1484 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
1488 * n_tty_set_termios - termios data changed
1490 * @old: previous data
1492 * Called by the tty layer when the user changes termios flags so
1493 * that the line discipline can plan ahead. This function cannot sleep
1494 * and is protected from re-entry by the tty layer. The user is
1495 * guaranteed that this function will not be re-entered or in progress
1496 * when the ldisc is closed.
1498 * Locking: Caller holds tty->termios_mutex
1501 static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
1503 struct n_tty_data *ldata = tty->disc_data;
1504 int canon_change = 1;
1507 canon_change = (old->c_lflag ^ tty->termios.c_lflag) & ICANON;
1509 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
1510 ldata->canon_head = ldata->read_tail;
1511 ldata->canon_data = 0;
1515 if (canon_change && !L_ICANON(tty) && ldata->read_cnt)
1516 wake_up_interruptible(&tty->read_wait);
1518 ldata->icanon = (L_ICANON(tty) != 0);
1520 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1521 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1522 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1524 bitmap_zero(ldata->process_char_map, 256);
1526 if (I_IGNCR(tty) || I_ICRNL(tty))
1527 set_bit('\r', ldata->process_char_map);
1529 set_bit('\n', ldata->process_char_map);
1531 if (L_ICANON(tty)) {
1532 set_bit(ERASE_CHAR(tty), ldata->process_char_map);
1533 set_bit(KILL_CHAR(tty), ldata->process_char_map);
1534 set_bit(EOF_CHAR(tty), ldata->process_char_map);
1535 set_bit('\n', ldata->process_char_map);
1536 set_bit(EOL_CHAR(tty), ldata->process_char_map);
1537 if (L_IEXTEN(tty)) {
1538 set_bit(WERASE_CHAR(tty),
1539 ldata->process_char_map);
1540 set_bit(LNEXT_CHAR(tty),
1541 ldata->process_char_map);
1542 set_bit(EOL2_CHAR(tty),
1543 ldata->process_char_map);
1545 set_bit(REPRINT_CHAR(tty),
1546 ldata->process_char_map);
1550 set_bit(START_CHAR(tty), ldata->process_char_map);
1551 set_bit(STOP_CHAR(tty), ldata->process_char_map);
1554 set_bit(INTR_CHAR(tty), ldata->process_char_map);
1555 set_bit(QUIT_CHAR(tty), ldata->process_char_map);
1556 set_bit(SUSP_CHAR(tty), ldata->process_char_map);
1558 clear_bit(__DISABLED_CHAR, ldata->process_char_map);
1560 ldata->real_raw = 0;
1563 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1564 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1565 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
1566 ldata->real_raw = 1;
1568 ldata->real_raw = 0;
1570 n_tty_set_room(tty);
1572 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1573 * been stopped by STOP_CHAR(tty) before it.
1575 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
1579 /* The termios change make the tty ready for I/O */
1580 wake_up_interruptible(&tty->write_wait);
1581 wake_up_interruptible(&tty->read_wait);
1585 * n_tty_close - close the ldisc for this tty
1588 * Called from the terminal layer when this line discipline is
1589 * being shut down, either because of a close or becsuse of a
1590 * discipline change. The function will not be called while other
1591 * ldisc methods are in progress.
1594 static void n_tty_close(struct tty_struct *tty)
1596 struct n_tty_data *ldata = tty->disc_data;
1599 n_tty_packet_mode_flush(tty);
1601 kfree(ldata->read_buf);
1602 kfree(ldata->echo_buf);
1604 tty->disc_data = NULL;
1608 * n_tty_open - open an ldisc
1609 * @tty: terminal to open
1611 * Called when this line discipline is being attached to the
1612 * terminal device. Can sleep. Called serialized so that no
1613 * other events will occur in parallel. No further open will occur
1617 static int n_tty_open(struct tty_struct *tty)
1619 struct n_tty_data *ldata;
1621 ldata = kzalloc(sizeof(*ldata), GFP_KERNEL);
1625 ldata->overrun_time = jiffies;
1626 mutex_init(&ldata->atomic_read_lock);
1627 mutex_init(&ldata->output_lock);
1628 mutex_init(&ldata->echo_lock);
1629 raw_spin_lock_init(&ldata->read_lock);
1631 /* These are ugly. Currently a malloc failure here can panic */
1632 ldata->read_buf = kzalloc(N_TTY_BUF_SIZE, GFP_KERNEL);
1633 ldata->echo_buf = kzalloc(N_TTY_BUF_SIZE, GFP_KERNEL);
1634 if (!ldata->read_buf || !ldata->echo_buf)
1637 tty->disc_data = ldata;
1638 reset_buffer_flags(tty->disc_data);
1640 ldata->minimum_to_wake = 1;
1642 /* indicate buffer work may resume */
1643 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1644 n_tty_set_termios(tty, NULL);
1645 tty_unthrottle(tty);
1649 kfree(ldata->read_buf);
1650 kfree(ldata->echo_buf);
1656 static inline int input_available_p(struct tty_struct *tty, int amt)
1658 struct n_tty_data *ldata = tty->disc_data;
1660 tty_flush_to_ldisc(tty);
1661 if (ldata->icanon && !L_EXTPROC(tty)) {
1662 if (ldata->canon_data)
1664 } else if (ldata->read_cnt >= (amt ? amt : 1))
1671 * copy_from_read_buf - copy read data directly
1672 * @tty: terminal device
1676 * Helper function to speed up n_tty_read. It is only called when
1677 * ICANON is off; it copies characters straight from the tty queue to
1678 * user space directly. It can be profitably called twice; once to
1679 * drain the space from the tail pointer to the (physical) end of the
1680 * buffer, and once to drain the space from the (physical) beginning of
1681 * the buffer to head pointer.
1683 * Called under the ldata->atomic_read_lock sem
1687 static int copy_from_read_buf(struct tty_struct *tty,
1688 unsigned char __user **b,
1692 struct n_tty_data *ldata = tty->disc_data;
1695 unsigned long flags;
1699 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1700 n = min(ldata->read_cnt, N_TTY_BUF_SIZE - ldata->read_tail);
1702 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
1704 retval = copy_to_user(*b, &ldata->read_buf[ldata->read_tail], n);
1707 ldata->read_buf[ldata->read_tail] == EOF_CHAR(tty);
1708 tty_audit_add_data(tty, &ldata->read_buf[ldata->read_tail], n,
1710 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1711 ldata->read_tail = (ldata->read_tail + n) & (N_TTY_BUF_SIZE-1);
1712 ldata->read_cnt -= n;
1713 /* Turn single EOF into zero-length read */
1714 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !ldata->read_cnt)
1716 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
1723 extern ssize_t redirected_tty_write(struct file *, const char __user *,
1727 * job_control - check job control
1729 * @file: file handle
1731 * Perform job control management checks on this file/tty descriptor
1732 * and if appropriate send any needed signals and return a negative
1733 * error code if action should be taken.
1735 * Locking: redirected write test is safe
1736 * current->signal->tty check is safe
1737 * ctrl_lock to safely reference tty->pgrp
1740 static int job_control(struct tty_struct *tty, struct file *file)
1742 /* Job control check -- must be done at start and after
1743 every sleep (POSIX.1 7.1.1.4). */
1744 /* NOTE: not yet done after every sleep pending a thorough
1745 check of the logic of this change. -- jlc */
1746 /* don't stop on /dev/console */
1747 if (file->f_op->write == redirected_tty_write ||
1748 current->signal->tty != tty)
1751 spin_lock_irq(&tty->ctrl_lock);
1753 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
1754 else if (task_pgrp(current) != tty->pgrp) {
1755 spin_unlock_irq(&tty->ctrl_lock);
1756 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
1758 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
1759 set_thread_flag(TIF_SIGPENDING);
1760 return -ERESTARTSYS;
1762 spin_unlock_irq(&tty->ctrl_lock);
1768 * n_tty_read - read function for tty
1770 * @file: file object
1771 * @buf: userspace buffer pointer
1774 * Perform reads for the line discipline. We are guaranteed that the
1775 * line discipline will not be closed under us but we may get multiple
1776 * parallel readers and must handle this ourselves. We may also get
1777 * a hangup. Always called in user context, may sleep.
1779 * This code must be sure never to sleep through a hangup.
1782 static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
1783 unsigned char __user *buf, size_t nr)
1785 struct n_tty_data *ldata = tty->disc_data;
1786 unsigned char __user *b = buf;
1787 DECLARE_WAITQUEUE(wait, current);
1793 unsigned long flags;
1797 c = job_control(tty, file);
1802 timeout = MAX_SCHEDULE_TIMEOUT;
1803 if (!ldata->icanon) {
1804 time = (HZ / 10) * TIME_CHAR(tty);
1805 minimum = MIN_CHAR(tty);
1808 ldata->minimum_to_wake = 1;
1809 else if (!waitqueue_active(&tty->read_wait) ||
1810 (ldata->minimum_to_wake > minimum))
1811 ldata->minimum_to_wake = minimum;
1818 ldata->minimum_to_wake = minimum = 1;
1823 * Internal serialization of reads.
1825 if (file->f_flags & O_NONBLOCK) {
1826 if (!mutex_trylock(&ldata->atomic_read_lock))
1829 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
1830 return -ERESTARTSYS;
1832 packet = tty->packet;
1834 add_wait_queue(&tty->read_wait, &wait);
1836 /* First test for status change. */
1837 if (packet && tty->link->ctrl_status) {
1841 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
1842 cs = tty->link->ctrl_status;
1843 tty->link->ctrl_status = 0;
1844 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
1845 if (tty_put_user(tty, cs, b++)) {
1853 /* This statement must be first before checking for input
1854 so that any interrupt will set the state back to
1856 set_current_state(TASK_INTERRUPTIBLE);
1858 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
1859 ((minimum - (b - buf)) >= 1))
1860 ldata->minimum_to_wake = (minimum - (b - buf));
1862 if (!input_available_p(tty, 0)) {
1863 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
1867 if (tty_hung_up_p(file))
1871 if (file->f_flags & O_NONBLOCK) {
1875 if (signal_pending(current)) {
1876 retval = -ERESTARTSYS;
1879 /* FIXME: does n_tty_set_room need locking ? */
1880 n_tty_set_room(tty);
1881 timeout = schedule_timeout(timeout);
1884 __set_current_state(TASK_RUNNING);
1886 /* Deal with packet mode. */
1887 if (packet && b == buf) {
1888 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
1896 if (ldata->icanon && !L_EXTPROC(tty)) {
1897 /* N.B. avoid overrun if nr == 0 */
1898 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1899 while (nr && ldata->read_cnt) {
1902 eol = test_and_clear_bit(ldata->read_tail,
1904 c = ldata->read_buf[ldata->read_tail];
1905 ldata->read_tail = ((ldata->read_tail+1) &
1906 (N_TTY_BUF_SIZE-1));
1909 /* this test should be redundant:
1910 * we shouldn't be reading data if
1913 if (--ldata->canon_data < 0)
1914 ldata->canon_data = 0;
1916 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
1918 if (!eol || (c != __DISABLED_CHAR)) {
1919 if (tty_put_user(tty, c, b++)) {
1922 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1928 tty_audit_push(tty);
1929 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1932 raw_spin_lock_irqsave(&ldata->read_lock, flags);
1934 raw_spin_unlock_irqrestore(&ldata->read_lock, flags);
1939 /* The copy function takes the read lock and handles
1940 locking internally for this case */
1941 uncopied = copy_from_read_buf(tty, &b, &nr);
1942 uncopied += copy_from_read_buf(tty, &b, &nr);
1949 /* If there is enough space in the read buffer now, let the
1950 * low-level driver know. We use n_tty_chars_in_buffer() to
1951 * check the buffer, as it now knows about canonical mode.
1952 * Otherwise, if the driver is throttled and the line is
1953 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
1954 * we won't get any more characters.
1957 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
1958 if (n_tty_chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
1962 n_tty_set_room(tty);
1963 if (!tty_unthrottle_safe(tty))
1966 __tty_set_flow_change(tty, 0);
1968 if (b - buf >= minimum)
1973 mutex_unlock(&ldata->atomic_read_lock);
1974 remove_wait_queue(&tty->read_wait, &wait);
1976 if (!waitqueue_active(&tty->read_wait))
1977 ldata->minimum_to_wake = minimum;
1979 __set_current_state(TASK_RUNNING);
1984 clear_bit(TTY_PUSH, &tty->flags);
1985 } else if (test_and_clear_bit(TTY_PUSH, &tty->flags))
1988 n_tty_set_room(tty);
1993 * n_tty_write - write function for tty
1995 * @file: file object
1996 * @buf: userspace buffer pointer
1999 * Write function of the terminal device. This is serialized with
2000 * respect to other write callers but not to termios changes, reads
2001 * and other such events. Since the receive code will echo characters,
2002 * thus calling driver write methods, the output_lock is used in
2003 * the output processing functions called here as well as in the
2004 * echo processing function to protect the column state and space
2005 * left in the buffer.
2007 * This code must be sure never to sleep through a hangup.
2009 * Locking: output_lock to protect column state and space left
2010 * (note that the process_output*() functions take this
2014 static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
2015 const unsigned char *buf, size_t nr)
2017 const unsigned char *b = buf;
2018 DECLARE_WAITQUEUE(wait, current);
2022 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2023 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2024 retval = tty_check_change(tty);
2029 /* Write out any echoed characters that are still pending */
2030 process_echoes(tty);
2032 add_wait_queue(&tty->write_wait, &wait);
2034 set_current_state(TASK_INTERRUPTIBLE);
2035 if (signal_pending(current)) {
2036 retval = -ERESTARTSYS;
2039 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2045 ssize_t num = process_output_block(tty, b, nr);
2057 if (process_output(c, tty) < 0)
2061 if (tty->ops->flush_chars)
2062 tty->ops->flush_chars(tty);
2065 c = tty->ops->write(tty, b, nr);
2078 if (file->f_flags & O_NONBLOCK) {
2085 __set_current_state(TASK_RUNNING);
2086 remove_wait_queue(&tty->write_wait, &wait);
2087 if (b - buf != nr && tty->fasync)
2088 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2089 return (b - buf) ? b - buf : retval;
2093 * n_tty_poll - poll method for N_TTY
2094 * @tty: terminal device
2095 * @file: file accessing it
2098 * Called when the line discipline is asked to poll() for data or
2099 * for special events. This code is not serialized with respect to
2100 * other events save open/close.
2102 * This code must be sure never to sleep through a hangup.
2103 * Called without the kernel lock held - fine
2106 static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
2109 struct n_tty_data *ldata = tty->disc_data;
2110 unsigned int mask = 0;
2112 poll_wait(file, &tty->read_wait, wait);
2113 poll_wait(file, &tty->write_wait, wait);
2114 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
2115 mask |= POLLIN | POLLRDNORM;
2116 if (tty->packet && tty->link->ctrl_status)
2117 mask |= POLLPRI | POLLIN | POLLRDNORM;
2118 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2120 if (tty_hung_up_p(file))
2122 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2123 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
2124 ldata->minimum_to_wake = MIN_CHAR(tty);
2126 ldata->minimum_to_wake = 1;
2128 if (tty->ops->write && !tty_is_writelocked(tty) &&
2129 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2130 tty_write_room(tty) > 0)
2131 mask |= POLLOUT | POLLWRNORM;
2135 static unsigned long inq_canon(struct n_tty_data *ldata)
2139 if (!ldata->canon_data)
2141 head = ldata->canon_head;
2142 tail = ldata->read_tail;
2143 nr = (head - tail) & (N_TTY_BUF_SIZE-1);
2144 /* Skip EOF-chars.. */
2145 while (head != tail) {
2146 if (test_bit(tail, ldata->read_flags) &&
2147 ldata->read_buf[tail] == __DISABLED_CHAR)
2149 tail = (tail+1) & (N_TTY_BUF_SIZE-1);
2154 static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2155 unsigned int cmd, unsigned long arg)
2157 struct n_tty_data *ldata = tty->disc_data;
2162 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2164 /* FIXME: Locking */
2165 retval = ldata->read_cnt;
2167 retval = inq_canon(ldata);
2168 return put_user(retval, (unsigned int __user *) arg);
2170 return n_tty_ioctl_helper(tty, file, cmd, arg);
2174 static void n_tty_fasync(struct tty_struct *tty, int on)
2176 struct n_tty_data *ldata = tty->disc_data;
2178 if (!waitqueue_active(&tty->read_wait)) {
2180 ldata->minimum_to_wake = 1;
2181 else if (!tty->fasync)
2182 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2186 struct tty_ldisc_ops tty_ldisc_N_TTY = {
2187 .magic = TTY_LDISC_MAGIC,
2190 .close = n_tty_close,
2191 .flush_buffer = n_tty_flush_buffer,
2192 .chars_in_buffer = n_tty_chars_in_buffer,
2194 .write = n_tty_write,
2195 .ioctl = n_tty_ioctl,
2196 .set_termios = n_tty_set_termios,
2198 .receive_buf = n_tty_receive_buf,
2199 .write_wakeup = n_tty_write_wakeup,
2200 .fasync = n_tty_fasync,
2204 * n_tty_inherit_ops - inherit N_TTY methods
2205 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2207 * Enables a 'subclass' line discipline to 'inherit' N_TTY
2211 void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2213 *ops = tty_ldisc_N_TTY;
2215 ops->refcount = ops->flags = 0;
2217 EXPORT_SYMBOL_GPL(n_tty_inherit_ops);