PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / tty / n_tty.c
blobd15624c1b75161877e6319e6460981866feb54cb
1 /*
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,
7 * anyway...)
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
19 * License.
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
30 * EAGAIN
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>
43 #include <linux/mm.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/poll.h>
47 #include <linux/bitops.h>
48 #include <linux/audit.h>
49 #include <linux/file.h>
50 #include <linux/uaccess.h>
51 #include <linux/module.h>
52 #include <linux/ratelimit.h>
53 #include <linux/vmalloc.h>
56 /* number of characters left in xmit buffer before select has we have room */
57 #define WAKEUP_CHARS 256
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
64 #define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
65 #define TTY_THRESHOLD_UNTHROTTLE 128
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
71 * codes.
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)
83 #undef N_TTY_TRACE
84 #ifdef N_TTY_TRACE
85 # define n_tty_trace(f, args...) trace_printk(f, ##args)
86 #else
87 # define n_tty_trace(f, args...)
88 #endif
90 struct n_tty_data {
91 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
94 size_t echo_head;
95 size_t echo_commit;
96 size_t echo_mark;
97 DECLARE_BITMAP(char_map, 256);
99 /* private to n_tty_receive_overrun (single-threaded) */
100 unsigned long overrun_time;
101 int num_overrun;
103 /* non-atomic */
104 bool no_room;
106 /* must hold exclusive termios_rwsem to reset these */
107 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
108 unsigned char push:1;
110 /* shared by producer and consumer */
111 char read_buf[N_TTY_BUF_SIZE];
112 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
113 unsigned char echo_buf[N_TTY_BUF_SIZE];
115 int minimum_to_wake;
117 /* consumer-published */
118 size_t read_tail;
119 size_t line_start;
121 /* protected by output lock */
122 unsigned int column;
123 unsigned int canon_column;
124 size_t echo_tail;
126 struct mutex atomic_read_lock;
127 struct mutex output_lock;
130 static inline size_t read_cnt(struct n_tty_data *ldata)
132 return ldata->read_head - ldata->read_tail;
135 static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
137 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
140 static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
142 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
145 static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
147 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
150 static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
152 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
155 static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
156 unsigned char __user *ptr)
158 struct n_tty_data *ldata = tty->disc_data;
160 tty_audit_add_data(tty, &x, 1, ldata->icanon);
161 return put_user(x, ptr);
164 static int receive_room(struct tty_struct *tty)
166 struct n_tty_data *ldata = tty->disc_data;
167 int left;
169 if (I_PARMRK(tty)) {
170 /* Multiply read_cnt by 3, since each byte might take up to
171 * three times as many spaces when PARMRK is set (depending on
172 * its flags, e.g. parity error). */
173 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
174 } else
175 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
178 * If we are doing input canonicalization, and there are no
179 * pending newlines, let characters through without limit, so
180 * that erase characters will be handled. Other excess
181 * characters will be beeped.
183 if (left <= 0)
184 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
186 return left;
190 * n_tty_set_room - receive space
191 * @tty: terminal
193 * Re-schedules the flip buffer work if space just became available.
195 * Caller holds exclusive termios_rwsem
196 * or
197 * n_tty_read()/consumer path:
198 * holds non-exclusive termios_rwsem
201 static void n_tty_set_room(struct tty_struct *tty)
203 struct n_tty_data *ldata = tty->disc_data;
205 /* Did this open up the receive buffer? We may need to flip */
206 if (unlikely(ldata->no_room) && receive_room(tty)) {
207 ldata->no_room = 0;
209 WARN_RATELIMIT(tty->port->itty == NULL,
210 "scheduling with invalid itty\n");
211 /* see if ldisc has been killed - if so, this means that
212 * even though the ldisc has been halted and ->buf.work
213 * cancelled, ->buf.work is about to be rescheduled
215 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
216 "scheduling buffer work for halted ldisc\n");
217 queue_work(system_unbound_wq, &tty->port->buf.work);
221 static ssize_t chars_in_buffer(struct tty_struct *tty)
223 struct n_tty_data *ldata = tty->disc_data;
224 ssize_t n = 0;
226 if (!ldata->icanon)
227 n = read_cnt(ldata);
228 else
229 n = ldata->canon_head - ldata->read_tail;
230 return n;
234 * n_tty_write_wakeup - asynchronous I/O notifier
235 * @tty: tty device
237 * Required for the ptys, serial driver etc. since processes
238 * that attach themselves to the master and rely on ASYNC
239 * IO must be woken up
242 static void n_tty_write_wakeup(struct tty_struct *tty)
244 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
245 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
248 static void n_tty_check_throttle(struct tty_struct *tty)
250 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
251 return;
253 * Check the remaining room for the input canonicalization
254 * mode. We don't want to throttle the driver if we're in
255 * canonical mode and don't have a newline yet!
257 while (1) {
258 int throttled;
259 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
260 if (receive_room(tty) >= TTY_THRESHOLD_THROTTLE)
261 break;
262 throttled = tty_throttle_safe(tty);
263 if (!throttled)
264 break;
266 __tty_set_flow_change(tty, 0);
269 static void n_tty_check_unthrottle(struct tty_struct *tty)
271 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
272 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
273 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
274 return;
275 if (!tty->count)
276 return;
277 n_tty_set_room(tty);
278 n_tty_write_wakeup(tty->link);
279 if (waitqueue_active(&tty->link->write_wait))
280 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
281 return;
284 /* If there is enough space in the read buffer now, let the
285 * low-level driver know. We use chars_in_buffer() to
286 * check the buffer, as it now knows about canonical mode.
287 * Otherwise, if the driver is throttled and the line is
288 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
289 * we won't get any more characters.
292 while (1) {
293 int unthrottled;
294 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
295 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
296 break;
297 if (!tty->count)
298 break;
299 n_tty_set_room(tty);
300 unthrottled = tty_unthrottle_safe(tty);
301 if (!unthrottled)
302 break;
304 __tty_set_flow_change(tty, 0);
308 * put_tty_queue - add character to tty
309 * @c: character
310 * @ldata: n_tty data
312 * Add a character to the tty read_buf queue.
314 * n_tty_receive_buf()/producer path:
315 * caller holds non-exclusive termios_rwsem
316 * modifies read_head
318 * read_head is only considered 'published' if canonical mode is
319 * not active.
322 static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
324 *read_buf_addr(ldata, ldata->read_head++) = c;
328 * reset_buffer_flags - reset buffer state
329 * @tty: terminal to reset
331 * Reset the read buffer counters and clear the flags.
332 * Called from n_tty_open() and n_tty_flush_buffer().
334 * Locking: caller holds exclusive termios_rwsem
335 * (or locking is not required)
338 static void reset_buffer_flags(struct n_tty_data *ldata)
340 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
341 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
342 ldata->echo_mark = 0;
343 ldata->line_start = 0;
345 ldata->erasing = 0;
346 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
347 ldata->push = 0;
350 static void n_tty_packet_mode_flush(struct tty_struct *tty)
352 unsigned long flags;
354 spin_lock_irqsave(&tty->ctrl_lock, flags);
355 if (tty->link->packet) {
356 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
357 if (waitqueue_active(&tty->link->read_wait))
358 wake_up_interruptible(&tty->link->read_wait);
360 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
364 * n_tty_flush_buffer - clean input queue
365 * @tty: terminal device
367 * Flush the input buffer. Called when the tty layer wants the
368 * buffer flushed (eg at hangup) or when the N_TTY line discipline
369 * internally has to clean the pending queue (for example some signals).
371 * Holds termios_rwsem to exclude producer/consumer while
372 * buffer indices are reset.
374 * Locking: ctrl_lock, exclusive termios_rwsem
377 static void n_tty_flush_buffer(struct tty_struct *tty)
379 down_write(&tty->termios_rwsem);
380 reset_buffer_flags(tty->disc_data);
381 n_tty_set_room(tty);
383 if (tty->link)
384 n_tty_packet_mode_flush(tty);
385 up_write(&tty->termios_rwsem);
389 * n_tty_chars_in_buffer - report available bytes
390 * @tty: tty device
392 * Report the number of characters buffered to be delivered to user
393 * at this instant in time.
395 * Locking: exclusive termios_rwsem
398 static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
400 ssize_t n;
402 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
404 down_write(&tty->termios_rwsem);
405 n = chars_in_buffer(tty);
406 up_write(&tty->termios_rwsem);
407 return n;
411 * is_utf8_continuation - utf8 multibyte check
412 * @c: byte to check
414 * Returns true if the utf8 character 'c' is a multibyte continuation
415 * character. We use this to correctly compute the on screen size
416 * of the character when printing
419 static inline int is_utf8_continuation(unsigned char c)
421 return (c & 0xc0) == 0x80;
425 * is_continuation - multibyte check
426 * @c: byte to check
428 * Returns true if the utf8 character 'c' is a multibyte continuation
429 * character and the terminal is in unicode mode.
432 static inline int is_continuation(unsigned char c, struct tty_struct *tty)
434 return I_IUTF8(tty) && is_utf8_continuation(c);
438 * do_output_char - output one character
439 * @c: character (or partial unicode symbol)
440 * @tty: terminal device
441 * @space: space available in tty driver write buffer
443 * This is a helper function that handles one output character
444 * (including special characters like TAB, CR, LF, etc.),
445 * doing OPOST processing and putting the results in the
446 * tty driver's write buffer.
448 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
449 * and NLDLY. They simply aren't relevant in the world today.
450 * If you ever need them, add them here.
452 * Returns the number of bytes of buffer space used or -1 if
453 * no space left.
455 * Locking: should be called under the output_lock to protect
456 * the column state and space left in the buffer
459 static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
461 struct n_tty_data *ldata = tty->disc_data;
462 int spaces;
464 if (!space)
465 return -1;
467 switch (c) {
468 case '\n':
469 if (O_ONLRET(tty))
470 ldata->column = 0;
471 if (O_ONLCR(tty)) {
472 if (space < 2)
473 return -1;
474 ldata->canon_column = ldata->column = 0;
475 tty->ops->write(tty, "\r\n", 2);
476 return 2;
478 ldata->canon_column = ldata->column;
479 break;
480 case '\r':
481 if (O_ONOCR(tty) && ldata->column == 0)
482 return 0;
483 if (O_OCRNL(tty)) {
484 c = '\n';
485 if (O_ONLRET(tty))
486 ldata->canon_column = ldata->column = 0;
487 break;
489 ldata->canon_column = ldata->column = 0;
490 break;
491 case '\t':
492 spaces = 8 - (ldata->column & 7);
493 if (O_TABDLY(tty) == XTABS) {
494 if (space < spaces)
495 return -1;
496 ldata->column += spaces;
497 tty->ops->write(tty, " ", spaces);
498 return spaces;
500 ldata->column += spaces;
501 break;
502 case '\b':
503 if (ldata->column > 0)
504 ldata->column--;
505 break;
506 default:
507 if (!iscntrl(c)) {
508 if (O_OLCUC(tty))
509 c = toupper(c);
510 if (!is_continuation(c, tty))
511 ldata->column++;
513 break;
516 tty_put_char(tty, c);
517 return 1;
521 * process_output - output post processor
522 * @c: character (or partial unicode symbol)
523 * @tty: terminal device
525 * Output one character with OPOST processing.
526 * Returns -1 when the output device is full and the character
527 * must be retried.
529 * Locking: output_lock to protect column state and space left
530 * (also, this is called from n_tty_write under the
531 * tty layer write lock)
534 static int process_output(unsigned char c, struct tty_struct *tty)
536 struct n_tty_data *ldata = tty->disc_data;
537 int space, retval;
539 mutex_lock(&ldata->output_lock);
541 space = tty_write_room(tty);
542 retval = do_output_char(c, tty, space);
544 mutex_unlock(&ldata->output_lock);
545 if (retval < 0)
546 return -1;
547 else
548 return 0;
552 * process_output_block - block post processor
553 * @tty: terminal device
554 * @buf: character buffer
555 * @nr: number of bytes to output
557 * Output a block of characters with OPOST processing.
558 * Returns the number of characters output.
560 * This path is used to speed up block console writes, among other
561 * things when processing blocks of output data. It handles only
562 * the simple cases normally found and helps to generate blocks of
563 * symbols for the console driver and thus improve performance.
565 * Locking: output_lock to protect column state and space left
566 * (also, this is called from n_tty_write under the
567 * tty layer write lock)
570 static ssize_t process_output_block(struct tty_struct *tty,
571 const unsigned char *buf, unsigned int nr)
573 struct n_tty_data *ldata = tty->disc_data;
574 int space;
575 int i;
576 const unsigned char *cp;
578 mutex_lock(&ldata->output_lock);
580 space = tty_write_room(tty);
581 if (!space) {
582 mutex_unlock(&ldata->output_lock);
583 return 0;
585 if (nr > space)
586 nr = space;
588 for (i = 0, cp = buf; i < nr; i++, cp++) {
589 unsigned char c = *cp;
591 switch (c) {
592 case '\n':
593 if (O_ONLRET(tty))
594 ldata->column = 0;
595 if (O_ONLCR(tty))
596 goto break_out;
597 ldata->canon_column = ldata->column;
598 break;
599 case '\r':
600 if (O_ONOCR(tty) && ldata->column == 0)
601 goto break_out;
602 if (O_OCRNL(tty))
603 goto break_out;
604 ldata->canon_column = ldata->column = 0;
605 break;
606 case '\t':
607 goto break_out;
608 case '\b':
609 if (ldata->column > 0)
610 ldata->column--;
611 break;
612 default:
613 if (!iscntrl(c)) {
614 if (O_OLCUC(tty))
615 goto break_out;
616 if (!is_continuation(c, tty))
617 ldata->column++;
619 break;
622 break_out:
623 i = tty->ops->write(tty, buf, i);
625 mutex_unlock(&ldata->output_lock);
626 return i;
630 * process_echoes - write pending echo characters
631 * @tty: terminal device
633 * Write previously buffered echo (and other ldisc-generated)
634 * characters to the tty.
636 * Characters generated by the ldisc (including echoes) need to
637 * be buffered because the driver's write buffer can fill during
638 * heavy program output. Echoing straight to the driver will
639 * often fail under these conditions, causing lost characters and
640 * resulting mismatches of ldisc state information.
642 * Since the ldisc state must represent the characters actually sent
643 * to the driver at the time of the write, operations like certain
644 * changes in column state are also saved in the buffer and executed
645 * here.
647 * A circular fifo buffer is used so that the most recent characters
648 * are prioritized. Also, when control characters are echoed with a
649 * prefixed "^", the pair is treated atomically and thus not separated.
651 * Locking: callers must hold output_lock
654 static size_t __process_echoes(struct tty_struct *tty)
656 struct n_tty_data *ldata = tty->disc_data;
657 int space, old_space;
658 size_t tail;
659 unsigned char c;
661 old_space = space = tty_write_room(tty);
663 tail = ldata->echo_tail;
664 while (ldata->echo_commit != tail) {
665 c = echo_buf(ldata, tail);
666 if (c == ECHO_OP_START) {
667 unsigned char op;
668 int no_space_left = 0;
671 * If the buffer byte is the start of a multi-byte
672 * operation, get the next byte, which is either the
673 * op code or a control character value.
675 op = echo_buf(ldata, tail + 1);
677 switch (op) {
678 unsigned int num_chars, num_bs;
680 case ECHO_OP_ERASE_TAB:
681 num_chars = echo_buf(ldata, tail + 2);
684 * Determine how many columns to go back
685 * in order to erase the tab.
686 * This depends on the number of columns
687 * used by other characters within the tab
688 * area. If this (modulo 8) count is from
689 * the start of input rather than from a
690 * previous tab, we offset by canon column.
691 * Otherwise, tab spacing is normal.
693 if (!(num_chars & 0x80))
694 num_chars += ldata->canon_column;
695 num_bs = 8 - (num_chars & 7);
697 if (num_bs > space) {
698 no_space_left = 1;
699 break;
701 space -= num_bs;
702 while (num_bs--) {
703 tty_put_char(tty, '\b');
704 if (ldata->column > 0)
705 ldata->column--;
707 tail += 3;
708 break;
710 case ECHO_OP_SET_CANON_COL:
711 ldata->canon_column = ldata->column;
712 tail += 2;
713 break;
715 case ECHO_OP_MOVE_BACK_COL:
716 if (ldata->column > 0)
717 ldata->column--;
718 tail += 2;
719 break;
721 case ECHO_OP_START:
722 /* This is an escaped echo op start code */
723 if (!space) {
724 no_space_left = 1;
725 break;
727 tty_put_char(tty, ECHO_OP_START);
728 ldata->column++;
729 space--;
730 tail += 2;
731 break;
733 default:
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.
743 if (space < 2) {
744 no_space_left = 1;
745 break;
747 tty_put_char(tty, '^');
748 tty_put_char(tty, op ^ 0100);
749 ldata->column += 2;
750 space -= 2;
751 tail += 2;
754 if (no_space_left)
755 break;
756 } else {
757 if (O_OPOST(tty)) {
758 int retval = do_output_char(c, tty, space);
759 if (retval < 0)
760 break;
761 space -= retval;
762 } else {
763 if (!space)
764 break;
765 tty_put_char(tty, c);
766 space -= 1;
768 tail += 1;
772 /* If the echo buffer is nearly full (so that the possibility exists
773 * of echo overrun before the next commit), then discard enough
774 * data at the tail to prevent a subsequent overrun */
775 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
776 if (echo_buf(ldata, tail) == ECHO_OP_START) {
777 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
778 tail += 3;
779 else
780 tail += 2;
781 } else
782 tail++;
785 ldata->echo_tail = tail;
786 return old_space - space;
789 static void commit_echoes(struct tty_struct *tty)
791 struct n_tty_data *ldata = tty->disc_data;
792 size_t nr, old, echoed;
793 size_t head;
795 head = ldata->echo_head;
796 ldata->echo_mark = head;
797 old = ldata->echo_commit - ldata->echo_tail;
799 /* Process committed echoes if the accumulated # of bytes
800 * is over the threshold (and try again each time another
801 * block is accumulated) */
802 nr = head - ldata->echo_tail;
803 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
804 return;
806 mutex_lock(&ldata->output_lock);
807 ldata->echo_commit = head;
808 echoed = __process_echoes(tty);
809 mutex_unlock(&ldata->output_lock);
811 if (echoed && tty->ops->flush_chars)
812 tty->ops->flush_chars(tty);
815 static void process_echoes(struct tty_struct *tty)
817 struct n_tty_data *ldata = tty->disc_data;
818 size_t echoed;
820 if (ldata->echo_mark == ldata->echo_tail)
821 return;
823 mutex_lock(&ldata->output_lock);
824 ldata->echo_commit = ldata->echo_mark;
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 /* NB: echo_mark and echo_head should be equivalent here */
833 static void flush_echoes(struct tty_struct *tty)
835 struct n_tty_data *ldata = tty->disc_data;
837 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
838 ldata->echo_commit == ldata->echo_head)
839 return;
841 mutex_lock(&ldata->output_lock);
842 ldata->echo_commit = ldata->echo_head;
843 __process_echoes(tty);
844 mutex_unlock(&ldata->output_lock);
848 * add_echo_byte - add a byte to the echo buffer
849 * @c: unicode byte to echo
850 * @ldata: n_tty data
852 * Add a character or operation byte to the echo buffer.
855 static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
857 *echo_buf_addr(ldata, ldata->echo_head++) = c;
861 * echo_move_back_col - add operation to move back a column
862 * @ldata: n_tty data
864 * Add an operation to the echo buffer to move back one column.
867 static void echo_move_back_col(struct n_tty_data *ldata)
869 add_echo_byte(ECHO_OP_START, ldata);
870 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
874 * echo_set_canon_col - add operation to set the canon column
875 * @ldata: n_tty data
877 * Add an operation to the echo buffer to set the canon column
878 * to the current column.
881 static void echo_set_canon_col(struct n_tty_data *ldata)
883 add_echo_byte(ECHO_OP_START, ldata);
884 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
888 * echo_erase_tab - add operation to erase a tab
889 * @num_chars: number of character columns already used
890 * @after_tab: true if num_chars starts after a previous tab
891 * @ldata: n_tty data
893 * Add an operation to the echo buffer to erase a tab.
895 * Called by the eraser function, which knows how many character
896 * columns have been used since either a previous tab or the start
897 * of input. This information will be used later, along with
898 * canon column (if applicable), to go back the correct number
899 * of columns.
902 static void echo_erase_tab(unsigned int num_chars, int after_tab,
903 struct n_tty_data *ldata)
905 add_echo_byte(ECHO_OP_START, ldata);
906 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
908 /* We only need to know this modulo 8 (tab spacing) */
909 num_chars &= 7;
911 /* Set the high bit as a flag if num_chars is after a previous tab */
912 if (after_tab)
913 num_chars |= 0x80;
915 add_echo_byte(num_chars, ldata);
919 * echo_char_raw - echo a character raw
920 * @c: unicode byte to echo
921 * @tty: terminal device
923 * Echo user input back onto the screen. This must be called only when
924 * L_ECHO(tty) is true. Called from the driver receive_buf path.
926 * This variant does not treat control characters specially.
929 static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
931 if (c == ECHO_OP_START) {
932 add_echo_byte(ECHO_OP_START, ldata);
933 add_echo_byte(ECHO_OP_START, ldata);
934 } else {
935 add_echo_byte(c, ldata);
940 * echo_char - echo a character
941 * @c: unicode byte to echo
942 * @tty: terminal device
944 * Echo user input back onto the screen. This must be called only when
945 * L_ECHO(tty) is true. Called from the driver receive_buf path.
947 * This variant tags control characters to be echoed as "^X"
948 * (where X is the letter representing the control char).
951 static void echo_char(unsigned char c, struct tty_struct *tty)
953 struct n_tty_data *ldata = tty->disc_data;
955 if (c == ECHO_OP_START) {
956 add_echo_byte(ECHO_OP_START, ldata);
957 add_echo_byte(ECHO_OP_START, ldata);
958 } else {
959 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
960 add_echo_byte(ECHO_OP_START, ldata);
961 add_echo_byte(c, ldata);
966 * finish_erasing - complete erase
967 * @ldata: n_tty data
970 static inline void finish_erasing(struct n_tty_data *ldata)
972 if (ldata->erasing) {
973 echo_char_raw('/', ldata);
974 ldata->erasing = 0;
979 * eraser - handle erase function
980 * @c: character input
981 * @tty: terminal device
983 * Perform erase and necessary output when an erase character is
984 * present in the stream from the driver layer. Handles the complexities
985 * of UTF-8 multibyte symbols.
987 * n_tty_receive_buf()/producer path:
988 * caller holds non-exclusive termios_rwsem
989 * modifies read_head
991 * Modifying the read_head is not considered a publish in this context
992 * because canonical mode is active -- only canon_head publishes
995 static void eraser(unsigned char c, struct tty_struct *tty)
997 struct n_tty_data *ldata = tty->disc_data;
998 enum { ERASE, WERASE, KILL } kill_type;
999 size_t head;
1000 size_t cnt;
1001 int seen_alnums;
1003 if (ldata->read_head == ldata->canon_head) {
1004 /* process_output('\a', tty); */ /* what do you think? */
1005 return;
1007 if (c == ERASE_CHAR(tty))
1008 kill_type = ERASE;
1009 else if (c == WERASE_CHAR(tty))
1010 kill_type = WERASE;
1011 else {
1012 if (!L_ECHO(tty)) {
1013 ldata->read_head = ldata->canon_head;
1014 return;
1016 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
1017 ldata->read_head = ldata->canon_head;
1018 finish_erasing(ldata);
1019 echo_char(KILL_CHAR(tty), tty);
1020 /* Add a newline if ECHOK is on and ECHOKE is off. */
1021 if (L_ECHOK(tty))
1022 echo_char_raw('\n', ldata);
1023 return;
1025 kill_type = KILL;
1028 seen_alnums = 0;
1029 while (ldata->read_head != ldata->canon_head) {
1030 head = ldata->read_head;
1032 /* erase a single possibly multibyte character */
1033 do {
1034 head--;
1035 c = read_buf(ldata, head);
1036 } while (is_continuation(c, tty) && head != ldata->canon_head);
1038 /* do not partially erase */
1039 if (is_continuation(c, tty))
1040 break;
1042 if (kill_type == WERASE) {
1043 /* Equivalent to BSD's ALTWERASE. */
1044 if (isalnum(c) || c == '_')
1045 seen_alnums++;
1046 else if (seen_alnums)
1047 break;
1049 cnt = ldata->read_head - head;
1050 ldata->read_head = head;
1051 if (L_ECHO(tty)) {
1052 if (L_ECHOPRT(tty)) {
1053 if (!ldata->erasing) {
1054 echo_char_raw('\\', ldata);
1055 ldata->erasing = 1;
1057 /* if cnt > 1, output a multi-byte character */
1058 echo_char(c, tty);
1059 while (--cnt > 0) {
1060 head++;
1061 echo_char_raw(read_buf(ldata, head), ldata);
1062 echo_move_back_col(ldata);
1064 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1065 echo_char(ERASE_CHAR(tty), tty);
1066 } else if (c == '\t') {
1067 unsigned int num_chars = 0;
1068 int after_tab = 0;
1069 size_t tail = ldata->read_head;
1072 * Count the columns used for characters
1073 * since the start of input or after a
1074 * previous tab.
1075 * This info is used to go back the correct
1076 * number of columns.
1078 while (tail != ldata->canon_head) {
1079 tail--;
1080 c = read_buf(ldata, tail);
1081 if (c == '\t') {
1082 after_tab = 1;
1083 break;
1084 } else if (iscntrl(c)) {
1085 if (L_ECHOCTL(tty))
1086 num_chars += 2;
1087 } else if (!is_continuation(c, tty)) {
1088 num_chars++;
1091 echo_erase_tab(num_chars, after_tab, ldata);
1092 } else {
1093 if (iscntrl(c) && L_ECHOCTL(tty)) {
1094 echo_char_raw('\b', ldata);
1095 echo_char_raw(' ', ldata);
1096 echo_char_raw('\b', ldata);
1098 if (!iscntrl(c) || L_ECHOCTL(tty)) {
1099 echo_char_raw('\b', ldata);
1100 echo_char_raw(' ', ldata);
1101 echo_char_raw('\b', ldata);
1105 if (kill_type == ERASE)
1106 break;
1108 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
1109 finish_erasing(ldata);
1113 * isig - handle the ISIG optio
1114 * @sig: signal
1115 * @tty: terminal
1117 * Called when a signal is being sent due to terminal input.
1118 * Called from the driver receive_buf path so serialized.
1120 * Locking: ctrl_lock
1123 static void isig(int sig, struct tty_struct *tty)
1125 struct pid *tty_pgrp = tty_get_pgrp(tty);
1126 if (tty_pgrp) {
1127 kill_pgrp(tty_pgrp, sig, 1);
1128 put_pid(tty_pgrp);
1133 * n_tty_receive_break - handle break
1134 * @tty: terminal
1136 * An RS232 break event has been hit in the incoming bitstream. This
1137 * can cause a variety of events depending upon the termios settings.
1139 * n_tty_receive_buf()/producer path:
1140 * caller holds non-exclusive termios_rwsem
1141 * publishes read_head via put_tty_queue()
1143 * Note: may get exclusive termios_rwsem if flushing input buffer
1146 static void n_tty_receive_break(struct tty_struct *tty)
1148 struct n_tty_data *ldata = tty->disc_data;
1150 if (I_IGNBRK(tty))
1151 return;
1152 if (I_BRKINT(tty)) {
1153 isig(SIGINT, tty);
1154 if (!L_NOFLSH(tty)) {
1155 /* flushing needs exclusive termios_rwsem */
1156 up_read(&tty->termios_rwsem);
1157 n_tty_flush_buffer(tty);
1158 tty_driver_flush_buffer(tty);
1159 down_read(&tty->termios_rwsem);
1161 return;
1163 if (I_PARMRK(tty)) {
1164 put_tty_queue('\377', ldata);
1165 put_tty_queue('\0', ldata);
1167 put_tty_queue('\0', ldata);
1168 if (waitqueue_active(&tty->read_wait))
1169 wake_up_interruptible(&tty->read_wait);
1173 * n_tty_receive_overrun - handle overrun reporting
1174 * @tty: terminal
1176 * Data arrived faster than we could process it. While the tty
1177 * driver has flagged this the bits that were missed are gone
1178 * forever.
1180 * Called from the receive_buf path so single threaded. Does not
1181 * need locking as num_overrun and overrun_time are function
1182 * private.
1185 static void n_tty_receive_overrun(struct tty_struct *tty)
1187 struct n_tty_data *ldata = tty->disc_data;
1188 char buf[64];
1190 ldata->num_overrun++;
1191 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1192 time_after(ldata->overrun_time, jiffies)) {
1193 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1194 tty_name(tty, buf),
1195 ldata->num_overrun);
1196 ldata->overrun_time = jiffies;
1197 ldata->num_overrun = 0;
1202 * n_tty_receive_parity_error - error notifier
1203 * @tty: terminal device
1204 * @c: character
1206 * Process a parity error and queue the right data to indicate
1207 * the error case if necessary.
1209 * n_tty_receive_buf()/producer path:
1210 * caller holds non-exclusive termios_rwsem
1211 * publishes read_head via put_tty_queue()
1213 static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
1215 struct n_tty_data *ldata = tty->disc_data;
1217 if (I_IGNPAR(tty))
1218 return;
1219 if (I_PARMRK(tty)) {
1220 put_tty_queue('\377', ldata);
1221 put_tty_queue('\0', ldata);
1222 put_tty_queue(c, ldata);
1223 } else if (I_INPCK(tty))
1224 put_tty_queue('\0', ldata);
1225 else
1226 put_tty_queue(c, ldata);
1227 if (waitqueue_active(&tty->read_wait))
1228 wake_up_interruptible(&tty->read_wait);
1231 static void
1232 n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1234 if (!L_NOFLSH(tty)) {
1235 /* flushing needs exclusive termios_rwsem */
1236 up_read(&tty->termios_rwsem);
1237 n_tty_flush_buffer(tty);
1238 tty_driver_flush_buffer(tty);
1239 down_read(&tty->termios_rwsem);
1241 if (I_IXON(tty))
1242 start_tty(tty);
1243 if (L_ECHO(tty)) {
1244 echo_char(c, tty);
1245 commit_echoes(tty);
1246 } else
1247 process_echoes(tty);
1248 isig(signal, tty);
1249 return;
1253 * n_tty_receive_char - perform processing
1254 * @tty: terminal device
1255 * @c: character
1257 * Process an individual character of input received from the driver.
1258 * This is serialized with respect to itself by the rules for the
1259 * driver above.
1261 * n_tty_receive_buf()/producer path:
1262 * caller holds non-exclusive termios_rwsem
1263 * publishes canon_head if canonical mode is active
1264 * otherwise, publishes read_head via put_tty_queue()
1266 * Returns 1 if LNEXT was received, else returns 0
1269 static int
1270 n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
1272 struct n_tty_data *ldata = tty->disc_data;
1274 if (I_IXON(tty)) {
1275 if (c == START_CHAR(tty)) {
1276 start_tty(tty);
1277 process_echoes(tty);
1278 return 0;
1280 if (c == STOP_CHAR(tty)) {
1281 stop_tty(tty);
1282 return 0;
1286 if (L_ISIG(tty)) {
1287 if (c == INTR_CHAR(tty)) {
1288 n_tty_receive_signal_char(tty, SIGINT, c);
1289 return 0;
1290 } else if (c == QUIT_CHAR(tty)) {
1291 n_tty_receive_signal_char(tty, SIGQUIT, c);
1292 return 0;
1293 } else if (c == SUSP_CHAR(tty)) {
1294 n_tty_receive_signal_char(tty, SIGTSTP, c);
1295 return 0;
1299 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1300 start_tty(tty);
1301 process_echoes(tty);
1304 if (c == '\r') {
1305 if (I_IGNCR(tty))
1306 return 0;
1307 if (I_ICRNL(tty))
1308 c = '\n';
1309 } else if (c == '\n' && I_INLCR(tty))
1310 c = '\r';
1312 if (ldata->icanon) {
1313 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1314 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1315 eraser(c, tty);
1316 commit_echoes(tty);
1317 return 0;
1319 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
1320 ldata->lnext = 1;
1321 if (L_ECHO(tty)) {
1322 finish_erasing(ldata);
1323 if (L_ECHOCTL(tty)) {
1324 echo_char_raw('^', ldata);
1325 echo_char_raw('\b', ldata);
1326 commit_echoes(tty);
1329 return 1;
1331 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
1332 size_t tail = ldata->canon_head;
1334 finish_erasing(ldata);
1335 echo_char(c, tty);
1336 echo_char_raw('\n', ldata);
1337 while (tail != ldata->read_head) {
1338 echo_char(read_buf(ldata, tail), tty);
1339 tail++;
1341 commit_echoes(tty);
1342 return 0;
1344 if (c == '\n') {
1345 if (L_ECHO(tty) || L_ECHONL(tty)) {
1346 echo_char_raw('\n', ldata);
1347 commit_echoes(tty);
1349 goto handle_newline;
1351 if (c == EOF_CHAR(tty)) {
1352 c = __DISABLED_CHAR;
1353 goto handle_newline;
1355 if ((c == EOL_CHAR(tty)) ||
1356 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1358 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1360 if (L_ECHO(tty)) {
1361 /* Record the column of first canon char. */
1362 if (ldata->canon_head == ldata->read_head)
1363 echo_set_canon_col(ldata);
1364 echo_char(c, tty);
1365 commit_echoes(tty);
1368 * XXX does PARMRK doubling happen for
1369 * EOL_CHAR and EOL2_CHAR?
1371 if (c == (unsigned char) '\377' && I_PARMRK(tty))
1372 put_tty_queue(c, ldata);
1374 handle_newline:
1375 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
1376 put_tty_queue(c, ldata);
1377 ldata->canon_head = ldata->read_head;
1378 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1379 if (waitqueue_active(&tty->read_wait))
1380 wake_up_interruptible(&tty->read_wait);
1381 return 0;
1385 if (L_ECHO(tty)) {
1386 finish_erasing(ldata);
1387 if (c == '\n')
1388 echo_char_raw('\n', ldata);
1389 else {
1390 /* Record the column of first canon char. */
1391 if (ldata->canon_head == ldata->read_head)
1392 echo_set_canon_col(ldata);
1393 echo_char(c, tty);
1395 commit_echoes(tty);
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);
1403 return 0;
1406 static inline void
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)) {
1412 start_tty(tty);
1413 process_echoes(tty);
1415 if (L_ECHO(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);
1420 echo_char(c, tty);
1421 commit_echoes(tty);
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);
1434 static inline void
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)) {
1440 start_tty(tty);
1441 process_echoes(tty);
1443 if (L_ECHO(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);
1448 echo_char(c, tty);
1449 commit_echoes(tty);
1451 put_tty_queue(c, ldata);
1454 static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
1456 if (I_ISTRIP(tty))
1457 c &= 0x7f;
1458 if (I_IUCLC(tty) && L_IEXTEN(tty))
1459 c = tolower(c);
1461 if (I_IXON(tty)) {
1462 if (c == STOP_CHAR(tty))
1463 stop_tty(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))) {
1468 start_tty(tty);
1469 process_echoes(tty);
1474 static void
1475 n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1477 char buf[64];
1479 switch (flag) {
1480 case TTY_BREAK:
1481 n_tty_receive_break(tty);
1482 break;
1483 case TTY_PARITY:
1484 case TTY_FRAME:
1485 n_tty_receive_parity_error(tty, c);
1486 break;
1487 case TTY_OVERRUN:
1488 n_tty_receive_overrun(tty);
1489 break;
1490 default:
1491 printk(KERN_ERR "%s: unknown flag %d\n",
1492 tty_name(tty, buf), flag);
1493 break;
1497 static void
1498 n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1500 struct n_tty_data *ldata = tty->disc_data;
1502 ldata->lnext = 0;
1503 if (likely(flag == TTY_NORMAL)) {
1504 if (I_ISTRIP(tty))
1505 c &= 0x7f;
1506 if (I_IUCLC(tty) && L_IEXTEN(tty))
1507 c = tolower(c);
1508 n_tty_receive_char(tty, c);
1509 } else
1510 n_tty_receive_char_flagged(tty, c, flag);
1514 * n_tty_receive_buf - data receive
1515 * @tty: terminal device
1516 * @cp: buffer
1517 * @fp: flag buffer
1518 * @count: characters
1520 * Called by the terminal driver when a block of characters has
1521 * been received. This function must be called from soft contexts
1522 * not from interrupt context. The driver is responsible for making
1523 * calls one at a time and in order (or using flush_to_ldisc)
1525 * n_tty_receive_buf()/producer path:
1526 * claims non-exclusive termios_rwsem
1527 * publishes read_head and canon_head
1530 static void
1531 n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1532 char *fp, int count)
1534 struct n_tty_data *ldata = tty->disc_data;
1535 size_t n, head;
1537 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1538 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1539 n = min_t(size_t, count, n);
1540 memcpy(read_buf_addr(ldata, head), cp, n);
1541 ldata->read_head += n;
1542 cp += n;
1543 count -= n;
1545 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1546 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1547 n = min_t(size_t, count, n);
1548 memcpy(read_buf_addr(ldata, head), cp, n);
1549 ldata->read_head += n;
1552 static void
1553 n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1554 char *fp, int count)
1556 struct n_tty_data *ldata = tty->disc_data;
1557 char flag = TTY_NORMAL;
1559 while (count--) {
1560 if (fp)
1561 flag = *fp++;
1562 if (likely(flag == TTY_NORMAL))
1563 put_tty_queue(*cp++, ldata);
1564 else
1565 n_tty_receive_char_flagged(tty, *cp++, flag);
1569 static void
1570 n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1571 char *fp, int count)
1573 char flag = TTY_NORMAL;
1575 while (count--) {
1576 if (fp)
1577 flag = *fp++;
1578 if (likely(flag == TTY_NORMAL))
1579 n_tty_receive_char_closing(tty, *cp++);
1580 else
1581 n_tty_receive_char_flagged(tty, *cp++, flag);
1585 static void
1586 n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
1587 char *fp, int count)
1589 struct n_tty_data *ldata = tty->disc_data;
1590 char flag = TTY_NORMAL;
1592 while (count--) {
1593 if (fp)
1594 flag = *fp++;
1595 if (likely(flag == TTY_NORMAL)) {
1596 unsigned char c = *cp++;
1598 if (I_ISTRIP(tty))
1599 c &= 0x7f;
1600 if (I_IUCLC(tty) && L_IEXTEN(tty))
1601 c = tolower(c);
1602 if (L_EXTPROC(tty)) {
1603 put_tty_queue(c, ldata);
1604 continue;
1606 if (!test_bit(c, ldata->char_map))
1607 n_tty_receive_char_inline(tty, c);
1608 else if (n_tty_receive_char_special(tty, c) && count) {
1609 if (fp)
1610 flag = *fp++;
1611 n_tty_receive_char_lnext(tty, *cp++, flag);
1612 count--;
1614 } else
1615 n_tty_receive_char_flagged(tty, *cp++, flag);
1619 static void
1620 n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1621 char *fp, int count)
1623 struct n_tty_data *ldata = tty->disc_data;
1624 char flag = TTY_NORMAL;
1626 while (count--) {
1627 if (fp)
1628 flag = *fp++;
1629 if (likely(flag == TTY_NORMAL)) {
1630 unsigned char c = *cp++;
1632 if (!test_bit(c, ldata->char_map))
1633 n_tty_receive_char_fast(tty, c);
1634 else if (n_tty_receive_char_special(tty, c) && count) {
1635 if (fp)
1636 flag = *fp++;
1637 n_tty_receive_char_lnext(tty, *cp++, flag);
1638 count--;
1640 } else
1641 n_tty_receive_char_flagged(tty, *cp++, flag);
1645 static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1646 char *fp, int count)
1648 struct n_tty_data *ldata = tty->disc_data;
1649 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
1651 if (ldata->real_raw)
1652 n_tty_receive_buf_real_raw(tty, cp, fp, count);
1653 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
1654 n_tty_receive_buf_raw(tty, cp, fp, count);
1655 else if (tty->closing && !L_EXTPROC(tty))
1656 n_tty_receive_buf_closing(tty, cp, fp, count);
1657 else {
1658 if (ldata->lnext) {
1659 char flag = TTY_NORMAL;
1661 if (fp)
1662 flag = *fp++;
1663 n_tty_receive_char_lnext(tty, *cp++, flag);
1664 count--;
1667 if (!preops && !I_PARMRK(tty))
1668 n_tty_receive_buf_fast(tty, cp, fp, count);
1669 else
1670 n_tty_receive_buf_standard(tty, cp, fp, count);
1672 flush_echoes(tty);
1673 if (tty->ops->flush_chars)
1674 tty->ops->flush_chars(tty);
1677 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
1678 L_EXTPROC(tty)) {
1679 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1680 if (waitqueue_active(&tty->read_wait))
1681 wake_up_interruptible(&tty->read_wait);
1685 static int
1686 n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1687 char *fp, int count, int flow)
1689 struct n_tty_data *ldata = tty->disc_data;
1690 int room, n, rcvd = 0;
1692 down_read(&tty->termios_rwsem);
1694 while (1) {
1695 room = receive_room(tty);
1696 n = min(count, room);
1697 if (!n) {
1698 if (flow && !room)
1699 ldata->no_room = 1;
1700 break;
1702 __receive_buf(tty, cp, fp, n);
1703 cp += n;
1704 if (fp)
1705 fp += n;
1706 count -= n;
1707 rcvd += n;
1710 tty->receive_room = room;
1711 n_tty_check_throttle(tty);
1712 up_read(&tty->termios_rwsem);
1714 return rcvd;
1717 static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1718 char *fp, int count)
1720 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1723 static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1724 char *fp, int count)
1726 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1729 int is_ignored(int sig)
1731 return (sigismember(&current->blocked, sig) ||
1732 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
1736 * n_tty_set_termios - termios data changed
1737 * @tty: terminal
1738 * @old: previous data
1740 * Called by the tty layer when the user changes termios flags so
1741 * that the line discipline can plan ahead. This function cannot sleep
1742 * and is protected from re-entry by the tty layer. The user is
1743 * guaranteed that this function will not be re-entered or in progress
1744 * when the ldisc is closed.
1746 * Locking: Caller holds tty->termios_rwsem
1749 static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
1751 struct n_tty_data *ldata = tty->disc_data;
1753 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
1754 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
1755 ldata->line_start = ldata->read_tail;
1756 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1757 ldata->canon_head = ldata->read_tail;
1758 ldata->push = 0;
1759 } else {
1760 set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1761 ldata->read_flags);
1762 ldata->canon_head = ldata->read_head;
1763 ldata->push = 1;
1765 ldata->erasing = 0;
1766 ldata->lnext = 0;
1769 ldata->icanon = (L_ICANON(tty) != 0);
1771 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1772 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1773 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1774 I_PARMRK(tty)) {
1775 bitmap_zero(ldata->char_map, 256);
1777 if (I_IGNCR(tty) || I_ICRNL(tty))
1778 set_bit('\r', ldata->char_map);
1779 if (I_INLCR(tty))
1780 set_bit('\n', ldata->char_map);
1782 if (L_ICANON(tty)) {
1783 set_bit(ERASE_CHAR(tty), ldata->char_map);
1784 set_bit(KILL_CHAR(tty), ldata->char_map);
1785 set_bit(EOF_CHAR(tty), ldata->char_map);
1786 set_bit('\n', ldata->char_map);
1787 set_bit(EOL_CHAR(tty), ldata->char_map);
1788 if (L_IEXTEN(tty)) {
1789 set_bit(WERASE_CHAR(tty), ldata->char_map);
1790 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1791 set_bit(EOL2_CHAR(tty), ldata->char_map);
1792 if (L_ECHO(tty))
1793 set_bit(REPRINT_CHAR(tty),
1794 ldata->char_map);
1797 if (I_IXON(tty)) {
1798 set_bit(START_CHAR(tty), ldata->char_map);
1799 set_bit(STOP_CHAR(tty), ldata->char_map);
1801 if (L_ISIG(tty)) {
1802 set_bit(INTR_CHAR(tty), ldata->char_map);
1803 set_bit(QUIT_CHAR(tty), ldata->char_map);
1804 set_bit(SUSP_CHAR(tty), ldata->char_map);
1806 clear_bit(__DISABLED_CHAR, ldata->char_map);
1807 ldata->raw = 0;
1808 ldata->real_raw = 0;
1809 } else {
1810 ldata->raw = 1;
1811 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1812 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1813 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
1814 ldata->real_raw = 1;
1815 else
1816 ldata->real_raw = 0;
1818 n_tty_set_room(tty);
1820 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1821 * been stopped by STOP_CHAR(tty) before it.
1823 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
1824 start_tty(tty);
1825 process_echoes(tty);
1828 /* The termios change make the tty ready for I/O */
1829 if (waitqueue_active(&tty->write_wait))
1830 wake_up_interruptible(&tty->write_wait);
1831 if (waitqueue_active(&tty->read_wait))
1832 wake_up_interruptible(&tty->read_wait);
1836 * n_tty_close - close the ldisc for this tty
1837 * @tty: device
1839 * Called from the terminal layer when this line discipline is
1840 * being shut down, either because of a close or becsuse of a
1841 * discipline change. The function will not be called while other
1842 * ldisc methods are in progress.
1845 static void n_tty_close(struct tty_struct *tty)
1847 struct n_tty_data *ldata = tty->disc_data;
1849 if (tty->link)
1850 n_tty_packet_mode_flush(tty);
1852 vfree(ldata);
1853 tty->disc_data = NULL;
1857 * n_tty_open - open an ldisc
1858 * @tty: terminal to open
1860 * Called when this line discipline is being attached to the
1861 * terminal device. Can sleep. Called serialized so that no
1862 * other events will occur in parallel. No further open will occur
1863 * until a close.
1866 static int n_tty_open(struct tty_struct *tty)
1868 struct n_tty_data *ldata;
1870 /* Currently a malloc failure here can panic */
1871 ldata = vmalloc(sizeof(*ldata));
1872 if (!ldata)
1873 goto err;
1875 ldata->overrun_time = jiffies;
1876 mutex_init(&ldata->atomic_read_lock);
1877 mutex_init(&ldata->output_lock);
1879 tty->disc_data = ldata;
1880 reset_buffer_flags(tty->disc_data);
1881 ldata->column = 0;
1882 ldata->canon_column = 0;
1883 ldata->minimum_to_wake = 1;
1884 ldata->num_overrun = 0;
1885 ldata->no_room = 0;
1886 ldata->lnext = 0;
1887 tty->closing = 0;
1888 /* indicate buffer work may resume */
1889 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1890 n_tty_set_termios(tty, NULL);
1891 tty_unthrottle(tty);
1893 return 0;
1894 err:
1895 return -ENOMEM;
1898 static inline int input_available_p(struct tty_struct *tty, int poll)
1900 struct n_tty_data *ldata = tty->disc_data;
1901 int amt = poll && !TIME_CHAR(tty) && MIN_CHAR(tty) ? MIN_CHAR(tty) : 1;
1903 if (ldata->icanon && !L_EXTPROC(tty)) {
1904 if (ldata->canon_head != ldata->read_tail)
1905 return 1;
1906 } else if (read_cnt(ldata) >= amt)
1907 return 1;
1909 return 0;
1913 * copy_from_read_buf - copy read data directly
1914 * @tty: terminal device
1915 * @b: user data
1916 * @nr: size of data
1918 * Helper function to speed up n_tty_read. It is only called when
1919 * ICANON is off; it copies characters straight from the tty queue to
1920 * user space directly. It can be profitably called twice; once to
1921 * drain the space from the tail pointer to the (physical) end of the
1922 * buffer, and once to drain the space from the (physical) beginning of
1923 * the buffer to head pointer.
1925 * Called under the ldata->atomic_read_lock sem
1927 * n_tty_read()/consumer path:
1928 * caller holds non-exclusive termios_rwsem
1929 * read_tail published
1932 static int copy_from_read_buf(struct tty_struct *tty,
1933 unsigned char __user **b,
1934 size_t *nr)
1937 struct n_tty_data *ldata = tty->disc_data;
1938 int retval;
1939 size_t n;
1940 bool is_eof;
1941 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
1943 retval = 0;
1944 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
1945 n = min(*nr, n);
1946 if (n) {
1947 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
1948 n -= retval;
1949 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1950 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
1951 ldata->icanon);
1952 ldata->read_tail += n;
1953 /* Turn single EOF into zero-length read */
1954 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
1955 n = 0;
1956 *b += n;
1957 *nr -= n;
1959 return retval;
1963 * canon_copy_from_read_buf - copy read data in canonical mode
1964 * @tty: terminal device
1965 * @b: user data
1966 * @nr: size of data
1968 * Helper function for n_tty_read. It is only called when ICANON is on;
1969 * it copies one line of input up to and including the line-delimiting
1970 * character into the user-space buffer.
1972 * NB: When termios is changed from non-canonical to canonical mode and
1973 * the read buffer contains data, n_tty_set_termios() simulates an EOF
1974 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
1975 * This causes data already processed as input to be immediately available
1976 * as input although a newline has not been received.
1978 * Called under the atomic_read_lock mutex
1980 * n_tty_read()/consumer path:
1981 * caller holds non-exclusive termios_rwsem
1982 * read_tail published
1985 static int canon_copy_from_read_buf(struct tty_struct *tty,
1986 unsigned char __user **b,
1987 size_t *nr)
1989 struct n_tty_data *ldata = tty->disc_data;
1990 size_t n, size, more, c;
1991 size_t eol;
1992 size_t tail;
1993 int ret, found = 0;
1994 bool eof_push = 0;
1996 /* N.B. avoid overrun if nr == 0 */
1997 n = min(*nr, read_cnt(ldata));
1998 if (!n)
1999 return 0;
2001 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
2002 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
2004 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
2005 __func__, *nr, tail, n, size);
2007 eol = find_next_bit(ldata->read_flags, size, tail);
2008 more = n - (size - tail);
2009 if (eol == N_TTY_BUF_SIZE && more) {
2010 /* scan wrapped without finding set bit */
2011 eol = find_next_bit(ldata->read_flags, more, 0);
2012 if (eol != more)
2013 found = 1;
2014 } else if (eol != size)
2015 found = 1;
2017 size = N_TTY_BUF_SIZE - tail;
2018 n = eol - tail;
2019 if (n > 4096)
2020 n += 4096;
2021 n += found;
2022 c = n;
2024 if (found && !ldata->push && read_buf(ldata, eol) == __DISABLED_CHAR) {
2025 n--;
2026 eof_push = !n && ldata->read_tail != ldata->line_start;
2029 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
2030 __func__, eol, found, n, c, size, more);
2032 if (n > size) {
2033 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
2034 if (ret)
2035 return -EFAULT;
2036 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2037 } else
2038 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
2040 if (ret)
2041 return -EFAULT;
2042 *b += n;
2043 *nr -= n;
2045 if (found)
2046 clear_bit(eol, ldata->read_flags);
2047 smp_mb__after_clear_bit();
2048 ldata->read_tail += c;
2050 if (found) {
2051 if (!ldata->push)
2052 ldata->line_start = ldata->read_tail;
2053 else
2054 ldata->push = 0;
2055 tty_audit_push(tty);
2057 return eof_push ? -EAGAIN : 0;
2060 extern ssize_t redirected_tty_write(struct file *, const char __user *,
2061 size_t, loff_t *);
2064 * job_control - check job control
2065 * @tty: tty
2066 * @file: file handle
2068 * Perform job control management checks on this file/tty descriptor
2069 * and if appropriate send any needed signals and return a negative
2070 * error code if action should be taken.
2072 * Locking: redirected write test is safe
2073 * current->signal->tty check is safe
2074 * ctrl_lock to safely reference tty->pgrp
2077 static int job_control(struct tty_struct *tty, struct file *file)
2079 /* Job control check -- must be done at start and after
2080 every sleep (POSIX.1 7.1.1.4). */
2081 /* NOTE: not yet done after every sleep pending a thorough
2082 check of the logic of this change. -- jlc */
2083 /* don't stop on /dev/console */
2084 if (file->f_op->write == redirected_tty_write ||
2085 current->signal->tty != tty)
2086 return 0;
2088 spin_lock_irq(&tty->ctrl_lock);
2089 if (!tty->pgrp)
2090 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2091 else if (task_pgrp(current) != tty->pgrp) {
2092 spin_unlock_irq(&tty->ctrl_lock);
2093 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2094 return -EIO;
2095 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2096 set_thread_flag(TIF_SIGPENDING);
2097 return -ERESTARTSYS;
2099 spin_unlock_irq(&tty->ctrl_lock);
2100 return 0;
2105 * n_tty_read - read function for tty
2106 * @tty: tty device
2107 * @file: file object
2108 * @buf: userspace buffer pointer
2109 * @nr: size of I/O
2111 * Perform reads for the line discipline. We are guaranteed that the
2112 * line discipline will not be closed under us but we may get multiple
2113 * parallel readers and must handle this ourselves. We may also get
2114 * a hangup. Always called in user context, may sleep.
2116 * This code must be sure never to sleep through a hangup.
2118 * n_tty_read()/consumer path:
2119 * claims non-exclusive termios_rwsem
2120 * publishes read_tail
2123 static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
2124 unsigned char __user *buf, size_t nr)
2126 struct n_tty_data *ldata = tty->disc_data;
2127 unsigned char __user *b = buf;
2128 DECLARE_WAITQUEUE(wait, current);
2129 int c;
2130 int minimum, time;
2131 ssize_t retval = 0;
2132 long timeout;
2133 unsigned long flags;
2134 int packet;
2136 c = job_control(tty, file);
2137 if (c < 0)
2138 return c;
2141 * Internal serialization of reads.
2143 if (file->f_flags & O_NONBLOCK) {
2144 if (!mutex_trylock(&ldata->atomic_read_lock))
2145 return -EAGAIN;
2146 } else {
2147 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2148 return -ERESTARTSYS;
2151 down_read(&tty->termios_rwsem);
2153 minimum = time = 0;
2154 timeout = MAX_SCHEDULE_TIMEOUT;
2155 if (!ldata->icanon) {
2156 minimum = MIN_CHAR(tty);
2157 if (minimum) {
2158 time = (HZ / 10) * TIME_CHAR(tty);
2159 if (time)
2160 ldata->minimum_to_wake = 1;
2161 else if (!waitqueue_active(&tty->read_wait) ||
2162 (ldata->minimum_to_wake > minimum))
2163 ldata->minimum_to_wake = minimum;
2164 } else {
2165 timeout = (HZ / 10) * TIME_CHAR(tty);
2166 ldata->minimum_to_wake = minimum = 1;
2170 packet = tty->packet;
2172 add_wait_queue(&tty->read_wait, &wait);
2173 while (nr) {
2174 /* First test for status change. */
2175 if (packet && tty->link->ctrl_status) {
2176 unsigned char cs;
2177 if (b != buf)
2178 break;
2179 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
2180 cs = tty->link->ctrl_status;
2181 tty->link->ctrl_status = 0;
2182 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
2183 if (tty_put_user(tty, cs, b++)) {
2184 retval = -EFAULT;
2185 b--;
2186 break;
2188 nr--;
2189 break;
2191 /* This statement must be first before checking for input
2192 so that any interrupt will set the state back to
2193 TASK_RUNNING. */
2194 set_current_state(TASK_INTERRUPTIBLE);
2196 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
2197 ((minimum - (b - buf)) >= 1))
2198 ldata->minimum_to_wake = (minimum - (b - buf));
2200 if (!input_available_p(tty, 0)) {
2201 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
2202 up_read(&tty->termios_rwsem);
2203 tty_flush_to_ldisc(tty);
2204 down_read(&tty->termios_rwsem);
2205 if (!input_available_p(tty, 0)) {
2206 retval = -EIO;
2207 break;
2209 } else {
2210 if (tty_hung_up_p(file))
2211 break;
2212 if (!timeout)
2213 break;
2214 if (file->f_flags & O_NONBLOCK) {
2215 retval = -EAGAIN;
2216 break;
2218 if (signal_pending(current)) {
2219 retval = -ERESTARTSYS;
2220 break;
2222 n_tty_set_room(tty);
2223 up_read(&tty->termios_rwsem);
2225 timeout = schedule_timeout(timeout);
2227 down_read(&tty->termios_rwsem);
2228 continue;
2231 __set_current_state(TASK_RUNNING);
2233 /* Deal with packet mode. */
2234 if (packet && b == buf) {
2235 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
2236 retval = -EFAULT;
2237 b--;
2238 break;
2240 nr--;
2243 if (ldata->icanon && !L_EXTPROC(tty)) {
2244 retval = canon_copy_from_read_buf(tty, &b, &nr);
2245 if (retval == -EAGAIN) {
2246 retval = 0;
2247 continue;
2248 } else if (retval)
2249 break;
2250 } else {
2251 int uncopied;
2252 /* The copy function takes the read lock and handles
2253 locking internally for this case */
2254 uncopied = copy_from_read_buf(tty, &b, &nr);
2255 uncopied += copy_from_read_buf(tty, &b, &nr);
2256 if (uncopied) {
2257 retval = -EFAULT;
2258 break;
2262 n_tty_check_unthrottle(tty);
2264 if (b - buf >= minimum)
2265 break;
2266 if (time)
2267 timeout = time;
2269 n_tty_set_room(tty);
2270 up_read(&tty->termios_rwsem);
2272 remove_wait_queue(&tty->read_wait, &wait);
2273 if (!waitqueue_active(&tty->read_wait))
2274 ldata->minimum_to_wake = minimum;
2276 mutex_unlock(&ldata->atomic_read_lock);
2278 __set_current_state(TASK_RUNNING);
2279 if (b - buf)
2280 retval = b - buf;
2282 return retval;
2286 * n_tty_write - write function for tty
2287 * @tty: tty device
2288 * @file: file object
2289 * @buf: userspace buffer pointer
2290 * @nr: size of I/O
2292 * Write function of the terminal device. This is serialized with
2293 * respect to other write callers but not to termios changes, reads
2294 * and other such events. Since the receive code will echo characters,
2295 * thus calling driver write methods, the output_lock is used in
2296 * the output processing functions called here as well as in the
2297 * echo processing function to protect the column state and space
2298 * left in the buffer.
2300 * This code must be sure never to sleep through a hangup.
2302 * Locking: output_lock to protect column state and space left
2303 * (note that the process_output*() functions take this
2304 * lock themselves)
2307 static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
2308 const unsigned char *buf, size_t nr)
2310 const unsigned char *b = buf;
2311 DECLARE_WAITQUEUE(wait, current);
2312 int c;
2313 ssize_t retval = 0;
2315 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2316 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2317 retval = tty_check_change(tty);
2318 if (retval)
2319 return retval;
2322 down_read(&tty->termios_rwsem);
2324 /* Write out any echoed characters that are still pending */
2325 process_echoes(tty);
2327 add_wait_queue(&tty->write_wait, &wait);
2328 while (1) {
2329 set_current_state(TASK_INTERRUPTIBLE);
2330 if (signal_pending(current)) {
2331 retval = -ERESTARTSYS;
2332 break;
2334 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2335 retval = -EIO;
2336 break;
2338 if (O_OPOST(tty)) {
2339 while (nr > 0) {
2340 ssize_t num = process_output_block(tty, b, nr);
2341 if (num < 0) {
2342 if (num == -EAGAIN)
2343 break;
2344 retval = num;
2345 goto break_out;
2347 b += num;
2348 nr -= num;
2349 if (nr == 0)
2350 break;
2351 c = *b;
2352 if (process_output(c, tty) < 0)
2353 break;
2354 b++; nr--;
2356 if (tty->ops->flush_chars)
2357 tty->ops->flush_chars(tty);
2358 } else {
2359 while (nr > 0) {
2360 c = tty->ops->write(tty, b, nr);
2361 if (c < 0) {
2362 retval = c;
2363 goto break_out;
2365 if (!c)
2366 break;
2367 b += c;
2368 nr -= c;
2371 if (!nr)
2372 break;
2373 if (file->f_flags & O_NONBLOCK) {
2374 retval = -EAGAIN;
2375 break;
2377 up_read(&tty->termios_rwsem);
2379 schedule();
2381 down_read(&tty->termios_rwsem);
2383 break_out:
2384 __set_current_state(TASK_RUNNING);
2385 remove_wait_queue(&tty->write_wait, &wait);
2386 if (b - buf != nr && tty->fasync)
2387 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
2388 up_read(&tty->termios_rwsem);
2389 return (b - buf) ? b - buf : retval;
2393 * n_tty_poll - poll method for N_TTY
2394 * @tty: terminal device
2395 * @file: file accessing it
2396 * @wait: poll table
2398 * Called when the line discipline is asked to poll() for data or
2399 * for special events. This code is not serialized with respect to
2400 * other events save open/close.
2402 * This code must be sure never to sleep through a hangup.
2403 * Called without the kernel lock held - fine
2406 static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
2407 poll_table *wait)
2409 struct n_tty_data *ldata = tty->disc_data;
2410 unsigned int mask = 0;
2412 poll_wait(file, &tty->read_wait, wait);
2413 poll_wait(file, &tty->write_wait, wait);
2414 if (input_available_p(tty, 1))
2415 mask |= POLLIN | POLLRDNORM;
2416 if (tty->packet && tty->link->ctrl_status)
2417 mask |= POLLPRI | POLLIN | POLLRDNORM;
2418 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2419 mask |= POLLHUP;
2420 if (tty_hung_up_p(file))
2421 mask |= POLLHUP;
2422 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2423 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
2424 ldata->minimum_to_wake = MIN_CHAR(tty);
2425 else
2426 ldata->minimum_to_wake = 1;
2428 if (tty->ops->write && !tty_is_writelocked(tty) &&
2429 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2430 tty_write_room(tty) > 0)
2431 mask |= POLLOUT | POLLWRNORM;
2432 return mask;
2435 static unsigned long inq_canon(struct n_tty_data *ldata)
2437 size_t nr, head, tail;
2439 if (ldata->canon_head == ldata->read_tail)
2440 return 0;
2441 head = ldata->canon_head;
2442 tail = ldata->read_tail;
2443 nr = head - tail;
2444 /* Skip EOF-chars.. */
2445 while (head != tail) {
2446 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2447 read_buf(ldata, tail) == __DISABLED_CHAR)
2448 nr--;
2449 tail++;
2451 return nr;
2454 static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2455 unsigned int cmd, unsigned long arg)
2457 struct n_tty_data *ldata = tty->disc_data;
2458 int retval;
2460 switch (cmd) {
2461 case TIOCOUTQ:
2462 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2463 case TIOCINQ:
2464 down_write(&tty->termios_rwsem);
2465 if (L_ICANON(tty))
2466 retval = inq_canon(ldata);
2467 else
2468 retval = read_cnt(ldata);
2469 up_write(&tty->termios_rwsem);
2470 return put_user(retval, (unsigned int __user *) arg);
2471 default:
2472 return n_tty_ioctl_helper(tty, file, cmd, arg);
2476 static void n_tty_fasync(struct tty_struct *tty, int on)
2478 struct n_tty_data *ldata = tty->disc_data;
2480 if (!waitqueue_active(&tty->read_wait)) {
2481 if (on)
2482 ldata->minimum_to_wake = 1;
2483 else if (!tty->fasync)
2484 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2488 struct tty_ldisc_ops tty_ldisc_N_TTY = {
2489 .magic = TTY_LDISC_MAGIC,
2490 .name = "n_tty",
2491 .open = n_tty_open,
2492 .close = n_tty_close,
2493 .flush_buffer = n_tty_flush_buffer,
2494 .chars_in_buffer = n_tty_chars_in_buffer,
2495 .read = n_tty_read,
2496 .write = n_tty_write,
2497 .ioctl = n_tty_ioctl,
2498 .set_termios = n_tty_set_termios,
2499 .poll = n_tty_poll,
2500 .receive_buf = n_tty_receive_buf,
2501 .write_wakeup = n_tty_write_wakeup,
2502 .fasync = n_tty_fasync,
2503 .receive_buf2 = n_tty_receive_buf2,
2507 * n_tty_inherit_ops - inherit N_TTY methods
2508 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2510 * Enables a 'subclass' line discipline to 'inherit' N_TTY
2511 * methods.
2514 void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2516 *ops = tty_ldisc_N_TTY;
2517 ops->owner = NULL;
2518 ops->refcount = ops->flags = 0;
2520 EXPORT_SYMBOL_GPL(n_tty_inherit_ops);