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>
53 #include <linux/vmalloc.h>
56 /* number of characters left in xmit buffer before select has we have room */
57 #define WAKEUP_CHARS 256
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
64 #define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
65 #define TTY_THRESHOLD_UNTHROTTLE 128
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
73 #define ECHO_OP_START 0xff
74 #define ECHO_OP_MOVE_BACK_COL 0x80
75 #define ECHO_OP_SET_CANON_COL 0x81
76 #define ECHO_OP_ERASE_TAB 0x82
78 #define ECHO_COMMIT_WATERMARK 256
79 #define ECHO_BLOCK 256
80 #define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
85 # define n_tty_trace(f, args...) trace_printk(f, ##args)
87 # define n_tty_trace(f, args...)
91 /* producer-published */
97 DECLARE_BITMAP(char_map
, 256);
99 /* private to n_tty_receive_overrun (single-threaded) */
100 unsigned long overrun_time
;
106 /* must hold exclusive termios_rwsem to reset these */
107 unsigned char lnext
:1, erasing
:1, raw
:1, real_raw
:1, icanon
:1;
108 unsigned char push
:1;
110 /* shared by producer and consumer */
111 char read_buf
[N_TTY_BUF_SIZE
];
112 DECLARE_BITMAP(read_flags
, N_TTY_BUF_SIZE
);
113 unsigned char echo_buf
[N_TTY_BUF_SIZE
];
117 /* consumer-published */
121 /* protected by output lock */
123 unsigned int canon_column
;
126 struct mutex atomic_read_lock
;
127 struct mutex output_lock
;
130 static inline size_t read_cnt(struct n_tty_data
*ldata
)
132 return ldata
->read_head
- ldata
->read_tail
;
135 static inline unsigned char read_buf(struct n_tty_data
*ldata
, size_t i
)
137 return ldata
->read_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
140 static inline unsigned char *read_buf_addr(struct n_tty_data
*ldata
, size_t i
)
142 return &ldata
->read_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
145 static inline unsigned char echo_buf(struct n_tty_data
*ldata
, size_t i
)
147 return ldata
->echo_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
150 static inline unsigned char *echo_buf_addr(struct n_tty_data
*ldata
, size_t i
)
152 return &ldata
->echo_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
155 static inline int tty_put_user(struct tty_struct
*tty
, unsigned char x
,
156 unsigned char __user
*ptr
)
158 struct n_tty_data
*ldata
= tty
->disc_data
;
160 tty_audit_add_data(tty
, &x
, 1, ldata
->icanon
);
161 return put_user(x
, ptr
);
164 static inline int tty_copy_to_user(struct tty_struct
*tty
,
169 struct n_tty_data
*ldata
= tty
->disc_data
;
171 tty_audit_add_data(tty
, to
, n
, ldata
->icanon
);
172 return copy_to_user(to
, from
, n
);
175 static int receive_room(struct tty_struct
*tty
)
177 struct n_tty_data
*ldata
= tty
->disc_data
;
181 /* Multiply read_cnt by 3, since each byte might take up to
182 * three times as many spaces when PARMRK is set (depending on
183 * its flags, e.g. parity error). */
184 left
= N_TTY_BUF_SIZE
- read_cnt(ldata
) * 3 - 1;
186 left
= N_TTY_BUF_SIZE
- read_cnt(ldata
) - 1;
189 * If we are doing input canonicalization, and there are no
190 * pending newlines, let characters through without limit, so
191 * that erase characters will be handled. Other excess
192 * characters will be beeped.
195 left
= ldata
->icanon
&& ldata
->canon_head
== ldata
->read_tail
;
201 * n_tty_set_room - receive space
204 * Re-schedules the flip buffer work if space just became available.
206 * Caller holds exclusive termios_rwsem
208 * n_tty_read()/consumer path:
209 * holds non-exclusive termios_rwsem
212 static void n_tty_set_room(struct tty_struct
*tty
)
214 struct n_tty_data
*ldata
= tty
->disc_data
;
216 /* Did this open up the receive buffer? We may need to flip */
217 if (unlikely(ldata
->no_room
) && receive_room(tty
)) {
220 WARN_RATELIMIT(tty
->port
->itty
== NULL
,
221 "scheduling with invalid itty\n");
222 /* see if ldisc has been killed - if so, this means that
223 * even though the ldisc has been halted and ->buf.work
224 * cancelled, ->buf.work is about to be rescheduled
226 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED
, &tty
->flags
),
227 "scheduling buffer work for halted ldisc\n");
228 queue_work(system_unbound_wq
, &tty
->port
->buf
.work
);
232 static ssize_t
chars_in_buffer(struct tty_struct
*tty
)
234 struct n_tty_data
*ldata
= tty
->disc_data
;
240 n
= ldata
->canon_head
- ldata
->read_tail
;
245 * n_tty_write_wakeup - asynchronous I/O notifier
248 * Required for the ptys, serial driver etc. since processes
249 * that attach themselves to the master and rely on ASYNC
250 * IO must be woken up
253 static void n_tty_write_wakeup(struct tty_struct
*tty
)
255 if (tty
->fasync
&& test_and_clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
))
256 kill_fasync(&tty
->fasync
, SIGIO
, POLL_OUT
);
259 static void n_tty_check_throttle(struct tty_struct
*tty
)
262 * Check the remaining room for the input canonicalization
263 * mode. We don't want to throttle the driver if we're in
264 * canonical mode and don't have a newline yet!
268 tty_set_flow_change(tty
, TTY_THROTTLE_SAFE
);
269 if (receive_room(tty
) >= TTY_THRESHOLD_THROTTLE
)
271 throttled
= tty_throttle_safe(tty
);
275 __tty_set_flow_change(tty
, 0);
278 static void n_tty_check_unthrottle(struct tty_struct
*tty
)
280 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
) {
281 if (chars_in_buffer(tty
) > TTY_THRESHOLD_UNTHROTTLE
)
286 tty_wakeup(tty
->link
);
290 /* If there is enough space in the read buffer now, let the
291 * low-level driver know. We use chars_in_buffer() to
292 * check the buffer, as it now knows about canonical mode.
293 * Otherwise, if the driver is throttled and the line is
294 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
295 * we won't get any more characters.
300 tty_set_flow_change(tty
, TTY_UNTHROTTLE_SAFE
);
301 if (chars_in_buffer(tty
) > TTY_THRESHOLD_UNTHROTTLE
)
306 unthrottled
= tty_unthrottle_safe(tty
);
310 __tty_set_flow_change(tty
, 0);
314 * put_tty_queue - add character to tty
318 * Add a character to the tty read_buf queue.
320 * n_tty_receive_buf()/producer path:
321 * caller holds non-exclusive termios_rwsem
324 * read_head is only considered 'published' if canonical mode is
328 static inline void put_tty_queue(unsigned char c
, struct n_tty_data
*ldata
)
330 *read_buf_addr(ldata
, ldata
->read_head
) = c
;
335 * reset_buffer_flags - reset buffer state
336 * @tty: terminal to reset
338 * Reset the read buffer counters and clear the flags.
339 * Called from n_tty_open() and n_tty_flush_buffer().
341 * Locking: caller holds exclusive termios_rwsem
342 * (or locking is not required)
345 static void reset_buffer_flags(struct n_tty_data
*ldata
)
347 ldata
->read_head
= ldata
->canon_head
= ldata
->read_tail
= 0;
348 ldata
->echo_head
= ldata
->echo_tail
= ldata
->echo_commit
= 0;
349 ldata
->echo_mark
= 0;
350 ldata
->line_start
= 0;
353 bitmap_zero(ldata
->read_flags
, N_TTY_BUF_SIZE
);
357 static void n_tty_packet_mode_flush(struct tty_struct
*tty
)
361 spin_lock_irqsave(&tty
->ctrl_lock
, flags
);
362 if (tty
->link
->packet
) {
363 tty
->ctrl_status
|= TIOCPKT_FLUSHREAD
;
364 wake_up_interruptible(&tty
->link
->read_wait
);
366 spin_unlock_irqrestore(&tty
->ctrl_lock
, flags
);
370 * n_tty_flush_buffer - clean input queue
371 * @tty: terminal device
373 * Flush the input buffer. Called when the tty layer wants the
374 * buffer flushed (eg at hangup) or when the N_TTY line discipline
375 * internally has to clean the pending queue (for example some signals).
377 * Holds termios_rwsem to exclude producer/consumer while
378 * buffer indices are reset.
380 * Locking: ctrl_lock, exclusive termios_rwsem
383 static void n_tty_flush_buffer(struct tty_struct
*tty
)
385 down_write(&tty
->termios_rwsem
);
386 reset_buffer_flags(tty
->disc_data
);
390 n_tty_packet_mode_flush(tty
);
391 up_write(&tty
->termios_rwsem
);
395 * n_tty_chars_in_buffer - report available bytes
398 * Report the number of characters buffered to be delivered to user
399 * at this instant in time.
401 * Locking: exclusive termios_rwsem
404 static ssize_t
n_tty_chars_in_buffer(struct tty_struct
*tty
)
408 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__
);
410 down_write(&tty
->termios_rwsem
);
411 n
= chars_in_buffer(tty
);
412 up_write(&tty
->termios_rwsem
);
417 * is_utf8_continuation - utf8 multibyte check
420 * Returns true if the utf8 character 'c' is a multibyte continuation
421 * character. We use this to correctly compute the on screen size
422 * of the character when printing
425 static inline int is_utf8_continuation(unsigned char c
)
427 return (c
& 0xc0) == 0x80;
431 * is_continuation - multibyte check
434 * Returns true if the utf8 character 'c' is a multibyte continuation
435 * character and the terminal is in unicode mode.
438 static inline int is_continuation(unsigned char c
, struct tty_struct
*tty
)
440 return I_IUTF8(tty
) && is_utf8_continuation(c
);
444 * do_output_char - output one character
445 * @c: character (or partial unicode symbol)
446 * @tty: terminal device
447 * @space: space available in tty driver write buffer
449 * This is a helper function that handles one output character
450 * (including special characters like TAB, CR, LF, etc.),
451 * doing OPOST processing and putting the results in the
452 * tty driver's write buffer.
454 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
455 * and NLDLY. They simply aren't relevant in the world today.
456 * If you ever need them, add them here.
458 * Returns the number of bytes of buffer space used or -1 if
461 * Locking: should be called under the output_lock to protect
462 * the column state and space left in the buffer
465 static int do_output_char(unsigned char c
, struct tty_struct
*tty
, int space
)
467 struct n_tty_data
*ldata
= tty
->disc_data
;
480 ldata
->canon_column
= ldata
->column
= 0;
481 tty
->ops
->write(tty
, "\r\n", 2);
484 ldata
->canon_column
= ldata
->column
;
487 if (O_ONOCR(tty
) && ldata
->column
== 0)
492 ldata
->canon_column
= ldata
->column
= 0;
495 ldata
->canon_column
= ldata
->column
= 0;
498 spaces
= 8 - (ldata
->column
& 7);
499 if (O_TABDLY(tty
) == XTABS
) {
502 ldata
->column
+= spaces
;
503 tty
->ops
->write(tty
, " ", spaces
);
506 ldata
->column
+= spaces
;
509 if (ldata
->column
> 0)
516 if (!is_continuation(c
, tty
))
522 tty_put_char(tty
, c
);
527 * process_output - output post processor
528 * @c: character (or partial unicode symbol)
529 * @tty: terminal device
531 * Output one character with OPOST processing.
532 * Returns -1 when the output device is full and the character
535 * Locking: output_lock to protect column state and space left
536 * (also, this is called from n_tty_write under the
537 * tty layer write lock)
540 static int process_output(unsigned char c
, struct tty_struct
*tty
)
542 struct n_tty_data
*ldata
= tty
->disc_data
;
545 mutex_lock(&ldata
->output_lock
);
547 space
= tty_write_room(tty
);
548 retval
= do_output_char(c
, tty
, space
);
550 mutex_unlock(&ldata
->output_lock
);
558 * process_output_block - block post processor
559 * @tty: terminal device
560 * @buf: character buffer
561 * @nr: number of bytes to output
563 * Output a block of characters with OPOST processing.
564 * Returns the number of characters output.
566 * This path is used to speed up block console writes, among other
567 * things when processing blocks of output data. It handles only
568 * the simple cases normally found and helps to generate blocks of
569 * symbols for the console driver and thus improve performance.
571 * Locking: output_lock to protect column state and space left
572 * (also, this is called from n_tty_write under the
573 * tty layer write lock)
576 static ssize_t
process_output_block(struct tty_struct
*tty
,
577 const unsigned char *buf
, unsigned int nr
)
579 struct n_tty_data
*ldata
= tty
->disc_data
;
582 const unsigned char *cp
;
584 mutex_lock(&ldata
->output_lock
);
586 space
= tty_write_room(tty
);
588 mutex_unlock(&ldata
->output_lock
);
594 for (i
= 0, cp
= buf
; i
< nr
; i
++, cp
++) {
595 unsigned char c
= *cp
;
603 ldata
->canon_column
= ldata
->column
;
606 if (O_ONOCR(tty
) && ldata
->column
== 0)
610 ldata
->canon_column
= ldata
->column
= 0;
615 if (ldata
->column
> 0)
622 if (!is_continuation(c
, tty
))
629 i
= tty
->ops
->write(tty
, buf
, i
);
631 mutex_unlock(&ldata
->output_lock
);
636 * process_echoes - write pending echo characters
637 * @tty: terminal device
639 * Write previously buffered echo (and other ldisc-generated)
640 * characters to the tty.
642 * Characters generated by the ldisc (including echoes) need to
643 * be buffered because the driver's write buffer can fill during
644 * heavy program output. Echoing straight to the driver will
645 * often fail under these conditions, causing lost characters and
646 * resulting mismatches of ldisc state information.
648 * Since the ldisc state must represent the characters actually sent
649 * to the driver at the time of the write, operations like certain
650 * changes in column state are also saved in the buffer and executed
653 * A circular fifo buffer is used so that the most recent characters
654 * are prioritized. Also, when control characters are echoed with a
655 * prefixed "^", the pair is treated atomically and thus not separated.
657 * Locking: callers must hold output_lock
660 static size_t __process_echoes(struct tty_struct
*tty
)
662 struct n_tty_data
*ldata
= tty
->disc_data
;
663 int space
, old_space
;
667 old_space
= space
= tty_write_room(tty
);
669 tail
= ldata
->echo_tail
;
670 while (ldata
->echo_commit
!= tail
) {
671 c
= echo_buf(ldata
, tail
);
672 if (c
== ECHO_OP_START
) {
674 int no_space_left
= 0;
677 * If the buffer byte is the start of a multi-byte
678 * operation, get the next byte, which is either the
679 * op code or a control character value.
681 op
= echo_buf(ldata
, tail
+ 1);
684 unsigned int num_chars
, num_bs
;
686 case ECHO_OP_ERASE_TAB
:
687 num_chars
= echo_buf(ldata
, tail
+ 2);
690 * Determine how many columns to go back
691 * in order to erase the tab.
692 * This depends on the number of columns
693 * used by other characters within the tab
694 * area. If this (modulo 8) count is from
695 * the start of input rather than from a
696 * previous tab, we offset by canon column.
697 * Otherwise, tab spacing is normal.
699 if (!(num_chars
& 0x80))
700 num_chars
+= ldata
->canon_column
;
701 num_bs
= 8 - (num_chars
& 7);
703 if (num_bs
> space
) {
709 tty_put_char(tty
, '\b');
710 if (ldata
->column
> 0)
716 case ECHO_OP_SET_CANON_COL
:
717 ldata
->canon_column
= ldata
->column
;
721 case ECHO_OP_MOVE_BACK_COL
:
722 if (ldata
->column
> 0)
728 /* This is an escaped echo op start code */
733 tty_put_char(tty
, ECHO_OP_START
);
741 * If the op is not a special byte code,
742 * it is a ctrl char tagged to be echoed
743 * as "^X" (where X is the letter
744 * representing the control char).
745 * Note that we must ensure there is
746 * enough space for the whole ctrl pair.
753 tty_put_char(tty
, '^');
754 tty_put_char(tty
, op
^ 0100);
764 int retval
= do_output_char(c
, tty
, space
);
771 tty_put_char(tty
, c
);
778 /* If the echo buffer is nearly full (so that the possibility exists
779 * of echo overrun before the next commit), then discard enough
780 * data at the tail to prevent a subsequent overrun */
781 while (ldata
->echo_commit
- tail
>= ECHO_DISCARD_WATERMARK
) {
782 if (echo_buf(ldata
, tail
) == ECHO_OP_START
) {
783 if (echo_buf(ldata
, tail
+ 1) == ECHO_OP_ERASE_TAB
)
791 ldata
->echo_tail
= tail
;
792 return old_space
- space
;
795 static void commit_echoes(struct tty_struct
*tty
)
797 struct n_tty_data
*ldata
= tty
->disc_data
;
798 size_t nr
, old
, echoed
;
801 head
= ldata
->echo_head
;
802 ldata
->echo_mark
= head
;
803 old
= ldata
->echo_commit
- ldata
->echo_tail
;
805 /* Process committed echoes if the accumulated # of bytes
806 * is over the threshold (and try again each time another
807 * block is accumulated) */
808 nr
= head
- ldata
->echo_tail
;
809 if (nr
< ECHO_COMMIT_WATERMARK
|| (nr
% ECHO_BLOCK
> old
% ECHO_BLOCK
))
812 mutex_lock(&ldata
->output_lock
);
813 ldata
->echo_commit
= head
;
814 echoed
= __process_echoes(tty
);
815 mutex_unlock(&ldata
->output_lock
);
817 if (echoed
&& tty
->ops
->flush_chars
)
818 tty
->ops
->flush_chars(tty
);
821 static void process_echoes(struct tty_struct
*tty
)
823 struct n_tty_data
*ldata
= tty
->disc_data
;
826 if (ldata
->echo_mark
== ldata
->echo_tail
)
829 mutex_lock(&ldata
->output_lock
);
830 ldata
->echo_commit
= ldata
->echo_mark
;
831 echoed
= __process_echoes(tty
);
832 mutex_unlock(&ldata
->output_lock
);
834 if (echoed
&& tty
->ops
->flush_chars
)
835 tty
->ops
->flush_chars(tty
);
838 /* NB: echo_mark and echo_head should be equivalent here */
839 static void flush_echoes(struct tty_struct
*tty
)
841 struct n_tty_data
*ldata
= tty
->disc_data
;
843 if ((!L_ECHO(tty
) && !L_ECHONL(tty
)) ||
844 ldata
->echo_commit
== ldata
->echo_head
)
847 mutex_lock(&ldata
->output_lock
);
848 ldata
->echo_commit
= ldata
->echo_head
;
849 __process_echoes(tty
);
850 mutex_unlock(&ldata
->output_lock
);
854 * add_echo_byte - add a byte to the echo buffer
855 * @c: unicode byte to echo
858 * Add a character or operation byte to the echo buffer.
861 static inline void add_echo_byte(unsigned char c
, struct n_tty_data
*ldata
)
863 *echo_buf_addr(ldata
, ldata
->echo_head
++) = c
;
867 * echo_move_back_col - add operation to move back a column
870 * Add an operation to the echo buffer to move back one column.
873 static void echo_move_back_col(struct n_tty_data
*ldata
)
875 add_echo_byte(ECHO_OP_START
, ldata
);
876 add_echo_byte(ECHO_OP_MOVE_BACK_COL
, ldata
);
880 * echo_set_canon_col - add operation to set the canon column
883 * Add an operation to the echo buffer to set the canon column
884 * to the current column.
887 static void echo_set_canon_col(struct n_tty_data
*ldata
)
889 add_echo_byte(ECHO_OP_START
, ldata
);
890 add_echo_byte(ECHO_OP_SET_CANON_COL
, ldata
);
894 * echo_erase_tab - add operation to erase a tab
895 * @num_chars: number of character columns already used
896 * @after_tab: true if num_chars starts after a previous tab
899 * Add an operation to the echo buffer to erase a tab.
901 * Called by the eraser function, which knows how many character
902 * columns have been used since either a previous tab or the start
903 * of input. This information will be used later, along with
904 * canon column (if applicable), to go back the correct number
908 static void echo_erase_tab(unsigned int num_chars
, int after_tab
,
909 struct n_tty_data
*ldata
)
911 add_echo_byte(ECHO_OP_START
, ldata
);
912 add_echo_byte(ECHO_OP_ERASE_TAB
, ldata
);
914 /* We only need to know this modulo 8 (tab spacing) */
917 /* Set the high bit as a flag if num_chars is after a previous tab */
921 add_echo_byte(num_chars
, ldata
);
925 * echo_char_raw - echo a character raw
926 * @c: unicode byte to echo
927 * @tty: terminal device
929 * Echo user input back onto the screen. This must be called only when
930 * L_ECHO(tty) is true. Called from the driver receive_buf path.
932 * This variant does not treat control characters specially.
935 static void echo_char_raw(unsigned char c
, struct n_tty_data
*ldata
)
937 if (c
== ECHO_OP_START
) {
938 add_echo_byte(ECHO_OP_START
, ldata
);
939 add_echo_byte(ECHO_OP_START
, ldata
);
941 add_echo_byte(c
, ldata
);
946 * echo_char - echo a character
947 * @c: unicode byte to echo
948 * @tty: terminal device
950 * Echo user input back onto the screen. This must be called only when
951 * L_ECHO(tty) is true. Called from the driver receive_buf path.
953 * This variant tags control characters to be echoed as "^X"
954 * (where X is the letter representing the control char).
957 static void echo_char(unsigned char c
, struct tty_struct
*tty
)
959 struct n_tty_data
*ldata
= tty
->disc_data
;
961 if (c
== ECHO_OP_START
) {
962 add_echo_byte(ECHO_OP_START
, ldata
);
963 add_echo_byte(ECHO_OP_START
, ldata
);
965 if (L_ECHOCTL(tty
) && iscntrl(c
) && c
!= '\t')
966 add_echo_byte(ECHO_OP_START
, ldata
);
967 add_echo_byte(c
, ldata
);
972 * finish_erasing - complete erase
976 static inline void finish_erasing(struct n_tty_data
*ldata
)
978 if (ldata
->erasing
) {
979 echo_char_raw('/', ldata
);
985 * eraser - handle erase function
986 * @c: character input
987 * @tty: terminal device
989 * Perform erase and necessary output when an erase character is
990 * present in the stream from the driver layer. Handles the complexities
991 * of UTF-8 multibyte symbols.
993 * n_tty_receive_buf()/producer path:
994 * caller holds non-exclusive termios_rwsem
997 * Modifying the read_head is not considered a publish in this context
998 * because canonical mode is active -- only canon_head publishes
1001 static void eraser(unsigned char c
, struct tty_struct
*tty
)
1003 struct n_tty_data
*ldata
= tty
->disc_data
;
1004 enum { ERASE
, WERASE
, KILL
} kill_type
;
1009 if (ldata
->read_head
== ldata
->canon_head
) {
1010 /* process_output('\a', tty); */ /* what do you think? */
1013 if (c
== ERASE_CHAR(tty
))
1015 else if (c
== WERASE_CHAR(tty
))
1019 ldata
->read_head
= ldata
->canon_head
;
1022 if (!L_ECHOK(tty
) || !L_ECHOKE(tty
) || !L_ECHOE(tty
)) {
1023 ldata
->read_head
= ldata
->canon_head
;
1024 finish_erasing(ldata
);
1025 echo_char(KILL_CHAR(tty
), tty
);
1026 /* Add a newline if ECHOK is on and ECHOKE is off. */
1028 echo_char_raw('\n', ldata
);
1035 while (ldata
->read_head
!= ldata
->canon_head
) {
1036 head
= ldata
->read_head
;
1038 /* erase a single possibly multibyte character */
1041 c
= read_buf(ldata
, head
);
1042 } while (is_continuation(c
, tty
) && head
!= ldata
->canon_head
);
1044 /* do not partially erase */
1045 if (is_continuation(c
, tty
))
1048 if (kill_type
== WERASE
) {
1049 /* Equivalent to BSD's ALTWERASE. */
1050 if (isalnum(c
) || c
== '_')
1052 else if (seen_alnums
)
1055 cnt
= ldata
->read_head
- head
;
1056 ldata
->read_head
= head
;
1058 if (L_ECHOPRT(tty
)) {
1059 if (!ldata
->erasing
) {
1060 echo_char_raw('\\', ldata
);
1063 /* if cnt > 1, output a multi-byte character */
1067 echo_char_raw(read_buf(ldata
, head
), ldata
);
1068 echo_move_back_col(ldata
);
1070 } else if (kill_type
== ERASE
&& !L_ECHOE(tty
)) {
1071 echo_char(ERASE_CHAR(tty
), tty
);
1072 } else if (c
== '\t') {
1073 unsigned int num_chars
= 0;
1075 size_t tail
= ldata
->read_head
;
1078 * Count the columns used for characters
1079 * since the start of input or after a
1081 * This info is used to go back the correct
1082 * number of columns.
1084 while (tail
!= ldata
->canon_head
) {
1086 c
= read_buf(ldata
, tail
);
1090 } else if (iscntrl(c
)) {
1093 } else if (!is_continuation(c
, tty
)) {
1097 echo_erase_tab(num_chars
, after_tab
, ldata
);
1099 if (iscntrl(c
) && L_ECHOCTL(tty
)) {
1100 echo_char_raw('\b', ldata
);
1101 echo_char_raw(' ', ldata
);
1102 echo_char_raw('\b', ldata
);
1104 if (!iscntrl(c
) || L_ECHOCTL(tty
)) {
1105 echo_char_raw('\b', ldata
);
1106 echo_char_raw(' ', ldata
);
1107 echo_char_raw('\b', ldata
);
1111 if (kill_type
== ERASE
)
1114 if (ldata
->read_head
== ldata
->canon_head
&& L_ECHO(tty
))
1115 finish_erasing(ldata
);
1119 * isig - handle the ISIG optio
1123 * Called when a signal is being sent due to terminal input.
1124 * Called from the driver receive_buf path so serialized.
1126 * Locking: ctrl_lock
1129 static void isig(int sig
, struct tty_struct
*tty
)
1131 struct pid
*tty_pgrp
= tty_get_pgrp(tty
);
1133 kill_pgrp(tty_pgrp
, sig
, 1);
1139 * n_tty_receive_break - handle break
1142 * An RS232 break event has been hit in the incoming bitstream. This
1143 * can cause a variety of events depending upon the termios settings.
1145 * n_tty_receive_buf()/producer path:
1146 * caller holds non-exclusive termios_rwsem
1147 * publishes read_head via put_tty_queue()
1149 * Note: may get exclusive termios_rwsem if flushing input buffer
1152 static void n_tty_receive_break(struct tty_struct
*tty
)
1154 struct n_tty_data
*ldata
= tty
->disc_data
;
1158 if (I_BRKINT(tty
)) {
1160 if (!L_NOFLSH(tty
)) {
1161 /* flushing needs exclusive termios_rwsem */
1162 up_read(&tty
->termios_rwsem
);
1163 n_tty_flush_buffer(tty
);
1164 tty_driver_flush_buffer(tty
);
1165 down_read(&tty
->termios_rwsem
);
1169 if (I_PARMRK(tty
)) {
1170 put_tty_queue('\377', ldata
);
1171 put_tty_queue('\0', ldata
);
1173 put_tty_queue('\0', ldata
);
1174 if (waitqueue_active(&tty
->read_wait
))
1175 wake_up_interruptible(&tty
->read_wait
);
1179 * n_tty_receive_overrun - handle overrun reporting
1182 * Data arrived faster than we could process it. While the tty
1183 * driver has flagged this the bits that were missed are gone
1186 * Called from the receive_buf path so single threaded. Does not
1187 * need locking as num_overrun and overrun_time are function
1191 static void n_tty_receive_overrun(struct tty_struct
*tty
)
1193 struct n_tty_data
*ldata
= tty
->disc_data
;
1196 ldata
->num_overrun
++;
1197 if (time_after(jiffies
, ldata
->overrun_time
+ HZ
) ||
1198 time_after(ldata
->overrun_time
, jiffies
)) {
1199 printk(KERN_WARNING
"%s: %d input overrun(s)\n",
1201 ldata
->num_overrun
);
1202 ldata
->overrun_time
= jiffies
;
1203 ldata
->num_overrun
= 0;
1208 * n_tty_receive_parity_error - error notifier
1209 * @tty: terminal device
1212 * Process a parity error and queue the right data to indicate
1213 * the error case if necessary.
1215 * n_tty_receive_buf()/producer path:
1216 * caller holds non-exclusive termios_rwsem
1217 * publishes read_head via put_tty_queue()
1219 static void n_tty_receive_parity_error(struct tty_struct
*tty
, unsigned char c
)
1221 struct n_tty_data
*ldata
= tty
->disc_data
;
1226 if (I_PARMRK(tty
)) {
1227 put_tty_queue('\377', ldata
);
1228 put_tty_queue('\0', ldata
);
1229 put_tty_queue(c
, ldata
);
1231 put_tty_queue('\0', ldata
);
1233 put_tty_queue(c
, ldata
);
1234 if (waitqueue_active(&tty
->read_wait
))
1235 wake_up_interruptible(&tty
->read_wait
);
1239 n_tty_receive_signal_char(struct tty_struct
*tty
, int signal
, unsigned char c
)
1241 if (!L_NOFLSH(tty
)) {
1242 /* flushing needs exclusive termios_rwsem */
1243 up_read(&tty
->termios_rwsem
);
1244 n_tty_flush_buffer(tty
);
1245 tty_driver_flush_buffer(tty
);
1246 down_read(&tty
->termios_rwsem
);
1254 process_echoes(tty
);
1260 * n_tty_receive_char - perform processing
1261 * @tty: terminal device
1264 * Process an individual character of input received from the driver.
1265 * This is serialized with respect to itself by the rules for the
1268 * n_tty_receive_buf()/producer path:
1269 * caller holds non-exclusive termios_rwsem
1270 * publishes canon_head if canonical mode is active
1271 * otherwise, publishes read_head via put_tty_queue()
1273 * Returns 1 if LNEXT was received, else returns 0
1277 n_tty_receive_char_special(struct tty_struct
*tty
, unsigned char c
)
1279 struct n_tty_data
*ldata
= tty
->disc_data
;
1282 if (c
== START_CHAR(tty
)) {
1284 process_echoes(tty
);
1287 if (c
== STOP_CHAR(tty
)) {
1294 if (c
== INTR_CHAR(tty
)) {
1295 n_tty_receive_signal_char(tty
, SIGINT
, c
);
1297 } else if (c
== QUIT_CHAR(tty
)) {
1298 n_tty_receive_signal_char(tty
, SIGQUIT
, c
);
1300 } else if (c
== SUSP_CHAR(tty
)) {
1301 n_tty_receive_signal_char(tty
, SIGTSTP
, c
);
1306 if (tty
->stopped
&& !tty
->flow_stopped
&& I_IXON(tty
) && I_IXANY(tty
)) {
1308 process_echoes(tty
);
1316 } else if (c
== '\n' && I_INLCR(tty
))
1319 if (ldata
->icanon
) {
1320 if (c
== ERASE_CHAR(tty
) || c
== KILL_CHAR(tty
) ||
1321 (c
== WERASE_CHAR(tty
) && L_IEXTEN(tty
))) {
1326 if (c
== LNEXT_CHAR(tty
) && L_IEXTEN(tty
)) {
1329 finish_erasing(ldata
);
1330 if (L_ECHOCTL(tty
)) {
1331 echo_char_raw('^', ldata
);
1332 echo_char_raw('\b', ldata
);
1338 if (c
== REPRINT_CHAR(tty
) && L_ECHO(tty
) && L_IEXTEN(tty
)) {
1339 size_t tail
= ldata
->canon_head
;
1341 finish_erasing(ldata
);
1343 echo_char_raw('\n', ldata
);
1344 while (tail
!= ldata
->read_head
) {
1345 echo_char(read_buf(ldata
, tail
), tty
);
1352 if (L_ECHO(tty
) || L_ECHONL(tty
)) {
1353 echo_char_raw('\n', ldata
);
1356 goto handle_newline
;
1358 if (c
== EOF_CHAR(tty
)) {
1359 c
= __DISABLED_CHAR
;
1360 goto handle_newline
;
1362 if ((c
== EOL_CHAR(tty
)) ||
1363 (c
== EOL2_CHAR(tty
) && L_IEXTEN(tty
))) {
1365 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1368 /* Record the column of first canon char. */
1369 if (ldata
->canon_head
== ldata
->read_head
)
1370 echo_set_canon_col(ldata
);
1375 * XXX does PARMRK doubling happen for
1376 * EOL_CHAR and EOL2_CHAR?
1378 if (c
== (unsigned char) '\377' && I_PARMRK(tty
))
1379 put_tty_queue(c
, ldata
);
1382 set_bit(ldata
->read_head
& (N_TTY_BUF_SIZE
- 1), ldata
->read_flags
);
1383 put_tty_queue(c
, ldata
);
1384 ldata
->canon_head
= ldata
->read_head
;
1385 kill_fasync(&tty
->fasync
, SIGIO
, POLL_IN
);
1386 wake_up_interruptible(&tty
->read_wait
);
1392 finish_erasing(ldata
);
1394 echo_char_raw('\n', ldata
);
1396 /* Record the column of first canon char. */
1397 if (ldata
->canon_head
== ldata
->read_head
)
1398 echo_set_canon_col(ldata
);
1404 /* PARMRK doubling check */
1405 if (c
== (unsigned char) '\377' && I_PARMRK(tty
))
1406 put_tty_queue(c
, ldata
);
1408 put_tty_queue(c
, ldata
);
1413 n_tty_receive_char_inline(struct tty_struct
*tty
, unsigned char c
)
1415 struct n_tty_data
*ldata
= tty
->disc_data
;
1417 if (tty
->stopped
&& !tty
->flow_stopped
&& I_IXON(tty
) && I_IXANY(tty
)) {
1419 process_echoes(tty
);
1422 finish_erasing(ldata
);
1423 /* Record the column of first canon char. */
1424 if (ldata
->canon_head
== ldata
->read_head
)
1425 echo_set_canon_col(ldata
);
1429 /* PARMRK doubling check */
1430 if (c
== (unsigned char) '\377' && I_PARMRK(tty
))
1431 put_tty_queue(c
, ldata
);
1432 put_tty_queue(c
, ldata
);
1435 static void n_tty_receive_char(struct tty_struct
*tty
, unsigned char c
)
1437 n_tty_receive_char_inline(tty
, c
);
1441 n_tty_receive_char_fast(struct tty_struct
*tty
, unsigned char c
)
1443 struct n_tty_data
*ldata
= tty
->disc_data
;
1445 if (tty
->stopped
&& !tty
->flow_stopped
&& I_IXON(tty
) && I_IXANY(tty
)) {
1447 process_echoes(tty
);
1450 finish_erasing(ldata
);
1451 /* Record the column of first canon char. */
1452 if (ldata
->canon_head
== ldata
->read_head
)
1453 echo_set_canon_col(ldata
);
1457 put_tty_queue(c
, ldata
);
1460 static void n_tty_receive_char_closing(struct tty_struct
*tty
, unsigned char c
)
1464 if (I_IUCLC(tty
) && L_IEXTEN(tty
))
1468 if (c
== STOP_CHAR(tty
))
1470 else if (c
== START_CHAR(tty
) ||
1471 (tty
->stopped
&& !tty
->flow_stopped
&& I_IXANY(tty
) &&
1472 c
!= INTR_CHAR(tty
) && c
!= QUIT_CHAR(tty
) &&
1473 c
!= SUSP_CHAR(tty
))) {
1475 process_echoes(tty
);
1481 n_tty_receive_char_flagged(struct tty_struct
*tty
, unsigned char c
, char flag
)
1487 n_tty_receive_break(tty
);
1491 n_tty_receive_parity_error(tty
, c
);
1494 n_tty_receive_overrun(tty
);
1497 printk(KERN_ERR
"%s: unknown flag %d\n",
1498 tty_name(tty
, buf
), flag
);
1504 n_tty_receive_char_lnext(struct tty_struct
*tty
, unsigned char c
, char flag
)
1506 struct n_tty_data
*ldata
= tty
->disc_data
;
1509 if (likely(flag
== TTY_NORMAL
)) {
1512 if (I_IUCLC(tty
) && L_IEXTEN(tty
))
1514 n_tty_receive_char(tty
, c
);
1516 n_tty_receive_char_flagged(tty
, c
, flag
);
1520 n_tty_receive_buf_real_raw(struct tty_struct
*tty
, const unsigned char *cp
,
1521 char *fp
, int count
)
1523 struct n_tty_data
*ldata
= tty
->disc_data
;
1526 head
= ldata
->read_head
& (N_TTY_BUF_SIZE
- 1);
1527 n
= N_TTY_BUF_SIZE
- max(read_cnt(ldata
), head
);
1528 n
= min_t(size_t, count
, n
);
1529 memcpy(read_buf_addr(ldata
, head
), cp
, n
);
1530 ldata
->read_head
+= n
;
1534 head
= ldata
->read_head
& (N_TTY_BUF_SIZE
- 1);
1535 n
= N_TTY_BUF_SIZE
- max(read_cnt(ldata
), head
);
1536 n
= min_t(size_t, count
, n
);
1537 memcpy(read_buf_addr(ldata
, head
), cp
, n
);
1538 ldata
->read_head
+= n
;
1542 n_tty_receive_buf_raw(struct tty_struct
*tty
, const unsigned char *cp
,
1543 char *fp
, int count
)
1545 struct n_tty_data
*ldata
= tty
->disc_data
;
1546 char flag
= TTY_NORMAL
;
1551 if (likely(flag
== TTY_NORMAL
))
1552 put_tty_queue(*cp
++, ldata
);
1554 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1559 n_tty_receive_buf_closing(struct tty_struct
*tty
, const unsigned char *cp
,
1560 char *fp
, int count
)
1562 char flag
= TTY_NORMAL
;
1567 if (likely(flag
== TTY_NORMAL
))
1568 n_tty_receive_char_closing(tty
, *cp
++);
1570 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1575 n_tty_receive_buf_standard(struct tty_struct
*tty
, const unsigned char *cp
,
1576 char *fp
, int count
)
1578 struct n_tty_data
*ldata
= tty
->disc_data
;
1579 char flag
= TTY_NORMAL
;
1584 if (likely(flag
== TTY_NORMAL
)) {
1585 unsigned char c
= *cp
++;
1589 if (I_IUCLC(tty
) && L_IEXTEN(tty
))
1591 if (L_EXTPROC(tty
)) {
1592 put_tty_queue(c
, ldata
);
1595 if (!test_bit(c
, ldata
->char_map
))
1596 n_tty_receive_char_inline(tty
, c
);
1597 else if (n_tty_receive_char_special(tty
, c
) && count
) {
1600 n_tty_receive_char_lnext(tty
, *cp
++, flag
);
1604 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1609 n_tty_receive_buf_fast(struct tty_struct
*tty
, const unsigned char *cp
,
1610 char *fp
, int count
)
1612 struct n_tty_data
*ldata
= tty
->disc_data
;
1613 char flag
= TTY_NORMAL
;
1618 if (likely(flag
== TTY_NORMAL
)) {
1619 unsigned char c
= *cp
++;
1621 if (!test_bit(c
, ldata
->char_map
))
1622 n_tty_receive_char_fast(tty
, c
);
1623 else if (n_tty_receive_char_special(tty
, c
) && count
) {
1626 n_tty_receive_char_lnext(tty
, *cp
++, flag
);
1630 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1634 static void __receive_buf(struct tty_struct
*tty
, const unsigned char *cp
,
1635 char *fp
, int count
)
1637 struct n_tty_data
*ldata
= tty
->disc_data
;
1638 bool preops
= I_ISTRIP(tty
) || (I_IUCLC(tty
) && L_IEXTEN(tty
));
1640 if (ldata
->real_raw
)
1641 n_tty_receive_buf_real_raw(tty
, cp
, fp
, count
);
1642 else if (ldata
->raw
|| (L_EXTPROC(tty
) && !preops
))
1643 n_tty_receive_buf_raw(tty
, cp
, fp
, count
);
1644 else if (tty
->closing
&& !L_EXTPROC(tty
))
1645 n_tty_receive_buf_closing(tty
, cp
, fp
, count
);
1648 char flag
= TTY_NORMAL
;
1652 n_tty_receive_char_lnext(tty
, *cp
++, flag
);
1656 if (!preops
&& !I_PARMRK(tty
))
1657 n_tty_receive_buf_fast(tty
, cp
, fp
, count
);
1659 n_tty_receive_buf_standard(tty
, cp
, fp
, count
);
1662 if (tty
->ops
->flush_chars
)
1663 tty
->ops
->flush_chars(tty
);
1666 if ((!ldata
->icanon
&& (read_cnt(ldata
) >= ldata
->minimum_to_wake
)) ||
1668 kill_fasync(&tty
->fasync
, SIGIO
, POLL_IN
);
1669 wake_up_interruptible(&tty
->read_wait
);
1674 * n_tty_receive_buf_common - process input
1675 * @tty: device to receive input
1677 * @fp: flags for each char (if NULL, all chars are TTY_NORMAL)
1678 * @count: number of input chars in @cp
1680 * Called by the terminal driver when a block of characters has
1681 * been received. This function must be called from soft contexts
1682 * not from interrupt context. The driver is responsible for making
1683 * calls one at a time and in order (or using flush_to_ldisc)
1685 * Returns the # of input chars from @cp which were processed.
1687 * In canonical mode, the maximum line length is 4096 chars (including
1688 * the line termination char); lines longer than 4096 chars are
1689 * truncated. After 4095 chars, input data is still processed but
1690 * not stored. Overflow processing ensures the tty can always
1691 * receive more input until at least one line can be read.
1693 * In non-canonical mode, the read buffer will only accept 4095 chars;
1694 * this provides the necessary space for a newline char if the input
1695 * mode is switched to canonical.
1697 * Note it is possible for the read buffer to _contain_ 4096 chars
1698 * in non-canonical mode: the read buffer could already contain the
1699 * maximum canon line of 4096 chars when the mode is switched to
1702 * n_tty_receive_buf()/producer path:
1703 * claims non-exclusive termios_rwsem
1704 * publishes commit_head or canon_head
1707 n_tty_receive_buf_common(struct tty_struct
*tty
, const unsigned char *cp
,
1708 char *fp
, int count
, int flow
)
1710 struct n_tty_data
*ldata
= tty
->disc_data
;
1711 int room
, n
, rcvd
= 0, overflow
;
1713 down_read(&tty
->termios_rwsem
);
1717 * When PARMRK is set, each input char may take up to 3 chars
1718 * in the read buf; reduce the buffer space avail by 3x
1720 * If we are doing input canonicalization, and there are no
1721 * pending newlines, let characters through without limit, so
1722 * that erase characters will be handled. Other excess
1723 * characters will be beeped.
1725 * paired with store in *_copy_from_read_buf() -- guarantees
1726 * the consumer has loaded the data in read_buf up to the new
1727 * read_tail (so this producer will not overwrite unread data)
1729 size_t tail
= ldata
->read_tail
;
1731 room
= N_TTY_BUF_SIZE
- (ldata
->read_head
- tail
);
1733 room
= (room
+ 2) / 3;
1736 overflow
= ldata
->icanon
&& ldata
->canon_head
== tail
;
1737 if (overflow
&& room
< 0)
1740 ldata
->no_room
= flow
&& !room
;
1744 n
= min(count
, room
);
1748 /* ignore parity errors if handling overflow */
1749 if (!overflow
|| !fp
|| *fp
!= TTY_PARITY
)
1750 __receive_buf(tty
, cp
, fp
, n
);
1759 tty
->receive_room
= room
;
1761 /* Unthrottle if handling overflow on pty */
1762 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
) {
1764 tty_set_flow_change(tty
, TTY_UNTHROTTLE_SAFE
);
1765 tty_unthrottle_safe(tty
);
1766 __tty_set_flow_change(tty
, 0);
1769 n_tty_check_throttle(tty
);
1771 up_read(&tty
->termios_rwsem
);
1776 static void n_tty_receive_buf(struct tty_struct
*tty
, const unsigned char *cp
,
1777 char *fp
, int count
)
1779 n_tty_receive_buf_common(tty
, cp
, fp
, count
, 0);
1782 static int n_tty_receive_buf2(struct tty_struct
*tty
, const unsigned char *cp
,
1783 char *fp
, int count
)
1785 return n_tty_receive_buf_common(tty
, cp
, fp
, count
, 1);
1788 int is_ignored(int sig
)
1790 return (sigismember(¤t
->blocked
, sig
) ||
1791 current
->sighand
->action
[sig
-1].sa
.sa_handler
== SIG_IGN
);
1795 * n_tty_set_termios - termios data changed
1797 * @old: previous data
1799 * Called by the tty layer when the user changes termios flags so
1800 * that the line discipline can plan ahead. This function cannot sleep
1801 * and is protected from re-entry by the tty layer. The user is
1802 * guaranteed that this function will not be re-entered or in progress
1803 * when the ldisc is closed.
1805 * Locking: Caller holds tty->termios_rwsem
1808 static void n_tty_set_termios(struct tty_struct
*tty
, struct ktermios
*old
)
1810 struct n_tty_data
*ldata
= tty
->disc_data
;
1812 if (!old
|| (old
->c_lflag
^ tty
->termios
.c_lflag
) & ICANON
) {
1813 bitmap_zero(ldata
->read_flags
, N_TTY_BUF_SIZE
);
1814 ldata
->line_start
= ldata
->read_tail
;
1815 if (!L_ICANON(tty
) || !read_cnt(ldata
)) {
1816 ldata
->canon_head
= ldata
->read_tail
;
1819 set_bit((ldata
->read_head
- 1) & (N_TTY_BUF_SIZE
- 1),
1821 ldata
->canon_head
= ldata
->read_head
;
1828 ldata
->icanon
= (L_ICANON(tty
) != 0);
1830 if (I_ISTRIP(tty
) || I_IUCLC(tty
) || I_IGNCR(tty
) ||
1831 I_ICRNL(tty
) || I_INLCR(tty
) || L_ICANON(tty
) ||
1832 I_IXON(tty
) || L_ISIG(tty
) || L_ECHO(tty
) ||
1834 bitmap_zero(ldata
->char_map
, 256);
1836 if (I_IGNCR(tty
) || I_ICRNL(tty
))
1837 set_bit('\r', ldata
->char_map
);
1839 set_bit('\n', ldata
->char_map
);
1841 if (L_ICANON(tty
)) {
1842 set_bit(ERASE_CHAR(tty
), ldata
->char_map
);
1843 set_bit(KILL_CHAR(tty
), ldata
->char_map
);
1844 set_bit(EOF_CHAR(tty
), ldata
->char_map
);
1845 set_bit('\n', ldata
->char_map
);
1846 set_bit(EOL_CHAR(tty
), ldata
->char_map
);
1847 if (L_IEXTEN(tty
)) {
1848 set_bit(WERASE_CHAR(tty
), ldata
->char_map
);
1849 set_bit(LNEXT_CHAR(tty
), ldata
->char_map
);
1850 set_bit(EOL2_CHAR(tty
), ldata
->char_map
);
1852 set_bit(REPRINT_CHAR(tty
),
1857 set_bit(START_CHAR(tty
), ldata
->char_map
);
1858 set_bit(STOP_CHAR(tty
), ldata
->char_map
);
1861 set_bit(INTR_CHAR(tty
), ldata
->char_map
);
1862 set_bit(QUIT_CHAR(tty
), ldata
->char_map
);
1863 set_bit(SUSP_CHAR(tty
), ldata
->char_map
);
1865 clear_bit(__DISABLED_CHAR
, ldata
->char_map
);
1867 ldata
->real_raw
= 0;
1870 if ((I_IGNBRK(tty
) || (!I_BRKINT(tty
) && !I_PARMRK(tty
))) &&
1871 (I_IGNPAR(tty
) || !I_INPCK(tty
)) &&
1872 (tty
->driver
->flags
& TTY_DRIVER_REAL_RAW
))
1873 ldata
->real_raw
= 1;
1875 ldata
->real_raw
= 0;
1877 n_tty_set_room(tty
);
1879 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1880 * been stopped by STOP_CHAR(tty) before it.
1882 if (!I_IXON(tty
) && old
&& (old
->c_iflag
& IXON
) && !tty
->flow_stopped
) {
1884 process_echoes(tty
);
1887 /* The termios change make the tty ready for I/O */
1888 wake_up_interruptible(&tty
->write_wait
);
1889 wake_up_interruptible(&tty
->read_wait
);
1893 * n_tty_close - close the ldisc for this tty
1896 * Called from the terminal layer when this line discipline is
1897 * being shut down, either because of a close or becsuse of a
1898 * discipline change. The function will not be called while other
1899 * ldisc methods are in progress.
1902 static void n_tty_close(struct tty_struct
*tty
)
1904 struct n_tty_data
*ldata
= tty
->disc_data
;
1907 n_tty_packet_mode_flush(tty
);
1910 tty
->disc_data
= NULL
;
1914 * n_tty_open - open an ldisc
1915 * @tty: terminal to open
1917 * Called when this line discipline is being attached to the
1918 * terminal device. Can sleep. Called serialized so that no
1919 * other events will occur in parallel. No further open will occur
1923 static int n_tty_open(struct tty_struct
*tty
)
1925 struct n_tty_data
*ldata
;
1927 /* Currently a malloc failure here can panic */
1928 ldata
= vmalloc(sizeof(*ldata
));
1932 ldata
->overrun_time
= jiffies
;
1933 mutex_init(&ldata
->atomic_read_lock
);
1934 mutex_init(&ldata
->output_lock
);
1936 tty
->disc_data
= ldata
;
1937 reset_buffer_flags(tty
->disc_data
);
1939 ldata
->canon_column
= 0;
1940 ldata
->minimum_to_wake
= 1;
1941 ldata
->num_overrun
= 0;
1945 /* indicate buffer work may resume */
1946 clear_bit(TTY_LDISC_HALTED
, &tty
->flags
);
1947 n_tty_set_termios(tty
, NULL
);
1948 tty_unthrottle(tty
);
1955 static inline int input_available_p(struct tty_struct
*tty
, int poll
)
1957 struct n_tty_data
*ldata
= tty
->disc_data
;
1958 int amt
= poll
&& !TIME_CHAR(tty
) && MIN_CHAR(tty
) ? MIN_CHAR(tty
) : 1;
1960 if (ldata
->icanon
&& !L_EXTPROC(tty
))
1961 return ldata
->canon_head
!= ldata
->read_tail
;
1963 return read_cnt(ldata
) >= amt
;
1967 * copy_from_read_buf - copy read data directly
1968 * @tty: terminal device
1972 * Helper function to speed up n_tty_read. It is only called when
1973 * ICANON is off; it copies characters straight from the tty queue to
1974 * user space directly. It can be profitably called twice; once to
1975 * drain the space from the tail pointer to the (physical) end of the
1976 * buffer, and once to drain the space from the (physical) beginning of
1977 * the buffer to head pointer.
1979 * Called under the ldata->atomic_read_lock sem
1981 * n_tty_read()/consumer path:
1982 * caller holds non-exclusive termios_rwsem
1983 * read_tail published
1986 static int copy_from_read_buf(struct tty_struct
*tty
,
1987 unsigned char __user
**b
,
1991 struct n_tty_data
*ldata
= tty
->disc_data
;
1995 size_t tail
= ldata
->read_tail
& (N_TTY_BUF_SIZE
- 1);
1998 n
= min(read_cnt(ldata
), N_TTY_BUF_SIZE
- tail
);
2001 retval
= copy_to_user(*b
, read_buf_addr(ldata
, tail
), n
);
2003 is_eof
= n
== 1 && read_buf(ldata
, tail
) == EOF_CHAR(tty
);
2004 tty_audit_add_data(tty
, read_buf_addr(ldata
, tail
), n
,
2006 ldata
->read_tail
+= n
;
2007 /* Turn single EOF into zero-length read */
2008 if (L_EXTPROC(tty
) && ldata
->icanon
&& is_eof
&& !read_cnt(ldata
))
2017 * canon_copy_from_read_buf - copy read data in canonical mode
2018 * @tty: terminal device
2022 * Helper function for n_tty_read. It is only called when ICANON is on;
2023 * it copies one line of input up to and including the line-delimiting
2024 * character into the user-space buffer.
2026 * NB: When termios is changed from non-canonical to canonical mode and
2027 * the read buffer contains data, n_tty_set_termios() simulates an EOF
2028 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
2029 * This causes data already processed as input to be immediately available
2030 * as input although a newline has not been received.
2032 * Called under the atomic_read_lock mutex
2034 * n_tty_read()/consumer path:
2035 * caller holds non-exclusive termios_rwsem
2036 * read_tail published
2039 static int canon_copy_from_read_buf(struct tty_struct
*tty
,
2040 unsigned char __user
**b
,
2043 struct n_tty_data
*ldata
= tty
->disc_data
;
2044 size_t n
, size
, more
, c
;
2049 /* N.B. avoid overrun if nr == 0 */
2053 n
= min(*nr
+ 1, read_cnt(ldata
));
2055 tail
= ldata
->read_tail
& (N_TTY_BUF_SIZE
- 1);
2056 size
= min_t(size_t, tail
+ n
, N_TTY_BUF_SIZE
);
2058 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
2059 __func__
, *nr
, tail
, n
, size
);
2061 eol
= find_next_bit(ldata
->read_flags
, size
, tail
);
2062 more
= n
- (size
- tail
);
2063 if (eol
== N_TTY_BUF_SIZE
&& more
) {
2064 /* scan wrapped without finding set bit */
2065 eol
= find_next_bit(ldata
->read_flags
, more
, 0);
2068 } else if (eol
!= size
)
2071 size
= N_TTY_BUF_SIZE
- tail
;
2077 if (!found
|| read_buf(ldata
, eol
) != __DISABLED_CHAR
) {
2082 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
2083 __func__
, eol
, found
, n
, c
, size
, more
);
2086 ret
= tty_copy_to_user(tty
, *b
, read_buf_addr(ldata
, tail
), size
);
2089 ret
= tty_copy_to_user(tty
, *b
+ size
, ldata
->read_buf
, n
- size
);
2091 ret
= tty_copy_to_user(tty
, *b
, read_buf_addr(ldata
, tail
), n
);
2099 clear_bit(eol
, ldata
->read_flags
);
2100 smp_mb__after_atomic();
2101 ldata
->read_tail
+= c
;
2105 ldata
->line_start
= ldata
->read_tail
;
2108 tty_audit_push(tty
);
2113 extern ssize_t
redirected_tty_write(struct file
*, const char __user
*,
2117 * job_control - check job control
2119 * @file: file handle
2121 * Perform job control management checks on this file/tty descriptor
2122 * and if appropriate send any needed signals and return a negative
2123 * error code if action should be taken.
2125 * Locking: redirected write test is safe
2126 * current->signal->tty check is safe
2127 * ctrl_lock to safely reference tty->pgrp
2130 static int job_control(struct tty_struct
*tty
, struct file
*file
)
2132 /* Job control check -- must be done at start and after
2133 every sleep (POSIX.1 7.1.1.4). */
2134 /* NOTE: not yet done after every sleep pending a thorough
2135 check of the logic of this change. -- jlc */
2136 /* don't stop on /dev/console */
2137 if (file
->f_op
->write
== redirected_tty_write
||
2138 current
->signal
->tty
!= tty
)
2141 spin_lock_irq(&tty
->ctrl_lock
);
2143 printk(KERN_ERR
"n_tty_read: no tty->pgrp!\n");
2144 else if (task_pgrp(current
) != tty
->pgrp
) {
2145 spin_unlock_irq(&tty
->ctrl_lock
);
2146 if (is_ignored(SIGTTIN
) || is_current_pgrp_orphaned())
2148 kill_pgrp(task_pgrp(current
), SIGTTIN
, 1);
2149 set_thread_flag(TIF_SIGPENDING
);
2150 return -ERESTARTSYS
;
2152 spin_unlock_irq(&tty
->ctrl_lock
);
2158 * n_tty_read - read function for tty
2160 * @file: file object
2161 * @buf: userspace buffer pointer
2164 * Perform reads for the line discipline. We are guaranteed that the
2165 * line discipline will not be closed under us but we may get multiple
2166 * parallel readers and must handle this ourselves. We may also get
2167 * a hangup. Always called in user context, may sleep.
2169 * This code must be sure never to sleep through a hangup.
2171 * n_tty_read()/consumer path:
2172 * claims non-exclusive termios_rwsem
2173 * publishes read_tail
2176 static ssize_t
n_tty_read(struct tty_struct
*tty
, struct file
*file
,
2177 unsigned char __user
*buf
, size_t nr
)
2179 struct n_tty_data
*ldata
= tty
->disc_data
;
2180 unsigned char __user
*b
= buf
;
2181 DECLARE_WAITQUEUE(wait
, current
);
2186 unsigned long flags
;
2189 c
= job_control(tty
, file
);
2194 * Internal serialization of reads.
2196 if (file
->f_flags
& O_NONBLOCK
) {
2197 if (!mutex_trylock(&ldata
->atomic_read_lock
))
2200 if (mutex_lock_interruptible(&ldata
->atomic_read_lock
))
2201 return -ERESTARTSYS
;
2204 down_read(&tty
->termios_rwsem
);
2207 timeout
= MAX_SCHEDULE_TIMEOUT
;
2208 if (!ldata
->icanon
) {
2209 minimum
= MIN_CHAR(tty
);
2211 time
= (HZ
/ 10) * TIME_CHAR(tty
);
2213 ldata
->minimum_to_wake
= 1;
2214 else if (!waitqueue_active(&tty
->read_wait
) ||
2215 (ldata
->minimum_to_wake
> minimum
))
2216 ldata
->minimum_to_wake
= minimum
;
2218 timeout
= (HZ
/ 10) * TIME_CHAR(tty
);
2219 ldata
->minimum_to_wake
= minimum
= 1;
2223 packet
= tty
->packet
;
2225 add_wait_queue(&tty
->read_wait
, &wait
);
2227 /* First test for status change. */
2228 if (packet
&& tty
->link
->ctrl_status
) {
2232 spin_lock_irqsave(&tty
->link
->ctrl_lock
, flags
);
2233 cs
= tty
->link
->ctrl_status
;
2234 tty
->link
->ctrl_status
= 0;
2235 spin_unlock_irqrestore(&tty
->link
->ctrl_lock
, flags
);
2236 if (tty_put_user(tty
, cs
, b
++)) {
2244 /* This statement must be first before checking for input
2245 so that any interrupt will set the state back to
2247 set_current_state(TASK_INTERRUPTIBLE
);
2249 if (((minimum
- (b
- buf
)) < ldata
->minimum_to_wake
) &&
2250 ((minimum
- (b
- buf
)) >= 1))
2251 ldata
->minimum_to_wake
= (minimum
- (b
- buf
));
2253 if (!input_available_p(tty
, 0)) {
2254 if (test_bit(TTY_OTHER_CLOSED
, &tty
->flags
)) {
2255 up_read(&tty
->termios_rwsem
);
2256 tty_flush_to_ldisc(tty
);
2257 down_read(&tty
->termios_rwsem
);
2258 if (!input_available_p(tty
, 0)) {
2263 if (tty_hung_up_p(file
))
2267 if (file
->f_flags
& O_NONBLOCK
) {
2271 if (signal_pending(current
)) {
2272 retval
= -ERESTARTSYS
;
2275 n_tty_set_room(tty
);
2276 up_read(&tty
->termios_rwsem
);
2278 timeout
= schedule_timeout(timeout
);
2280 down_read(&tty
->termios_rwsem
);
2284 __set_current_state(TASK_RUNNING
);
2286 /* Deal with packet mode. */
2287 if (packet
&& b
== buf
) {
2288 if (tty_put_user(tty
, TIOCPKT_DATA
, b
++)) {
2296 if (ldata
->icanon
&& !L_EXTPROC(tty
)) {
2297 retval
= canon_copy_from_read_buf(tty
, &b
, &nr
);
2302 /* The copy function takes the read lock and handles
2303 locking internally for this case */
2304 uncopied
= copy_from_read_buf(tty
, &b
, &nr
);
2305 uncopied
+= copy_from_read_buf(tty
, &b
, &nr
);
2312 n_tty_check_unthrottle(tty
);
2314 if (b
- buf
>= minimum
)
2319 n_tty_set_room(tty
);
2320 up_read(&tty
->termios_rwsem
);
2322 remove_wait_queue(&tty
->read_wait
, &wait
);
2323 if (!waitqueue_active(&tty
->read_wait
))
2324 ldata
->minimum_to_wake
= minimum
;
2326 mutex_unlock(&ldata
->atomic_read_lock
);
2328 __set_current_state(TASK_RUNNING
);
2336 * n_tty_write - write function for tty
2338 * @file: file object
2339 * @buf: userspace buffer pointer
2342 * Write function of the terminal device. This is serialized with
2343 * respect to other write callers but not to termios changes, reads
2344 * and other such events. Since the receive code will echo characters,
2345 * thus calling driver write methods, the output_lock is used in
2346 * the output processing functions called here as well as in the
2347 * echo processing function to protect the column state and space
2348 * left in the buffer.
2350 * This code must be sure never to sleep through a hangup.
2352 * Locking: output_lock to protect column state and space left
2353 * (note that the process_output*() functions take this
2357 static ssize_t
n_tty_write(struct tty_struct
*tty
, struct file
*file
,
2358 const unsigned char *buf
, size_t nr
)
2360 const unsigned char *b
= buf
;
2361 DECLARE_WAITQUEUE(wait
, current
);
2365 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2366 if (L_TOSTOP(tty
) && file
->f_op
->write
!= redirected_tty_write
) {
2367 retval
= tty_check_change(tty
);
2372 down_read(&tty
->termios_rwsem
);
2374 /* Write out any echoed characters that are still pending */
2375 process_echoes(tty
);
2377 add_wait_queue(&tty
->write_wait
, &wait
);
2379 set_current_state(TASK_INTERRUPTIBLE
);
2380 if (signal_pending(current
)) {
2381 retval
= -ERESTARTSYS
;
2384 if (tty_hung_up_p(file
) || (tty
->link
&& !tty
->link
->count
)) {
2390 ssize_t num
= process_output_block(tty
, b
, nr
);
2402 if (process_output(c
, tty
) < 0)
2406 if (tty
->ops
->flush_chars
)
2407 tty
->ops
->flush_chars(tty
);
2409 struct n_tty_data
*ldata
= tty
->disc_data
;
2412 mutex_lock(&ldata
->output_lock
);
2413 c
= tty
->ops
->write(tty
, b
, nr
);
2414 mutex_unlock(&ldata
->output_lock
);
2427 if (file
->f_flags
& O_NONBLOCK
) {
2431 up_read(&tty
->termios_rwsem
);
2435 down_read(&tty
->termios_rwsem
);
2438 __set_current_state(TASK_RUNNING
);
2439 remove_wait_queue(&tty
->write_wait
, &wait
);
2440 if (b
- buf
!= nr
&& tty
->fasync
)
2441 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
2442 up_read(&tty
->termios_rwsem
);
2443 return (b
- buf
) ? b
- buf
: retval
;
2447 * n_tty_poll - poll method for N_TTY
2448 * @tty: terminal device
2449 * @file: file accessing it
2452 * Called when the line discipline is asked to poll() for data or
2453 * for special events. This code is not serialized with respect to
2454 * other events save open/close.
2456 * This code must be sure never to sleep through a hangup.
2457 * Called without the kernel lock held - fine
2460 static unsigned int n_tty_poll(struct tty_struct
*tty
, struct file
*file
,
2463 struct n_tty_data
*ldata
= tty
->disc_data
;
2464 unsigned int mask
= 0;
2466 poll_wait(file
, &tty
->read_wait
, wait
);
2467 poll_wait(file
, &tty
->write_wait
, wait
);
2468 if (test_bit(TTY_OTHER_CLOSED
, &tty
->flags
))
2470 if (input_available_p(tty
, 1))
2471 mask
|= POLLIN
| POLLRDNORM
;
2472 else if (mask
& POLLHUP
) {
2473 tty_flush_to_ldisc(tty
);
2474 if (input_available_p(tty
, 1))
2475 mask
|= POLLIN
| POLLRDNORM
;
2477 if (tty
->packet
&& tty
->link
->ctrl_status
)
2478 mask
|= POLLPRI
| POLLIN
| POLLRDNORM
;
2479 if (tty_hung_up_p(file
))
2481 if (!(mask
& (POLLHUP
| POLLIN
| POLLRDNORM
))) {
2482 if (MIN_CHAR(tty
) && !TIME_CHAR(tty
))
2483 ldata
->minimum_to_wake
= MIN_CHAR(tty
);
2485 ldata
->minimum_to_wake
= 1;
2487 if (tty
->ops
->write
&& !tty_is_writelocked(tty
) &&
2488 tty_chars_in_buffer(tty
) < WAKEUP_CHARS
&&
2489 tty_write_room(tty
) > 0)
2490 mask
|= POLLOUT
| POLLWRNORM
;
2494 static unsigned long inq_canon(struct n_tty_data
*ldata
)
2496 size_t nr
, head
, tail
;
2498 if (ldata
->canon_head
== ldata
->read_tail
)
2500 head
= ldata
->canon_head
;
2501 tail
= ldata
->read_tail
;
2503 /* Skip EOF-chars.. */
2504 while (head
!= tail
) {
2505 if (test_bit(tail
& (N_TTY_BUF_SIZE
- 1), ldata
->read_flags
) &&
2506 read_buf(ldata
, tail
) == __DISABLED_CHAR
)
2513 static int n_tty_ioctl(struct tty_struct
*tty
, struct file
*file
,
2514 unsigned int cmd
, unsigned long arg
)
2516 struct n_tty_data
*ldata
= tty
->disc_data
;
2521 return put_user(tty_chars_in_buffer(tty
), (int __user
*) arg
);
2523 down_write(&tty
->termios_rwsem
);
2525 retval
= inq_canon(ldata
);
2527 retval
= read_cnt(ldata
);
2528 up_write(&tty
->termios_rwsem
);
2529 return put_user(retval
, (unsigned int __user
*) arg
);
2531 return n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
2535 static void n_tty_fasync(struct tty_struct
*tty
, int on
)
2537 struct n_tty_data
*ldata
= tty
->disc_data
;
2539 if (!waitqueue_active(&tty
->read_wait
)) {
2541 ldata
->minimum_to_wake
= 1;
2542 else if (!tty
->fasync
)
2543 ldata
->minimum_to_wake
= N_TTY_BUF_SIZE
;
2547 struct tty_ldisc_ops tty_ldisc_N_TTY
= {
2548 .magic
= TTY_LDISC_MAGIC
,
2551 .close
= n_tty_close
,
2552 .flush_buffer
= n_tty_flush_buffer
,
2553 .chars_in_buffer
= n_tty_chars_in_buffer
,
2555 .write
= n_tty_write
,
2556 .ioctl
= n_tty_ioctl
,
2557 .set_termios
= n_tty_set_termios
,
2559 .receive_buf
= n_tty_receive_buf
,
2560 .write_wakeup
= n_tty_write_wakeup
,
2561 .fasync
= n_tty_fasync
,
2562 .receive_buf2
= n_tty_receive_buf2
,
2566 * n_tty_inherit_ops - inherit N_TTY methods
2567 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2569 * Enables a 'subclass' line discipline to 'inherit' N_TTY
2573 void n_tty_inherit_ops(struct tty_ldisc_ops
*ops
)
2575 *ops
= tty_ldisc_N_TTY
;
2577 ops
->refcount
= ops
->flags
= 0;
2579 EXPORT_SYMBOL_GPL(n_tty_inherit_ops
);