n_tty: Merge .receive_buf() flavors
[deliverable/linux.git] / drivers / tty / n_tty.c
CommitLineData
1da177e4
LT
1/*
2 * n_tty.c --- implements the N_TTY line discipline.
4edf1827 3 *
1da177e4
LT
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...)
8 *
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
4edf1827 11 * to N_TTY if it can not switch to any other line discipline.
1da177e4
LT
12 *
13 * Written by Theodore Ts'o, Copyright 1994.
4edf1827 14 *
1da177e4
LT
15 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
4edf1827 17 *
1da177e4
LT
18 * This file may be redistributed under the terms of the GNU General Public
19 * License.
20 *
21 * Reduced memory usage for older ARM systems - Russell King.
22 *
4edf1827 23 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
1da177e4
LT
24 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
26 *
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
11a96d18 29 * Also fixed a bug in BLOCKING mode where n_tty_write returns
1da177e4
LT
30 * EAGAIN
31 */
32
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>
522ed776
MT
48#include <linux/audit.h>
49#include <linux/file.h>
300a6204 50#include <linux/uaccess.h>
572b9adb 51#include <linux/module.h>
593fb1ae 52#include <linux/ratelimit.h>
86e35aea 53#include <linux/vmalloc.h>
1da177e4 54
1da177e4
LT
55
56/* number of characters left in xmit buffer before select has we have room */
57#define WAKEUP_CHARS 256
58
59/*
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.
63 */
64#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
bbd20759 65#define TTY_THRESHOLD_UNTHROTTLE 128
1da177e4 66
a88a69c9
JP
67/*
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.
72 */
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
77
cbfd0340
PH
78#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
32f13521
PH
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
89
70ece7a7 90struct n_tty_data {
fb7aa03d
PH
91 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
9dfd16dd
PH
94 size_t echo_head;
95 size_t echo_commit;
1bb9d562 96 DECLARE_BITMAP(char_map, 256);
fb7aa03d
PH
97
98 /* private to n_tty_receive_overrun (single-threaded) */
53c5ee2c
JS
99 unsigned long overrun_time;
100 int num_overrun;
101
24a89d1c
PH
102 /* non-atomic */
103 bool no_room;
104
fb7aa03d 105 /* must hold exclusive termios_rwsem to reset these */
53c5ee2c 106 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
3fe780b3 107
fb7aa03d 108 /* shared by producer and consumer */
20bafb3d 109 char read_buf[N_TTY_BUF_SIZE];
3fe780b3 110 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
20bafb3d 111 unsigned char echo_buf[N_TTY_BUF_SIZE];
ba2e68ac 112
f6c8dbe6 113 int minimum_to_wake;
ba2e68ac 114
fb7aa03d
PH
115 /* consumer-published */
116 size_t read_tail;
40d5e090 117 size_t line_start;
fb7aa03d 118
fb7aa03d
PH
119 /* protected by output lock */
120 unsigned int column;
ba2e68ac 121 unsigned int canon_column;
9dfd16dd 122 size_t echo_tail;
bddc7152
JS
123
124 struct mutex atomic_read_lock;
125 struct mutex output_lock;
70ece7a7
JS
126};
127
ce74117a
PH
128static inline size_t read_cnt(struct n_tty_data *ldata)
129{
a2f73be8 130 return ldata->read_head - ldata->read_tail;
ce74117a
PH
131}
132
bc5a5e3f
PH
133static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
134{
135 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
136}
137
138static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
139{
140 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
141}
142
addaebcc
PH
143static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
144{
145 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
146}
147
148static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
149{
150 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
151}
152
522ed776
MT
153static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
154 unsigned char __user *ptr)
155{
53c5ee2c
JS
156 struct n_tty_data *ldata = tty->disc_data;
157
158 tty_audit_add_data(tty, &x, 1, ldata->icanon);
522ed776
MT
159 return put_user(x, ptr);
160}
161
24a89d1c 162static int receive_room(struct tty_struct *tty)
55db4c64 163{
53c5ee2c 164 struct n_tty_data *ldata = tty->disc_data;
090abf7b 165 int left;
55db4c64 166
090abf7b
JA
167 if (I_PARMRK(tty)) {
168 /* Multiply read_cnt by 3, since each byte might take up to
169 * three times as many spaces when PARMRK is set (depending on
170 * its flags, e.g. parity error). */
ce74117a 171 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
090abf7b 172 } else
ce74117a 173 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
090abf7b 174
55db4c64
LT
175 /*
176 * If we are doing input canonicalization, and there are no
177 * pending newlines, let characters through without limit, so
178 * that erase characters will be handled. Other excess
179 * characters will be beeped.
180 */
181 if (left <= 0)
a73d3d69 182 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
55db4c64 183
24a89d1c 184 return left;
7879a9f9
PH
185}
186
24a89d1c
PH
187/**
188 * n_tty_set_room - receive space
189 * @tty: terminal
190 *
191 * Re-schedules the flip buffer work if space just became available.
192 *
6d76bd26
PH
193 * Caller holds exclusive termios_rwsem
194 * or
195 * n_tty_read()/consumer path:
196 * holds non-exclusive termios_rwsem
24a89d1c
PH
197 */
198
7879a9f9
PH
199static void n_tty_set_room(struct tty_struct *tty)
200{
24a89d1c
PH
201 struct n_tty_data *ldata = tty->disc_data;
202
55db4c64 203 /* Did this open up the receive buffer? We may need to flip */
24a89d1c
PH
204 if (unlikely(ldata->no_room) && receive_room(tty)) {
205 ldata->no_room = 0;
206
ecbbfd44 207 WARN_RATELIMIT(tty->port->itty == NULL,
cadf7486 208 "scheduling with invalid itty\n");
21622939
PH
209 /* see if ldisc has been killed - if so, this means that
210 * even though the ldisc has been halted and ->buf.work
211 * cancelled, ->buf.work is about to be rescheduled
212 */
213 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
214 "scheduling buffer work for halted ldisc\n");
f0f947c1 215 queue_work(system_unbound_wq, &tty->port->buf.work);
ecbbfd44 216 }
55db4c64
LT
217}
218
9a4aec2d
PH
219static ssize_t chars_in_buffer(struct tty_struct *tty)
220{
221 struct n_tty_data *ldata = tty->disc_data;
222 ssize_t n = 0;
223
224 if (!ldata->icanon)
225 n = read_cnt(ldata);
226 else
227 n = ldata->canon_head - ldata->read_tail;
228 return n;
229}
230
ee0bab83
PH
231/**
232 * n_tty_write_wakeup - asynchronous I/O notifier
233 * @tty: tty device
234 *
235 * Required for the ptys, serial driver etc. since processes
236 * that attach themselves to the master and rely on ASYNC
237 * IO must be woken up
238 */
239
240static void n_tty_write_wakeup(struct tty_struct *tty)
241{
242 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
243 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
244}
245
4a23a4df 246static void n_tty_check_throttle(struct tty_struct *tty)
6367ca72 247{
3afb1b39
PH
248 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
249 return;
6367ca72
PH
250 /*
251 * Check the remaining room for the input canonicalization
252 * mode. We don't want to throttle the driver if we're in
253 * canonical mode and don't have a newline yet!
254 */
255 while (1) {
256 int throttled;
257 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
258 if (receive_room(tty) >= TTY_THRESHOLD_THROTTLE)
259 break;
260 throttled = tty_throttle_safe(tty);
261 if (!throttled)
262 break;
263 }
264 __tty_set_flow_change(tty, 0);
265}
266
4b293492 267static void n_tty_check_unthrottle(struct tty_struct *tty)
6367ca72 268{
3afb1b39
PH
269 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
270 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
271 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
272 return;
273 if (!tty->count)
274 return;
275 n_tty_set_room(tty);
276 n_tty_write_wakeup(tty->link);
277 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
278 return;
279 }
280
6367ca72
PH
281 /* If there is enough space in the read buffer now, let the
282 * low-level driver know. We use chars_in_buffer() to
283 * check the buffer, as it now knows about canonical mode.
284 * Otherwise, if the driver is throttled and the line is
285 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
286 * we won't get any more characters.
287 */
288
289 while (1) {
290 int unthrottled;
291 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
292 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
293 break;
294 if (!tty->count)
295 break;
296 n_tty_set_room(tty);
297 unthrottled = tty_unthrottle_safe(tty);
298 if (!unthrottled)
299 break;
300 }
301 __tty_set_flow_change(tty, 0);
302}
303
17b82060
AC
304/**
305 * put_tty_queue - add character to tty
306 * @c: character
57c94121 307 * @ldata: n_tty data
17b82060 308 *
6d76bd26
PH
309 * Add a character to the tty read_buf queue.
310 *
311 * n_tty_receive_buf()/producer path:
312 * caller holds non-exclusive termios_rwsem
313 * modifies read_head
314 *
315 * read_head is only considered 'published' if canonical mode is
316 * not active.
17b82060
AC
317 */
318
19e2ad6a 319static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
1da177e4 320{
19e2ad6a 321 *read_buf_addr(ldata, ldata->read_head++) = c;
1da177e4
LT
322}
323
1da177e4
LT
324/**
325 * reset_buffer_flags - reset buffer state
326 * @tty: terminal to reset
327 *
25518c68
PH
328 * Reset the read buffer counters and clear the flags.
329 * Called from n_tty_open() and n_tty_flush_buffer().
17b82060 330 *
6d76bd26
PH
331 * Locking: caller holds exclusive termios_rwsem
332 * (or locking is not required)
1da177e4 333 */
a88a69c9 334
b66f4fa5 335static void reset_buffer_flags(struct n_tty_data *ldata)
1da177e4 336{
a73d3d69 337 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
17bd7907 338 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
40d5e090 339 ldata->line_start = 0;
a88a69c9 340
a73d3d69 341 ldata->erasing = 0;
3fe780b3 342 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
1da177e4
LT
343}
344
a30737ab
PH
345static void n_tty_packet_mode_flush(struct tty_struct *tty)
346{
347 unsigned long flags;
348
349 spin_lock_irqsave(&tty->ctrl_lock, flags);
350 if (tty->link->packet) {
351 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
352 wake_up_interruptible(&tty->link->read_wait);
353 }
354 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
355}
356
1da177e4
LT
357/**
358 * n_tty_flush_buffer - clean input queue
359 * @tty: terminal device
360 *
25518c68
PH
361 * Flush the input buffer. Called when the tty layer wants the
362 * buffer flushed (eg at hangup) or when the N_TTY line discipline
363 * internally has to clean the pending queue (for example some signals).
1da177e4 364 *
6d76bd26
PH
365 * Holds termios_rwsem to exclude producer/consumer while
366 * buffer indices are reset.
367 *
368 * Locking: ctrl_lock, exclusive termios_rwsem
1da177e4 369 */
4edf1827
AC
370
371static void n_tty_flush_buffer(struct tty_struct *tty)
1da177e4 372{
6d76bd26 373 down_write(&tty->termios_rwsem);
b66f4fa5
PH
374 reset_buffer_flags(tty->disc_data);
375 n_tty_set_room(tty);
4edf1827 376
a30737ab
PH
377 if (tty->link)
378 n_tty_packet_mode_flush(tty);
6d76bd26 379 up_write(&tty->termios_rwsem);
1da177e4
LT
380}
381
6d76bd26
PH
382/**
383 * n_tty_chars_in_buffer - report available bytes
384 * @tty: tty device
385 *
386 * Report the number of characters buffered to be delivered to user
387 * at this instant in time.
388 *
389 * Locking: exclusive termios_rwsem
390 */
391
a19d0c6a
PH
392static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
393{
6d76bd26
PH
394 ssize_t n;
395
47534084 396 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
6d76bd26
PH
397
398 down_write(&tty->termios_rwsem);
399 n = chars_in_buffer(tty);
400 up_write(&tty->termios_rwsem);
401 return n;
a19d0c6a
PH
402}
403
1da177e4
LT
404/**
405 * is_utf8_continuation - utf8 multibyte check
406 * @c: byte to check
407 *
408 * Returns true if the utf8 character 'c' is a multibyte continuation
409 * character. We use this to correctly compute the on screen size
410 * of the character when printing
411 */
4edf1827 412
1da177e4
LT
413static inline int is_utf8_continuation(unsigned char c)
414{
415 return (c & 0xc0) == 0x80;
416}
417
418/**
419 * is_continuation - multibyte check
420 * @c: byte to check
421 *
422 * Returns true if the utf8 character 'c' is a multibyte continuation
423 * character and the terminal is in unicode mode.
424 */
4edf1827 425
1da177e4
LT
426static inline int is_continuation(unsigned char c, struct tty_struct *tty)
427{
428 return I_IUTF8(tty) && is_utf8_continuation(c);
429}
430
431/**
a88a69c9 432 * do_output_char - output one character
1da177e4
LT
433 * @c: character (or partial unicode symbol)
434 * @tty: terminal device
a88a69c9 435 * @space: space available in tty driver write buffer
1da177e4 436 *
a88a69c9
JP
437 * This is a helper function that handles one output character
438 * (including special characters like TAB, CR, LF, etc.),
ee5aa7b8
JP
439 * doing OPOST processing and putting the results in the
440 * tty driver's write buffer.
a88a69c9
JP
441 *
442 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
443 * and NLDLY. They simply aren't relevant in the world today.
444 * If you ever need them, add them here.
1da177e4 445 *
a88a69c9
JP
446 * Returns the number of bytes of buffer space used or -1 if
447 * no space left.
448 *
449 * Locking: should be called under the output_lock to protect
450 * the column state and space left in the buffer
1da177e4 451 */
4edf1827 452
a88a69c9 453static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
1da177e4 454{
53c5ee2c 455 struct n_tty_data *ldata = tty->disc_data;
a88a69c9 456 int spaces;
1da177e4 457
1da177e4
LT
458 if (!space)
459 return -1;
300a6204 460
a88a69c9
JP
461 switch (c) {
462 case '\n':
463 if (O_ONLRET(tty))
53c5ee2c 464 ldata->column = 0;
a88a69c9
JP
465 if (O_ONLCR(tty)) {
466 if (space < 2)
467 return -1;
ba2e68ac 468 ldata->canon_column = ldata->column = 0;
37f81fa1 469 tty->ops->write(tty, "\r\n", 2);
a88a69c9
JP
470 return 2;
471 }
ba2e68ac 472 ldata->canon_column = ldata->column;
a88a69c9
JP
473 break;
474 case '\r':
53c5ee2c 475 if (O_ONOCR(tty) && ldata->column == 0)
a88a69c9
JP
476 return 0;
477 if (O_OCRNL(tty)) {
478 c = '\n';
479 if (O_ONLRET(tty))
ba2e68ac 480 ldata->canon_column = ldata->column = 0;
1da177e4 481 break;
a88a69c9 482 }
ba2e68ac 483 ldata->canon_column = ldata->column = 0;
a88a69c9
JP
484 break;
485 case '\t':
53c5ee2c 486 spaces = 8 - (ldata->column & 7);
a88a69c9
JP
487 if (O_TABDLY(tty) == XTABS) {
488 if (space < spaces)
489 return -1;
53c5ee2c 490 ldata->column += spaces;
a88a69c9
JP
491 tty->ops->write(tty, " ", spaces);
492 return spaces;
1da177e4 493 }
53c5ee2c 494 ldata->column += spaces;
a88a69c9
JP
495 break;
496 case '\b':
53c5ee2c
JS
497 if (ldata->column > 0)
498 ldata->column--;
a88a69c9
JP
499 break;
500 default:
a59c0d6f
JP
501 if (!iscntrl(c)) {
502 if (O_OLCUC(tty))
503 c = toupper(c);
504 if (!is_continuation(c, tty))
53c5ee2c 505 ldata->column++;
a59c0d6f 506 }
a88a69c9 507 break;
1da177e4 508 }
a88a69c9 509
f34d7a5b 510 tty_put_char(tty, c);
a88a69c9
JP
511 return 1;
512}
513
514/**
515 * process_output - output post processor
516 * @c: character (or partial unicode symbol)
517 * @tty: terminal device
518 *
ee5aa7b8
JP
519 * Output one character with OPOST processing.
520 * Returns -1 when the output device is full and the character
521 * must be retried.
a88a69c9
JP
522 *
523 * Locking: output_lock to protect column state and space left
524 * (also, this is called from n_tty_write under the
525 * tty layer write lock)
526 */
527
528static int process_output(unsigned char c, struct tty_struct *tty)
529{
bddc7152 530 struct n_tty_data *ldata = tty->disc_data;
a88a69c9
JP
531 int space, retval;
532
bddc7152 533 mutex_lock(&ldata->output_lock);
a88a69c9
JP
534
535 space = tty_write_room(tty);
536 retval = do_output_char(c, tty, space);
537
bddc7152 538 mutex_unlock(&ldata->output_lock);
a88a69c9
JP
539 if (retval < 0)
540 return -1;
541 else
542 return 0;
1da177e4
LT
543}
544
545/**
a88a69c9 546 * process_output_block - block post processor
1da177e4 547 * @tty: terminal device
ee5aa7b8
JP
548 * @buf: character buffer
549 * @nr: number of bytes to output
550 *
551 * Output a block of characters with OPOST processing.
552 * Returns the number of characters output.
1da177e4
LT
553 *
554 * This path is used to speed up block console writes, among other
555 * things when processing blocks of output data. It handles only
556 * the simple cases normally found and helps to generate blocks of
557 * symbols for the console driver and thus improve performance.
558 *
a88a69c9
JP
559 * Locking: output_lock to protect column state and space left
560 * (also, this is called from n_tty_write under the
561 * tty layer write lock)
1da177e4 562 */
4edf1827 563
a88a69c9
JP
564static ssize_t process_output_block(struct tty_struct *tty,
565 const unsigned char *buf, unsigned int nr)
1da177e4 566{
53c5ee2c 567 struct n_tty_data *ldata = tty->disc_data;
1da177e4 568 int space;
bbd20759 569 int i;
1da177e4
LT
570 const unsigned char *cp;
571
bddc7152 572 mutex_lock(&ldata->output_lock);
a88a69c9 573
f34d7a5b 574 space = tty_write_room(tty);
300a6204 575 if (!space) {
bddc7152 576 mutex_unlock(&ldata->output_lock);
1da177e4 577 return 0;
a88a69c9 578 }
1da177e4
LT
579 if (nr > space)
580 nr = space;
581
582 for (i = 0, cp = buf; i < nr; i++, cp++) {
a59c0d6f
JP
583 unsigned char c = *cp;
584
585 switch (c) {
1da177e4
LT
586 case '\n':
587 if (O_ONLRET(tty))
53c5ee2c 588 ldata->column = 0;
1da177e4
LT
589 if (O_ONLCR(tty))
590 goto break_out;
ba2e68ac 591 ldata->canon_column = ldata->column;
1da177e4
LT
592 break;
593 case '\r':
53c5ee2c 594 if (O_ONOCR(tty) && ldata->column == 0)
1da177e4
LT
595 goto break_out;
596 if (O_OCRNL(tty))
597 goto break_out;
ba2e68ac 598 ldata->canon_column = ldata->column = 0;
1da177e4
LT
599 break;
600 case '\t':
601 goto break_out;
602 case '\b':
53c5ee2c
JS
603 if (ldata->column > 0)
604 ldata->column--;
1da177e4
LT
605 break;
606 default:
a59c0d6f
JP
607 if (!iscntrl(c)) {
608 if (O_OLCUC(tty))
609 goto break_out;
610 if (!is_continuation(c, tty))
53c5ee2c 611 ldata->column++;
a59c0d6f 612 }
1da177e4
LT
613 break;
614 }
615 }
616break_out:
f34d7a5b 617 i = tty->ops->write(tty, buf, i);
a88a69c9 618
bddc7152 619 mutex_unlock(&ldata->output_lock);
1da177e4
LT
620 return i;
621}
622
a88a69c9
JP
623/**
624 * process_echoes - write pending echo characters
625 * @tty: terminal device
626 *
627 * Write previously buffered echo (and other ldisc-generated)
628 * characters to the tty.
629 *
630 * Characters generated by the ldisc (including echoes) need to
631 * be buffered because the driver's write buffer can fill during
632 * heavy program output. Echoing straight to the driver will
633 * often fail under these conditions, causing lost characters and
634 * resulting mismatches of ldisc state information.
635 *
636 * Since the ldisc state must represent the characters actually sent
637 * to the driver at the time of the write, operations like certain
638 * changes in column state are also saved in the buffer and executed
639 * here.
640 *
641 * A circular fifo buffer is used so that the most recent characters
642 * are prioritized. Also, when control characters are echoed with a
643 * prefixed "^", the pair is treated atomically and thus not separated.
644 *
019ebdf9 645 * Locking: callers must hold output_lock
a88a69c9
JP
646 */
647
bc5b1ec5 648static size_t __process_echoes(struct tty_struct *tty)
a88a69c9 649{
53c5ee2c 650 struct n_tty_data *ldata = tty->disc_data;
bc5b1ec5 651 int space, old_space;
addaebcc 652 size_t tail;
a88a69c9 653 unsigned char c;
a88a69c9 654
bc5b1ec5 655 old_space = space = tty_write_room(tty);
a88a69c9 656
addaebcc 657 tail = ldata->echo_tail;
29c7c5ca 658 while (ldata->echo_commit != tail) {
addaebcc 659 c = echo_buf(ldata, tail);
a88a69c9
JP
660 if (c == ECHO_OP_START) {
661 unsigned char op;
a88a69c9
JP
662 int no_space_left = 0;
663
664 /*
665 * If the buffer byte is the start of a multi-byte
666 * operation, get the next byte, which is either the
667 * op code or a control character value.
668 */
addaebcc 669 op = echo_buf(ldata, tail + 1);
300a6204 670
a88a69c9
JP
671 switch (op) {
672 unsigned int num_chars, num_bs;
673
674 case ECHO_OP_ERASE_TAB:
addaebcc 675 num_chars = echo_buf(ldata, tail + 2);
a88a69c9
JP
676
677 /*
678 * Determine how many columns to go back
679 * in order to erase the tab.
680 * This depends on the number of columns
681 * used by other characters within the tab
682 * area. If this (modulo 8) count is from
683 * the start of input rather than from a
684 * previous tab, we offset by canon column.
685 * Otherwise, tab spacing is normal.
686 */
687 if (!(num_chars & 0x80))
ba2e68ac 688 num_chars += ldata->canon_column;
a88a69c9
JP
689 num_bs = 8 - (num_chars & 7);
690
691 if (num_bs > space) {
692 no_space_left = 1;
693 break;
694 }
695 space -= num_bs;
696 while (num_bs--) {
697 tty_put_char(tty, '\b');
53c5ee2c
JS
698 if (ldata->column > 0)
699 ldata->column--;
a88a69c9 700 }
addaebcc 701 tail += 3;
a88a69c9
JP
702 break;
703
704 case ECHO_OP_SET_CANON_COL:
ba2e68ac 705 ldata->canon_column = ldata->column;
addaebcc 706 tail += 2;
a88a69c9
JP
707 break;
708
709 case ECHO_OP_MOVE_BACK_COL:
53c5ee2c
JS
710 if (ldata->column > 0)
711 ldata->column--;
addaebcc 712 tail += 2;
a88a69c9
JP
713 break;
714
715 case ECHO_OP_START:
716 /* This is an escaped echo op start code */
717 if (!space) {
718 no_space_left = 1;
719 break;
720 }
721 tty_put_char(tty, ECHO_OP_START);
53c5ee2c 722 ldata->column++;
a88a69c9 723 space--;
addaebcc 724 tail += 2;
a88a69c9
JP
725 break;
726
727 default:
a88a69c9 728 /*
62b26358
JP
729 * If the op is not a special byte code,
730 * it is a ctrl char tagged to be echoed
731 * as "^X" (where X is the letter
732 * representing the control char).
733 * Note that we must ensure there is
734 * enough space for the whole ctrl pair.
735 *
a88a69c9 736 */
62b26358
JP
737 if (space < 2) {
738 no_space_left = 1;
739 break;
740 }
741 tty_put_char(tty, '^');
742 tty_put_char(tty, op ^ 0100);
53c5ee2c 743 ldata->column += 2;
62b26358 744 space -= 2;
addaebcc 745 tail += 2;
a88a69c9
JP
746 }
747
748 if (no_space_left)
749 break;
750 } else {
582f5590 751 if (O_OPOST(tty)) {
ee5aa7b8
JP
752 int retval = do_output_char(c, tty, space);
753 if (retval < 0)
754 break;
755 space -= retval;
756 } else {
757 if (!space)
758 break;
759 tty_put_char(tty, c);
760 space -= 1;
761 }
addaebcc 762 tail += 1;
a88a69c9 763 }
a88a69c9
JP
764 }
765
cbfd0340
PH
766 /* If the echo buffer is nearly full (so that the possibility exists
767 * of echo overrun before the next commit), then discard enough
768 * data at the tail to prevent a subsequent overrun */
769 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
c476f658 770 if (echo_buf(ldata, tail) == ECHO_OP_START) {
6f222536 771 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
cbfd0340
PH
772 tail += 3;
773 else
774 tail += 2;
775 } else
776 tail++;
777 }
778
addaebcc 779 ldata->echo_tail = tail;
bc5b1ec5 780 return old_space - space;
019ebdf9
PH
781}
782
783static void commit_echoes(struct tty_struct *tty)
784{
785 struct n_tty_data *ldata = tty->disc_data;
bc5b1ec5 786 size_t nr, old, echoed;
cbfd0340
PH
787 size_t head;
788
789 head = ldata->echo_head;
790 old = ldata->echo_commit - ldata->echo_tail;
791
792 /* Process committed echoes if the accumulated # of bytes
793 * is over the threshold (and try again each time another
794 * block is accumulated) */
795 nr = head - ldata->echo_tail;
796 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
797 return;
a88a69c9 798
019ebdf9 799 mutex_lock(&ldata->output_lock);
cbfd0340 800 ldata->echo_commit = head;
bc5b1ec5 801 echoed = __process_echoes(tty);
bddc7152 802 mutex_unlock(&ldata->output_lock);
a88a69c9 803
bc5b1ec5 804 if (echoed && tty->ops->flush_chars)
a88a69c9
JP
805 tty->ops->flush_chars(tty);
806}
807
019ebdf9 808static void process_echoes(struct tty_struct *tty)
17bd7907
PH
809{
810 struct n_tty_data *ldata = tty->disc_data;
bc5b1ec5 811 size_t echoed;
17bd7907 812
019ebdf9
PH
813 if (!L_ECHO(tty) || ldata->echo_commit == ldata->echo_tail)
814 return;
815
816 mutex_lock(&ldata->output_lock);
bc5b1ec5 817 echoed = __process_echoes(tty);
019ebdf9
PH
818 mutex_unlock(&ldata->output_lock);
819
bc5b1ec5 820 if (echoed && tty->ops->flush_chars)
019ebdf9 821 tty->ops->flush_chars(tty);
17bd7907
PH
822}
823
cbfd0340
PH
824static void flush_echoes(struct tty_struct *tty)
825{
826 struct n_tty_data *ldata = tty->disc_data;
827
828 if (!L_ECHO(tty) || ldata->echo_commit == ldata->echo_head)
829 return;
830
831 mutex_lock(&ldata->output_lock);
832 ldata->echo_commit = ldata->echo_head;
833 __process_echoes(tty);
834 mutex_unlock(&ldata->output_lock);
835}
836
a88a69c9
JP
837/**
838 * add_echo_byte - add a byte to the echo buffer
839 * @c: unicode byte to echo
57c94121 840 * @ldata: n_tty data
a88a69c9
JP
841 *
842 * Add a character or operation byte to the echo buffer.
a88a69c9
JP
843 */
844
cbfd0340 845static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
a88a69c9 846{
addaebcc 847 *echo_buf_addr(ldata, ldata->echo_head++) = c;
a88a69c9
JP
848}
849
850/**
851 * echo_move_back_col - add operation to move back a column
57c94121 852 * @ldata: n_tty data
a88a69c9
JP
853 *
854 * Add an operation to the echo buffer to move back one column.
a88a69c9
JP
855 */
856
57c94121 857static void echo_move_back_col(struct n_tty_data *ldata)
a88a69c9 858{
57c94121
JS
859 add_echo_byte(ECHO_OP_START, ldata);
860 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
a88a69c9
JP
861}
862
863/**
864 * echo_set_canon_col - add operation to set the canon column
57c94121 865 * @ldata: n_tty data
a88a69c9
JP
866 *
867 * Add an operation to the echo buffer to set the canon column
868 * to the current column.
a88a69c9
JP
869 */
870
57c94121 871static void echo_set_canon_col(struct n_tty_data *ldata)
a88a69c9 872{
57c94121
JS
873 add_echo_byte(ECHO_OP_START, ldata);
874 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
a88a69c9
JP
875}
876
877/**
878 * echo_erase_tab - add operation to erase a tab
879 * @num_chars: number of character columns already used
880 * @after_tab: true if num_chars starts after a previous tab
57c94121 881 * @ldata: n_tty data
a88a69c9
JP
882 *
883 * Add an operation to the echo buffer to erase a tab.
884 *
885 * Called by the eraser function, which knows how many character
886 * columns have been used since either a previous tab or the start
887 * of input. This information will be used later, along with
888 * canon column (if applicable), to go back the correct number
889 * of columns.
a88a69c9
JP
890 */
891
892static void echo_erase_tab(unsigned int num_chars, int after_tab,
57c94121 893 struct n_tty_data *ldata)
a88a69c9 894{
57c94121
JS
895 add_echo_byte(ECHO_OP_START, ldata);
896 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
a88a69c9
JP
897
898 /* We only need to know this modulo 8 (tab spacing) */
899 num_chars &= 7;
900
901 /* Set the high bit as a flag if num_chars is after a previous tab */
902 if (after_tab)
903 num_chars |= 0x80;
300a6204 904
57c94121 905 add_echo_byte(num_chars, ldata);
a88a69c9
JP
906}
907
908/**
909 * echo_char_raw - echo a character raw
910 * @c: unicode byte to echo
911 * @tty: terminal device
912 *
913 * Echo user input back onto the screen. This must be called only when
914 * L_ECHO(tty) is true. Called from the driver receive_buf path.
915 *
916 * This variant does not treat control characters specially.
a88a69c9
JP
917 */
918
57c94121 919static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
a88a69c9 920{
a88a69c9 921 if (c == ECHO_OP_START) {
57c94121
JS
922 add_echo_byte(ECHO_OP_START, ldata);
923 add_echo_byte(ECHO_OP_START, ldata);
a88a69c9 924 } else {
57c94121 925 add_echo_byte(c, ldata);
a88a69c9 926 }
a88a69c9 927}
1da177e4 928
1da177e4 929/**
a88a69c9 930 * echo_char - echo a character
1da177e4
LT
931 * @c: unicode byte to echo
932 * @tty: terminal device
933 *
4edf1827 934 * Echo user input back onto the screen. This must be called only when
1da177e4 935 * L_ECHO(tty) is true. Called from the driver receive_buf path.
17b82060 936 *
62b26358
JP
937 * This variant tags control characters to be echoed as "^X"
938 * (where X is the letter representing the control char).
1da177e4
LT
939 */
940
941static void echo_char(unsigned char c, struct tty_struct *tty)
942{
bddc7152
JS
943 struct n_tty_data *ldata = tty->disc_data;
944
a88a69c9 945 if (c == ECHO_OP_START) {
57c94121
JS
946 add_echo_byte(ECHO_OP_START, ldata);
947 add_echo_byte(ECHO_OP_START, ldata);
a88a69c9 948 } else {
62b26358 949 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
57c94121
JS
950 add_echo_byte(ECHO_OP_START, ldata);
951 add_echo_byte(c, ldata);
a88a69c9 952 }
1da177e4
LT
953}
954
17b82060 955/**
a88a69c9 956 * finish_erasing - complete erase
57c94121 957 * @ldata: n_tty data
17b82060 958 */
a88a69c9 959
57c94121 960static inline void finish_erasing(struct n_tty_data *ldata)
1da177e4 961{
53c5ee2c 962 if (ldata->erasing) {
57c94121 963 echo_char_raw('/', ldata);
53c5ee2c 964 ldata->erasing = 0;
1da177e4
LT
965 }
966}
967
968/**
969 * eraser - handle erase function
970 * @c: character input
971 * @tty: terminal device
972 *
3a4fa0a2 973 * Perform erase and necessary output when an erase character is
1da177e4
LT
974 * present in the stream from the driver layer. Handles the complexities
975 * of UTF-8 multibyte symbols.
17b82060 976 *
6d76bd26
PH
977 * n_tty_receive_buf()/producer path:
978 * caller holds non-exclusive termios_rwsem
979 * modifies read_head
980 *
981 * Modifying the read_head is not considered a publish in this context
982 * because canonical mode is active -- only canon_head publishes
1da177e4 983 */
4edf1827 984
1da177e4
LT
985static void eraser(unsigned char c, struct tty_struct *tty)
986{
53c5ee2c 987 struct n_tty_data *ldata = tty->disc_data;
1da177e4 988 enum { ERASE, WERASE, KILL } kill_type;
bc5a5e3f
PH
989 size_t head;
990 size_t cnt;
991 int seen_alnums;
1da177e4 992
ba2e68ac 993 if (ldata->read_head == ldata->canon_head) {
7e94b1d9 994 /* process_output('\a', tty); */ /* what do you think? */
1da177e4
LT
995 return;
996 }
997 if (c == ERASE_CHAR(tty))
998 kill_type = ERASE;
999 else if (c == WERASE_CHAR(tty))
1000 kill_type = WERASE;
1001 else {
1002 if (!L_ECHO(tty)) {
ba2e68ac 1003 ldata->read_head = ldata->canon_head;
1da177e4
LT
1004 return;
1005 }
1006 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
ba2e68ac 1007 ldata->read_head = ldata->canon_head;
57c94121 1008 finish_erasing(ldata);
1da177e4
LT
1009 echo_char(KILL_CHAR(tty), tty);
1010 /* Add a newline if ECHOK is on and ECHOKE is off. */
1011 if (L_ECHOK(tty))
57c94121 1012 echo_char_raw('\n', ldata);
1da177e4
LT
1013 return;
1014 }
1015 kill_type = KILL;
1016 }
1017
1018 seen_alnums = 0;
ba2e68ac
JS
1019 while (ldata->read_head != ldata->canon_head) {
1020 head = ldata->read_head;
1da177e4
LT
1021
1022 /* erase a single possibly multibyte character */
1023 do {
bc5a5e3f
PH
1024 head--;
1025 c = read_buf(ldata, head);
ba2e68ac 1026 } while (is_continuation(c, tty) && head != ldata->canon_head);
1da177e4
LT
1027
1028 /* do not partially erase */
1029 if (is_continuation(c, tty))
1030 break;
1031
1032 if (kill_type == WERASE) {
1033 /* Equivalent to BSD's ALTWERASE. */
1034 if (isalnum(c) || c == '_')
1035 seen_alnums++;
1036 else if (seen_alnums)
1037 break;
1038 }
bc5a5e3f 1039 cnt = ldata->read_head - head;
ba2e68ac 1040 ldata->read_head = head;
1da177e4
LT
1041 if (L_ECHO(tty)) {
1042 if (L_ECHOPRT(tty)) {
53c5ee2c 1043 if (!ldata->erasing) {
57c94121 1044 echo_char_raw('\\', ldata);
53c5ee2c 1045 ldata->erasing = 1;
1da177e4
LT
1046 }
1047 /* if cnt > 1, output a multi-byte character */
1048 echo_char(c, tty);
1049 while (--cnt > 0) {
bc5a5e3f
PH
1050 head++;
1051 echo_char_raw(read_buf(ldata, head), ldata);
57c94121 1052 echo_move_back_col(ldata);
1da177e4
LT
1053 }
1054 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1055 echo_char(ERASE_CHAR(tty), tty);
1056 } else if (c == '\t') {
a88a69c9
JP
1057 unsigned int num_chars = 0;
1058 int after_tab = 0;
bc5a5e3f 1059 size_t tail = ldata->read_head;
a88a69c9
JP
1060
1061 /*
1062 * Count the columns used for characters
1063 * since the start of input or after a
1064 * previous tab.
1065 * This info is used to go back the correct
1066 * number of columns.
1067 */
ba2e68ac 1068 while (tail != ldata->canon_head) {
bc5a5e3f
PH
1069 tail--;
1070 c = read_buf(ldata, tail);
a88a69c9
JP
1071 if (c == '\t') {
1072 after_tab = 1;
1073 break;
300a6204 1074 } else if (iscntrl(c)) {
1da177e4 1075 if (L_ECHOCTL(tty))
a88a69c9
JP
1076 num_chars += 2;
1077 } else if (!is_continuation(c, tty)) {
1078 num_chars++;
1079 }
1da177e4 1080 }
57c94121 1081 echo_erase_tab(num_chars, after_tab, ldata);
1da177e4
LT
1082 } else {
1083 if (iscntrl(c) && L_ECHOCTL(tty)) {
57c94121
JS
1084 echo_char_raw('\b', ldata);
1085 echo_char_raw(' ', ldata);
1086 echo_char_raw('\b', ldata);
1da177e4
LT
1087 }
1088 if (!iscntrl(c) || L_ECHOCTL(tty)) {
57c94121
JS
1089 echo_char_raw('\b', ldata);
1090 echo_char_raw(' ', ldata);
1091 echo_char_raw('\b', ldata);
1da177e4
LT
1092 }
1093 }
1094 }
1095 if (kill_type == ERASE)
1096 break;
1097 }
ba2e68ac 1098 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
57c94121 1099 finish_erasing(ldata);
1da177e4
LT
1100}
1101
1102/**
1103 * isig - handle the ISIG optio
1104 * @sig: signal
1105 * @tty: terminal
1da177e4 1106 *
8c985d18
PH
1107 * Called when a signal is being sent due to terminal input.
1108 * Called from the driver receive_buf path so serialized.
17b82060 1109 *
8c985d18 1110 * Locking: ctrl_lock
1da177e4 1111 */
4edf1827 1112
4b293492 1113static void isig(int sig, struct tty_struct *tty)
1da177e4 1114{
8c985d18
PH
1115 struct pid *tty_pgrp = tty_get_pgrp(tty);
1116 if (tty_pgrp) {
1117 kill_pgrp(tty_pgrp, sig, 1);
1118 put_pid(tty_pgrp);
1da177e4
LT
1119 }
1120}
1121
1122/**
1123 * n_tty_receive_break - handle break
1124 * @tty: terminal
1125 *
1126 * An RS232 break event has been hit in the incoming bitstream. This
1127 * can cause a variety of events depending upon the termios settings.
1128 *
6d76bd26
PH
1129 * n_tty_receive_buf()/producer path:
1130 * caller holds non-exclusive termios_rwsem
1131 * publishes read_head via put_tty_queue()
1132 *
1133 * Note: may get exclusive termios_rwsem if flushing input buffer
1da177e4 1134 */
4edf1827 1135
4b293492 1136static void n_tty_receive_break(struct tty_struct *tty)
1da177e4 1137{
57c94121
JS
1138 struct n_tty_data *ldata = tty->disc_data;
1139
1da177e4
LT
1140 if (I_IGNBRK(tty))
1141 return;
1142 if (I_BRKINT(tty)) {
8c985d18
PH
1143 isig(SIGINT, tty);
1144 if (!L_NOFLSH(tty)) {
6d76bd26
PH
1145 /* flushing needs exclusive termios_rwsem */
1146 up_read(&tty->termios_rwsem);
8c985d18
PH
1147 n_tty_flush_buffer(tty);
1148 tty_driver_flush_buffer(tty);
6d76bd26 1149 down_read(&tty->termios_rwsem);
8c985d18 1150 }
1da177e4
LT
1151 return;
1152 }
1153 if (I_PARMRK(tty)) {
57c94121
JS
1154 put_tty_queue('\377', ldata);
1155 put_tty_queue('\0', ldata);
1da177e4 1156 }
57c94121 1157 put_tty_queue('\0', ldata);
1da177e4
LT
1158 wake_up_interruptible(&tty->read_wait);
1159}
1160
1161/**
1162 * n_tty_receive_overrun - handle overrun reporting
1163 * @tty: terminal
1164 *
1165 * Data arrived faster than we could process it. While the tty
1166 * driver has flagged this the bits that were missed are gone
1167 * forever.
1168 *
1169 * Called from the receive_buf path so single threaded. Does not
1170 * need locking as num_overrun and overrun_time are function
1171 * private.
1172 */
4edf1827 1173
4b293492 1174static void n_tty_receive_overrun(struct tty_struct *tty)
1da177e4 1175{
53c5ee2c 1176 struct n_tty_data *ldata = tty->disc_data;
1da177e4
LT
1177 char buf[64];
1178
53c5ee2c
JS
1179 ldata->num_overrun++;
1180 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1181 time_after(ldata->overrun_time, jiffies)) {
1da177e4
LT
1182 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1183 tty_name(tty, buf),
53c5ee2c
JS
1184 ldata->num_overrun);
1185 ldata->overrun_time = jiffies;
1186 ldata->num_overrun = 0;
1da177e4
LT
1187 }
1188}
1189
1190/**
1191 * n_tty_receive_parity_error - error notifier
1192 * @tty: terminal device
1193 * @c: character
1194 *
1195 * Process a parity error and queue the right data to indicate
6d76bd26
PH
1196 * the error case if necessary.
1197 *
1198 * n_tty_receive_buf()/producer path:
1199 * caller holds non-exclusive termios_rwsem
1200 * publishes read_head via put_tty_queue()
1da177e4 1201 */
4b293492 1202static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
1da177e4 1203{
57c94121
JS
1204 struct n_tty_data *ldata = tty->disc_data;
1205
4edf1827 1206 if (I_IGNPAR(tty))
1da177e4 1207 return;
1da177e4 1208 if (I_PARMRK(tty)) {
57c94121
JS
1209 put_tty_queue('\377', ldata);
1210 put_tty_queue('\0', ldata);
1211 put_tty_queue(c, ldata);
1da177e4 1212 } else if (I_INPCK(tty))
57c94121 1213 put_tty_queue('\0', ldata);
1da177e4 1214 else
57c94121 1215 put_tty_queue(c, ldata);
1da177e4
LT
1216 wake_up_interruptible(&tty->read_wait);
1217}
1218
b0ac50be
PH
1219static void
1220n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1221{
1222 if (!L_NOFLSH(tty)) {
1223 /* flushing needs exclusive termios_rwsem */
1224 up_read(&tty->termios_rwsem);
1225 n_tty_flush_buffer(tty);
1226 tty_driver_flush_buffer(tty);
1227 down_read(&tty->termios_rwsem);
1228 }
1229 if (I_IXON(tty))
1230 start_tty(tty);
1231 if (L_ECHO(tty)) {
1232 echo_char(c, tty);
1233 commit_echoes(tty);
1234 }
1235 isig(signal, tty);
1236 return;
1237}
1238
1da177e4
LT
1239/**
1240 * n_tty_receive_char - perform processing
1241 * @tty: terminal device
1242 * @c: character
1243 *
1244 * Process an individual character of input received from the driver.
4edf1827 1245 * This is serialized with respect to itself by the rules for the
1da177e4 1246 * driver above.
6d76bd26
PH
1247 *
1248 * n_tty_receive_buf()/producer path:
1249 * caller holds non-exclusive termios_rwsem
1250 * publishes canon_head if canonical mode is active
1251 * otherwise, publishes read_head via put_tty_queue()
e60d27c4
PH
1252 *
1253 * Returns 1 if LNEXT was received, else returns 0
1da177e4
LT
1254 */
1255
e60d27c4 1256static int
4b1f79c2 1257n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
1da177e4 1258{
53c5ee2c 1259 struct n_tty_data *ldata = tty->disc_data;
acc71bba 1260 int parmrk;
1da177e4 1261
1da177e4
LT
1262 if (I_IXON(tty)) {
1263 if (c == START_CHAR(tty)) {
1264 start_tty(tty);
17bd7907 1265 commit_echoes(tty);
e60d27c4 1266 return 0;
1da177e4
LT
1267 }
1268 if (c == STOP_CHAR(tty)) {
1269 stop_tty(tty);
e60d27c4 1270 return 0;
1da177e4
LT
1271 }
1272 }
575537b3 1273
1da177e4 1274 if (L_ISIG(tty)) {
b0ac50be
PH
1275 if (c == INTR_CHAR(tty)) {
1276 n_tty_receive_signal_char(tty, SIGINT, c);
e60d27c4 1277 return 0;
b0ac50be
PH
1278 } else if (c == QUIT_CHAR(tty)) {
1279 n_tty_receive_signal_char(tty, SIGQUIT, c);
e60d27c4 1280 return 0;
b0ac50be
PH
1281 } else if (c == SUSP_CHAR(tty)) {
1282 n_tty_receive_signal_char(tty, SIGTSTP, c);
e60d27c4 1283 return 0;
1da177e4
LT
1284 }
1285 }
575537b3 1286
855df3c0
PH
1287 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1288 start_tty(tty);
1289 process_echoes(tty);
1290 }
1291
575537b3
JP
1292 if (c == '\r') {
1293 if (I_IGNCR(tty))
e60d27c4 1294 return 0;
575537b3
JP
1295 if (I_ICRNL(tty))
1296 c = '\n';
1297 } else if (c == '\n' && I_INLCR(tty))
1298 c = '\r';
1299
53c5ee2c 1300 if (ldata->icanon) {
1da177e4
LT
1301 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1302 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1303 eraser(c, tty);
17bd7907 1304 commit_echoes(tty);
e60d27c4 1305 return 0;
1da177e4
LT
1306 }
1307 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
53c5ee2c 1308 ldata->lnext = 1;
1da177e4 1309 if (L_ECHO(tty)) {
57c94121 1310 finish_erasing(ldata);
1da177e4 1311 if (L_ECHOCTL(tty)) {
57c94121
JS
1312 echo_char_raw('^', ldata);
1313 echo_char_raw('\b', ldata);
17bd7907 1314 commit_echoes(tty);
1da177e4
LT
1315 }
1316 }
e60d27c4 1317 return 1;
1da177e4 1318 }
e60d27c4 1319 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
bc5a5e3f 1320 size_t tail = ldata->canon_head;
1da177e4 1321
57c94121 1322 finish_erasing(ldata);
1da177e4 1323 echo_char(c, tty);
57c94121 1324 echo_char_raw('\n', ldata);
ba2e68ac 1325 while (tail != ldata->read_head) {
bc5a5e3f
PH
1326 echo_char(read_buf(ldata, tail), tty);
1327 tail++;
1da177e4 1328 }
17bd7907 1329 commit_echoes(tty);
e60d27c4 1330 return 0;
1da177e4
LT
1331 }
1332 if (c == '\n') {
acc71bba 1333 if (L_ECHO(tty) || L_ECHONL(tty)) {
57c94121 1334 echo_char_raw('\n', ldata);
17bd7907 1335 commit_echoes(tty);
1da177e4
LT
1336 }
1337 goto handle_newline;
1338 }
1339 if (c == EOF_CHAR(tty)) {
1da177e4
LT
1340 c = __DISABLED_CHAR;
1341 goto handle_newline;
1342 }
1343 if ((c == EOL_CHAR(tty)) ||
1344 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
acc71bba
JP
1345 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty))
1346 ? 1 : 0;
1da177e4
LT
1347 /*
1348 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1349 */
1350 if (L_ECHO(tty)) {
1da177e4 1351 /* Record the column of first canon char. */
ba2e68ac 1352 if (ldata->canon_head == ldata->read_head)
57c94121 1353 echo_set_canon_col(ldata);
1da177e4 1354 echo_char(c, tty);
17bd7907 1355 commit_echoes(tty);
1da177e4
LT
1356 }
1357 /*
1358 * XXX does PARMRK doubling happen for
1359 * EOL_CHAR and EOL2_CHAR?
1360 */
acc71bba 1361 if (parmrk)
57c94121 1362 put_tty_queue(c, ldata);
1da177e4 1363
4edf1827 1364handle_newline:
bc5a5e3f 1365 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
6d76bd26 1366 put_tty_queue(c, ldata);
ba2e68ac 1367 ldata->canon_head = ldata->read_head;
1da177e4
LT
1368 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1369 if (waitqueue_active(&tty->read_wait))
1370 wake_up_interruptible(&tty->read_wait);
e60d27c4 1371 return 0;
1da177e4
LT
1372 }
1373 }
4edf1827 1374
acc71bba 1375 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
acc71bba 1376 if (L_ECHO(tty)) {
57c94121 1377 finish_erasing(ldata);
1da177e4 1378 if (c == '\n')
57c94121 1379 echo_char_raw('\n', ldata);
1da177e4
LT
1380 else {
1381 /* Record the column of first canon char. */
ba2e68ac 1382 if (ldata->canon_head == ldata->read_head)
57c94121 1383 echo_set_canon_col(ldata);
1da177e4
LT
1384 echo_char(c, tty);
1385 }
17bd7907 1386 commit_echoes(tty);
1da177e4
LT
1387 }
1388
acc71bba 1389 if (parmrk)
57c94121 1390 put_tty_queue(c, ldata);
1da177e4 1391
57c94121 1392 put_tty_queue(c, ldata);
e60d27c4 1393 return 0;
4edf1827 1394}
1da177e4 1395
e60d27c4
PH
1396static inline void
1397n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
4b1f79c2
PH
1398{
1399 struct n_tty_data *ldata = tty->disc_data;
1400 int parmrk;
1401
e60d27c4
PH
1402 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1403 start_tty(tty);
1404 process_echoes(tty);
1405 }
1406 if (L_ECHO(tty)) {
1407 finish_erasing(ldata);
1408 /* Record the column of first canon char. */
1409 if (ldata->canon_head == ldata->read_head)
1410 echo_set_canon_col(ldata);
1411 echo_char(c, tty);
1412 commit_echoes(tty);
4b1f79c2 1413 }
e60d27c4
PH
1414 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1415 if (parmrk)
1416 put_tty_queue(c, ldata);
1417 put_tty_queue(c, ldata);
1418}
4b1f79c2 1419
e60d27c4
PH
1420static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1421{
1422 n_tty_receive_char_inline(tty, c);
4b1f79c2
PH
1423}
1424
7de971b0
PH
1425static inline void
1426n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1427{
1428 struct n_tty_data *ldata = tty->disc_data;
1429
e60d27c4
PH
1430 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1431 start_tty(tty);
1432 process_echoes(tty);
7de971b0 1433 }
e60d27c4
PH
1434 if (L_ECHO(tty)) {
1435 finish_erasing(ldata);
1436 /* Record the column of first canon char. */
1437 if (ldata->canon_head == ldata->read_head)
1438 echo_set_canon_col(ldata);
1439 echo_char(c, tty);
1440 commit_echoes(tty);
1441 }
1442 put_tty_queue(c, ldata);
7de971b0
PH
1443}
1444
ad0cc7ba
PH
1445static inline void
1446n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
1447{
1448 if (I_ISTRIP(tty))
1449 c &= 0x7f;
1450 if (I_IUCLC(tty) && L_IEXTEN(tty))
1451 c = tolower(c);
1452
1453 if (I_IXON(tty)) {
1454 if (c == STOP_CHAR(tty))
1455 stop_tty(tty);
1456 else if (c == START_CHAR(tty) ||
1457 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1458 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1459 c != SUSP_CHAR(tty))) {
1460 start_tty(tty);
1461 process_echoes(tty);
1462 }
1463 }
1464}
1465
d2f8d7ab
PH
1466static void
1467n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1468{
1469 char buf[64];
1470
1471 switch (flag) {
1472 case TTY_BREAK:
1473 n_tty_receive_break(tty);
1474 break;
1475 case TTY_PARITY:
1476 case TTY_FRAME:
1477 n_tty_receive_parity_error(tty, c);
1478 break;
1479 case TTY_OVERRUN:
1480 n_tty_receive_overrun(tty);
1481 break;
1482 default:
1483 printk(KERN_ERR "%s: unknown flag %d\n",
1484 tty_name(tty, buf), flag);
1485 break;
1486 }
1487}
1488
e60d27c4
PH
1489static void
1490n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1491{
1492 struct n_tty_data *ldata = tty->disc_data;
1493
1494 ldata->lnext = 0;
1495 if (likely(flag == TTY_NORMAL)) {
1496 if (I_ISTRIP(tty))
1497 c &= 0x7f;
1498 if (I_IUCLC(tty) && L_IEXTEN(tty))
1499 c = tolower(c);
1500 n_tty_receive_char(tty, c);
1501 } else
1502 n_tty_receive_char_flagged(tty, c, flag);
1503}
1504
1da177e4
LT
1505/**
1506 * n_tty_receive_buf - data receive
1507 * @tty: terminal device
1508 * @cp: buffer
1509 * @fp: flag buffer
1510 * @count: characters
1511 *
1512 * Called by the terminal driver when a block of characters has
1513 * been received. This function must be called from soft contexts
1514 * not from interrupt context. The driver is responsible for making
1515 * calls one at a time and in order (or using flush_to_ldisc)
6d76bd26
PH
1516 *
1517 * n_tty_receive_buf()/producer path:
1518 * claims non-exclusive termios_rwsem
1519 * publishes read_head and canon_head
1da177e4 1520 */
4edf1827 1521
4a23a4df
PH
1522static void
1523n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1524 char *fp, int count)
1525{
1526 struct n_tty_data *ldata = tty->disc_data;
1527 size_t n, head;
1528
1529 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1530 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1531 n = min_t(size_t, count, n);
1532 memcpy(read_buf_addr(ldata, head), cp, n);
1533 ldata->read_head += n;
1534 cp += n;
1535 count -= n;
1536
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}
1543
554117bd
PH
1544static void
1545n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1546 char *fp, int count)
1547{
1548 struct n_tty_data *ldata = tty->disc_data;
1549 char flag = TTY_NORMAL;
1550
1551 while (count--) {
1552 if (fp)
1553 flag = *fp++;
1554 if (likely(flag == TTY_NORMAL))
1555 put_tty_queue(*cp++, ldata);
1556 else
1557 n_tty_receive_char_flagged(tty, *cp++, flag);
1558 }
1559}
1560
ad0cc7ba
PH
1561static void
1562n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1563 char *fp, int count)
1564{
1565 char flag = TTY_NORMAL;
1566
1567 while (count--) {
1568 if (fp)
1569 flag = *fp++;
1570 if (likely(flag == TTY_NORMAL))
1571 n_tty_receive_char_closing(tty, *cp++);
1572 else
1573 n_tty_receive_char_flagged(tty, *cp++, flag);
1574 }
1575}
1576
7d88d637
PH
1577static void
1578n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
6baad008
PH
1579 char *fp, int count)
1580{
1581 struct n_tty_data *ldata = tty->disc_data;
1582 char flag = TTY_NORMAL;
1583
1584 while (count--) {
1585 if (fp)
1586 flag = *fp++;
1587 if (likely(flag == TTY_NORMAL)) {
1588 unsigned char c = *cp++;
1589
1590 if (I_ISTRIP(tty))
1591 c &= 0x7f;
1592 if (I_IUCLC(tty) && L_IEXTEN(tty))
1593 c = tolower(c);
1594 if (L_EXTPROC(tty)) {
1595 put_tty_queue(c, ldata);
1596 continue;
1597 }
e60d27c4
PH
1598 if (!test_bit(c, ldata->char_map))
1599 n_tty_receive_char_inline(tty, c);
1600 else if (n_tty_receive_char_special(tty, c) && count) {
1601 if (fp)
1602 flag = *fp++;
1603 n_tty_receive_char_lnext(tty, *cp++, flag);
1604 count--;
1605 }
6baad008
PH
1606 } else
1607 n_tty_receive_char_flagged(tty, *cp++, flag);
1608 }
1609}
1610
1611static void
1612n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1613 char *fp, int count)
7d88d637 1614{
e60d27c4 1615 struct n_tty_data *ldata = tty->disc_data;
7d88d637
PH
1616 char flag = TTY_NORMAL;
1617
1618 while (count--) {
1619 if (fp)
1620 flag = *fp++;
e60d27c4
PH
1621 if (likely(flag == TTY_NORMAL)) {
1622 unsigned char c = *cp++;
1623
1624 if (!test_bit(c, ldata->char_map))
1625 n_tty_receive_char_fast(tty, c);
1626 else if (n_tty_receive_char_special(tty, c) && count) {
1627 if (fp)
1628 flag = *fp++;
1629 n_tty_receive_char_lnext(tty, *cp++, flag);
1630 count--;
1631 }
1632 } else
7d88d637
PH
1633 n_tty_receive_char_flagged(tty, *cp++, flag);
1634 }
1635}
1636
24a89d1c
PH
1637static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1638 char *fp, int count)
1da177e4 1639{
53c5ee2c 1640 struct n_tty_data *ldata = tty->disc_data;
a1dd30e9 1641 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
1da177e4 1642
4a23a4df
PH
1643 if (ldata->real_raw)
1644 n_tty_receive_buf_real_raw(tty, cp, fp, count);
a1dd30e9 1645 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
554117bd 1646 n_tty_receive_buf_raw(tty, cp, fp, count);
ad0cc7ba
PH
1647 else if (tty->closing && !L_EXTPROC(tty))
1648 n_tty_receive_buf_closing(tty, cp, fp, count);
4a23a4df 1649 else {
e60d27c4
PH
1650 if (ldata->lnext) {
1651 char flag = TTY_NORMAL;
1652
1653 if (fp)
1654 flag = *fp++;
1655 n_tty_receive_char_lnext(tty, *cp++, flag);
1656 count--;
1657 }
1658
7de971b0 1659 if (!preops && !I_PARMRK(tty))
6baad008
PH
1660 n_tty_receive_buf_fast(tty, cp, fp, count);
1661 else
1662 n_tty_receive_buf_standard(tty, cp, fp, count);
cbfd0340
PH
1663
1664 flush_echoes(tty);
f34d7a5b
AC
1665 if (tty->ops->flush_chars)
1666 tty->ops->flush_chars(tty);
1da177e4
LT
1667 }
1668
ce74117a 1669 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
26df6d13 1670 L_EXTPROC(tty)) {
1da177e4
LT
1671 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1672 if (waitqueue_active(&tty->read_wait))
1673 wake_up_interruptible(&tty->read_wait);
1674 }
1da177e4
LT
1675}
1676
5c32d123
PH
1677static int
1678n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1679 char *fp, int count, int flow)
24a89d1c
PH
1680{
1681 struct n_tty_data *ldata = tty->disc_data;
19e2ad6a 1682 int room, n, rcvd = 0;
24a89d1c 1683
9356b535
PH
1684 down_read(&tty->termios_rwsem);
1685
19e2ad6a
PH
1686 while (1) {
1687 room = receive_room(tty);
1688 n = min(count, room);
1689 if (!n) {
5c32d123 1690 if (flow && !room)
19e2ad6a
PH
1691 ldata->no_room = 1;
1692 break;
1693 }
1694 __receive_buf(tty, cp, fp, n);
1695 cp += n;
1696 if (fp)
1697 fp += n;
1698 count -= n;
1699 rcvd += n;
4a23a4df 1700 }
24a89d1c 1701
19e2ad6a
PH
1702 tty->receive_room = room;
1703 n_tty_check_throttle(tty);
9356b535
PH
1704 up_read(&tty->termios_rwsem);
1705
19e2ad6a 1706 return rcvd;
24a89d1c
PH
1707}
1708
5c32d123
PH
1709static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1710 char *fp, int count)
1711{
1712 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1713}
1714
1715static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1716 char *fp, int count)
1717{
1718 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1719}
1720
1da177e4
LT
1721int is_ignored(int sig)
1722{
1723 return (sigismember(&current->blocked, sig) ||
4edf1827 1724 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
1da177e4
LT
1725}
1726
1727/**
1728 * n_tty_set_termios - termios data changed
1729 * @tty: terminal
1730 * @old: previous data
1731 *
1732 * Called by the tty layer when the user changes termios flags so
1733 * that the line discipline can plan ahead. This function cannot sleep
4edf1827 1734 * and is protected from re-entry by the tty layer. The user is
1da177e4
LT
1735 * guaranteed that this function will not be re-entered or in progress
1736 * when the ldisc is closed.
17b82060 1737 *
6a1c0680 1738 * Locking: Caller holds tty->termios_rwsem
1da177e4 1739 */
4edf1827
AC
1740
1741static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
1da177e4 1742{
53c5ee2c 1743 struct n_tty_data *ldata = tty->disc_data;
47afa7a5 1744
c786f74e 1745 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
3fe780b3 1746 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
93a8d416 1747 ldata->line_start = ldata->canon_head = ldata->read_tail;
53c5ee2c 1748 ldata->erasing = 0;
6f9b028a 1749 ldata->lnext = 0;
47afa7a5
AC
1750 }
1751
53c5ee2c 1752 ldata->icanon = (L_ICANON(tty) != 0);
582f5590 1753
1da177e4
LT
1754 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1755 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1756 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1757 I_PARMRK(tty)) {
1bb9d562 1758 bitmap_zero(ldata->char_map, 256);
1da177e4
LT
1759
1760 if (I_IGNCR(tty) || I_ICRNL(tty))
1bb9d562 1761 set_bit('\r', ldata->char_map);
1da177e4 1762 if (I_INLCR(tty))
1bb9d562 1763 set_bit('\n', ldata->char_map);
1da177e4
LT
1764
1765 if (L_ICANON(tty)) {
1bb9d562
PH
1766 set_bit(ERASE_CHAR(tty), ldata->char_map);
1767 set_bit(KILL_CHAR(tty), ldata->char_map);
1768 set_bit(EOF_CHAR(tty), ldata->char_map);
1769 set_bit('\n', ldata->char_map);
1770 set_bit(EOL_CHAR(tty), ldata->char_map);
1da177e4 1771 if (L_IEXTEN(tty)) {
1bb9d562
PH
1772 set_bit(WERASE_CHAR(tty), ldata->char_map);
1773 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1774 set_bit(EOL2_CHAR(tty), ldata->char_map);
1da177e4
LT
1775 if (L_ECHO(tty))
1776 set_bit(REPRINT_CHAR(tty),
1bb9d562 1777 ldata->char_map);
1da177e4
LT
1778 }
1779 }
1780 if (I_IXON(tty)) {
1bb9d562
PH
1781 set_bit(START_CHAR(tty), ldata->char_map);
1782 set_bit(STOP_CHAR(tty), ldata->char_map);
1da177e4
LT
1783 }
1784 if (L_ISIG(tty)) {
1bb9d562
PH
1785 set_bit(INTR_CHAR(tty), ldata->char_map);
1786 set_bit(QUIT_CHAR(tty), ldata->char_map);
1787 set_bit(SUSP_CHAR(tty), ldata->char_map);
1da177e4 1788 }
1bb9d562 1789 clear_bit(__DISABLED_CHAR, ldata->char_map);
53c5ee2c
JS
1790 ldata->raw = 0;
1791 ldata->real_raw = 0;
1da177e4 1792 } else {
53c5ee2c 1793 ldata->raw = 1;
1da177e4
LT
1794 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1795 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1796 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
53c5ee2c 1797 ldata->real_raw = 1;
1da177e4 1798 else
53c5ee2c 1799 ldata->real_raw = 0;
1da177e4 1800 }
55db4c64 1801 n_tty_set_room(tty);
dab73b4e
WY
1802 /*
1803 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1804 * been stopped by STOP_CHAR(tty) before it.
1805 */
103fcbe2 1806 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped)
dab73b4e 1807 start_tty(tty);
dab73b4e 1808
f34d7a5b
AC
1809 /* The termios change make the tty ready for I/O */
1810 wake_up_interruptible(&tty->write_wait);
1811 wake_up_interruptible(&tty->read_wait);
1da177e4
LT
1812}
1813
1814/**
1815 * n_tty_close - close the ldisc for this tty
1816 * @tty: device
1817 *
4edf1827
AC
1818 * Called from the terminal layer when this line discipline is
1819 * being shut down, either because of a close or becsuse of a
1da177e4
LT
1820 * discipline change. The function will not be called while other
1821 * ldisc methods are in progress.
1822 */
4edf1827 1823
1da177e4
LT
1824static void n_tty_close(struct tty_struct *tty)
1825{
70ece7a7
JS
1826 struct n_tty_data *ldata = tty->disc_data;
1827
79901317
PH
1828 if (tty->link)
1829 n_tty_packet_mode_flush(tty);
1830
20bafb3d 1831 vfree(ldata);
70ece7a7 1832 tty->disc_data = NULL;
1da177e4
LT
1833}
1834
1835/**
1836 * n_tty_open - open an ldisc
1837 * @tty: terminal to open
1838 *
4edf1827 1839 * Called when this line discipline is being attached to the
1da177e4
LT
1840 * terminal device. Can sleep. Called serialized so that no
1841 * other events will occur in parallel. No further open will occur
1842 * until a close.
1843 */
1844
1845static int n_tty_open(struct tty_struct *tty)
1846{
70ece7a7
JS
1847 struct n_tty_data *ldata;
1848
20bafb3d
PH
1849 /* Currently a malloc failure here can panic */
1850 ldata = vmalloc(sizeof(*ldata));
70ece7a7
JS
1851 if (!ldata)
1852 goto err;
1853
53c5ee2c 1854 ldata->overrun_time = jiffies;
bddc7152
JS
1855 mutex_init(&ldata->atomic_read_lock);
1856 mutex_init(&ldata->output_lock);
53c5ee2c 1857
70ece7a7 1858 tty->disc_data = ldata;
b66f4fa5 1859 reset_buffer_flags(tty->disc_data);
53c5ee2c 1860 ldata->column = 0;
20bafb3d 1861 ldata->canon_column = 0;
f6c8dbe6 1862 ldata->minimum_to_wake = 1;
20bafb3d
PH
1863 ldata->num_overrun = 0;
1864 ldata->no_room = 0;
1865 ldata->lnext = 0;
1da177e4 1866 tty->closing = 0;
b66f4fa5
PH
1867 /* indicate buffer work may resume */
1868 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1869 n_tty_set_termios(tty, NULL);
1870 tty_unthrottle(tty);
70ece7a7 1871
1da177e4 1872 return 0;
70ece7a7 1873err:
b91939f5 1874 return -ENOMEM;
1da177e4
LT
1875}
1876
1877static inline int input_available_p(struct tty_struct *tty, int amt)
1878{
53c5ee2c
JS
1879 struct n_tty_data *ldata = tty->disc_data;
1880
53c5ee2c 1881 if (ldata->icanon && !L_EXTPROC(tty)) {
a73d3d69 1882 if (ldata->canon_head != ldata->read_tail)
1da177e4 1883 return 1;
ce74117a 1884 } else if (read_cnt(ldata) >= (amt ? amt : 1))
1da177e4
LT
1885 return 1;
1886
1887 return 0;
1888}
1889
1890/**
bbd20759 1891 * copy_from_read_buf - copy read data directly
1da177e4
LT
1892 * @tty: terminal device
1893 * @b: user data
1894 * @nr: size of data
1895 *
11a96d18 1896 * Helper function to speed up n_tty_read. It is only called when
1da177e4
LT
1897 * ICANON is off; it copies characters straight from the tty queue to
1898 * user space directly. It can be profitably called twice; once to
1899 * drain the space from the tail pointer to the (physical) end of the
1900 * buffer, and once to drain the space from the (physical) beginning of
1901 * the buffer to head pointer.
1902 *
bddc7152 1903 * Called under the ldata->atomic_read_lock sem
1da177e4 1904 *
6d76bd26
PH
1905 * n_tty_read()/consumer path:
1906 * caller holds non-exclusive termios_rwsem
1907 * read_tail published
1da177e4 1908 */
4edf1827 1909
33f0f88f 1910static int copy_from_read_buf(struct tty_struct *tty,
1da177e4
LT
1911 unsigned char __user **b,
1912 size_t *nr)
1913
1914{
53c5ee2c 1915 struct n_tty_data *ldata = tty->disc_data;
1da177e4
LT
1916 int retval;
1917 size_t n;
3fa10cc8 1918 bool is_eof;
bc5a5e3f 1919 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
1da177e4
LT
1920
1921 retval = 0;
bc5a5e3f 1922 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
1da177e4 1923 n = min(*nr, n);
1da177e4 1924 if (n) {
bc5a5e3f 1925 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
1da177e4 1926 n -= retval;
bc5a5e3f
PH
1927 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1928 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
53c5ee2c 1929 ldata->icanon);
bc5a5e3f 1930 ldata->read_tail += n;
26df6d13 1931 /* Turn single EOF into zero-length read */
ce74117a 1932 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
3fa10cc8 1933 n = 0;
1da177e4
LT
1934 *b += n;
1935 *nr -= n;
1936 }
1937 return retval;
1938}
1939
88bb0de3 1940/**
32f13521 1941 * canon_copy_from_read_buf - copy read data in canonical mode
88bb0de3
PH
1942 * @tty: terminal device
1943 * @b: user data
1944 * @nr: size of data
1945 *
1946 * Helper function for n_tty_read. It is only called when ICANON is on;
32f13521
PH
1947 * it copies one line of input up to and including the line-delimiting
1948 * character into the user-space buffer.
88bb0de3
PH
1949 *
1950 * Called under the atomic_read_lock mutex
6d76bd26
PH
1951 *
1952 * n_tty_read()/consumer path:
1953 * caller holds non-exclusive termios_rwsem
1954 * read_tail published
88bb0de3
PH
1955 */
1956
32f13521
PH
1957static int canon_copy_from_read_buf(struct tty_struct *tty,
1958 unsigned char __user **b,
1959 size_t *nr)
88bb0de3
PH
1960{
1961 struct n_tty_data *ldata = tty->disc_data;
32f13521 1962 size_t n, size, more, c;
bc5a5e3f
PH
1963 size_t eol;
1964 size_t tail;
1965 int ret, found = 0;
40d5e090 1966 bool eof_push = 0;
88bb0de3
PH
1967
1968 /* N.B. avoid overrun if nr == 0 */
ce74117a 1969 n = min(*nr, read_cnt(ldata));
6d76bd26 1970 if (!n)
32f13521 1971 return 0;
88bb0de3 1972
bc5a5e3f 1973 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
32f13521
PH
1974 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1975
bc5a5e3f 1976 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
32f13521
PH
1977 __func__, *nr, tail, n, size);
1978
1979 eol = find_next_bit(ldata->read_flags, size, tail);
1980 more = n - (size - tail);
1981 if (eol == N_TTY_BUF_SIZE && more) {
1982 /* scan wrapped without finding set bit */
1983 eol = find_next_bit(ldata->read_flags, more, 0);
1984 if (eol != more)
1985 found = 1;
1986 } else if (eol != size)
1987 found = 1;
1988
1989 size = N_TTY_BUF_SIZE - tail;
c77569d2
PH
1990 n = eol - tail;
1991 if (n > 4096)
1992 n += 4096;
1993 n += found;
32f13521
PH
1994 c = n;
1995
40d5e090 1996 if (found && read_buf(ldata, eol) == __DISABLED_CHAR) {
32f13521 1997 n--;
40d5e090
PH
1998 eof_push = !n && ldata->read_tail != ldata->line_start;
1999 }
32f13521 2000
bc5a5e3f 2001 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
32f13521
PH
2002 __func__, eol, found, n, c, size, more);
2003
32f13521 2004 if (n > size) {
bc5a5e3f 2005 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
32f13521
PH
2006 if (ret)
2007 return -EFAULT;
2008 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2009 } else
bc5a5e3f 2010 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
32f13521
PH
2011
2012 if (ret)
2013 return -EFAULT;
2014 *b += n;
2015 *nr -= n;
2016
a73d3d69 2017 if (found)
6d76bd26
PH
2018 clear_bit(eol, ldata->read_flags);
2019 smp_mb__after_clear_bit();
2020 ldata->read_tail += c;
88bb0de3 2021
40d5e090
PH
2022 if (found) {
2023 ldata->line_start = ldata->read_tail;
32f13521 2024 tty_audit_push(tty);
40d5e090
PH
2025 }
2026 return eof_push ? -EAGAIN : 0;
88bb0de3
PH
2027}
2028
cc4191dc 2029extern ssize_t redirected_tty_write(struct file *, const char __user *,
4edf1827 2030 size_t, loff_t *);
1da177e4
LT
2031
2032/**
2033 * job_control - check job control
2034 * @tty: tty
2035 * @file: file handle
2036 *
2037 * Perform job control management checks on this file/tty descriptor
4edf1827 2038 * and if appropriate send any needed signals and return a negative
1da177e4 2039 * error code if action should be taken.
04f378b1 2040 *
01a5e440
PH
2041 * Locking: redirected write test is safe
2042 * current->signal->tty check is safe
2043 * ctrl_lock to safely reference tty->pgrp
1da177e4 2044 */
4edf1827 2045
1da177e4
LT
2046static int job_control(struct tty_struct *tty, struct file *file)
2047{
2048 /* Job control check -- must be done at start and after
2049 every sleep (POSIX.1 7.1.1.4). */
2050 /* NOTE: not yet done after every sleep pending a thorough
2051 check of the logic of this change. -- jlc */
2052 /* don't stop on /dev/console */
01a5e440
PH
2053 if (file->f_op->write == redirected_tty_write ||
2054 current->signal->tty != tty)
2055 return 0;
2056
2057 spin_lock_irq(&tty->ctrl_lock);
2058 if (!tty->pgrp)
2059 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2060 else if (task_pgrp(current) != tty->pgrp) {
2061 spin_unlock_irq(&tty->ctrl_lock);
2062 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2063 return -EIO;
2064 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2065 set_thread_flag(TIF_SIGPENDING);
2066 return -ERESTARTSYS;
1da177e4 2067 }
01a5e440 2068 spin_unlock_irq(&tty->ctrl_lock);
1da177e4
LT
2069 return 0;
2070}
4edf1827 2071
1da177e4
LT
2072
2073/**
11a96d18 2074 * n_tty_read - read function for tty
1da177e4
LT
2075 * @tty: tty device
2076 * @file: file object
2077 * @buf: userspace buffer pointer
2078 * @nr: size of I/O
2079 *
2080 * Perform reads for the line discipline. We are guaranteed that the
2081 * line discipline will not be closed under us but we may get multiple
2082 * parallel readers and must handle this ourselves. We may also get
2083 * a hangup. Always called in user context, may sleep.
2084 *
2085 * This code must be sure never to sleep through a hangup.
6d76bd26
PH
2086 *
2087 * n_tty_read()/consumer path:
2088 * claims non-exclusive termios_rwsem
2089 * publishes read_tail
1da177e4 2090 */
4edf1827 2091
11a96d18 2092static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
1da177e4
LT
2093 unsigned char __user *buf, size_t nr)
2094{
53c5ee2c 2095 struct n_tty_data *ldata = tty->disc_data;
1da177e4
LT
2096 unsigned char __user *b = buf;
2097 DECLARE_WAITQUEUE(wait, current);
2098 int c;
2099 int minimum, time;
2100 ssize_t retval = 0;
1da177e4
LT
2101 long timeout;
2102 unsigned long flags;
04f378b1 2103 int packet;
1da177e4 2104
1da177e4 2105 c = job_control(tty, file);
4edf1827 2106 if (c < 0)
1da177e4 2107 return c;
4edf1827 2108
aefceaf4
PH
2109 /*
2110 * Internal serialization of reads.
2111 */
2112 if (file->f_flags & O_NONBLOCK) {
2113 if (!mutex_trylock(&ldata->atomic_read_lock))
2114 return -EAGAIN;
2115 } else {
2116 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2117 return -ERESTARTSYS;
2118 }
2119
9356b535
PH
2120 down_read(&tty->termios_rwsem);
2121
1da177e4
LT
2122 minimum = time = 0;
2123 timeout = MAX_SCHEDULE_TIMEOUT;
53c5ee2c 2124 if (!ldata->icanon) {
1da177e4
LT
2125 minimum = MIN_CHAR(tty);
2126 if (minimum) {
a6e54319 2127 time = (HZ / 10) * TIME_CHAR(tty);
1da177e4 2128 if (time)
f6c8dbe6 2129 ldata->minimum_to_wake = 1;
1da177e4 2130 else if (!waitqueue_active(&tty->read_wait) ||
f6c8dbe6
PH
2131 (ldata->minimum_to_wake > minimum))
2132 ldata->minimum_to_wake = minimum;
1da177e4 2133 } else {
a6e54319 2134 timeout = (HZ / 10) * TIME_CHAR(tty);
f6c8dbe6 2135 ldata->minimum_to_wake = minimum = 1;
1da177e4
LT
2136 }
2137 }
2138
04f378b1 2139 packet = tty->packet;
1da177e4
LT
2140
2141 add_wait_queue(&tty->read_wait, &wait);
1da177e4
LT
2142 while (nr) {
2143 /* First test for status change. */
04f378b1 2144 if (packet && tty->link->ctrl_status) {
1da177e4
LT
2145 unsigned char cs;
2146 if (b != buf)
2147 break;
04f378b1 2148 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
1da177e4
LT
2149 cs = tty->link->ctrl_status;
2150 tty->link->ctrl_status = 0;
04f378b1 2151 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
522ed776 2152 if (tty_put_user(tty, cs, b++)) {
1da177e4
LT
2153 retval = -EFAULT;
2154 b--;
2155 break;
2156 }
2157 nr--;
2158 break;
2159 }
2160 /* This statement must be first before checking for input
2161 so that any interrupt will set the state back to
2162 TASK_RUNNING. */
2163 set_current_state(TASK_INTERRUPTIBLE);
4edf1827 2164
f6c8dbe6 2165 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
1da177e4 2166 ((minimum - (b - buf)) >= 1))
f6c8dbe6 2167 ldata->minimum_to_wake = (minimum - (b - buf));
4edf1827 2168
1da177e4
LT
2169 if (!input_available_p(tty, 0)) {
2170 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
f8747d4a
PH
2171 up_read(&tty->termios_rwsem);
2172 tty_flush_to_ldisc(tty);
2173 down_read(&tty->termios_rwsem);
2174 if (!input_available_p(tty, 0)) {
2175 retval = -EIO;
2176 break;
2177 }
2178 } else {
2179 if (tty_hung_up_p(file))
2180 break;
2181 if (!timeout)
2182 break;
2183 if (file->f_flags & O_NONBLOCK) {
2184 retval = -EAGAIN;
2185 break;
2186 }
2187 if (signal_pending(current)) {
2188 retval = -ERESTARTSYS;
2189 break;
2190 }
2191 n_tty_set_room(tty);
2192 up_read(&tty->termios_rwsem);
9356b535 2193
f8747d4a 2194 timeout = schedule_timeout(timeout);
9356b535 2195
f8747d4a
PH
2196 down_read(&tty->termios_rwsem);
2197 continue;
2198 }
1da177e4
LT
2199 }
2200 __set_current_state(TASK_RUNNING);
2201
2202 /* Deal with packet mode. */
04f378b1 2203 if (packet && b == buf) {
522ed776 2204 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
1da177e4
LT
2205 retval = -EFAULT;
2206 b--;
2207 break;
2208 }
2209 nr--;
2210 }
2211
53c5ee2c 2212 if (ldata->icanon && !L_EXTPROC(tty)) {
32f13521 2213 retval = canon_copy_from_read_buf(tty, &b, &nr);
40d5e090
PH
2214 if (retval == -EAGAIN) {
2215 retval = 0;
2216 continue;
2217 } else if (retval)
1da177e4
LT
2218 break;
2219 } else {
2220 int uncopied;
04f378b1
AC
2221 /* The copy function takes the read lock and handles
2222 locking internally for this case */
1da177e4
LT
2223 uncopied = copy_from_read_buf(tty, &b, &nr);
2224 uncopied += copy_from_read_buf(tty, &b, &nr);
2225 if (uncopied) {
2226 retval = -EFAULT;
2227 break;
2228 }
2229 }
2230
6367ca72 2231 n_tty_check_unthrottle(tty);
1da177e4
LT
2232
2233 if (b - buf >= minimum)
2234 break;
2235 if (time)
2236 timeout = time;
2237 }
42458f41
PH
2238 n_tty_set_room(tty);
2239 up_read(&tty->termios_rwsem);
2240
1da177e4 2241 remove_wait_queue(&tty->read_wait, &wait);
1da177e4 2242 if (!waitqueue_active(&tty->read_wait))
f6c8dbe6 2243 ldata->minimum_to_wake = minimum;
1da177e4 2244
aebf0453
PH
2245 mutex_unlock(&ldata->atomic_read_lock);
2246
1da177e4 2247 __set_current_state(TASK_RUNNING);
40d5e090
PH
2248 if (b - buf)
2249 retval = b - buf;
1da177e4
LT
2250
2251 return retval;
2252}
2253
2254/**
11a96d18 2255 * n_tty_write - write function for tty
1da177e4
LT
2256 * @tty: tty device
2257 * @file: file object
2258 * @buf: userspace buffer pointer
2259 * @nr: size of I/O
2260 *
a88a69c9 2261 * Write function of the terminal device. This is serialized with
1da177e4 2262 * respect to other write callers but not to termios changes, reads
a88a69c9
JP
2263 * and other such events. Since the receive code will echo characters,
2264 * thus calling driver write methods, the output_lock is used in
2265 * the output processing functions called here as well as in the
2266 * echo processing function to protect the column state and space
2267 * left in the buffer.
1da177e4
LT
2268 *
2269 * This code must be sure never to sleep through a hangup.
a88a69c9
JP
2270 *
2271 * Locking: output_lock to protect column state and space left
2272 * (note that the process_output*() functions take this
2273 * lock themselves)
1da177e4 2274 */
4edf1827 2275
11a96d18 2276static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
a88a69c9 2277 const unsigned char *buf, size_t nr)
1da177e4
LT
2278{
2279 const unsigned char *b = buf;
2280 DECLARE_WAITQUEUE(wait, current);
2281 int c;
2282 ssize_t retval = 0;
2283
2284 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2285 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2286 retval = tty_check_change(tty);
2287 if (retval)
2288 return retval;
2289 }
2290
9356b535
PH
2291 down_read(&tty->termios_rwsem);
2292
a88a69c9
JP
2293 /* Write out any echoed characters that are still pending */
2294 process_echoes(tty);
300a6204 2295
1da177e4
LT
2296 add_wait_queue(&tty->write_wait, &wait);
2297 while (1) {
2298 set_current_state(TASK_INTERRUPTIBLE);
2299 if (signal_pending(current)) {
2300 retval = -ERESTARTSYS;
2301 break;
2302 }
2303 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2304 retval = -EIO;
2305 break;
2306 }
582f5590 2307 if (O_OPOST(tty)) {
1da177e4 2308 while (nr > 0) {
a88a69c9 2309 ssize_t num = process_output_block(tty, b, nr);
1da177e4
LT
2310 if (num < 0) {
2311 if (num == -EAGAIN)
2312 break;
2313 retval = num;
2314 goto break_out;
2315 }
2316 b += num;
2317 nr -= num;
2318 if (nr == 0)
2319 break;
2320 c = *b;
a88a69c9 2321 if (process_output(c, tty) < 0)
1da177e4
LT
2322 break;
2323 b++; nr--;
2324 }
f34d7a5b
AC
2325 if (tty->ops->flush_chars)
2326 tty->ops->flush_chars(tty);
1da177e4 2327 } else {
d6afe27b 2328 while (nr > 0) {
f34d7a5b 2329 c = tty->ops->write(tty, b, nr);
d6afe27b
RZ
2330 if (c < 0) {
2331 retval = c;
2332 goto break_out;
2333 }
2334 if (!c)
2335 break;
2336 b += c;
2337 nr -= c;
1da177e4 2338 }
1da177e4
LT
2339 }
2340 if (!nr)
2341 break;
2342 if (file->f_flags & O_NONBLOCK) {
2343 retval = -EAGAIN;
2344 break;
2345 }
9356b535
PH
2346 up_read(&tty->termios_rwsem);
2347
1da177e4 2348 schedule();
9356b535
PH
2349
2350 down_read(&tty->termios_rwsem);
1da177e4
LT
2351 }
2352break_out:
2353 __set_current_state(TASK_RUNNING);
2354 remove_wait_queue(&tty->write_wait, &wait);
ff8cb0fd
TP
2355 if (b - buf != nr && tty->fasync)
2356 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
9356b535 2357 up_read(&tty->termios_rwsem);
1da177e4
LT
2358 return (b - buf) ? b - buf : retval;
2359}
2360
2361/**
11a96d18 2362 * n_tty_poll - poll method for N_TTY
1da177e4
LT
2363 * @tty: terminal device
2364 * @file: file accessing it
2365 * @wait: poll table
2366 *
2367 * Called when the line discipline is asked to poll() for data or
2368 * for special events. This code is not serialized with respect to
2369 * other events save open/close.
2370 *
2371 * This code must be sure never to sleep through a hangup.
2372 * Called without the kernel lock held - fine
1da177e4 2373 */
4edf1827 2374
11a96d18 2375static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
4edf1827 2376 poll_table *wait)
1da177e4 2377{
f6c8dbe6 2378 struct n_tty_data *ldata = tty->disc_data;
1da177e4
LT
2379 unsigned int mask = 0;
2380
2381 poll_wait(file, &tty->read_wait, wait);
2382 poll_wait(file, &tty->write_wait, wait);
2383 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
2384 mask |= POLLIN | POLLRDNORM;
2385 if (tty->packet && tty->link->ctrl_status)
2386 mask |= POLLPRI | POLLIN | POLLRDNORM;
2387 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2388 mask |= POLLHUP;
2389 if (tty_hung_up_p(file))
2390 mask |= POLLHUP;
2391 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2392 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
f6c8dbe6 2393 ldata->minimum_to_wake = MIN_CHAR(tty);
1da177e4 2394 else
f6c8dbe6 2395 ldata->minimum_to_wake = 1;
1da177e4 2396 }
f34d7a5b
AC
2397 if (tty->ops->write && !tty_is_writelocked(tty) &&
2398 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2399 tty_write_room(tty) > 0)
1da177e4
LT
2400 mask |= POLLOUT | POLLWRNORM;
2401 return mask;
2402}
2403
57c94121 2404static unsigned long inq_canon(struct n_tty_data *ldata)
47afa7a5 2405{
bc5a5e3f 2406 size_t nr, head, tail;
47afa7a5 2407
a73d3d69 2408 if (ldata->canon_head == ldata->read_tail)
47afa7a5 2409 return 0;
ba2e68ac
JS
2410 head = ldata->canon_head;
2411 tail = ldata->read_tail;
bc5a5e3f 2412 nr = head - tail;
47afa7a5
AC
2413 /* Skip EOF-chars.. */
2414 while (head != tail) {
bc5a5e3f
PH
2415 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2416 read_buf(ldata, tail) == __DISABLED_CHAR)
47afa7a5 2417 nr--;
bc5a5e3f 2418 tail++;
47afa7a5
AC
2419 }
2420 return nr;
2421}
2422
2423static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2424 unsigned int cmd, unsigned long arg)
2425{
ba2e68ac 2426 struct n_tty_data *ldata = tty->disc_data;
47afa7a5
AC
2427 int retval;
2428
2429 switch (cmd) {
2430 case TIOCOUTQ:
2431 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2432 case TIOCINQ:
6d76bd26 2433 down_write(&tty->termios_rwsem);
47afa7a5 2434 if (L_ICANON(tty))
57c94121 2435 retval = inq_canon(ldata);
6d76bd26
PH
2436 else
2437 retval = read_cnt(ldata);
2438 up_write(&tty->termios_rwsem);
47afa7a5
AC
2439 return put_user(retval, (unsigned int __user *) arg);
2440 default:
2441 return n_tty_ioctl_helper(tty, file, cmd, arg);
2442 }
2443}
2444
f6c8dbe6
PH
2445static void n_tty_fasync(struct tty_struct *tty, int on)
2446{
2447 struct n_tty_data *ldata = tty->disc_data;
2448
2449 if (!waitqueue_active(&tty->read_wait)) {
2450 if (on)
2451 ldata->minimum_to_wake = 1;
2452 else if (!tty->fasync)
2453 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2454 }
2455}
2456
a352def2 2457struct tty_ldisc_ops tty_ldisc_N_TTY = {
e10cc1df
PF
2458 .magic = TTY_LDISC_MAGIC,
2459 .name = "n_tty",
2460 .open = n_tty_open,
2461 .close = n_tty_close,
2462 .flush_buffer = n_tty_flush_buffer,
2463 .chars_in_buffer = n_tty_chars_in_buffer,
11a96d18
AC
2464 .read = n_tty_read,
2465 .write = n_tty_write,
e10cc1df
PF
2466 .ioctl = n_tty_ioctl,
2467 .set_termios = n_tty_set_termios,
11a96d18 2468 .poll = n_tty_poll,
e10cc1df 2469 .receive_buf = n_tty_receive_buf,
f6c8dbe6
PH
2470 .write_wakeup = n_tty_write_wakeup,
2471 .fasync = n_tty_fasync,
24a89d1c 2472 .receive_buf2 = n_tty_receive_buf2,
1da177e4 2473};
572b9adb
RG
2474
2475/**
2476 * n_tty_inherit_ops - inherit N_TTY methods
2477 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2478 *
593fb1ae 2479 * Enables a 'subclass' line discipline to 'inherit' N_TTY
572b9adb
RG
2480 * methods.
2481 */
2482
2483void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2484{
2485 *ops = tty_ldisc_N_TTY;
2486 ops->owner = NULL;
2487 ops->refcount = ops->flags = 0;
2488}
2489EXPORT_SYMBOL_GPL(n_tty_inherit_ops);
This page took 1.586477 seconds and 5 git commands to generate.