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