1 // SPDX-License-Identifier: GPL-1.0+
3 * n_tty.c --- implements the N_TTY line discipline.
5 * This code used to be in tty_io.c, but things are getting hairy
6 * enough that it made sense to split things off. (The N_TTY
7 * processing has changed so much that it's hardly recognizable,
10 * Note that the open routine for N_TTY is guaranteed never to return
11 * an error. This is because Linux will fall back to setting a line
12 * to N_TTY if it can not switch to any other line discipline.
14 * Written by Theodore Ts'o, Copyright 1994.
16 * This file also contains code originally written by Linus Torvalds,
17 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
19 * Reduced memory usage for older ARM systems - Russell King.
21 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
22 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
23 * who actually finally proved there really was a race.
25 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
26 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
27 * Also fixed a bug in BLOCKING mode where n_tty_write returns
31 #include <linux/types.h>
32 #include <linux/major.h>
33 #include <linux/errno.h>
34 #include <linux/signal.h>
35 #include <linux/fcntl.h>
36 #include <linux/sched.h>
37 #include <linux/interrupt.h>
38 #include <linux/tty.h>
39 #include <linux/timer.h>
40 #include <linux/ctype.h>
42 #include <linux/string.h>
43 #include <linux/slab.h>
44 #include <linux/poll.h>
45 #include <linux/bitops.h>
46 #include <linux/audit.h>
47 #include <linux/file.h>
48 #include <linux/uaccess.h>
49 #include <linux/module.h>
50 #include <linux/ratelimit.h>
51 #include <linux/vmalloc.h>
54 * Until this number of characters is queued in the xmit buffer, select will
55 * return "we have room for writes".
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...) no_printk(f, ##args)
91 /* producer-published */
98 DECLARE_BITMAP(char_map
, 256);
100 /* private to n_tty_receive_overrun (single-threaded) */
101 unsigned long overrun_time
;
107 /* must hold exclusive termios_rwsem to reset these */
108 unsigned char lnext
:1, erasing
:1, raw
:1, real_raw
:1, icanon
:1;
109 unsigned char push
:1;
111 /* shared by producer and consumer */
112 char read_buf
[N_TTY_BUF_SIZE
];
113 DECLARE_BITMAP(read_flags
, N_TTY_BUF_SIZE
);
114 unsigned char echo_buf
[N_TTY_BUF_SIZE
];
116 /* consumer-published */
120 /* protected by output lock */
122 unsigned int canon_column
;
125 struct mutex atomic_read_lock
;
126 struct mutex output_lock
;
129 #define MASK(x) ((x) & (N_TTY_BUF_SIZE - 1))
131 static inline size_t read_cnt(struct n_tty_data
*ldata
)
133 return ldata
->read_head
- ldata
->read_tail
;
136 static inline unsigned char read_buf(struct n_tty_data
*ldata
, size_t i
)
138 return ldata
->read_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
141 static inline unsigned char *read_buf_addr(struct n_tty_data
*ldata
, size_t i
)
143 return &ldata
->read_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
146 static inline unsigned char echo_buf(struct n_tty_data
*ldata
, size_t i
)
148 smp_rmb(); /* Matches smp_wmb() in add_echo_byte(). */
149 return ldata
->echo_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
152 static inline unsigned char *echo_buf_addr(struct n_tty_data
*ldata
, size_t i
)
154 return &ldata
->echo_buf
[i
& (N_TTY_BUF_SIZE
- 1)];
157 /* If we are not echoing the data, perhaps this is a secret so erase it */
158 static void zero_buffer(struct tty_struct
*tty
, u8
*buffer
, int size
)
160 bool icanon
= !!L_ICANON(tty
);
161 bool no_echo
= !L_ECHO(tty
);
163 if (icanon
&& no_echo
)
164 memset(buffer
, 0x00, size
);
167 static int tty_copy_to_user(struct tty_struct
*tty
, void __user
*to
,
168 size_t tail
, size_t n
)
170 struct n_tty_data
*ldata
= tty
->disc_data
;
171 size_t size
= N_TTY_BUF_SIZE
- tail
;
172 void *from
= read_buf_addr(ldata
, tail
);
176 tty_audit_add_data(tty
, from
, size
);
177 uncopied
= copy_to_user(to
, from
, size
);
178 zero_buffer(tty
, from
, size
- uncopied
);
183 from
= ldata
->read_buf
;
186 tty_audit_add_data(tty
, from
, n
);
187 uncopied
= copy_to_user(to
, from
, n
);
188 zero_buffer(tty
, from
, n
- uncopied
);
193 * n_tty_kick_worker - start input worker (if required)
196 * Re-schedules the flip buffer work if it may have stopped
198 * Caller holds exclusive termios_rwsem
200 * n_tty_read()/consumer path:
201 * holds non-exclusive termios_rwsem
204 static void n_tty_kick_worker(struct tty_struct
*tty
)
206 struct n_tty_data
*ldata
= tty
->disc_data
;
208 /* Did the input worker stop? Restart it */
209 if (unlikely(ldata
->no_room
)) {
212 WARN_RATELIMIT(tty
->port
->itty
== NULL
,
213 "scheduling with invalid itty\n");
214 /* see if ldisc has been killed - if so, this means that
215 * even though the ldisc has been halted and ->buf.work
216 * cancelled, ->buf.work is about to be rescheduled
218 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED
, &tty
->flags
),
219 "scheduling buffer work for halted ldisc\n");
220 tty_buffer_restart_work(tty
->port
);
224 static ssize_t
chars_in_buffer(struct tty_struct
*tty
)
226 struct n_tty_data
*ldata
= tty
->disc_data
;
230 n
= ldata
->commit_head
- ldata
->read_tail
;
232 n
= ldata
->canon_head
- ldata
->read_tail
;
237 * n_tty_write_wakeup - asynchronous I/O notifier
240 * Required for the ptys, serial driver etc. since processes
241 * that attach themselves to the master and rely on ASYNC
242 * IO must be woken up
245 static void n_tty_write_wakeup(struct tty_struct
*tty
)
247 clear_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
248 kill_fasync(&tty
->fasync
, SIGIO
, POLL_OUT
);
251 static void n_tty_check_throttle(struct tty_struct
*tty
)
253 struct n_tty_data
*ldata
= tty
->disc_data
;
256 * Check the remaining room for the input canonicalization
257 * mode. We don't want to throttle the driver if we're in
258 * canonical mode and don't have a newline yet!
260 if (ldata
->icanon
&& ldata
->canon_head
== ldata
->read_tail
)
265 tty_set_flow_change(tty
, TTY_THROTTLE_SAFE
);
266 if (N_TTY_BUF_SIZE
- read_cnt(ldata
) >= TTY_THRESHOLD_THROTTLE
)
268 throttled
= tty_throttle_safe(tty
);
272 __tty_set_flow_change(tty
, 0);
275 static void n_tty_check_unthrottle(struct tty_struct
*tty
)
277 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
) {
278 if (chars_in_buffer(tty
) > TTY_THRESHOLD_UNTHROTTLE
)
280 n_tty_kick_worker(tty
);
281 tty_wakeup(tty
->link
);
285 /* If there is enough space in the read buffer now, let the
286 * low-level driver know. We use chars_in_buffer() to
287 * check the buffer, as it now knows about canonical mode.
288 * Otherwise, if the driver is throttled and the line is
289 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
290 * we won't get any more characters.
295 tty_set_flow_change(tty
, TTY_UNTHROTTLE_SAFE
);
296 if (chars_in_buffer(tty
) > TTY_THRESHOLD_UNTHROTTLE
)
298 n_tty_kick_worker(tty
);
299 unthrottled
= tty_unthrottle_safe(tty
);
303 __tty_set_flow_change(tty
, 0);
307 * put_tty_queue - add character to tty
311 * Add a character to the tty read_buf queue.
313 * n_tty_receive_buf()/producer path:
314 * caller holds non-exclusive termios_rwsem
317 static inline void put_tty_queue(unsigned char c
, struct n_tty_data
*ldata
)
319 *read_buf_addr(ldata
, ldata
->read_head
) = c
;
324 * reset_buffer_flags - reset buffer state
325 * @tty: terminal to reset
327 * Reset the read buffer counters and clear the flags.
328 * Called from n_tty_open() and n_tty_flush_buffer().
330 * Locking: caller holds exclusive termios_rwsem
331 * (or locking is not required)
334 static void reset_buffer_flags(struct n_tty_data
*ldata
)
336 ldata
->read_head
= ldata
->canon_head
= ldata
->read_tail
= 0;
337 ldata
->commit_head
= 0;
338 ldata
->line_start
= 0;
341 bitmap_zero(ldata
->read_flags
, N_TTY_BUF_SIZE
);
345 static void n_tty_packet_mode_flush(struct tty_struct
*tty
)
349 if (tty
->link
->packet
) {
350 spin_lock_irqsave(&tty
->ctrl_lock
, flags
);
351 tty
->ctrl_status
|= TIOCPKT_FLUSHREAD
;
352 spin_unlock_irqrestore(&tty
->ctrl_lock
, flags
);
353 wake_up_interruptible(&tty
->link
->read_wait
);
358 * n_tty_flush_buffer - clean input queue
359 * @tty: terminal device
361 * Flush the input buffer. Called when the tty layer wants the
362 * buffer flushed (eg at hangup) or when the N_TTY line discipline
363 * internally has to clean the pending queue (for example some signals).
365 * Holds termios_rwsem to exclude producer/consumer while
366 * buffer indices are reset.
368 * Locking: ctrl_lock, exclusive termios_rwsem
371 static void n_tty_flush_buffer(struct tty_struct
*tty
)
373 down_write(&tty
->termios_rwsem
);
374 reset_buffer_flags(tty
->disc_data
);
375 n_tty_kick_worker(tty
);
378 n_tty_packet_mode_flush(tty
);
379 up_write(&tty
->termios_rwsem
);
383 * is_utf8_continuation - utf8 multibyte check
386 * Returns true if the utf8 character 'c' is a multibyte continuation
387 * character. We use this to correctly compute the on screen size
388 * of the character when printing
391 static inline int is_utf8_continuation(unsigned char c
)
393 return (c
& 0xc0) == 0x80;
397 * is_continuation - multibyte check
400 * Returns true if the utf8 character 'c' is a multibyte continuation
401 * character and the terminal is in unicode mode.
404 static inline int is_continuation(unsigned char c
, struct tty_struct
*tty
)
406 return I_IUTF8(tty
) && is_utf8_continuation(c
);
410 * do_output_char - output one character
411 * @c: character (or partial unicode symbol)
412 * @tty: terminal device
413 * @space: space available in tty driver write buffer
415 * This is a helper function that handles one output character
416 * (including special characters like TAB, CR, LF, etc.),
417 * doing OPOST processing and putting the results in the
418 * tty driver's write buffer.
420 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
421 * and NLDLY. They simply aren't relevant in the world today.
422 * If you ever need them, add them here.
424 * Returns the number of bytes of buffer space used or -1 if
427 * Locking: should be called under the output_lock to protect
428 * the column state and space left in the buffer
431 static int do_output_char(unsigned char c
, struct tty_struct
*tty
, int space
)
433 struct n_tty_data
*ldata
= tty
->disc_data
;
446 ldata
->canon_column
= ldata
->column
= 0;
447 tty
->ops
->write(tty
, "\r\n", 2);
450 ldata
->canon_column
= ldata
->column
;
453 if (O_ONOCR(tty
) && ldata
->column
== 0)
458 ldata
->canon_column
= ldata
->column
= 0;
461 ldata
->canon_column
= ldata
->column
= 0;
464 spaces
= 8 - (ldata
->column
& 7);
465 if (O_TABDLY(tty
) == XTABS
) {
468 ldata
->column
+= spaces
;
469 tty
->ops
->write(tty
, " ", spaces
);
472 ldata
->column
+= spaces
;
475 if (ldata
->column
> 0)
482 if (!is_continuation(c
, tty
))
488 tty_put_char(tty
, c
);
493 * process_output - output post processor
494 * @c: character (or partial unicode symbol)
495 * @tty: terminal device
497 * Output one character with OPOST processing.
498 * Returns -1 when the output device is full and the character
501 * Locking: output_lock to protect column state and space left
502 * (also, this is called from n_tty_write under the
503 * tty layer write lock)
506 static int process_output(unsigned char c
, struct tty_struct
*tty
)
508 struct n_tty_data
*ldata
= tty
->disc_data
;
511 mutex_lock(&ldata
->output_lock
);
513 space
= tty_write_room(tty
);
514 retval
= do_output_char(c
, tty
, space
);
516 mutex_unlock(&ldata
->output_lock
);
524 * process_output_block - block post processor
525 * @tty: terminal device
526 * @buf: character buffer
527 * @nr: number of bytes to output
529 * Output a block of characters with OPOST processing.
530 * Returns the number of characters output.
532 * This path is used to speed up block console writes, among other
533 * things when processing blocks of output data. It handles only
534 * the simple cases normally found and helps to generate blocks of
535 * symbols for the console driver and thus improve performance.
537 * Locking: output_lock to protect column state and space left
538 * (also, this is called from n_tty_write under the
539 * tty layer write lock)
542 static ssize_t
process_output_block(struct tty_struct
*tty
,
543 const unsigned char *buf
, unsigned int nr
)
545 struct n_tty_data
*ldata
= tty
->disc_data
;
548 const unsigned char *cp
;
550 mutex_lock(&ldata
->output_lock
);
552 space
= tty_write_room(tty
);
554 mutex_unlock(&ldata
->output_lock
);
560 for (i
= 0, cp
= buf
; i
< nr
; i
++, cp
++) {
561 unsigned char c
= *cp
;
569 ldata
->canon_column
= ldata
->column
;
572 if (O_ONOCR(tty
) && ldata
->column
== 0)
576 ldata
->canon_column
= ldata
->column
= 0;
581 if (ldata
->column
> 0)
588 if (!is_continuation(c
, tty
))
595 i
= tty
->ops
->write(tty
, buf
, i
);
597 mutex_unlock(&ldata
->output_lock
);
602 * process_echoes - write pending echo characters
603 * @tty: terminal device
605 * Write previously buffered echo (and other ldisc-generated)
606 * characters to the tty.
608 * Characters generated by the ldisc (including echoes) need to
609 * be buffered because the driver's write buffer can fill during
610 * heavy program output. Echoing straight to the driver will
611 * often fail under these conditions, causing lost characters and
612 * resulting mismatches of ldisc state information.
614 * Since the ldisc state must represent the characters actually sent
615 * to the driver at the time of the write, operations like certain
616 * changes in column state are also saved in the buffer and executed
619 * A circular fifo buffer is used so that the most recent characters
620 * are prioritized. Also, when control characters are echoed with a
621 * prefixed "^", the pair is treated atomically and thus not separated.
623 * Locking: callers must hold output_lock
626 static size_t __process_echoes(struct tty_struct
*tty
)
628 struct n_tty_data
*ldata
= tty
->disc_data
;
629 int space
, old_space
;
633 old_space
= space
= tty_write_room(tty
);
635 tail
= ldata
->echo_tail
;
636 while (MASK(ldata
->echo_commit
) != MASK(tail
)) {
637 c
= echo_buf(ldata
, tail
);
638 if (c
== ECHO_OP_START
) {
640 int no_space_left
= 0;
643 * Since add_echo_byte() is called without holding
644 * output_lock, we might see only portion of multi-byte
647 if (MASK(ldata
->echo_commit
) == MASK(tail
+ 1))
650 * If the buffer byte is the start of a multi-byte
651 * operation, get the next byte, which is either the
652 * op code or a control character value.
654 op
= echo_buf(ldata
, tail
+ 1);
657 case ECHO_OP_ERASE_TAB
: {
658 unsigned int num_chars
, num_bs
;
660 if (MASK(ldata
->echo_commit
) == MASK(tail
+ 2))
662 num_chars
= echo_buf(ldata
, tail
+ 2);
665 * Determine how many columns to go back
666 * in order to erase the tab.
667 * This depends on the number of columns
668 * used by other characters within the tab
669 * area. If this (modulo 8) count is from
670 * the start of input rather than from a
671 * previous tab, we offset by canon column.
672 * Otherwise, tab spacing is normal.
674 if (!(num_chars
& 0x80))
675 num_chars
+= ldata
->canon_column
;
676 num_bs
= 8 - (num_chars
& 7);
678 if (num_bs
> space
) {
684 tty_put_char(tty
, '\b');
685 if (ldata
->column
> 0)
691 case ECHO_OP_SET_CANON_COL
:
692 ldata
->canon_column
= ldata
->column
;
696 case ECHO_OP_MOVE_BACK_COL
:
697 if (ldata
->column
> 0)
703 /* This is an escaped echo op start code */
708 tty_put_char(tty
, ECHO_OP_START
);
716 * If the op is not a special byte code,
717 * it is a ctrl char tagged to be echoed
718 * as "^X" (where X is the letter
719 * representing the control char).
720 * Note that we must ensure there is
721 * enough space for the whole ctrl pair.
728 tty_put_char(tty
, '^');
729 tty_put_char(tty
, op
^ 0100);
739 int retval
= do_output_char(c
, tty
, space
);
746 tty_put_char(tty
, c
);
753 /* If the echo buffer is nearly full (so that the possibility exists
754 * of echo overrun before the next commit), then discard enough
755 * data at the tail to prevent a subsequent overrun */
756 while (ldata
->echo_commit
> tail
&&
757 ldata
->echo_commit
- tail
>= ECHO_DISCARD_WATERMARK
) {
758 if (echo_buf(ldata
, tail
) == ECHO_OP_START
) {
759 if (echo_buf(ldata
, tail
+ 1) == ECHO_OP_ERASE_TAB
)
768 ldata
->echo_tail
= tail
;
769 return old_space
- space
;
772 static void commit_echoes(struct tty_struct
*tty
)
774 struct n_tty_data
*ldata
= tty
->disc_data
;
775 size_t nr
, old
, echoed
;
778 mutex_lock(&ldata
->output_lock
);
779 head
= ldata
->echo_head
;
780 ldata
->echo_mark
= head
;
781 old
= ldata
->echo_commit
- ldata
->echo_tail
;
783 /* Process committed echoes if the accumulated # of bytes
784 * is over the threshold (and try again each time another
785 * block is accumulated) */
786 nr
= head
- ldata
->echo_tail
;
787 if (nr
< ECHO_COMMIT_WATERMARK
||
788 (nr
% ECHO_BLOCK
> old
% ECHO_BLOCK
)) {
789 mutex_unlock(&ldata
->output_lock
);
793 ldata
->echo_commit
= head
;
794 echoed
= __process_echoes(tty
);
795 mutex_unlock(&ldata
->output_lock
);
797 if (echoed
&& tty
->ops
->flush_chars
)
798 tty
->ops
->flush_chars(tty
);
801 static void process_echoes(struct tty_struct
*tty
)
803 struct n_tty_data
*ldata
= tty
->disc_data
;
806 if (ldata
->echo_mark
== ldata
->echo_tail
)
809 mutex_lock(&ldata
->output_lock
);
810 ldata
->echo_commit
= ldata
->echo_mark
;
811 echoed
= __process_echoes(tty
);
812 mutex_unlock(&ldata
->output_lock
);
814 if (echoed
&& tty
->ops
->flush_chars
)
815 tty
->ops
->flush_chars(tty
);
818 /* NB: echo_mark and echo_head should be equivalent here */
819 static void flush_echoes(struct tty_struct
*tty
)
821 struct n_tty_data
*ldata
= tty
->disc_data
;
823 if ((!L_ECHO(tty
) && !L_ECHONL(tty
)) ||
824 ldata
->echo_commit
== ldata
->echo_head
)
827 mutex_lock(&ldata
->output_lock
);
828 ldata
->echo_commit
= ldata
->echo_head
;
829 __process_echoes(tty
);
830 mutex_unlock(&ldata
->output_lock
);
834 * add_echo_byte - add a byte to the echo buffer
835 * @c: unicode byte to echo
838 * Add a character or operation byte to the echo buffer.
841 static inline void add_echo_byte(unsigned char c
, struct n_tty_data
*ldata
)
843 *echo_buf_addr(ldata
, ldata
->echo_head
) = c
;
844 smp_wmb(); /* Matches smp_rmb() in echo_buf(). */
849 * echo_move_back_col - add operation to move back a column
852 * Add an operation to the echo buffer to move back one column.
855 static void echo_move_back_col(struct n_tty_data
*ldata
)
857 add_echo_byte(ECHO_OP_START
, ldata
);
858 add_echo_byte(ECHO_OP_MOVE_BACK_COL
, ldata
);
862 * echo_set_canon_col - add operation to set the canon column
865 * Add an operation to the echo buffer to set the canon column
866 * to the current column.
869 static void echo_set_canon_col(struct n_tty_data
*ldata
)
871 add_echo_byte(ECHO_OP_START
, ldata
);
872 add_echo_byte(ECHO_OP_SET_CANON_COL
, ldata
);
876 * echo_erase_tab - add operation to erase a tab
877 * @num_chars: number of character columns already used
878 * @after_tab: true if num_chars starts after a previous tab
881 * Add an operation to the echo buffer to erase a tab.
883 * Called by the eraser function, which knows how many character
884 * columns have been used since either a previous tab or the start
885 * of input. This information will be used later, along with
886 * canon column (if applicable), to go back the correct number
890 static void echo_erase_tab(unsigned int num_chars
, int after_tab
,
891 struct n_tty_data
*ldata
)
893 add_echo_byte(ECHO_OP_START
, ldata
);
894 add_echo_byte(ECHO_OP_ERASE_TAB
, ldata
);
896 /* We only need to know this modulo 8 (tab spacing) */
899 /* Set the high bit as a flag if num_chars is after a previous tab */
903 add_echo_byte(num_chars
, ldata
);
907 * echo_char_raw - echo a character raw
908 * @c: unicode byte to echo
909 * @tty: terminal device
911 * Echo user input back onto the screen. This must be called only when
912 * L_ECHO(tty) is true. Called from the driver receive_buf path.
914 * This variant does not treat control characters specially.
917 static void echo_char_raw(unsigned char c
, struct n_tty_data
*ldata
)
919 if (c
== ECHO_OP_START
) {
920 add_echo_byte(ECHO_OP_START
, ldata
);
921 add_echo_byte(ECHO_OP_START
, ldata
);
923 add_echo_byte(c
, ldata
);
928 * echo_char - echo a character
929 * @c: unicode byte to echo
930 * @tty: terminal device
932 * Echo user input back onto the screen. This must be called only when
933 * L_ECHO(tty) is true. Called from the driver receive_buf path.
935 * This variant tags control characters to be echoed as "^X"
936 * (where X is the letter representing the control char).
939 static void echo_char(unsigned char c
, struct tty_struct
*tty
)
941 struct n_tty_data
*ldata
= tty
->disc_data
;
943 if (c
== ECHO_OP_START
) {
944 add_echo_byte(ECHO_OP_START
, ldata
);
945 add_echo_byte(ECHO_OP_START
, ldata
);
947 if (L_ECHOCTL(tty
) && iscntrl(c
) && c
!= '\t')
948 add_echo_byte(ECHO_OP_START
, ldata
);
949 add_echo_byte(c
, ldata
);
954 * finish_erasing - complete erase
958 static inline void finish_erasing(struct n_tty_data
*ldata
)
960 if (ldata
->erasing
) {
961 echo_char_raw('/', ldata
);
967 * eraser - handle erase function
968 * @c: character input
969 * @tty: terminal device
971 * Perform erase and necessary output when an erase character is
972 * present in the stream from the driver layer. Handles the complexities
973 * of UTF-8 multibyte symbols.
975 * n_tty_receive_buf()/producer path:
976 * caller holds non-exclusive termios_rwsem
979 static void eraser(unsigned char c
, struct tty_struct
*tty
)
981 struct n_tty_data
*ldata
= tty
->disc_data
;
982 enum { ERASE
, WERASE
, KILL
} kill_type
;
987 if (ldata
->read_head
== ldata
->canon_head
) {
988 /* process_output('\a', tty); */ /* what do you think? */
991 if (c
== ERASE_CHAR(tty
))
993 else if (c
== WERASE_CHAR(tty
))
997 ldata
->read_head
= ldata
->canon_head
;
1000 if (!L_ECHOK(tty
) || !L_ECHOKE(tty
) || !L_ECHOE(tty
)) {
1001 ldata
->read_head
= ldata
->canon_head
;
1002 finish_erasing(ldata
);
1003 echo_char(KILL_CHAR(tty
), tty
);
1004 /* Add a newline if ECHOK is on and ECHOKE is off. */
1006 echo_char_raw('\n', ldata
);
1013 while (MASK(ldata
->read_head
) != MASK(ldata
->canon_head
)) {
1014 head
= ldata
->read_head
;
1016 /* erase a single possibly multibyte character */
1019 c
= read_buf(ldata
, head
);
1020 } while (is_continuation(c
, tty
) &&
1021 MASK(head
) != MASK(ldata
->canon_head
));
1023 /* do not partially erase */
1024 if (is_continuation(c
, tty
))
1027 if (kill_type
== WERASE
) {
1028 /* Equivalent to BSD's ALTWERASE. */
1029 if (isalnum(c
) || c
== '_')
1031 else if (seen_alnums
)
1034 cnt
= ldata
->read_head
- head
;
1035 ldata
->read_head
= head
;
1037 if (L_ECHOPRT(tty
)) {
1038 if (!ldata
->erasing
) {
1039 echo_char_raw('\\', ldata
);
1042 /* if cnt > 1, output a multi-byte character */
1046 echo_char_raw(read_buf(ldata
, head
), ldata
);
1047 echo_move_back_col(ldata
);
1049 } else if (kill_type
== ERASE
&& !L_ECHOE(tty
)) {
1050 echo_char(ERASE_CHAR(tty
), tty
);
1051 } else if (c
== '\t') {
1052 unsigned int num_chars
= 0;
1054 size_t tail
= ldata
->read_head
;
1057 * Count the columns used for characters
1058 * since the start of input or after a
1060 * This info is used to go back the correct
1061 * number of columns.
1063 while (MASK(tail
) != MASK(ldata
->canon_head
)) {
1065 c
= read_buf(ldata
, tail
);
1069 } else if (iscntrl(c
)) {
1072 } else if (!is_continuation(c
, tty
)) {
1076 echo_erase_tab(num_chars
, after_tab
, ldata
);
1078 if (iscntrl(c
) && L_ECHOCTL(tty
)) {
1079 echo_char_raw('\b', ldata
);
1080 echo_char_raw(' ', ldata
);
1081 echo_char_raw('\b', ldata
);
1083 if (!iscntrl(c
) || L_ECHOCTL(tty
)) {
1084 echo_char_raw('\b', ldata
);
1085 echo_char_raw(' ', ldata
);
1086 echo_char_raw('\b', ldata
);
1090 if (kill_type
== ERASE
)
1093 if (ldata
->read_head
== ldata
->canon_head
&& L_ECHO(tty
))
1094 finish_erasing(ldata
);
1098 * isig - handle the ISIG optio
1102 * Called when a signal is being sent due to terminal input.
1103 * Called from the driver receive_buf path so serialized.
1105 * Performs input and output flush if !NOFLSH. In this context, the echo
1106 * buffer is 'output'. The signal is processed first to alert any current
1107 * readers or writers to discontinue and exit their i/o loops.
1109 * Locking: ctrl_lock
1112 static void __isig(int sig
, struct tty_struct
*tty
)
1114 struct pid
*tty_pgrp
= tty_get_pgrp(tty
);
1116 kill_pgrp(tty_pgrp
, sig
, 1);
1121 static void isig(int sig
, struct tty_struct
*tty
)
1123 struct n_tty_data
*ldata
= tty
->disc_data
;
1125 if (L_NOFLSH(tty
)) {
1129 } else { /* signal and flush */
1130 up_read(&tty
->termios_rwsem
);
1131 down_write(&tty
->termios_rwsem
);
1135 /* clear echo buffer */
1136 mutex_lock(&ldata
->output_lock
);
1137 ldata
->echo_head
= ldata
->echo_tail
= 0;
1138 ldata
->echo_mark
= ldata
->echo_commit
= 0;
1139 mutex_unlock(&ldata
->output_lock
);
1141 /* clear output buffer */
1142 tty_driver_flush_buffer(tty
);
1144 /* clear input buffer */
1145 reset_buffer_flags(tty
->disc_data
);
1147 /* notify pty master of flush */
1149 n_tty_packet_mode_flush(tty
);
1151 up_write(&tty
->termios_rwsem
);
1152 down_read(&tty
->termios_rwsem
);
1157 * n_tty_receive_break - handle break
1160 * An RS232 break event has been hit in the incoming bitstream. This
1161 * can cause a variety of events depending upon the termios settings.
1163 * n_tty_receive_buf()/producer path:
1164 * caller holds non-exclusive termios_rwsem
1166 * Note: may get exclusive termios_rwsem if flushing input buffer
1169 static void n_tty_receive_break(struct tty_struct
*tty
)
1171 struct n_tty_data
*ldata
= tty
->disc_data
;
1175 if (I_BRKINT(tty
)) {
1179 if (I_PARMRK(tty
)) {
1180 put_tty_queue('\377', ldata
);
1181 put_tty_queue('\0', ldata
);
1183 put_tty_queue('\0', ldata
);
1187 * n_tty_receive_overrun - handle overrun reporting
1190 * Data arrived faster than we could process it. While the tty
1191 * driver has flagged this the bits that were missed are gone
1194 * Called from the receive_buf path so single threaded. Does not
1195 * need locking as num_overrun and overrun_time are function
1199 static void n_tty_receive_overrun(struct tty_struct
*tty
)
1201 struct n_tty_data
*ldata
= tty
->disc_data
;
1203 ldata
->num_overrun
++;
1204 if (time_after(jiffies
, ldata
->overrun_time
+ HZ
) ||
1205 time_after(ldata
->overrun_time
, jiffies
)) {
1206 tty_warn(tty
, "%d input overrun(s)\n", ldata
->num_overrun
);
1207 ldata
->overrun_time
= jiffies
;
1208 ldata
->num_overrun
= 0;
1213 * n_tty_receive_parity_error - error notifier
1214 * @tty: terminal device
1217 * Process a parity error and queue the right data to indicate
1218 * the error case if necessary.
1220 * n_tty_receive_buf()/producer path:
1221 * caller holds non-exclusive termios_rwsem
1223 static void n_tty_receive_parity_error(struct tty_struct
*tty
, unsigned char c
)
1225 struct n_tty_data
*ldata
= tty
->disc_data
;
1230 if (I_PARMRK(tty
)) {
1231 put_tty_queue('\377', ldata
);
1232 put_tty_queue('\0', ldata
);
1233 put_tty_queue(c
, ldata
);
1235 put_tty_queue('\0', ldata
);
1237 put_tty_queue(c
, ldata
);
1241 n_tty_receive_signal_char(struct tty_struct
*tty
, int signal
, unsigned char c
)
1250 process_echoes(tty
);
1255 * n_tty_receive_char - perform processing
1256 * @tty: terminal device
1259 * Process an individual character of input received from the driver.
1260 * This is serialized with respect to itself by the rules for the
1263 * n_tty_receive_buf()/producer path:
1264 * caller holds non-exclusive termios_rwsem
1265 * publishes canon_head if canonical mode is active
1267 * Returns 1 if LNEXT was received, else returns 0
1271 n_tty_receive_char_special(struct tty_struct
*tty
, unsigned char c
)
1273 struct n_tty_data
*ldata
= tty
->disc_data
;
1276 if (c
== START_CHAR(tty
)) {
1278 process_echoes(tty
);
1281 if (c
== STOP_CHAR(tty
)) {
1288 if (c
== INTR_CHAR(tty
)) {
1289 n_tty_receive_signal_char(tty
, SIGINT
, c
);
1291 } else if (c
== QUIT_CHAR(tty
)) {
1292 n_tty_receive_signal_char(tty
, SIGQUIT
, c
);
1294 } else if (c
== SUSP_CHAR(tty
)) {
1295 n_tty_receive_signal_char(tty
, SIGTSTP
, c
);
1300 if (tty
->stopped
&& !tty
->flow_stopped
&& I_IXON(tty
) && I_IXANY(tty
)) {
1302 process_echoes(tty
);
1310 } else if (c
== '\n' && I_INLCR(tty
))
1313 if (ldata
->icanon
) {
1314 if (c
== ERASE_CHAR(tty
) || c
== KILL_CHAR(tty
) ||
1315 (c
== WERASE_CHAR(tty
) && L_IEXTEN(tty
))) {
1320 if (c
== LNEXT_CHAR(tty
) && L_IEXTEN(tty
)) {
1323 finish_erasing(ldata
);
1324 if (L_ECHOCTL(tty
)) {
1325 echo_char_raw('^', ldata
);
1326 echo_char_raw('\b', ldata
);
1332 if (c
== REPRINT_CHAR(tty
) && L_ECHO(tty
) && L_IEXTEN(tty
)) {
1333 size_t tail
= ldata
->canon_head
;
1335 finish_erasing(ldata
);
1337 echo_char_raw('\n', ldata
);
1338 while (MASK(tail
) != MASK(ldata
->read_head
)) {
1339 echo_char(read_buf(ldata
, tail
), tty
);
1346 if (L_ECHO(tty
) || L_ECHONL(tty
)) {
1347 echo_char_raw('\n', ldata
);
1350 goto handle_newline
;
1352 if (c
== EOF_CHAR(tty
)) {
1353 c
= __DISABLED_CHAR
;
1354 goto handle_newline
;
1356 if ((c
== EOL_CHAR(tty
)) ||
1357 (c
== EOL2_CHAR(tty
) && L_IEXTEN(tty
))) {
1359 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1362 /* Record the column of first canon char. */
1363 if (ldata
->canon_head
== ldata
->read_head
)
1364 echo_set_canon_col(ldata
);
1369 * XXX does PARMRK doubling happen for
1370 * EOL_CHAR and EOL2_CHAR?
1372 if (c
== (unsigned char) '\377' && I_PARMRK(tty
))
1373 put_tty_queue(c
, ldata
);
1376 set_bit(ldata
->read_head
& (N_TTY_BUF_SIZE
- 1), ldata
->read_flags
);
1377 put_tty_queue(c
, ldata
);
1378 smp_store_release(&ldata
->canon_head
, ldata
->read_head
);
1379 kill_fasync(&tty
->fasync
, SIGIO
, POLL_IN
);
1380 wake_up_interruptible_poll(&tty
->read_wait
, EPOLLIN
);
1386 finish_erasing(ldata
);
1388 echo_char_raw('\n', ldata
);
1390 /* Record the column of first canon char. */
1391 if (ldata
->canon_head
== ldata
->read_head
)
1392 echo_set_canon_col(ldata
);
1398 /* PARMRK doubling check */
1399 if (c
== (unsigned char) '\377' && I_PARMRK(tty
))
1400 put_tty_queue(c
, ldata
);
1402 put_tty_queue(c
, ldata
);
1407 n_tty_receive_char_inline(struct tty_struct
*tty
, unsigned char c
)
1409 struct n_tty_data
*ldata
= tty
->disc_data
;
1411 if (tty
->stopped
&& !tty
->flow_stopped
&& I_IXON(tty
) && I_IXANY(tty
)) {
1413 process_echoes(tty
);
1416 finish_erasing(ldata
);
1417 /* Record the column of first canon char. */
1418 if (ldata
->canon_head
== ldata
->read_head
)
1419 echo_set_canon_col(ldata
);
1423 /* PARMRK doubling check */
1424 if (c
== (unsigned char) '\377' && I_PARMRK(tty
))
1425 put_tty_queue(c
, ldata
);
1426 put_tty_queue(c
, ldata
);
1429 static void n_tty_receive_char(struct tty_struct
*tty
, unsigned char c
)
1431 n_tty_receive_char_inline(tty
, c
);
1435 n_tty_receive_char_fast(struct tty_struct
*tty
, unsigned char c
)
1437 struct n_tty_data
*ldata
= tty
->disc_data
;
1439 if (tty
->stopped
&& !tty
->flow_stopped
&& I_IXON(tty
) && I_IXANY(tty
)) {
1441 process_echoes(tty
);
1444 finish_erasing(ldata
);
1445 /* Record the column of first canon char. */
1446 if (ldata
->canon_head
== ldata
->read_head
)
1447 echo_set_canon_col(ldata
);
1451 put_tty_queue(c
, ldata
);
1454 static void n_tty_receive_char_closing(struct tty_struct
*tty
, unsigned char c
)
1458 if (I_IUCLC(tty
) && L_IEXTEN(tty
))
1462 if (c
== STOP_CHAR(tty
))
1464 else if (c
== START_CHAR(tty
) ||
1465 (tty
->stopped
&& !tty
->flow_stopped
&& I_IXANY(tty
) &&
1466 c
!= INTR_CHAR(tty
) && c
!= QUIT_CHAR(tty
) &&
1467 c
!= SUSP_CHAR(tty
))) {
1469 process_echoes(tty
);
1475 n_tty_receive_char_flagged(struct tty_struct
*tty
, unsigned char c
, char flag
)
1479 n_tty_receive_break(tty
);
1483 n_tty_receive_parity_error(tty
, c
);
1486 n_tty_receive_overrun(tty
);
1489 tty_err(tty
, "unknown flag %d\n", flag
);
1495 n_tty_receive_char_lnext(struct tty_struct
*tty
, unsigned char c
, char flag
)
1497 struct n_tty_data
*ldata
= tty
->disc_data
;
1500 if (likely(flag
== TTY_NORMAL
)) {
1503 if (I_IUCLC(tty
) && L_IEXTEN(tty
))
1505 n_tty_receive_char(tty
, c
);
1507 n_tty_receive_char_flagged(tty
, c
, flag
);
1511 n_tty_receive_buf_real_raw(struct tty_struct
*tty
, const unsigned char *cp
,
1512 char *fp
, int count
)
1514 struct n_tty_data
*ldata
= tty
->disc_data
;
1517 head
= ldata
->read_head
& (N_TTY_BUF_SIZE
- 1);
1518 n
= min_t(size_t, count
, N_TTY_BUF_SIZE
- head
);
1519 memcpy(read_buf_addr(ldata
, head
), cp
, n
);
1520 ldata
->read_head
+= n
;
1524 head
= ldata
->read_head
& (N_TTY_BUF_SIZE
- 1);
1525 n
= min_t(size_t, count
, N_TTY_BUF_SIZE
- head
);
1526 memcpy(read_buf_addr(ldata
, head
), cp
, n
);
1527 ldata
->read_head
+= n
;
1531 n_tty_receive_buf_raw(struct tty_struct
*tty
, const unsigned char *cp
,
1532 char *fp
, int count
)
1534 struct n_tty_data
*ldata
= tty
->disc_data
;
1535 char flag
= TTY_NORMAL
;
1540 if (likely(flag
== TTY_NORMAL
))
1541 put_tty_queue(*cp
++, ldata
);
1543 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1548 n_tty_receive_buf_closing(struct tty_struct
*tty
, const unsigned char *cp
,
1549 char *fp
, int count
)
1551 char flag
= TTY_NORMAL
;
1556 if (likely(flag
== TTY_NORMAL
))
1557 n_tty_receive_char_closing(tty
, *cp
++);
1562 n_tty_receive_buf_standard(struct tty_struct
*tty
, const unsigned char *cp
,
1563 char *fp
, int count
)
1565 struct n_tty_data
*ldata
= tty
->disc_data
;
1566 char flag
= TTY_NORMAL
;
1571 if (likely(flag
== TTY_NORMAL
)) {
1572 unsigned char c
= *cp
++;
1576 if (I_IUCLC(tty
) && L_IEXTEN(tty
))
1578 if (L_EXTPROC(tty
)) {
1579 put_tty_queue(c
, ldata
);
1582 if (!test_bit(c
, ldata
->char_map
))
1583 n_tty_receive_char_inline(tty
, c
);
1584 else if (n_tty_receive_char_special(tty
, c
) && count
) {
1587 n_tty_receive_char_lnext(tty
, *cp
++, flag
);
1591 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1596 n_tty_receive_buf_fast(struct tty_struct
*tty
, const unsigned char *cp
,
1597 char *fp
, int count
)
1599 struct n_tty_data
*ldata
= tty
->disc_data
;
1600 char flag
= TTY_NORMAL
;
1605 if (likely(flag
== TTY_NORMAL
)) {
1606 unsigned char c
= *cp
++;
1608 if (!test_bit(c
, ldata
->char_map
))
1609 n_tty_receive_char_fast(tty
, c
);
1610 else if (n_tty_receive_char_special(tty
, c
) && count
) {
1613 n_tty_receive_char_lnext(tty
, *cp
++, flag
);
1617 n_tty_receive_char_flagged(tty
, *cp
++, flag
);
1621 static void __receive_buf(struct tty_struct
*tty
, const unsigned char *cp
,
1622 char *fp
, int count
)
1624 struct n_tty_data
*ldata
= tty
->disc_data
;
1625 bool preops
= I_ISTRIP(tty
) || (I_IUCLC(tty
) && L_IEXTEN(tty
));
1627 if (ldata
->real_raw
)
1628 n_tty_receive_buf_real_raw(tty
, cp
, fp
, count
);
1629 else if (ldata
->raw
|| (L_EXTPROC(tty
) && !preops
))
1630 n_tty_receive_buf_raw(tty
, cp
, fp
, count
);
1631 else if (tty
->closing
&& !L_EXTPROC(tty
))
1632 n_tty_receive_buf_closing(tty
, cp
, fp
, count
);
1635 char flag
= TTY_NORMAL
;
1639 n_tty_receive_char_lnext(tty
, *cp
++, flag
);
1643 if (!preops
&& !I_PARMRK(tty
))
1644 n_tty_receive_buf_fast(tty
, cp
, fp
, count
);
1646 n_tty_receive_buf_standard(tty
, cp
, fp
, count
);
1649 if (tty
->ops
->flush_chars
)
1650 tty
->ops
->flush_chars(tty
);
1653 if (ldata
->icanon
&& !L_EXTPROC(tty
))
1656 /* publish read_head to consumer */
1657 smp_store_release(&ldata
->commit_head
, ldata
->read_head
);
1659 if (read_cnt(ldata
)) {
1660 kill_fasync(&tty
->fasync
, SIGIO
, POLL_IN
);
1661 wake_up_interruptible_poll(&tty
->read_wait
, EPOLLIN
);
1666 * n_tty_receive_buf_common - process input
1667 * @tty: device to receive input
1669 * @fp: flags for each char (if NULL, all chars are TTY_NORMAL)
1670 * @count: number of input chars in @cp
1672 * Called by the terminal driver when a block of characters has
1673 * been received. This function must be called from soft contexts
1674 * not from interrupt context. The driver is responsible for making
1675 * calls one at a time and in order (or using flush_to_ldisc)
1677 * Returns the # of input chars from @cp which were processed.
1679 * In canonical mode, the maximum line length is 4096 chars (including
1680 * the line termination char); lines longer than 4096 chars are
1681 * truncated. After 4095 chars, input data is still processed but
1682 * not stored. Overflow processing ensures the tty can always
1683 * receive more input until at least one line can be read.
1685 * In non-canonical mode, the read buffer will only accept 4095 chars;
1686 * this provides the necessary space for a newline char if the input
1687 * mode is switched to canonical.
1689 * Note it is possible for the read buffer to _contain_ 4096 chars
1690 * in non-canonical mode: the read buffer could already contain the
1691 * maximum canon line of 4096 chars when the mode is switched to
1694 * n_tty_receive_buf()/producer path:
1695 * claims non-exclusive termios_rwsem
1696 * publishes commit_head or canon_head
1699 n_tty_receive_buf_common(struct tty_struct
*tty
, const unsigned char *cp
,
1700 char *fp
, int count
, int flow
)
1702 struct n_tty_data
*ldata
= tty
->disc_data
;
1703 int room
, n
, rcvd
= 0, overflow
;
1705 down_read(&tty
->termios_rwsem
);
1709 * When PARMRK is set, each input char may take up to 3 chars
1710 * in the read buf; reduce the buffer space avail by 3x
1712 * If we are doing input canonicalization, and there are no
1713 * pending newlines, let characters through without limit, so
1714 * that erase characters will be handled. Other excess
1715 * characters will be beeped.
1717 * paired with store in *_copy_from_read_buf() -- guarantees
1718 * the consumer has loaded the data in read_buf up to the new
1719 * read_tail (so this producer will not overwrite unread data)
1721 size_t tail
= smp_load_acquire(&ldata
->read_tail
);
1723 room
= N_TTY_BUF_SIZE
- (ldata
->read_head
- tail
);
1725 room
= (room
+ 2) / 3;
1728 overflow
= ldata
->icanon
&& ldata
->canon_head
== tail
;
1729 if (overflow
&& room
< 0)
1732 ldata
->no_room
= flow
&& !room
;
1736 n
= min(count
, room
);
1740 /* ignore parity errors if handling overflow */
1741 if (!overflow
|| !fp
|| *fp
!= TTY_PARITY
)
1742 __receive_buf(tty
, cp
, fp
, n
);
1749 } while (!test_bit(TTY_LDISC_CHANGING
, &tty
->flags
));
1751 tty
->receive_room
= room
;
1753 /* Unthrottle if handling overflow on pty */
1754 if (tty
->driver
->type
== TTY_DRIVER_TYPE_PTY
) {
1756 tty_set_flow_change(tty
, TTY_UNTHROTTLE_SAFE
);
1757 tty_unthrottle_safe(tty
);
1758 __tty_set_flow_change(tty
, 0);
1761 n_tty_check_throttle(tty
);
1763 up_read(&tty
->termios_rwsem
);
1768 static void n_tty_receive_buf(struct tty_struct
*tty
, const unsigned char *cp
,
1769 char *fp
, int count
)
1771 n_tty_receive_buf_common(tty
, cp
, fp
, count
, 0);
1774 static int n_tty_receive_buf2(struct tty_struct
*tty
, const unsigned char *cp
,
1775 char *fp
, int count
)
1777 return n_tty_receive_buf_common(tty
, cp
, fp
, count
, 1);
1781 * n_tty_set_termios - termios data changed
1783 * @old: previous data
1785 * Called by the tty layer when the user changes termios flags so
1786 * that the line discipline can plan ahead. This function cannot sleep
1787 * and is protected from re-entry by the tty layer. The user is
1788 * guaranteed that this function will not be re-entered or in progress
1789 * when the ldisc is closed.
1791 * Locking: Caller holds tty->termios_rwsem
1794 static void n_tty_set_termios(struct tty_struct
*tty
, struct ktermios
*old
)
1796 struct n_tty_data
*ldata
= tty
->disc_data
;
1798 if (!old
|| (old
->c_lflag
^ tty
->termios
.c_lflag
) & (ICANON
| EXTPROC
)) {
1799 bitmap_zero(ldata
->read_flags
, N_TTY_BUF_SIZE
);
1800 ldata
->line_start
= ldata
->read_tail
;
1801 if (!L_ICANON(tty
) || !read_cnt(ldata
)) {
1802 ldata
->canon_head
= ldata
->read_tail
;
1805 set_bit((ldata
->read_head
- 1) & (N_TTY_BUF_SIZE
- 1),
1807 ldata
->canon_head
= ldata
->read_head
;
1810 ldata
->commit_head
= ldata
->read_head
;
1815 ldata
->icanon
= (L_ICANON(tty
) != 0);
1817 if (I_ISTRIP(tty
) || I_IUCLC(tty
) || I_IGNCR(tty
) ||
1818 I_ICRNL(tty
) || I_INLCR(tty
) || L_ICANON(tty
) ||
1819 I_IXON(tty
) || L_ISIG(tty
) || L_ECHO(tty
) ||
1821 bitmap_zero(ldata
->char_map
, 256);
1823 if (I_IGNCR(tty
) || I_ICRNL(tty
))
1824 set_bit('\r', ldata
->char_map
);
1826 set_bit('\n', ldata
->char_map
);
1828 if (L_ICANON(tty
)) {
1829 set_bit(ERASE_CHAR(tty
), ldata
->char_map
);
1830 set_bit(KILL_CHAR(tty
), ldata
->char_map
);
1831 set_bit(EOF_CHAR(tty
), ldata
->char_map
);
1832 set_bit('\n', ldata
->char_map
);
1833 set_bit(EOL_CHAR(tty
), ldata
->char_map
);
1834 if (L_IEXTEN(tty
)) {
1835 set_bit(WERASE_CHAR(tty
), ldata
->char_map
);
1836 set_bit(LNEXT_CHAR(tty
), ldata
->char_map
);
1837 set_bit(EOL2_CHAR(tty
), ldata
->char_map
);
1839 set_bit(REPRINT_CHAR(tty
),
1844 set_bit(START_CHAR(tty
), ldata
->char_map
);
1845 set_bit(STOP_CHAR(tty
), ldata
->char_map
);
1848 set_bit(INTR_CHAR(tty
), ldata
->char_map
);
1849 set_bit(QUIT_CHAR(tty
), ldata
->char_map
);
1850 set_bit(SUSP_CHAR(tty
), ldata
->char_map
);
1852 clear_bit(__DISABLED_CHAR
, ldata
->char_map
);
1854 ldata
->real_raw
= 0;
1857 if ((I_IGNBRK(tty
) || (!I_BRKINT(tty
) && !I_PARMRK(tty
))) &&
1858 (I_IGNPAR(tty
) || !I_INPCK(tty
)) &&
1859 (tty
->driver
->flags
& TTY_DRIVER_REAL_RAW
))
1860 ldata
->real_raw
= 1;
1862 ldata
->real_raw
= 0;
1865 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1866 * been stopped by STOP_CHAR(tty) before it.
1868 if (!I_IXON(tty
) && old
&& (old
->c_iflag
& IXON
) && !tty
->flow_stopped
) {
1870 process_echoes(tty
);
1873 /* The termios change make the tty ready for I/O */
1874 wake_up_interruptible(&tty
->write_wait
);
1875 wake_up_interruptible(&tty
->read_wait
);
1879 * n_tty_close - close the ldisc for this tty
1882 * Called from the terminal layer when this line discipline is
1883 * being shut down, either because of a close or becsuse of a
1884 * discipline change. The function will not be called while other
1885 * ldisc methods are in progress.
1888 static void n_tty_close(struct tty_struct
*tty
)
1890 struct n_tty_data
*ldata
= tty
->disc_data
;
1893 n_tty_packet_mode_flush(tty
);
1896 tty
->disc_data
= NULL
;
1900 * n_tty_open - open an ldisc
1901 * @tty: terminal to open
1903 * Called when this line discipline is being attached to the
1904 * terminal device. Can sleep. Called serialized so that no
1905 * other events will occur in parallel. No further open will occur
1909 static int n_tty_open(struct tty_struct
*tty
)
1911 struct n_tty_data
*ldata
;
1913 /* Currently a malloc failure here can panic */
1914 ldata
= vzalloc(sizeof(*ldata
));
1918 ldata
->overrun_time
= jiffies
;
1919 mutex_init(&ldata
->atomic_read_lock
);
1920 mutex_init(&ldata
->output_lock
);
1922 tty
->disc_data
= ldata
;
1924 /* indicate buffer work may resume */
1925 clear_bit(TTY_LDISC_HALTED
, &tty
->flags
);
1926 n_tty_set_termios(tty
, NULL
);
1927 tty_unthrottle(tty
);
1931 static inline int input_available_p(struct tty_struct
*tty
, int poll
)
1933 struct n_tty_data
*ldata
= tty
->disc_data
;
1934 int amt
= poll
&& !TIME_CHAR(tty
) && MIN_CHAR(tty
) ? MIN_CHAR(tty
) : 1;
1936 if (ldata
->icanon
&& !L_EXTPROC(tty
))
1937 return ldata
->canon_head
!= ldata
->read_tail
;
1939 return ldata
->commit_head
- ldata
->read_tail
>= amt
;
1943 * copy_from_read_buf - copy read data directly
1944 * @tty: terminal device
1948 * Helper function to speed up n_tty_read. It is only called when
1949 * ICANON is off; it copies characters straight from the tty queue to
1950 * user space directly. It can be profitably called twice; once to
1951 * drain the space from the tail pointer to the (physical) end of the
1952 * buffer, and once to drain the space from the (physical) beginning of
1953 * the buffer to head pointer.
1955 * Called under the ldata->atomic_read_lock sem
1957 * n_tty_read()/consumer path:
1958 * caller holds non-exclusive termios_rwsem
1959 * read_tail published
1962 static int copy_from_read_buf(struct tty_struct
*tty
,
1963 unsigned char __user
**b
,
1967 struct n_tty_data
*ldata
= tty
->disc_data
;
1971 size_t head
= smp_load_acquire(&ldata
->commit_head
);
1972 size_t tail
= ldata
->read_tail
& (N_TTY_BUF_SIZE
- 1);
1975 n
= min(head
- ldata
->read_tail
, N_TTY_BUF_SIZE
- tail
);
1978 unsigned char *from
= read_buf_addr(ldata
, tail
);
1979 retval
= copy_to_user(*b
, from
, n
);
1981 is_eof
= n
== 1 && *from
== EOF_CHAR(tty
);
1982 tty_audit_add_data(tty
, from
, n
);
1983 zero_buffer(tty
, from
, n
);
1984 smp_store_release(&ldata
->read_tail
, ldata
->read_tail
+ n
);
1985 /* Turn single EOF into zero-length read */
1986 if (L_EXTPROC(tty
) && ldata
->icanon
&& is_eof
&&
1987 (head
== ldata
->read_tail
))
1996 * canon_copy_from_read_buf - copy read data in canonical mode
1997 * @tty: terminal device
2001 * Helper function for n_tty_read. It is only called when ICANON is on;
2002 * it copies one line of input up to and including the line-delimiting
2003 * character into the user-space buffer.
2005 * NB: When termios is changed from non-canonical to canonical mode and
2006 * the read buffer contains data, n_tty_set_termios() simulates an EOF
2007 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
2008 * This causes data already processed as input to be immediately available
2009 * as input although a newline has not been received.
2011 * Called under the atomic_read_lock mutex
2013 * n_tty_read()/consumer path:
2014 * caller holds non-exclusive termios_rwsem
2015 * read_tail published
2018 static int canon_copy_from_read_buf(struct tty_struct
*tty
,
2019 unsigned char __user
**b
,
2022 struct n_tty_data
*ldata
= tty
->disc_data
;
2023 size_t n
, size
, more
, c
;
2028 /* N.B. avoid overrun if nr == 0 */
2032 n
= min(*nr
+ 1, smp_load_acquire(&ldata
->canon_head
) - ldata
->read_tail
);
2034 tail
= ldata
->read_tail
& (N_TTY_BUF_SIZE
- 1);
2035 size
= min_t(size_t, tail
+ n
, N_TTY_BUF_SIZE
);
2037 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
2038 __func__
, *nr
, tail
, n
, size
);
2040 eol
= find_next_bit(ldata
->read_flags
, size
, tail
);
2041 more
= n
- (size
- tail
);
2042 if (eol
== N_TTY_BUF_SIZE
&& more
) {
2043 /* scan wrapped without finding set bit */
2044 eol
= find_next_bit(ldata
->read_flags
, more
, 0);
2045 found
= eol
!= more
;
2047 found
= eol
!= size
;
2050 if (n
> N_TTY_BUF_SIZE
)
2051 n
+= N_TTY_BUF_SIZE
;
2054 if (!found
|| read_buf(ldata
, eol
) != __DISABLED_CHAR
) {
2059 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu tail:%zu more:%zu\n",
2060 __func__
, eol
, found
, n
, c
, tail
, more
);
2062 ret
= tty_copy_to_user(tty
, *b
, tail
, n
);
2069 clear_bit(eol
, ldata
->read_flags
);
2070 smp_store_release(&ldata
->read_tail
, ldata
->read_tail
+ c
);
2074 ldata
->line_start
= ldata
->read_tail
;
2082 extern ssize_t
redirected_tty_write(struct file
*, const char __user
*,
2086 * job_control - check job control
2088 * @file: file handle
2090 * Perform job control management checks on this file/tty descriptor
2091 * and if appropriate send any needed signals and return a negative
2092 * error code if action should be taken.
2094 * Locking: redirected write test is safe
2095 * current->signal->tty check is safe
2096 * ctrl_lock to safely reference tty->pgrp
2099 static int job_control(struct tty_struct
*tty
, struct file
*file
)
2101 /* Job control check -- must be done at start and after
2102 every sleep (POSIX.1 7.1.1.4). */
2103 /* NOTE: not yet done after every sleep pending a thorough
2104 check of the logic of this change. -- jlc */
2105 /* don't stop on /dev/console */
2106 if (file
->f_op
->write
== redirected_tty_write
)
2109 return __tty_check_change(tty
, SIGTTIN
);
2114 * n_tty_read - read function for tty
2116 * @file: file object
2117 * @buf: userspace buffer pointer
2120 * Perform reads for the line discipline. We are guaranteed that the
2121 * line discipline will not be closed under us but we may get multiple
2122 * parallel readers and must handle this ourselves. We may also get
2123 * a hangup. Always called in user context, may sleep.
2125 * This code must be sure never to sleep through a hangup.
2127 * n_tty_read()/consumer path:
2128 * claims non-exclusive termios_rwsem
2129 * publishes read_tail
2132 static ssize_t
n_tty_read(struct tty_struct
*tty
, struct file
*file
,
2133 unsigned char __user
*buf
, size_t nr
)
2135 struct n_tty_data
*ldata
= tty
->disc_data
;
2136 unsigned char __user
*b
= buf
;
2137 DEFINE_WAIT_FUNC(wait
, woken_wake_function
);
2145 c
= job_control(tty
, file
);
2150 * Internal serialization of reads.
2152 if (file
->f_flags
& O_NONBLOCK
) {
2153 if (!mutex_trylock(&ldata
->atomic_read_lock
))
2156 if (mutex_lock_interruptible(&ldata
->atomic_read_lock
))
2157 return -ERESTARTSYS
;
2160 down_read(&tty
->termios_rwsem
);
2163 timeout
= MAX_SCHEDULE_TIMEOUT
;
2164 if (!ldata
->icanon
) {
2165 minimum
= MIN_CHAR(tty
);
2167 time
= (HZ
/ 10) * TIME_CHAR(tty
);
2169 timeout
= (HZ
/ 10) * TIME_CHAR(tty
);
2174 packet
= tty
->packet
;
2175 tail
= ldata
->read_tail
;
2177 add_wait_queue(&tty
->read_wait
, &wait
);
2179 /* First test for status change. */
2180 if (packet
&& tty
->link
->ctrl_status
) {
2184 spin_lock_irq(&tty
->link
->ctrl_lock
);
2185 cs
= tty
->link
->ctrl_status
;
2186 tty
->link
->ctrl_status
= 0;
2187 spin_unlock_irq(&tty
->link
->ctrl_lock
);
2188 if (put_user(cs
, b
)) {
2197 if (!input_available_p(tty
, 0)) {
2198 up_read(&tty
->termios_rwsem
);
2199 tty_buffer_flush_work(tty
->port
);
2200 down_read(&tty
->termios_rwsem
);
2201 if (!input_available_p(tty
, 0)) {
2202 if (test_bit(TTY_OTHER_CLOSED
, &tty
->flags
)) {
2206 if (tty_hung_up_p(file
))
2209 * Abort readers for ttys which never actually
2210 * get hung up. See __tty_hangup().
2212 if (test_bit(TTY_HUPPING
, &tty
->flags
))
2216 if (tty_io_nonblock(tty
, file
)) {
2220 if (signal_pending(current
)) {
2221 retval
= -ERESTARTSYS
;
2224 up_read(&tty
->termios_rwsem
);
2226 timeout
= wait_woken(&wait
, TASK_INTERRUPTIBLE
,
2229 down_read(&tty
->termios_rwsem
);
2234 if (ldata
->icanon
&& !L_EXTPROC(tty
)) {
2235 retval
= canon_copy_from_read_buf(tty
, &b
, &nr
);
2241 /* Deal with packet mode. */
2242 if (packet
&& b
== buf
) {
2243 if (put_user(TIOCPKT_DATA
, b
)) {
2251 uncopied
= copy_from_read_buf(tty
, &b
, &nr
);
2252 uncopied
+= copy_from_read_buf(tty
, &b
, &nr
);
2259 n_tty_check_unthrottle(tty
);
2261 if (b
- buf
>= minimum
)
2266 if (tail
!= ldata
->read_tail
)
2267 n_tty_kick_worker(tty
);
2268 up_read(&tty
->termios_rwsem
);
2270 remove_wait_queue(&tty
->read_wait
, &wait
);
2271 mutex_unlock(&ldata
->atomic_read_lock
);
2280 * n_tty_write - write function for tty
2282 * @file: file object
2283 * @buf: userspace buffer pointer
2286 * Write function of the terminal device. This is serialized with
2287 * respect to other write callers but not to termios changes, reads
2288 * and other such events. Since the receive code will echo characters,
2289 * thus calling driver write methods, the output_lock is used in
2290 * the output processing functions called here as well as in the
2291 * echo processing function to protect the column state and space
2292 * left in the buffer.
2294 * This code must be sure never to sleep through a hangup.
2296 * Locking: output_lock to protect column state and space left
2297 * (note that the process_output*() functions take this
2301 static ssize_t
n_tty_write(struct tty_struct
*tty
, struct file
*file
,
2302 const unsigned char *buf
, size_t nr
)
2304 const unsigned char *b
= buf
;
2305 DEFINE_WAIT_FUNC(wait
, woken_wake_function
);
2309 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2310 if (L_TOSTOP(tty
) && file
->f_op
->write
!= redirected_tty_write
) {
2311 retval
= tty_check_change(tty
);
2316 down_read(&tty
->termios_rwsem
);
2318 /* Write out any echoed characters that are still pending */
2319 process_echoes(tty
);
2321 add_wait_queue(&tty
->write_wait
, &wait
);
2323 if (signal_pending(current
)) {
2324 retval
= -ERESTARTSYS
;
2327 if (tty_hung_up_p(file
) || (tty
->link
&& !tty
->link
->count
)) {
2333 ssize_t num
= process_output_block(tty
, b
, nr
);
2345 if (process_output(c
, tty
) < 0)
2349 if (tty
->ops
->flush_chars
)
2350 tty
->ops
->flush_chars(tty
);
2352 struct n_tty_data
*ldata
= tty
->disc_data
;
2355 mutex_lock(&ldata
->output_lock
);
2356 c
= tty
->ops
->write(tty
, b
, nr
);
2357 mutex_unlock(&ldata
->output_lock
);
2370 if (tty_io_nonblock(tty
, file
)) {
2374 up_read(&tty
->termios_rwsem
);
2376 wait_woken(&wait
, TASK_INTERRUPTIBLE
, MAX_SCHEDULE_TIMEOUT
);
2378 down_read(&tty
->termios_rwsem
);
2381 remove_wait_queue(&tty
->write_wait
, &wait
);
2382 if (nr
&& tty
->fasync
)
2383 set_bit(TTY_DO_WRITE_WAKEUP
, &tty
->flags
);
2384 up_read(&tty
->termios_rwsem
);
2385 return (b
- buf
) ? b
- buf
: retval
;
2389 * n_tty_poll - poll method for N_TTY
2390 * @tty: terminal device
2391 * @file: file accessing it
2394 * Called when the line discipline is asked to poll() for data or
2395 * for special events. This code is not serialized with respect to
2396 * other events save open/close.
2398 * This code must be sure never to sleep through a hangup.
2399 * Called without the kernel lock held - fine
2402 static __poll_t
n_tty_poll(struct tty_struct
*tty
, struct file
*file
,
2407 poll_wait(file
, &tty
->read_wait
, wait
);
2408 poll_wait(file
, &tty
->write_wait
, wait
);
2409 if (input_available_p(tty
, 1))
2410 mask
|= EPOLLIN
| EPOLLRDNORM
;
2412 tty_buffer_flush_work(tty
->port
);
2413 if (input_available_p(tty
, 1))
2414 mask
|= EPOLLIN
| EPOLLRDNORM
;
2416 if (tty
->packet
&& tty
->link
->ctrl_status
)
2417 mask
|= EPOLLPRI
| EPOLLIN
| EPOLLRDNORM
;
2418 if (test_bit(TTY_OTHER_CLOSED
, &tty
->flags
))
2420 if (tty_hung_up_p(file
))
2422 if (tty
->ops
->write
&& !tty_is_writelocked(tty
) &&
2423 tty_chars_in_buffer(tty
) < WAKEUP_CHARS
&&
2424 tty_write_room(tty
) > 0)
2425 mask
|= EPOLLOUT
| EPOLLWRNORM
;
2429 static unsigned long inq_canon(struct n_tty_data
*ldata
)
2431 size_t nr
, head
, tail
;
2433 if (ldata
->canon_head
== ldata
->read_tail
)
2435 head
= ldata
->canon_head
;
2436 tail
= ldata
->read_tail
;
2438 /* Skip EOF-chars.. */
2439 while (MASK(head
) != MASK(tail
)) {
2440 if (test_bit(tail
& (N_TTY_BUF_SIZE
- 1), ldata
->read_flags
) &&
2441 read_buf(ldata
, tail
) == __DISABLED_CHAR
)
2448 static int n_tty_ioctl(struct tty_struct
*tty
, struct file
*file
,
2449 unsigned int cmd
, unsigned long arg
)
2451 struct n_tty_data
*ldata
= tty
->disc_data
;
2456 return put_user(tty_chars_in_buffer(tty
), (int __user
*) arg
);
2458 down_write(&tty
->termios_rwsem
);
2459 if (L_ICANON(tty
) && !L_EXTPROC(tty
))
2460 retval
= inq_canon(ldata
);
2462 retval
= read_cnt(ldata
);
2463 up_write(&tty
->termios_rwsem
);
2464 return put_user(retval
, (unsigned int __user
*) arg
);
2466 return n_tty_ioctl_helper(tty
, file
, cmd
, arg
);
2470 static struct tty_ldisc_ops n_tty_ops
= {
2471 .magic
= TTY_LDISC_MAGIC
,
2474 .close
= n_tty_close
,
2475 .flush_buffer
= n_tty_flush_buffer
,
2477 .write
= n_tty_write
,
2478 .ioctl
= n_tty_ioctl
,
2479 .set_termios
= n_tty_set_termios
,
2481 .receive_buf
= n_tty_receive_buf
,
2482 .write_wakeup
= n_tty_write_wakeup
,
2483 .receive_buf2
= n_tty_receive_buf2
,
2487 * n_tty_inherit_ops - inherit N_TTY methods
2488 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2490 * Enables a 'subclass' line discipline to 'inherit' N_TTY methods.
2493 void n_tty_inherit_ops(struct tty_ldisc_ops
*ops
)
2497 ops
->refcount
= ops
->flags
= 0;
2499 EXPORT_SYMBOL_GPL(n_tty_inherit_ops
);
2501 void __init
n_tty_init(void)
2503 tty_register_ldisc(N_TTY
, &n_tty_ops
);