2 * n_tty.c --- implements the N_TTY line discipline.
4 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
11 * to N_TTY if it can not switch to any other line discipline.
13 * Written by Theodore Ts'o, Copyright 1994.
15 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
18 * This file may be redistributed under the terms of the GNU General Public
21 * Reduced memory usage for older ARM systems - Russell King.
23 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
24 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
29 * Also fixed a bug in BLOCKING mode where n_tty_write returns
33 #include <linux/types.h>
34 #include <linux/major.h>
35 #include <linux/errno.h>
36 #include <linux/signal.h>
37 #include <linux/fcntl.h>
38 #include <linux/sched.h>
39 #include <linux/interrupt.h>
40 #include <linux/tty.h>
41 #include <linux/timer.h>
42 #include <linux/ctype.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/poll.h>
47 #include <linux/bitops.h>
48 #include <linux/audit.h>
49 #include <linux/file.h>
50 #include <linux/uaccess.h>
51 #include <linux/module.h>
52 #include <linux/ratelimit.h>
55 /* number of characters left in xmit buffer before select has we have room */
56 #define WAKEUP_CHARS 256
59 * This defines the low- and high-watermarks for throttling and
60 * unthrottling the TTY driver. These watermarks are used for
61 * controlling the space in the read buffer.
63 #define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
64 #define TTY_THRESHOLD_UNTHROTTLE 128
67 * Special byte codes used in the echo buffer to represent operations
68 * or special handling of characters. Bytes in the echo buffer that
69 * are not part of such special blocks are treated as normal character
72 #define ECHO_OP_START 0xff
73 #define ECHO_OP_MOVE_BACK_COL 0x80
74 #define ECHO_OP_SET_CANON_COL 0x81
75 #define ECHO_OP_ERASE_TAB 0x82
77 #define ECHO_COMMIT_WATERMARK 256
78 #define ECHO_BLOCK 256
79 #define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
84 # define n_tty_trace(f, args...) trace_printk(f, ##args)
86 # define n_tty_trace(f, args...)
90 /* producer-published */
93 DECLARE_BITMAP(process_char_map, 256);
95 /* private to n_tty_receive_overrun (single-threaded) */
96 unsigned long overrun_time;
102 /* must hold exclusive termios_rwsem to reset these */
103 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
105 /* shared by producer and consumer */
107 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
111 /* consumer-published */
114 unsigned char *echo_buf;
119 /* protected by output lock */
121 unsigned int canon_column;
123 struct mutex atomic_read_lock;
124 struct mutex output_lock;
127 static inline size_t read_cnt(struct n_tty_data *ldata)
129 return ldata->read_head - ldata->read_tail;
132 static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
134 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
137 static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
139 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
142 static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
144 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
147 static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
149 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
152 static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
153 unsigned char __user *ptr)
155 struct n_tty_data *ldata = tty->disc_data;
157 tty_audit_add_data(tty, &x, 1, ldata->icanon);
158 return put_user(x, ptr);
161 static int receive_room(struct tty_struct *tty)
163 struct n_tty_data *ldata = tty->disc_data;
167 /* Multiply read_cnt by 3, since each byte might take up to
168 * three times as many spaces when PARMRK is set (depending on
169 * its flags, e.g. parity error). */
170 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
172 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
175 * If we are doing input canonicalization, and there are no
176 * pending newlines, let characters through without limit, so
177 * that erase characters will be handled. Other excess
178 * characters will be beeped.
181 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
187 * n_tty_set_room - receive space
190 * Re-schedules the flip buffer work if space just became available.
192 * Caller holds exclusive termios_rwsem
194 * n_tty_read()/consumer path:
195 * holds non-exclusive termios_rwsem
198 static void n_tty_set_room(struct tty_struct *tty)
200 struct n_tty_data *ldata = tty->disc_data;
202 /* Did this open up the receive buffer? We may need to flip */
203 if (unlikely(ldata->no_room) && receive_room(tty)) {
206 WARN_RATELIMIT(tty->port->itty == NULL,
207 "scheduling with invalid itty\n");
208 /* see if ldisc has been killed - if so, this means that
209 * even though the ldisc has been halted and ->buf.work
210 * cancelled, ->buf.work is about to be rescheduled
212 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
213 "scheduling buffer work for halted ldisc\n");
214 queue_work(system_unbound_wq, &tty->port->buf.work);
218 static ssize_t chars_in_buffer(struct tty_struct *tty)
220 struct n_tty_data *ldata = tty->disc_data;
226 n = ldata->canon_head - ldata->read_tail;
231 * n_tty_write_wakeup - asynchronous I/O notifier
234 * Required for the ptys, serial driver etc. since processes
235 * that attach themselves to the master and rely on ASYNC
236 * IO must be woken up
239 static void n_tty_write_wakeup(struct tty_struct *tty)
241 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
242 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
245 static inline void n_tty_check_throttle(struct tty_struct *tty)
247 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
250 * Check the remaining room for the input canonicalization
251 * mode. We don't want to throttle the driver if we're in
252 * canonical mode and don't have a newline yet!
256 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
257 if (receive_room(tty) >= TTY_THRESHOLD_THROTTLE)
259 throttled = tty_throttle_safe(tty);
263 __tty_set_flow_change(tty, 0);
266 static inline void n_tty_check_unthrottle(struct tty_struct *tty)
268 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
269 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
270 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
275 n_tty_write_wakeup(tty->link);
276 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
280 /* If there is enough space in the read buffer now, let the
281 * low-level driver know. We use chars_in_buffer() to
282 * check the buffer, as it now knows about canonical mode.
283 * Otherwise, if the driver is throttled and the line is
284 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
285 * we won't get any more characters.
290 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
291 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
296 unthrottled = tty_unthrottle_safe(tty);
300 __tty_set_flow_change(tty, 0);
304 * put_tty_queue - add character to tty
308 * Add a character to the tty read_buf queue.
310 * n_tty_receive_buf()/producer path:
311 * caller holds non-exclusive termios_rwsem
314 * read_head is only considered 'published' if canonical mode is
318 static void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
320 if (read_cnt(ldata) < N_TTY_BUF_SIZE) {
321 *read_buf_addr(ldata, ldata->read_head) = c;
327 * reset_buffer_flags - reset buffer state
328 * @tty: terminal to reset
330 * Reset the read buffer counters and clear the flags.
331 * Called from n_tty_open() and n_tty_flush_buffer().
333 * Locking: caller holds exclusive termios_rwsem
334 * (or locking is not required)
337 static void reset_buffer_flags(struct n_tty_data *ldata)
339 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
340 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
343 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
346 static void n_tty_packet_mode_flush(struct tty_struct *tty)
350 spin_lock_irqsave(&tty->ctrl_lock, flags);
351 if (tty->link->packet) {
352 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
353 wake_up_interruptible(&tty->link->read_wait);
355 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
359 * n_tty_flush_buffer - clean input queue
360 * @tty: terminal device
362 * Flush the input buffer. Called when the tty layer wants the
363 * buffer flushed (eg at hangup) or when the N_TTY line discipline
364 * internally has to clean the pending queue (for example some signals).
366 * Holds termios_rwsem to exclude producer/consumer while
367 * buffer indices are reset.
369 * Locking: ctrl_lock, exclusive termios_rwsem
372 static void n_tty_flush_buffer(struct tty_struct *tty)
374 down_write(&tty->termios_rwsem);
375 reset_buffer_flags(tty->disc_data);
379 n_tty_packet_mode_flush(tty);
380 up_write(&tty->termios_rwsem);
384 * n_tty_chars_in_buffer - report available bytes
387 * Report the number of characters buffered to be delivered to user
388 * at this instant in time.
390 * Locking: exclusive termios_rwsem
393 static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
397 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
399 down_write(&tty->termios_rwsem);
400 n = chars_in_buffer(tty);
401 up_write(&tty->termios_rwsem);
406 * is_utf8_continuation - utf8 multibyte check
409 * Returns true if the utf8 character 'c' is a multibyte continuation
410 * character. We use this to correctly compute the on screen size
411 * of the character when printing
414 static inline int is_utf8_continuation(unsigned char c)
416 return (c & 0xc0) == 0x80;
420 * is_continuation - multibyte check
423 * Returns true if the utf8 character 'c' is a multibyte continuation
424 * character and the terminal is in unicode mode.
427 static inline int is_continuation(unsigned char c, struct tty_struct *tty)
429 return I_IUTF8(tty) && is_utf8_continuation(c);
433 * do_output_char - output one character
434 * @c: character (or partial unicode symbol)
435 * @tty: terminal device
436 * @space: space available in tty driver write buffer
438 * This is a helper function that handles one output character
439 * (including special characters like TAB, CR, LF, etc.),
440 * doing OPOST processing and putting the results in the
441 * tty driver's write buffer.
443 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
444 * and NLDLY. They simply aren't relevant in the world today.
445 * If you ever need them, add them here.
447 * Returns the number of bytes of buffer space used or -1 if
450 * Locking: should be called under the output_lock to protect
451 * the column state and space left in the buffer
454 static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
456 struct n_tty_data *ldata = tty->disc_data;
469 ldata->canon_column = ldata->column = 0;
470 tty->ops->write(tty, "\r\n", 2);
473 ldata->canon_column = ldata->column;
476 if (O_ONOCR(tty) && ldata->column == 0)
481 ldata->canon_column = ldata->column = 0;
484 ldata->canon_column = ldata->column = 0;
487 spaces = 8 - (ldata->column & 7);
488 if (O_TABDLY(tty) == XTABS) {
491 ldata->column += spaces;
492 tty->ops->write(tty, " ", spaces);
495 ldata->column += spaces;
498 if (ldata->column > 0)
505 if (!is_continuation(c, tty))
511 tty_put_char(tty, c);
516 * process_output - output post processor
517 * @c: character (or partial unicode symbol)
518 * @tty: terminal device
520 * Output one character with OPOST processing.
521 * Returns -1 when the output device is full and the character
524 * Locking: output_lock to protect column state and space left
525 * (also, this is called from n_tty_write under the
526 * tty layer write lock)
529 static int process_output(unsigned char c, struct tty_struct *tty)
531 struct n_tty_data *ldata = tty->disc_data;
534 mutex_lock(&ldata->output_lock);
536 space = tty_write_room(tty);
537 retval = do_output_char(c, tty, space);
539 mutex_unlock(&ldata->output_lock);
547 * process_output_block - block post processor
548 * @tty: terminal device
549 * @buf: character buffer
550 * @nr: number of bytes to output
552 * Output a block of characters with OPOST processing.
553 * Returns the number of characters output.
555 * This path is used to speed up block console writes, among other
556 * things when processing blocks of output data. It handles only
557 * the simple cases normally found and helps to generate blocks of
558 * symbols for the console driver and thus improve performance.
560 * Locking: output_lock to protect column state and space left
561 * (also, this is called from n_tty_write under the
562 * tty layer write lock)
565 static ssize_t process_output_block(struct tty_struct *tty,
566 const unsigned char *buf, unsigned int nr)
568 struct n_tty_data *ldata = tty->disc_data;
571 const unsigned char *cp;
573 mutex_lock(&ldata->output_lock);
575 space = tty_write_room(tty);
577 mutex_unlock(&ldata->output_lock);
583 for (i = 0, cp = buf; i < nr; i++, cp++) {
584 unsigned char c = *cp;
592 ldata->canon_column = ldata->column;
595 if (O_ONOCR(tty) && ldata->column == 0)
599 ldata->canon_column = ldata->column = 0;
604 if (ldata->column > 0)
611 if (!is_continuation(c, tty))
618 i = tty->ops->write(tty, buf, i);
620 mutex_unlock(&ldata->output_lock);
625 * process_echoes - write pending echo characters
626 * @tty: terminal device
628 * Write previously buffered echo (and other ldisc-generated)
629 * characters to the tty.
631 * Characters generated by the ldisc (including echoes) need to
632 * be buffered because the driver's write buffer can fill during
633 * heavy program output. Echoing straight to the driver will
634 * often fail under these conditions, causing lost characters and
635 * resulting mismatches of ldisc state information.
637 * Since the ldisc state must represent the characters actually sent
638 * to the driver at the time of the write, operations like certain
639 * changes in column state are also saved in the buffer and executed
642 * A circular fifo buffer is used so that the most recent characters
643 * are prioritized. Also, when control characters are echoed with a
644 * prefixed "^", the pair is treated atomically and thus not separated.
646 * Locking: callers must hold output_lock
649 static size_t __process_echoes(struct tty_struct *tty)
651 struct n_tty_data *ldata = tty->disc_data;
652 int space, old_space;
656 old_space = space = tty_write_room(tty);
658 tail = ldata->echo_tail;
659 nr = ldata->echo_commit - ldata->echo_tail;
661 c = echo_buf(ldata, tail);
662 if (c == ECHO_OP_START) {
664 int no_space_left = 0;
667 * If the buffer byte is the start of a multi-byte
668 * operation, get the next byte, which is either the
669 * op code or a control character value.
671 op = echo_buf(ldata, tail + 1);
674 unsigned int num_chars, num_bs;
676 case ECHO_OP_ERASE_TAB:
677 num_chars = echo_buf(ldata, tail + 2);
680 * Determine how many columns to go back
681 * in order to erase the tab.
682 * This depends on the number of columns
683 * used by other characters within the tab
684 * area. If this (modulo 8) count is from
685 * the start of input rather than from a
686 * previous tab, we offset by canon column.
687 * Otherwise, tab spacing is normal.
689 if (!(num_chars & 0x80))
690 num_chars += ldata->canon_column;
691 num_bs = 8 - (num_chars & 7);
693 if (num_bs > space) {
699 tty_put_char(tty, '\b');
700 if (ldata->column > 0)
707 case ECHO_OP_SET_CANON_COL:
708 ldata->canon_column = ldata->column;
713 case ECHO_OP_MOVE_BACK_COL:
714 if (ldata->column > 0)
721 /* This is an escaped echo op start code */
726 tty_put_char(tty, ECHO_OP_START);
735 * If the op is not a special byte code,
736 * it is a ctrl char tagged to be echoed
737 * as "^X" (where X is the letter
738 * representing the control char).
739 * Note that we must ensure there is
740 * enough space for the whole ctrl pair.
747 tty_put_char(tty, '^');
748 tty_put_char(tty, op ^ 0100);
759 int retval = do_output_char(c, tty, space);
766 tty_put_char(tty, c);
774 /* If the echo buffer is nearly full (so that the possibility exists
775 * of echo overrun before the next commit), then discard enough
776 * data at the tail to prevent a subsequent overrun */
777 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
778 if (echo_buf(ldata, tail == ECHO_OP_START)) {
779 if (echo_buf(ldata, tail) == ECHO_OP_ERASE_TAB)
787 ldata->echo_tail = tail;
788 return old_space - space;
791 static void commit_echoes(struct tty_struct *tty)
793 struct n_tty_data *ldata = tty->disc_data;
794 size_t nr, old, echoed;
797 head = ldata->echo_head;
798 old = ldata->echo_commit - ldata->echo_tail;
800 /* Process committed echoes if the accumulated # of bytes
801 * is over the threshold (and try again each time another
802 * block is accumulated) */
803 nr = head - ldata->echo_tail;
804 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
807 mutex_lock(&ldata->output_lock);
808 ldata->echo_commit = head;
809 echoed = __process_echoes(tty);
810 mutex_unlock(&ldata->output_lock);
812 if (echoed && tty->ops->flush_chars)
813 tty->ops->flush_chars(tty);
816 static void process_echoes(struct tty_struct *tty)
818 struct n_tty_data *ldata = tty->disc_data;
821 if (!L_ECHO(tty) || ldata->echo_commit == ldata->echo_tail)
824 mutex_lock(&ldata->output_lock);
825 echoed = __process_echoes(tty);
826 mutex_unlock(&ldata->output_lock);
828 if (echoed && tty->ops->flush_chars)
829 tty->ops->flush_chars(tty);
832 static void flush_echoes(struct tty_struct *tty)
834 struct n_tty_data *ldata = tty->disc_data;
836 if (!L_ECHO(tty) || ldata->echo_commit == ldata->echo_head)
839 mutex_lock(&ldata->output_lock);
840 ldata->echo_commit = ldata->echo_head;
841 __process_echoes(tty);
842 mutex_unlock(&ldata->output_lock);
846 * add_echo_byte - add a byte to the echo buffer
847 * @c: unicode byte to echo
850 * Add a character or operation byte to the echo buffer.
853 static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
855 *echo_buf_addr(ldata, ldata->echo_head++) = c;
859 * echo_move_back_col - add operation to move back a column
862 * Add an operation to the echo buffer to move back one column.
865 static void echo_move_back_col(struct n_tty_data *ldata)
867 add_echo_byte(ECHO_OP_START, ldata);
868 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
872 * echo_set_canon_col - add operation to set the canon column
875 * Add an operation to the echo buffer to set the canon column
876 * to the current column.
879 static void echo_set_canon_col(struct n_tty_data *ldata)
881 add_echo_byte(ECHO_OP_START, ldata);
882 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
886 * echo_erase_tab - add operation to erase a tab
887 * @num_chars: number of character columns already used
888 * @after_tab: true if num_chars starts after a previous tab
891 * Add an operation to the echo buffer to erase a tab.
893 * Called by the eraser function, which knows how many character
894 * columns have been used since either a previous tab or the start
895 * of input. This information will be used later, along with
896 * canon column (if applicable), to go back the correct number
900 static void echo_erase_tab(unsigned int num_chars, int after_tab,
901 struct n_tty_data *ldata)
903 add_echo_byte(ECHO_OP_START, ldata);
904 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
906 /* We only need to know this modulo 8 (tab spacing) */
909 /* Set the high bit as a flag if num_chars is after a previous tab */
913 add_echo_byte(num_chars, ldata);
917 * echo_char_raw - echo a character raw
918 * @c: unicode byte to echo
919 * @tty: terminal device
921 * Echo user input back onto the screen. This must be called only when
922 * L_ECHO(tty) is true. Called from the driver receive_buf path.
924 * This variant does not treat control characters specially.
927 static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
929 if (c == ECHO_OP_START) {
930 add_echo_byte(ECHO_OP_START, ldata);
931 add_echo_byte(ECHO_OP_START, ldata);
933 add_echo_byte(c, ldata);
938 * echo_char - echo a character
939 * @c: unicode byte to echo
940 * @tty: terminal device
942 * Echo user input back onto the screen. This must be called only when
943 * L_ECHO(tty) is true. Called from the driver receive_buf path.
945 * This variant tags control characters to be echoed as "^X"
946 * (where X is the letter representing the control char).
949 static void echo_char(unsigned char c, struct tty_struct *tty)
951 struct n_tty_data *ldata = tty->disc_data;
953 if (c == ECHO_OP_START) {
954 add_echo_byte(ECHO_OP_START, ldata);
955 add_echo_byte(ECHO_OP_START, ldata);
957 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
958 add_echo_byte(ECHO_OP_START, ldata);
959 add_echo_byte(c, ldata);
964 * finish_erasing - complete erase
968 static inline void finish_erasing(struct n_tty_data *ldata)
970 if (ldata->erasing) {
971 echo_char_raw('/', ldata);
977 * eraser - handle erase function
978 * @c: character input
979 * @tty: terminal device
981 * Perform erase and necessary output when an erase character is
982 * present in the stream from the driver layer. Handles the complexities
983 * of UTF-8 multibyte symbols.
985 * n_tty_receive_buf()/producer path:
986 * caller holds non-exclusive termios_rwsem
989 * Modifying the read_head is not considered a publish in this context
990 * because canonical mode is active -- only canon_head publishes
993 static void eraser(unsigned char c, struct tty_struct *tty)
995 struct n_tty_data *ldata = tty->disc_data;
996 enum { ERASE, WERASE, KILL } kill_type;
1001 if (ldata->read_head == ldata->canon_head) {
1002 /* process_output('\a', tty); */ /* what do you think? */
1005 if (c == ERASE_CHAR(tty))
1007 else if (c == WERASE_CHAR(tty))
1011 ldata->read_head = ldata->canon_head;
1014 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
1015 ldata->read_head = ldata->canon_head;
1016 finish_erasing(ldata);
1017 echo_char(KILL_CHAR(tty), tty);
1018 /* Add a newline if ECHOK is on and ECHOKE is off. */
1020 echo_char_raw('\n', ldata);
1027 while (ldata->read_head != ldata->canon_head) {
1028 head = ldata->read_head;
1030 /* erase a single possibly multibyte character */
1033 c = read_buf(ldata, head);
1034 } while (is_continuation(c, tty) && head != ldata->canon_head);
1036 /* do not partially erase */
1037 if (is_continuation(c, tty))
1040 if (kill_type == WERASE) {
1041 /* Equivalent to BSD's ALTWERASE. */
1042 if (isalnum(c) || c == '_')
1044 else if (seen_alnums)
1047 cnt = ldata->read_head - head;
1048 ldata->read_head = head;
1050 if (L_ECHOPRT(tty)) {
1051 if (!ldata->erasing) {
1052 echo_char_raw('\\', ldata);
1055 /* if cnt > 1, output a multi-byte character */
1059 echo_char_raw(read_buf(ldata, head), ldata);
1060 echo_move_back_col(ldata);
1062 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1063 echo_char(ERASE_CHAR(tty), tty);
1064 } else if (c == '\t') {
1065 unsigned int num_chars = 0;
1067 size_t tail = ldata->read_head;
1070 * Count the columns used for characters
1071 * since the start of input or after a
1073 * This info is used to go back the correct
1074 * number of columns.
1076 while (tail != ldata->canon_head) {
1078 c = read_buf(ldata, tail);
1082 } else if (iscntrl(c)) {
1085 } else if (!is_continuation(c, tty)) {
1089 echo_erase_tab(num_chars, after_tab, ldata);
1091 if (iscntrl(c) && L_ECHOCTL(tty)) {
1092 echo_char_raw('\b', ldata);
1093 echo_char_raw(' ', ldata);
1094 echo_char_raw('\b', ldata);
1096 if (!iscntrl(c) || L_ECHOCTL(tty)) {
1097 echo_char_raw('\b', ldata);
1098 echo_char_raw(' ', ldata);
1099 echo_char_raw('\b', ldata);
1103 if (kill_type == ERASE)
1106 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
1107 finish_erasing(ldata);
1111 * isig - handle the ISIG optio
1115 * Called when a signal is being sent due to terminal input.
1116 * Called from the driver receive_buf path so serialized.
1118 * Locking: ctrl_lock
1121 static inline void isig(int sig, struct tty_struct *tty)
1123 struct pid *tty_pgrp = tty_get_pgrp(tty);
1125 kill_pgrp(tty_pgrp, sig, 1);
1131 * n_tty_receive_break - handle break
1134 * An RS232 break event has been hit in the incoming bitstream. This
1135 * can cause a variety of events depending upon the termios settings.
1137 * n_tty_receive_buf()/producer path:
1138 * caller holds non-exclusive termios_rwsem
1139 * publishes read_head via put_tty_queue()
1141 * Note: may get exclusive termios_rwsem if flushing input buffer
1144 static inline void n_tty_receive_break(struct tty_struct *tty)
1146 struct n_tty_data *ldata = tty->disc_data;
1150 if (I_BRKINT(tty)) {
1152 if (!L_NOFLSH(tty)) {
1153 /* flushing needs exclusive termios_rwsem */
1154 up_read(&tty->termios_rwsem);
1155 n_tty_flush_buffer(tty);
1156 tty_driver_flush_buffer(tty);
1157 down_read(&tty->termios_rwsem);
1161 if (I_PARMRK(tty)) {
1162 put_tty_queue('\377', ldata);
1163 put_tty_queue('\0', ldata);
1165 put_tty_queue('\0', ldata);
1166 wake_up_interruptible(&tty->read_wait);
1170 * n_tty_receive_overrun - handle overrun reporting
1173 * Data arrived faster than we could process it. While the tty
1174 * driver has flagged this the bits that were missed are gone
1177 * Called from the receive_buf path so single threaded. Does not
1178 * need locking as num_overrun and overrun_time are function
1182 static inline void n_tty_receive_overrun(struct tty_struct *tty)
1184 struct n_tty_data *ldata = tty->disc_data;
1187 ldata->num_overrun++;
1188 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1189 time_after(ldata->overrun_time, jiffies)) {
1190 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1192 ldata->num_overrun);
1193 ldata->overrun_time = jiffies;
1194 ldata->num_overrun = 0;
1199 * n_tty_receive_parity_error - error notifier
1200 * @tty: terminal device
1203 * Process a parity error and queue the right data to indicate
1204 * the error case if necessary.
1206 * n_tty_receive_buf()/producer path:
1207 * caller holds non-exclusive termios_rwsem
1208 * publishes read_head via put_tty_queue()
1210 static inline void n_tty_receive_parity_error(struct tty_struct *tty,
1213 struct n_tty_data *ldata = tty->disc_data;
1217 if (I_PARMRK(tty)) {
1218 put_tty_queue('\377', ldata);
1219 put_tty_queue('\0', ldata);
1220 put_tty_queue(c, ldata);
1221 } else if (I_INPCK(tty))
1222 put_tty_queue('\0', ldata);
1224 put_tty_queue(c, ldata);
1225 wake_up_interruptible(&tty->read_wait);
1229 * n_tty_receive_char - perform processing
1230 * @tty: terminal device
1233 * Process an individual character of input received from the driver.
1234 * This is serialized with respect to itself by the rules for the
1237 * n_tty_receive_buf()/producer path:
1238 * caller holds non-exclusive termios_rwsem
1239 * publishes canon_head if canonical mode is active
1240 * otherwise, publishes read_head via put_tty_queue()
1243 static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1245 struct n_tty_data *ldata = tty->disc_data;
1249 put_tty_queue(c, ldata);
1255 if (I_IUCLC(tty) && L_IEXTEN(tty))
1258 if (L_EXTPROC(tty)) {
1259 put_tty_queue(c, ldata);
1263 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) &&
1264 I_IXANY(tty) && c != START_CHAR(tty) && c != STOP_CHAR(tty) &&
1265 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) && c != SUSP_CHAR(tty)) {
1267 process_echoes(tty);
1272 if (c == START_CHAR(tty)) {
1274 process_echoes(tty);
1275 } else if (c == STOP_CHAR(tty))
1282 * If the previous character was LNEXT, or we know that this
1283 * character is not one of the characters that we'll have to
1284 * handle specially, do shortcut processing to speed things
1287 if (!test_bit(c, ldata->process_char_map) || ldata->lnext) {
1289 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1290 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - parmrk - 1)) {
1291 /* beep if no space */
1293 process_output('\a', tty);
1297 finish_erasing(ldata);
1298 /* Record the column of first canon char. */
1299 if (ldata->canon_head == ldata->read_head)
1300 echo_set_canon_col(ldata);
1305 put_tty_queue(c, ldata);
1306 put_tty_queue(c, ldata);
1311 if (c == START_CHAR(tty)) {
1316 if (c == STOP_CHAR(tty)) {
1325 if (c == INTR_CHAR(tty))
1328 if (c == QUIT_CHAR(tty))
1331 if (c == SUSP_CHAR(tty)) {
1333 if (!L_NOFLSH(tty)) {
1334 /* flushing needs exclusive termios_rwsem */
1335 up_read(&tty->termios_rwsem);
1336 n_tty_flush_buffer(tty);
1337 tty_driver_flush_buffer(tty);
1338 down_read(&tty->termios_rwsem);
1356 } else if (c == '\n' && I_INLCR(tty))
1359 if (ldata->icanon) {
1360 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1361 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1366 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
1369 finish_erasing(ldata);
1370 if (L_ECHOCTL(tty)) {
1371 echo_char_raw('^', ldata);
1372 echo_char_raw('\b', ldata);
1378 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) &&
1380 size_t tail = ldata->canon_head;
1382 finish_erasing(ldata);
1384 echo_char_raw('\n', ldata);
1385 while (tail != ldata->read_head) {
1386 echo_char(read_buf(ldata, tail), tty);
1393 if (read_cnt(ldata) >= N_TTY_BUF_SIZE) {
1395 process_output('\a', tty);
1398 if (L_ECHO(tty) || L_ECHONL(tty)) {
1399 echo_char_raw('\n', ldata);
1402 goto handle_newline;
1404 if (c == EOF_CHAR(tty)) {
1405 if (read_cnt(ldata) >= N_TTY_BUF_SIZE)
1407 if (ldata->canon_head != ldata->read_head)
1408 set_bit(TTY_PUSH, &tty->flags);
1409 c = __DISABLED_CHAR;
1410 goto handle_newline;
1412 if ((c == EOL_CHAR(tty)) ||
1413 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1414 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty))
1416 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - parmrk)) {
1418 process_output('\a', tty);
1422 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1425 /* Record the column of first canon char. */
1426 if (ldata->canon_head == ldata->read_head)
1427 echo_set_canon_col(ldata);
1432 * XXX does PARMRK doubling happen for
1433 * EOL_CHAR and EOL2_CHAR?
1436 put_tty_queue(c, ldata);
1439 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
1440 put_tty_queue(c, ldata);
1441 ldata->canon_head = ldata->read_head;
1442 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1443 if (waitqueue_active(&tty->read_wait))
1444 wake_up_interruptible(&tty->read_wait);
1449 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1450 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - parmrk - 1)) {
1451 /* beep if no space */
1453 process_output('\a', tty);
1457 finish_erasing(ldata);
1459 echo_char_raw('\n', ldata);
1461 /* Record the column of first canon char. */
1462 if (ldata->canon_head == ldata->read_head)
1463 echo_set_canon_col(ldata);
1470 put_tty_queue(c, ldata);
1472 put_tty_queue(c, ldata);
1476 * n_tty_receive_buf - data receive
1477 * @tty: terminal device
1480 * @count: characters
1482 * Called by the terminal driver when a block of characters has
1483 * been received. This function must be called from soft contexts
1484 * not from interrupt context. The driver is responsible for making
1485 * calls one at a time and in order (or using flush_to_ldisc)
1487 * n_tty_receive_buf()/producer path:
1488 * claims non-exclusive termios_rwsem
1489 * publishes read_head and canon_head
1492 static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1493 char *fp, int count)
1495 struct n_tty_data *ldata = tty->disc_data;
1496 const unsigned char *p;
1497 char *f, flags = TTY_NORMAL;
1500 if (ldata->real_raw) {
1503 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1504 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1505 n = min_t(size_t, count, n);
1506 memcpy(read_buf_addr(ldata, head), cp, n);
1507 ldata->read_head += n;
1511 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1512 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1513 n = min_t(size_t, count, n);
1514 memcpy(read_buf_addr(ldata, head), cp, n);
1515 ldata->read_head += n;
1519 for (i = count, p = cp, f = fp; i; i--, p++) {
1524 n_tty_receive_char(tty, *p);
1527 n_tty_receive_break(tty);
1531 n_tty_receive_parity_error(tty, *p);
1534 n_tty_receive_overrun(tty);
1537 printk(KERN_ERR "%s: unknown flag %d\n",
1538 tty_name(tty, buf), flags);
1544 if (tty->ops->flush_chars)
1545 tty->ops->flush_chars(tty);
1548 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
1550 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1551 if (waitqueue_active(&tty->read_wait))
1552 wake_up_interruptible(&tty->read_wait);
1555 n_tty_check_throttle(tty);
1558 static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1559 char *fp, int count)
1561 down_read(&tty->termios_rwsem);
1562 __receive_buf(tty, cp, fp, count);
1563 up_read(&tty->termios_rwsem);
1566 static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1567 char *fp, int count)
1569 struct n_tty_data *ldata = tty->disc_data;
1572 down_read(&tty->termios_rwsem);
1574 tty->receive_room = room = receive_room(tty);
1577 count = min(count, room);
1579 __receive_buf(tty, cp, fp, count);
1581 up_read(&tty->termios_rwsem);
1586 int is_ignored(int sig)
1588 return (sigismember(¤t->blocked, sig) ||
1589 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
1593 * n_tty_set_termios - termios data changed
1595 * @old: previous data
1597 * Called by the tty layer when the user changes termios flags so
1598 * that the line discipline can plan ahead. This function cannot sleep
1599 * and is protected from re-entry by the tty layer. The user is
1600 * guaranteed that this function will not be re-entered or in progress
1601 * when the ldisc is closed.
1603 * Locking: Caller holds tty->termios_rwsem
1606 static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
1608 struct n_tty_data *ldata = tty->disc_data;
1609 int canon_change = 1;
1612 canon_change = (old->c_lflag ^ tty->termios.c_lflag) & ICANON;
1614 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
1615 ldata->canon_head = ldata->read_tail;
1620 if (canon_change && !L_ICANON(tty) && read_cnt(ldata))
1621 wake_up_interruptible(&tty->read_wait);
1623 ldata->icanon = (L_ICANON(tty) != 0);
1625 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1626 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1627 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1629 bitmap_zero(ldata->process_char_map, 256);
1631 if (I_IGNCR(tty) || I_ICRNL(tty))
1632 set_bit('\r', ldata->process_char_map);
1634 set_bit('\n', ldata->process_char_map);
1636 if (L_ICANON(tty)) {
1637 set_bit(ERASE_CHAR(tty), ldata->process_char_map);
1638 set_bit(KILL_CHAR(tty), ldata->process_char_map);
1639 set_bit(EOF_CHAR(tty), ldata->process_char_map);
1640 set_bit('\n', ldata->process_char_map);
1641 set_bit(EOL_CHAR(tty), ldata->process_char_map);
1642 if (L_IEXTEN(tty)) {
1643 set_bit(WERASE_CHAR(tty),
1644 ldata->process_char_map);
1645 set_bit(LNEXT_CHAR(tty),
1646 ldata->process_char_map);
1647 set_bit(EOL2_CHAR(tty),
1648 ldata->process_char_map);
1650 set_bit(REPRINT_CHAR(tty),
1651 ldata->process_char_map);
1655 set_bit(START_CHAR(tty), ldata->process_char_map);
1656 set_bit(STOP_CHAR(tty), ldata->process_char_map);
1659 set_bit(INTR_CHAR(tty), ldata->process_char_map);
1660 set_bit(QUIT_CHAR(tty), ldata->process_char_map);
1661 set_bit(SUSP_CHAR(tty), ldata->process_char_map);
1663 clear_bit(__DISABLED_CHAR, ldata->process_char_map);
1665 ldata->real_raw = 0;
1668 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1669 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1670 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
1671 ldata->real_raw = 1;
1673 ldata->real_raw = 0;
1675 n_tty_set_room(tty);
1677 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1678 * been stopped by STOP_CHAR(tty) before it.
1680 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
1684 /* The termios change make the tty ready for I/O */
1685 wake_up_interruptible(&tty->write_wait);
1686 wake_up_interruptible(&tty->read_wait);
1690 * n_tty_close - close the ldisc for this tty
1693 * Called from the terminal layer when this line discipline is
1694 * being shut down, either because of a close or becsuse of a
1695 * discipline change. The function will not be called while other
1696 * ldisc methods are in progress.
1699 static void n_tty_close(struct tty_struct *tty)
1701 struct n_tty_data *ldata = tty->disc_data;
1704 n_tty_packet_mode_flush(tty);
1706 kfree(ldata->read_buf);
1707 kfree(ldata->echo_buf);
1709 tty->disc_data = NULL;
1713 * n_tty_open - open an ldisc
1714 * @tty: terminal to open
1716 * Called when this line discipline is being attached to the
1717 * terminal device. Can sleep. Called serialized so that no
1718 * other events will occur in parallel. No further open will occur
1722 static int n_tty_open(struct tty_struct *tty)
1724 struct n_tty_data *ldata;
1726 ldata = kzalloc(sizeof(*ldata), GFP_KERNEL);
1730 ldata->overrun_time = jiffies;
1731 mutex_init(&ldata->atomic_read_lock);
1732 mutex_init(&ldata->output_lock);
1734 /* These are ugly. Currently a malloc failure here can panic */
1735 ldata->read_buf = kzalloc(N_TTY_BUF_SIZE, GFP_KERNEL);
1736 ldata->echo_buf = kzalloc(N_TTY_BUF_SIZE, GFP_KERNEL);
1737 if (!ldata->read_buf || !ldata->echo_buf)
1740 tty->disc_data = ldata;
1741 reset_buffer_flags(tty->disc_data);
1743 ldata->minimum_to_wake = 1;
1745 /* indicate buffer work may resume */
1746 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1747 n_tty_set_termios(tty, NULL);
1748 tty_unthrottle(tty);
1752 kfree(ldata->read_buf);
1753 kfree(ldata->echo_buf);
1759 static inline int input_available_p(struct tty_struct *tty, int amt)
1761 struct n_tty_data *ldata = tty->disc_data;
1763 if (ldata->icanon && !L_EXTPROC(tty)) {
1764 if (ldata->canon_head != ldata->read_tail)
1766 } else if (read_cnt(ldata) >= (amt ? amt : 1))
1773 * copy_from_read_buf - copy read data directly
1774 * @tty: terminal device
1778 * Helper function to speed up n_tty_read. It is only called when
1779 * ICANON is off; it copies characters straight from the tty queue to
1780 * user space directly. It can be profitably called twice; once to
1781 * drain the space from the tail pointer to the (physical) end of the
1782 * buffer, and once to drain the space from the (physical) beginning of
1783 * the buffer to head pointer.
1785 * Called under the ldata->atomic_read_lock sem
1787 * n_tty_read()/consumer path:
1788 * caller holds non-exclusive termios_rwsem
1789 * read_tail published
1792 static int copy_from_read_buf(struct tty_struct *tty,
1793 unsigned char __user **b,
1797 struct n_tty_data *ldata = tty->disc_data;
1801 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
1804 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
1807 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
1809 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1810 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
1812 ldata->read_tail += n;
1813 /* Turn single EOF into zero-length read */
1814 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
1823 * canon_copy_from_read_buf - copy read data in canonical mode
1824 * @tty: terminal device
1828 * Helper function for n_tty_read. It is only called when ICANON is on;
1829 * it copies one line of input up to and including the line-delimiting
1830 * character into the user-space buffer.
1832 * Called under the atomic_read_lock mutex
1834 * n_tty_read()/consumer path:
1835 * caller holds non-exclusive termios_rwsem
1836 * read_tail published
1839 static int canon_copy_from_read_buf(struct tty_struct *tty,
1840 unsigned char __user **b,
1843 struct n_tty_data *ldata = tty->disc_data;
1844 size_t n, size, more, c;
1849 /* N.B. avoid overrun if nr == 0 */
1850 n = min(*nr, read_cnt(ldata));
1854 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
1855 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1857 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
1858 __func__, *nr, tail, n, size);
1860 eol = find_next_bit(ldata->read_flags, size, tail);
1861 more = n - (size - tail);
1862 if (eol == N_TTY_BUF_SIZE && more) {
1863 /* scan wrapped without finding set bit */
1864 eol = find_next_bit(ldata->read_flags, more, 0);
1867 } else if (eol != size)
1870 size = N_TTY_BUF_SIZE - tail;
1871 n = (found + eol + size) & (N_TTY_BUF_SIZE - 1);
1874 if (found && read_buf(ldata, eol) == __DISABLED_CHAR)
1877 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
1878 __func__, eol, found, n, c, size, more);
1881 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
1884 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
1886 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
1894 clear_bit(eol, ldata->read_flags);
1895 smp_mb__after_clear_bit();
1896 ldata->read_tail += c;
1899 tty_audit_push(tty);
1903 extern ssize_t redirected_tty_write(struct file *, const char __user *,
1907 * job_control - check job control
1909 * @file: file handle
1911 * Perform job control management checks on this file/tty descriptor
1912 * and if appropriate send any needed signals and return a negative
1913 * error code if action should be taken.
1915 * Locking: redirected write test is safe
1916 * current->signal->tty check is safe
1917 * ctrl_lock to safely reference tty->pgrp
1920 static int job_control(struct tty_struct *tty, struct file *file)
1922 /* Job control check -- must be done at start and after
1923 every sleep (POSIX.1 7.1.1.4). */
1924 /* NOTE: not yet done after every sleep pending a thorough
1925 check of the logic of this change. -- jlc */
1926 /* don't stop on /dev/console */
1927 if (file->f_op->write == redirected_tty_write ||
1928 current->signal->tty != tty)
1931 spin_lock_irq(&tty->ctrl_lock);
1933 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
1934 else if (task_pgrp(current) != tty->pgrp) {
1935 spin_unlock_irq(&tty->ctrl_lock);
1936 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
1938 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
1939 set_thread_flag(TIF_SIGPENDING);
1940 return -ERESTARTSYS;
1942 spin_unlock_irq(&tty->ctrl_lock);
1948 * n_tty_read - read function for tty
1950 * @file: file object
1951 * @buf: userspace buffer pointer
1954 * Perform reads for the line discipline. We are guaranteed that the
1955 * line discipline will not be closed under us but we may get multiple
1956 * parallel readers and must handle this ourselves. We may also get
1957 * a hangup. Always called in user context, may sleep.
1959 * This code must be sure never to sleep through a hangup.
1961 * n_tty_read()/consumer path:
1962 * claims non-exclusive termios_rwsem
1963 * publishes read_tail
1966 static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
1967 unsigned char __user *buf, size_t nr)
1969 struct n_tty_data *ldata = tty->disc_data;
1970 unsigned char __user *b = buf;
1971 DECLARE_WAITQUEUE(wait, current);
1977 unsigned long flags;
1981 c = job_control(tty, file);
1985 down_read(&tty->termios_rwsem);
1988 timeout = MAX_SCHEDULE_TIMEOUT;
1989 if (!ldata->icanon) {
1990 minimum = MIN_CHAR(tty);
1992 time = (HZ / 10) * TIME_CHAR(tty);
1994 ldata->minimum_to_wake = 1;
1995 else if (!waitqueue_active(&tty->read_wait) ||
1996 (ldata->minimum_to_wake > minimum))
1997 ldata->minimum_to_wake = minimum;
1999 timeout = (HZ / 10) * TIME_CHAR(tty);
2000 ldata->minimum_to_wake = minimum = 1;
2005 * Internal serialization of reads.
2007 if (file->f_flags & O_NONBLOCK) {
2008 if (!mutex_trylock(&ldata->atomic_read_lock)) {
2009 up_read(&tty->termios_rwsem);
2013 if (mutex_lock_interruptible(&ldata->atomic_read_lock)) {
2014 up_read(&tty->termios_rwsem);
2015 return -ERESTARTSYS;
2018 packet = tty->packet;
2020 add_wait_queue(&tty->read_wait, &wait);
2022 /* First test for status change. */
2023 if (packet && tty->link->ctrl_status) {
2027 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
2028 cs = tty->link->ctrl_status;
2029 tty->link->ctrl_status = 0;
2030 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
2031 if (tty_put_user(tty, cs, b++)) {
2039 /* This statement must be first before checking for input
2040 so that any interrupt will set the state back to
2042 set_current_state(TASK_INTERRUPTIBLE);
2044 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
2045 ((minimum - (b - buf)) >= 1))
2046 ldata->minimum_to_wake = (minimum - (b - buf));
2048 if (!input_available_p(tty, 0)) {
2049 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
2053 if (tty_hung_up_p(file))
2057 if (file->f_flags & O_NONBLOCK) {
2061 if (signal_pending(current)) {
2062 retval = -ERESTARTSYS;
2065 n_tty_set_room(tty);
2066 up_read(&tty->termios_rwsem);
2068 timeout = schedule_timeout(timeout);
2070 down_read(&tty->termios_rwsem);
2073 __set_current_state(TASK_RUNNING);
2075 /* Deal with packet mode. */
2076 if (packet && b == buf) {
2077 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
2085 if (ldata->icanon && !L_EXTPROC(tty)) {
2086 retval = canon_copy_from_read_buf(tty, &b, &nr);
2091 /* The copy function takes the read lock and handles
2092 locking internally for this case */
2093 uncopied = copy_from_read_buf(tty, &b, &nr);
2094 uncopied += copy_from_read_buf(tty, &b, &nr);
2101 n_tty_check_unthrottle(tty);
2103 if (b - buf >= minimum)
2108 mutex_unlock(&ldata->atomic_read_lock);
2109 remove_wait_queue(&tty->read_wait, &wait);
2111 if (!waitqueue_active(&tty->read_wait))
2112 ldata->minimum_to_wake = minimum;
2114 __set_current_state(TASK_RUNNING);
2119 clear_bit(TTY_PUSH, &tty->flags);
2120 } else if (test_and_clear_bit(TTY_PUSH, &tty->flags)) {
2121 up_read(&tty->termios_rwsem);
2125 n_tty_set_room(tty);
2126 up_read(&tty->termios_rwsem);
2131 * n_tty_write - write function for tty
2133 * @file: file object
2134 * @buf: userspace buffer pointer
2137 * Write function of the terminal device. This is serialized with
2138 * respect to other write callers but not to termios changes, reads
2139 * and other such events. Since the receive code will echo characters,
2140 * thus calling driver write methods, the output_lock is used in
2141 * the output processing functions called here as well as in the
2142 * echo processing function to protect the column state and space
2143 * left in the buffer.
2145 * This code must be sure never to sleep through a hangup.
2147 * Locking: output_lock to protect column state and space left
2148 * (note that the process_output*() functions take this
2152 static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
2153 const unsigned char *buf, size_t nr)
2155 const unsigned char *b = buf;
2156 DECLARE_WAITQUEUE(wait, current);
2160 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2161 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2162 retval = tty_check_change(tty);
2167 down_read(&tty->termios_rwsem);
2169 /* Write out any echoed characters that are still pending */
2170 process_echoes(tty);
2172 add_wait_queue(&tty->write_wait, &wait);
2174 set_current_state(TASK_INTERRUPTIBLE);
2175 if (signal_pending(current)) {
2176 retval = -ERESTARTSYS;
2179 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2185 ssize_t num = process_output_block(tty, b, nr);
2197 if (process_output(c, tty) < 0)
2201 if (tty->ops->flush_chars)
2202 tty->ops->flush_chars(tty);
2205 c = tty->ops->write(tty, b, nr);
2218 if (file->f_flags & O_NONBLOCK) {
2222 up_read(&tty->termios_rwsem);
2226 down_read(&tty->termios_rwsem);
2229 __set_current_state(TASK_RUNNING);
2230 remove_wait_queue(&tty->write_wait, &wait);
2231 if (b - buf != nr && tty->fasync)
2232 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2233 up_read(&tty->termios_rwsem);
2234 return (b - buf) ? b - buf : retval;
2238 * n_tty_poll - poll method for N_TTY
2239 * @tty: terminal device
2240 * @file: file accessing it
2243 * Called when the line discipline is asked to poll() for data or
2244 * for special events. This code is not serialized with respect to
2245 * other events save open/close.
2247 * This code must be sure never to sleep through a hangup.
2248 * Called without the kernel lock held - fine
2251 static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
2254 struct n_tty_data *ldata = tty->disc_data;
2255 unsigned int mask = 0;
2257 poll_wait(file, &tty->read_wait, wait);
2258 poll_wait(file, &tty->write_wait, wait);
2259 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
2260 mask |= POLLIN | POLLRDNORM;
2261 if (tty->packet && tty->link->ctrl_status)
2262 mask |= POLLPRI | POLLIN | POLLRDNORM;
2263 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2265 if (tty_hung_up_p(file))
2267 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2268 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
2269 ldata->minimum_to_wake = MIN_CHAR(tty);
2271 ldata->minimum_to_wake = 1;
2273 if (tty->ops->write && !tty_is_writelocked(tty) &&
2274 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2275 tty_write_room(tty) > 0)
2276 mask |= POLLOUT | POLLWRNORM;
2280 static unsigned long inq_canon(struct n_tty_data *ldata)
2282 size_t nr, head, tail;
2284 if (ldata->canon_head == ldata->read_tail)
2286 head = ldata->canon_head;
2287 tail = ldata->read_tail;
2289 /* Skip EOF-chars.. */
2290 while (head != tail) {
2291 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2292 read_buf(ldata, tail) == __DISABLED_CHAR)
2299 static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2300 unsigned int cmd, unsigned long arg)
2302 struct n_tty_data *ldata = tty->disc_data;
2307 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2309 down_write(&tty->termios_rwsem);
2311 retval = inq_canon(ldata);
2313 retval = read_cnt(ldata);
2314 up_write(&tty->termios_rwsem);
2315 return put_user(retval, (unsigned int __user *) arg);
2317 return n_tty_ioctl_helper(tty, file, cmd, arg);
2321 static void n_tty_fasync(struct tty_struct *tty, int on)
2323 struct n_tty_data *ldata = tty->disc_data;
2325 if (!waitqueue_active(&tty->read_wait)) {
2327 ldata->minimum_to_wake = 1;
2328 else if (!tty->fasync)
2329 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2333 struct tty_ldisc_ops tty_ldisc_N_TTY = {
2334 .magic = TTY_LDISC_MAGIC,
2337 .close = n_tty_close,
2338 .flush_buffer = n_tty_flush_buffer,
2339 .chars_in_buffer = n_tty_chars_in_buffer,
2341 .write = n_tty_write,
2342 .ioctl = n_tty_ioctl,
2343 .set_termios = n_tty_set_termios,
2345 .receive_buf = n_tty_receive_buf,
2346 .write_wakeup = n_tty_write_wakeup,
2347 .fasync = n_tty_fasync,
2348 .receive_buf2 = n_tty_receive_buf2,
2352 * n_tty_inherit_ops - inherit N_TTY methods
2353 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2355 * Enables a 'subclass' line discipline to 'inherit' N_TTY
2359 void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2361 *ops = tty_ldisc_N_TTY;
2363 ops->refcount = ops->flags = 0;
2365 EXPORT_SYMBOL_GPL(n_tty_inherit_ops);