blob: fdc2ecde5ac2049c8c1877364e293412d330d9ac [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * 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
Alan Cox4edf1822008-02-08 04:18:44 -080011 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * 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 *
Alan Cox4edf1822008-02-08 04:18:44 -080023 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * 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>.
Alan Cox11a96d12008-10-13 10:46:24 +010029 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * 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>
Miloslav Trmac522ed772007-07-15 23:40:56 -070048#include <linux/audit.h>
49#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000050#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080051#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050052#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040053#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
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 */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010065#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Joe Petersona88a69c2009-01-02 13:40:53 +000067/*
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
Peter Hurleycbfd0342013-06-15 10:04:26 -040078#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
Peter Hurley32f13522013-06-15 09:14:17 -040083#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
Jiri Slaby70ece7a2012-10-18 22:26:38 +020090struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040091 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040094 size_t echo_head;
95 size_t echo_commit;
Peter Hurley1bb9d562013-06-15 10:21:20 -040096 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040097
98 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +020099 unsigned long overrun_time;
100 int num_overrun;
101
Peter Hurley24a89d12013-06-15 09:14:15 -0400102 /* non-atomic */
103 bool no_room;
104
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400105 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200106 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200107
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400108 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400109 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200110 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400111 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200112
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -0400113 int minimum_to_wake;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200114
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400115 /* consumer-published */
116 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400117 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400118
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400119 /* protected by output lock */
120 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200121 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400122 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200123
124 struct mutex atomic_read_lock;
125 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200126};
127
Peter Hurleyce741172013-06-15 09:14:20 -0400128static inline size_t read_cnt(struct n_tty_data *ldata)
129{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400130 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400131}
132
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400133static 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
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400143static 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
Miloslav Trmac522ed772007-07-15 23:40:56 -0700153static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
154 unsigned char __user *ptr)
155{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200156 struct n_tty_data *ldata = tty->disc_data;
157
158 tty_audit_add_data(tty, &x, 1, ldata->icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700159 return put_user(x, ptr);
160}
161
Peter Hurley24a89d12013-06-15 09:14:15 -0400162static int receive_room(struct tty_struct *tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900163{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200164 struct n_tty_data *ldata = tty->disc_data;
Jaeden Amero090abf72012-07-27 08:43:11 -0500165 int left;
Peter Hurleyb8483052013-06-15 07:28:30 -0400166
Jaeden Amero090abf72012-07-27 08:43:11 -0500167 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). */
Peter Hurleyce741172013-06-15 09:14:20 -0400171 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500172 } else
Peter Hurleyce741172013-06-15 09:14:20 -0400173 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500174
Linus Torvalds55db4c62011-06-04 06:33:24 +0900175 /*
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)
Peter Hurleya73d3d62013-06-15 09:14:25 -0400182 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
Linus Torvalds55db4c62011-06-04 06:33:24 +0900183
Peter Hurley24a89d12013-06-15 09:14:15 -0400184 return left;
Peter Hurley7879a9f2013-06-15 07:28:31 -0400185}
186
Peter Hurley24a89d12013-06-15 09:14:15 -0400187/**
188 * n_tty_set_room - receive space
189 * @tty: terminal
190 *
191 * Re-schedules the flip buffer work if space just became available.
192 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400193 * Caller holds exclusive termios_rwsem
194 * or
195 * n_tty_read()/consumer path:
196 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400197 */
198
Peter Hurley7879a9f2013-06-15 07:28:31 -0400199static void n_tty_set_room(struct tty_struct *tty)
200{
Peter Hurley24a89d12013-06-15 09:14:15 -0400201 struct n_tty_data *ldata = tty->disc_data;
202
Linus Torvalds55db4c62011-06-04 06:33:24 +0900203 /* Did this open up the receive buffer? We may need to flip */
Peter Hurley24a89d12013-06-15 09:14:15 -0400204 if (unlikely(ldata->no_room) && receive_room(tty)) {
205 ldata->no_room = 0;
206
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200207 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400208 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400209 /* 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");
Peter Hurleyf0f947c2013-06-15 09:14:36 -0400215 queue_work(system_unbound_wq, &tty->port->buf.work);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200216 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900217}
218
Peter Hurley9a4aec22013-06-15 09:14:32 -0400219static 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
Peter Hurleyee0bab82013-06-15 09:14:34 -0400231/**
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
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400246static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400247{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400248 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
249 return;
Peter Hurley6367ca72013-06-15 09:14:33 -0400250 /*
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
Peter Hurley4b293492013-07-24 08:29:55 -0400267static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400268{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400269 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);
Peter Hurley6c677162013-12-02 14:24:46 -0500277 if (waitqueue_active(&tty->link->write_wait))
278 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400279 return;
280 }
281
Peter Hurley6367ca72013-06-15 09:14:33 -0400282 /* If there is enough space in the read buffer now, let the
283 * low-level driver know. We use chars_in_buffer() to
284 * check the buffer, as it now knows about canonical mode.
285 * Otherwise, if the driver is throttled and the line is
286 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
287 * we won't get any more characters.
288 */
289
290 while (1) {
291 int unthrottled;
292 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
293 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
294 break;
295 if (!tty->count)
296 break;
297 n_tty_set_room(tty);
298 unthrottled = tty_unthrottle_safe(tty);
299 if (!unthrottled)
300 break;
301 }
302 __tty_set_flow_change(tty, 0);
303}
304
Alan Cox17b82062008-10-13 10:45:06 +0100305/**
306 * put_tty_queue - add character to tty
307 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200308 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100309 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400310 * Add a character to the tty read_buf queue.
311 *
312 * n_tty_receive_buf()/producer path:
313 * caller holds non-exclusive termios_rwsem
314 * modifies read_head
315 *
316 * read_head is only considered 'published' if canonical mode is
317 * not active.
Alan Cox17b82062008-10-13 10:45:06 +0100318 */
319
Peter Hurley19e2ad62013-07-24 08:29:54 -0400320static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
Peter Hurley19e2ad62013-07-24 08:29:54 -0400322 *read_buf_addr(ldata, ldata->read_head++) = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323}
324
325/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 * reset_buffer_flags - reset buffer state
327 * @tty: terminal to reset
328 *
Peter Hurley25518c62013-03-11 16:44:31 -0400329 * Reset the read buffer counters and clear the flags.
330 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100331 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400332 * Locking: caller holds exclusive termios_rwsem
333 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000335
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400336static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400338 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley17bd7902013-06-15 10:04:24 -0400339 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400340 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000341
Peter Hurleya73d3d62013-06-15 09:14:25 -0400342 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200343 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344}
345
Peter Hurleya30737a2013-03-11 16:44:22 -0400346static void n_tty_packet_mode_flush(struct tty_struct *tty)
347{
348 unsigned long flags;
349
350 spin_lock_irqsave(&tty->ctrl_lock, flags);
351 if (tty->link->packet) {
352 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
Peter Hurley6c677162013-12-02 14:24:46 -0500353 if (waitqueue_active(&tty->link->read_wait))
354 wake_up_interruptible(&tty->link->read_wait);
Peter Hurleya30737a2013-03-11 16:44:22 -0400355 }
356 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
357}
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359/**
360 * n_tty_flush_buffer - clean input queue
361 * @tty: terminal device
362 *
Peter Hurley25518c62013-03-11 16:44:31 -0400363 * Flush the input buffer. Called when the tty layer wants the
364 * buffer flushed (eg at hangup) or when the N_TTY line discipline
365 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400367 * Holds termios_rwsem to exclude producer/consumer while
368 * buffer indices are reset.
369 *
370 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 */
Alan Cox4edf1822008-02-08 04:18:44 -0800372
373static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400375 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400376 reset_buffer_flags(tty->disc_data);
377 n_tty_set_room(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800378
Peter Hurleya30737a2013-03-11 16:44:22 -0400379 if (tty->link)
380 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400381 up_write(&tty->termios_rwsem);
382}
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384/**
385 * n_tty_chars_in_buffer - report available bytes
386 * @tty: tty device
387 *
388 * Report the number of characters buffered to be delivered to user
Alan Cox4edf1822008-02-08 04:18:44 -0800389 * at this instant in time.
Alan Cox17b82062008-10-13 10:45:06 +0100390 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400391 * Locking: exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 */
Alan Cox4edf1822008-02-08 04:18:44 -0800393
Peter Hurleya19d0c62013-06-15 09:14:18 -0400394static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
395{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400396 ssize_t n;
397
Peter Hurley47534082013-06-15 09:14:19 -0400398 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400399
400 down_write(&tty->termios_rwsem);
401 n = chars_in_buffer(tty);
402 up_write(&tty->termios_rwsem);
403 return n;
Peter Hurleya19d0c62013-06-15 09:14:18 -0400404}
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406/**
407 * is_utf8_continuation - utf8 multibyte check
408 * @c: byte to check
409 *
410 * Returns true if the utf8 character 'c' is a multibyte continuation
411 * character. We use this to correctly compute the on screen size
412 * of the character when printing
413 */
Alan Cox4edf1822008-02-08 04:18:44 -0800414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415static inline int is_utf8_continuation(unsigned char c)
416{
417 return (c & 0xc0) == 0x80;
418}
419
420/**
421 * is_continuation - multibyte check
422 * @c: byte to check
423 *
424 * Returns true if the utf8 character 'c' is a multibyte continuation
425 * character and the terminal is in unicode mode.
426 */
Alan Cox4edf1822008-02-08 04:18:44 -0800427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428static inline int is_continuation(unsigned char c, struct tty_struct *tty)
429{
430 return I_IUTF8(tty) && is_utf8_continuation(c);
431}
432
433/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000434 * do_output_char - output one character
435 * @c: character (or partial unicode symbol)
436 * @tty: terminal device
437 * @space: space available in tty driver write buffer
438 *
439 * This is a helper function that handles one output character
440 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600441 * doing OPOST processing and putting the results in the
442 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000443 *
444 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
445 * and NLDLY. They simply aren't relevant in the world today.
446 * If you ever need them, add them here.
447 *
448 * Returns the number of bytes of buffer space used or -1 if
449 * no space left.
450 *
451 * Locking: should be called under the output_lock to protect
452 * the column state and space left in the buffer
453 */
454
455static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
456{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200457 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000458 int spaces;
459
460 if (!space)
461 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000462
Joe Petersona88a69c2009-01-02 13:40:53 +0000463 switch (c) {
464 case '\n':
465 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200466 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000467 if (O_ONLCR(tty)) {
468 if (space < 2)
469 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200470 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700471 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000472 return 2;
473 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200474 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000475 break;
476 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200477 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000478 return 0;
479 if (O_OCRNL(tty)) {
480 c = '\n';
481 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200482 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000483 break;
484 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200485 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000486 break;
487 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200488 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000489 if (O_TABDLY(tty) == XTABS) {
490 if (space < spaces)
491 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200492 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000493 tty->ops->write(tty, " ", spaces);
494 return spaces;
495 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200496 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000497 break;
498 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200499 if (ldata->column > 0)
500 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000501 break;
502 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000503 if (!iscntrl(c)) {
504 if (O_OLCUC(tty))
505 c = toupper(c);
506 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200507 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000508 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000509 break;
510 }
511
512 tty_put_char(tty, c);
513 return 1;
514}
515
516/**
517 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 * @c: character (or partial unicode symbol)
519 * @tty: terminal device
520 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600521 * Output one character with OPOST processing.
522 * Returns -1 when the output device is full and the character
523 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000525 * Locking: output_lock to protect column state and space left
526 * (also, this is called from n_tty_write under the
527 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 */
Alan Cox4edf1822008-02-08 04:18:44 -0800529
Joe Petersona88a69c2009-01-02 13:40:53 +0000530static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Jiri Slabybddc7152012-10-18 22:26:42 +0200532 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000533 int space, retval;
534
Jiri Slabybddc7152012-10-18 22:26:42 +0200535 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Alan Coxf34d7a52008-04-30 00:54:13 -0700537 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000538 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Jiri Slabybddc7152012-10-18 22:26:42 +0200540 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000541 if (retval < 0)
542 return -1;
543 else
544 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
546
547/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000548 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600550 * @buf: character buffer
551 * @nr: number of bytes to output
552 *
553 * Output a block of characters with OPOST processing.
554 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 *
556 * This path is used to speed up block console writes, among other
557 * things when processing blocks of output data. It handles only
558 * the simple cases normally found and helps to generate blocks of
559 * symbols for the console driver and thus improve performance.
560 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000561 * Locking: output_lock to protect column state and space left
562 * (also, this is called from n_tty_write under the
563 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 */
Alan Cox4edf1822008-02-08 04:18:44 -0800565
Joe Petersona88a69c2009-01-02 13:40:53 +0000566static ssize_t process_output_block(struct tty_struct *tty,
567 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200569 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100571 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 const unsigned char *cp;
573
Jiri Slabybddc7152012-10-18 22:26:42 +0200574 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000575
Alan Coxf34d7a52008-04-30 00:54:13 -0700576 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000577 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200578 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000580 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 if (nr > space)
582 nr = space;
583
584 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000585 unsigned char c = *cp;
586
587 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 case '\n':
589 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200590 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 if (O_ONLCR(tty))
592 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200593 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 break;
595 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200596 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 goto break_out;
598 if (O_OCRNL(tty))
599 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200600 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 break;
602 case '\t':
603 goto break_out;
604 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200605 if (ldata->column > 0)
606 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 break;
608 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000609 if (!iscntrl(c)) {
610 if (O_OLCUC(tty))
611 goto break_out;
612 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200613 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000614 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 break;
616 }
617 }
618break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700619 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000620
Jiri Slabybddc7152012-10-18 22:26:42 +0200621 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 return i;
623}
624
Joe Petersona88a69c2009-01-02 13:40:53 +0000625/**
626 * process_echoes - write pending echo characters
627 * @tty: terminal device
628 *
629 * Write previously buffered echo (and other ldisc-generated)
630 * characters to the tty.
631 *
632 * Characters generated by the ldisc (including echoes) need to
633 * be buffered because the driver's write buffer can fill during
634 * heavy program output. Echoing straight to the driver will
635 * often fail under these conditions, causing lost characters and
636 * resulting mismatches of ldisc state information.
637 *
638 * Since the ldisc state must represent the characters actually sent
639 * to the driver at the time of the write, operations like certain
640 * changes in column state are also saved in the buffer and executed
641 * here.
642 *
643 * A circular fifo buffer is used so that the most recent characters
644 * are prioritized. Also, when control characters are echoed with a
645 * prefixed "^", the pair is treated atomically and thus not separated.
646 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400647 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000648 */
649
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400650static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000651{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200652 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400653 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400654 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000655 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000656
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400657 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000658
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400659 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400660 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400661 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000662 if (c == ECHO_OP_START) {
663 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000664 int no_space_left = 0;
665
666 /*
667 * If the buffer byte is the start of a multi-byte
668 * operation, get the next byte, which is either the
669 * op code or a control character value.
670 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400671 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000672
Joe Petersona88a69c2009-01-02 13:40:53 +0000673 switch (op) {
674 unsigned int num_chars, num_bs;
675
676 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400677 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000678
679 /*
680 * Determine how many columns to go back
681 * in order to erase the tab.
682 * This depends on the number of columns
683 * used by other characters within the tab
684 * area. If this (modulo 8) count is from
685 * the start of input rather than from a
686 * previous tab, we offset by canon column.
687 * Otherwise, tab spacing is normal.
688 */
689 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200690 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000691 num_bs = 8 - (num_chars & 7);
692
693 if (num_bs > space) {
694 no_space_left = 1;
695 break;
696 }
697 space -= num_bs;
698 while (num_bs--) {
699 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200700 if (ldata->column > 0)
701 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000702 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400703 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000704 break;
705
706 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200707 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400708 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000709 break;
710
711 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200712 if (ldata->column > 0)
713 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400714 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000715 break;
716
717 case ECHO_OP_START:
718 /* This is an escaped echo op start code */
719 if (!space) {
720 no_space_left = 1;
721 break;
722 }
723 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200724 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000725 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400726 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000727 break;
728
729 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000730 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600731 * If the op is not a special byte code,
732 * it is a ctrl char tagged to be echoed
733 * as "^X" (where X is the letter
734 * representing the control char).
735 * Note that we must ensure there is
736 * enough space for the whole ctrl pair.
737 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000738 */
Joe Peterson62b26352009-09-09 15:03:47 -0600739 if (space < 2) {
740 no_space_left = 1;
741 break;
742 }
743 tty_put_char(tty, '^');
744 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200745 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600746 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400747 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000748 }
749
750 if (no_space_left)
751 break;
752 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400753 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600754 int retval = do_output_char(c, tty, space);
755 if (retval < 0)
756 break;
757 space -= retval;
758 } else {
759 if (!space)
760 break;
761 tty_put_char(tty, c);
762 space -= 1;
763 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400764 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000765 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000766 }
767
Peter Hurleycbfd0342013-06-15 10:04:26 -0400768 /* If the echo buffer is nearly full (so that the possibility exists
769 * of echo overrun before the next commit), then discard enough
770 * data at the tail to prevent a subsequent overrun */
771 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
Roel Kluinc476f652013-10-11 22:08:49 +0200772 if (echo_buf(ldata, tail) == ECHO_OP_START) {
Peter Hurley6f222532013-11-08 09:42:18 -0500773 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400774 tail += 3;
775 else
776 tail += 2;
777 } else
778 tail++;
779 }
780
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400781 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400782 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000783}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Peter Hurley17bd7902013-06-15 10:04:24 -0400785static void commit_echoes(struct tty_struct *tty)
786{
787 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400788 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400789 size_t head;
790
791 head = ldata->echo_head;
792 old = ldata->echo_commit - ldata->echo_tail;
793
794 /* Process committed echoes if the accumulated # of bytes
795 * is over the threshold (and try again each time another
796 * block is accumulated) */
797 nr = head - ldata->echo_tail;
798 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
799 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400800
Peter Hurley019ebdf2013-06-15 10:04:25 -0400801 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400802 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400803 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400804 mutex_unlock(&ldata->output_lock);
805
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400806 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400807 tty->ops->flush_chars(tty);
808}
809
810static void process_echoes(struct tty_struct *tty)
811{
812 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400813 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400814
Peter Hurley39434ab2013-11-29 12:56:10 -0500815 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
816 ldata->echo_commit == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400817 return;
818
819 mutex_lock(&ldata->output_lock);
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400820 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400821 mutex_unlock(&ldata->output_lock);
822
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400823 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400824 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400825}
826
Peter Hurleycbfd0342013-06-15 10:04:26 -0400827static void flush_echoes(struct tty_struct *tty)
828{
829 struct n_tty_data *ldata = tty->disc_data;
830
Peter Hurley39434ab2013-11-29 12:56:10 -0500831 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
832 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400833 return;
834
835 mutex_lock(&ldata->output_lock);
836 ldata->echo_commit = ldata->echo_head;
837 __process_echoes(tty);
838 mutex_unlock(&ldata->output_lock);
839}
840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000842 * add_echo_byte - add a byte to the echo buffer
843 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200844 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000845 *
846 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000847 */
848
Peter Hurleycbfd0342013-06-15 10:04:26 -0400849static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000850{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400851 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000852}
853
854/**
855 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200856 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000857 *
858 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000859 */
860
Jiri Slaby57c94122012-10-18 22:26:43 +0200861static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000862{
Jiri Slaby57c94122012-10-18 22:26:43 +0200863 add_echo_byte(ECHO_OP_START, ldata);
864 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000865}
866
867/**
868 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200869 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000870 *
871 * Add an operation to the echo buffer to set the canon column
872 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000873 */
874
Jiri Slaby57c94122012-10-18 22:26:43 +0200875static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000876{
Jiri Slaby57c94122012-10-18 22:26:43 +0200877 add_echo_byte(ECHO_OP_START, ldata);
878 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000879}
880
881/**
882 * echo_erase_tab - add operation to erase a tab
883 * @num_chars: number of character columns already used
884 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200885 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000886 *
887 * Add an operation to the echo buffer to erase a tab.
888 *
889 * Called by the eraser function, which knows how many character
890 * columns have been used since either a previous tab or the start
891 * of input. This information will be used later, along with
892 * canon column (if applicable), to go back the correct number
893 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000894 */
895
896static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200897 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000898{
Jiri Slaby57c94122012-10-18 22:26:43 +0200899 add_echo_byte(ECHO_OP_START, ldata);
900 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000901
902 /* We only need to know this modulo 8 (tab spacing) */
903 num_chars &= 7;
904
905 /* Set the high bit as a flag if num_chars is after a previous tab */
906 if (after_tab)
907 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000908
Jiri Slaby57c94122012-10-18 22:26:43 +0200909 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000910}
911
912/**
913 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 * @c: unicode byte to echo
915 * @tty: terminal device
916 *
Alan Cox4edf1822008-02-08 04:18:44 -0800917 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100919 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000920 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000921 */
922
Jiri Slaby57c94122012-10-18 22:26:43 +0200923static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000924{
Joe Petersona88a69c2009-01-02 13:40:53 +0000925 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200926 add_echo_byte(ECHO_OP_START, ldata);
927 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000928 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200929 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000930 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000931}
932
933/**
934 * echo_char - echo a character
935 * @c: unicode byte to echo
936 * @tty: terminal device
937 *
938 * Echo user input back onto the screen. This must be called only when
939 * L_ECHO(tty) is true. Called from the driver receive_buf path.
940 *
Joe Peterson62b26352009-09-09 15:03:47 -0600941 * This variant tags control characters to be echoed as "^X"
942 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 */
944
945static void echo_char(unsigned char c, struct tty_struct *tty)
946{
Jiri Slabybddc7152012-10-18 22:26:42 +0200947 struct n_tty_data *ldata = tty->disc_data;
948
Joe Petersona88a69c2009-01-02 13:40:53 +0000949 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200950 add_echo_byte(ECHO_OP_START, ldata);
951 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000952 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600953 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200954 add_echo_byte(ECHO_OP_START, ldata);
955 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
958
Alan Cox17b82062008-10-13 10:45:06 +0100959/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000960 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200961 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100962 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000963
Jiri Slaby57c94122012-10-18 22:26:43 +0200964static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200966 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200967 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200968 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 }
970}
971
972/**
973 * eraser - handle erase function
974 * @c: character input
975 * @tty: terminal device
976 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200977 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 * present in the stream from the driver layer. Handles the complexities
979 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100980 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400981 * n_tty_receive_buf()/producer path:
982 * caller holds non-exclusive termios_rwsem
983 * modifies read_head
984 *
985 * Modifying the read_head is not considered a publish in this context
986 * because canonical mode is active -- only canon_head publishes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 */
Alan Cox4edf1822008-02-08 04:18:44 -0800988
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989static void eraser(unsigned char c, struct tty_struct *tty)
990{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200991 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400993 size_t head;
994 size_t cnt;
995 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200997 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +0000998 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 return;
1000 }
1001 if (c == ERASE_CHAR(tty))
1002 kill_type = ERASE;
1003 else if (c == WERASE_CHAR(tty))
1004 kill_type = WERASE;
1005 else {
1006 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001007 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 return;
1009 }
1010 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001011 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +02001012 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 echo_char(KILL_CHAR(tty), tty);
1014 /* Add a newline if ECHOK is on and ECHOKE is off. */
1015 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001016 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 return;
1018 }
1019 kill_type = KILL;
1020 }
1021
1022 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001023 while (ldata->read_head != ldata->canon_head) {
1024 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
1026 /* erase a single possibly multibyte character */
1027 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001028 head--;
1029 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001030 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
1032 /* do not partially erase */
1033 if (is_continuation(c, tty))
1034 break;
1035
1036 if (kill_type == WERASE) {
1037 /* Equivalent to BSD's ALTWERASE. */
1038 if (isalnum(c) || c == '_')
1039 seen_alnums++;
1040 else if (seen_alnums)
1041 break;
1042 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001043 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001044 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 if (L_ECHO(tty)) {
1046 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001047 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001048 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001049 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 }
1051 /* if cnt > 1, output a multi-byte character */
1052 echo_char(c, tty);
1053 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001054 head++;
1055 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001056 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 }
1058 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1059 echo_char(ERASE_CHAR(tty), tty);
1060 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001061 unsigned int num_chars = 0;
1062 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001063 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
Joe Petersona88a69c2009-01-02 13:40:53 +00001065 /*
1066 * Count the columns used for characters
1067 * since the start of input or after a
1068 * previous tab.
1069 * This info is used to go back the correct
1070 * number of columns.
1071 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001072 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001073 tail--;
1074 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001075 if (c == '\t') {
1076 after_tab = 1;
1077 break;
Alan Cox300a6202009-01-02 13:41:04 +00001078 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001080 num_chars += 2;
1081 } else if (!is_continuation(c, tty)) {
1082 num_chars++;
1083 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001085 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 } else {
1087 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001088 echo_char_raw('\b', ldata);
1089 echo_char_raw(' ', ldata);
1090 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 }
1092 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001093 echo_char_raw('\b', ldata);
1094 echo_char_raw(' ', ldata);
1095 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 }
1097 }
1098 }
1099 if (kill_type == ERASE)
1100 break;
1101 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001102 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001103 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104}
1105
1106/**
1107 * isig - handle the ISIG optio
1108 * @sig: signal
1109 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001111 * Called when a signal is being sent due to terminal input.
1112 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001113 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001114 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 */
Alan Cox4edf1822008-02-08 04:18:44 -08001116
Peter Hurley4b293492013-07-24 08:29:55 -04001117static void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118{
Peter Hurley8c985d12013-03-06 08:38:19 -05001119 struct pid *tty_pgrp = tty_get_pgrp(tty);
1120 if (tty_pgrp) {
1121 kill_pgrp(tty_pgrp, sig, 1);
1122 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 }
1124}
1125
1126/**
1127 * n_tty_receive_break - handle break
1128 * @tty: terminal
1129 *
1130 * An RS232 break event has been hit in the incoming bitstream. This
1131 * can cause a variety of events depending upon the termios settings.
1132 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001133 * n_tty_receive_buf()/producer path:
1134 * caller holds non-exclusive termios_rwsem
1135 * publishes read_head via put_tty_queue()
1136 *
1137 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 */
Alan Cox4edf1822008-02-08 04:18:44 -08001139
Peter Hurley4b293492013-07-24 08:29:55 -04001140static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141{
Jiri Slaby57c94122012-10-18 22:26:43 +02001142 struct n_tty_data *ldata = tty->disc_data;
1143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 if (I_IGNBRK(tty))
1145 return;
1146 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001147 isig(SIGINT, tty);
1148 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001149 /* flushing needs exclusive termios_rwsem */
1150 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001151 n_tty_flush_buffer(tty);
1152 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001153 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 return;
1156 }
1157 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001158 put_tty_queue('\377', ldata);
1159 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001161 put_tty_queue('\0', ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001162 if (waitqueue_active(&tty->read_wait))
1163 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164}
1165
1166/**
1167 * n_tty_receive_overrun - handle overrun reporting
1168 * @tty: terminal
1169 *
1170 * Data arrived faster than we could process it. While the tty
1171 * driver has flagged this the bits that were missed are gone
1172 * forever.
1173 *
1174 * Called from the receive_buf path so single threaded. Does not
1175 * need locking as num_overrun and overrun_time are function
1176 * private.
1177 */
Alan Cox4edf1822008-02-08 04:18:44 -08001178
Peter Hurley4b293492013-07-24 08:29:55 -04001179static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001181 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 char buf[64];
1183
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001184 ldata->num_overrun++;
1185 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1186 time_after(ldata->overrun_time, jiffies)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1188 tty_name(tty, buf),
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001189 ldata->num_overrun);
1190 ldata->overrun_time = jiffies;
1191 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 }
1193}
1194
1195/**
1196 * n_tty_receive_parity_error - error notifier
1197 * @tty: terminal device
1198 * @c: character
1199 *
1200 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001201 * the error case if necessary.
1202 *
1203 * n_tty_receive_buf()/producer path:
1204 * caller holds non-exclusive termios_rwsem
1205 * publishes read_head via put_tty_queue()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 */
Peter Hurley4b293492013-07-24 08:29:55 -04001207static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208{
Jiri Slaby57c94122012-10-18 22:26:43 +02001209 struct n_tty_data *ldata = tty->disc_data;
1210
Alan Cox4edf1822008-02-08 04:18:44 -08001211 if (I_IGNPAR(tty))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001214 put_tty_queue('\377', ldata);
1215 put_tty_queue('\0', ldata);
1216 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 } else if (I_INPCK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001218 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 else
Jiri Slaby57c94122012-10-18 22:26:43 +02001220 put_tty_queue(c, ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001221 if (waitqueue_active(&tty->read_wait))
1222 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223}
1224
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001225static void
1226n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1227{
1228 if (!L_NOFLSH(tty)) {
1229 /* flushing needs exclusive termios_rwsem */
1230 up_read(&tty->termios_rwsem);
1231 n_tty_flush_buffer(tty);
1232 tty_driver_flush_buffer(tty);
1233 down_read(&tty->termios_rwsem);
1234 }
1235 if (I_IXON(tty))
1236 start_tty(tty);
1237 if (L_ECHO(tty)) {
1238 echo_char(c, tty);
1239 commit_echoes(tty);
1240 }
1241 isig(signal, tty);
1242 return;
1243}
1244
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245/**
1246 * n_tty_receive_char - perform processing
1247 * @tty: terminal device
1248 * @c: character
1249 *
1250 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001251 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001253 *
1254 * n_tty_receive_buf()/producer path:
1255 * caller holds non-exclusive termios_rwsem
1256 * publishes canon_head if canonical mode is active
1257 * otherwise, publishes read_head via put_tty_queue()
Peter Hurleye60d27c2013-07-24 08:29:56 -04001258 *
1259 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 */
1261
Peter Hurleye60d27c2013-07-24 08:29:56 -04001262static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001263n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001265 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 if (I_IXON(tty)) {
1268 if (c == START_CHAR(tty)) {
1269 start_tty(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001270 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001271 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 }
1273 if (c == STOP_CHAR(tty)) {
1274 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001275 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 }
1277 }
Joe Peterson575537b32008-04-30 00:53:30 -07001278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001280 if (c == INTR_CHAR(tty)) {
1281 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001282 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001283 } else if (c == QUIT_CHAR(tty)) {
1284 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001285 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001286 } else if (c == SUSP_CHAR(tty)) {
1287 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001288 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 }
1290 }
Joe Peterson575537b32008-04-30 00:53:30 -07001291
Peter Hurley855df3c2013-07-24 08:29:50 -04001292 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1293 start_tty(tty);
1294 process_echoes(tty);
1295 }
1296
Joe Peterson575537b32008-04-30 00:53:30 -07001297 if (c == '\r') {
1298 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001299 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001300 if (I_ICRNL(tty))
1301 c = '\n';
1302 } else if (c == '\n' && I_INLCR(tty))
1303 c = '\r';
1304
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001305 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1307 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1308 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001309 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001310 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 }
1312 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001313 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001315 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001317 echo_char_raw('^', ldata);
1318 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001319 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 }
1321 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001322 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001324 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001325 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
Jiri Slaby57c94122012-10-18 22:26:43 +02001327 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001329 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001330 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001331 echo_char(read_buf(ldata, tail), tty);
1332 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001334 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001335 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 }
1337 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001338 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001339 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001340 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 }
1342 goto handle_newline;
1343 }
1344 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 c = __DISABLED_CHAR;
1346 goto handle_newline;
1347 }
1348 if ((c == EOL_CHAR(tty)) ||
1349 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1350 /*
1351 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1352 */
1353 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001355 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001356 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001358 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 }
1360 /*
1361 * XXX does PARMRK doubling happen for
1362 * EOL_CHAR and EOL2_CHAR?
1363 */
Peter Hurley001ba922013-12-02 14:24:44 -05001364 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001365 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
Alan Cox4edf1822008-02-08 04:18:44 -08001367handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001368 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001369 put_tty_queue(c, ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001370 ldata->canon_head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1372 if (waitqueue_active(&tty->read_wait))
1373 wake_up_interruptible(&tty->read_wait);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001374 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 }
1376 }
Alan Cox4edf1822008-02-08 04:18:44 -08001377
Joe Petersonacc71bb2009-01-02 13:43:32 +00001378 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001379 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001381 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 else {
1383 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001384 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001385 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 echo_char(c, tty);
1387 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001388 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 }
1390
Peter Hurley001ba922013-12-02 14:24:44 -05001391 /* PARMRK doubling check */
1392 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001393 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
Jiri Slaby57c94122012-10-18 22:26:43 +02001395 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001396 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001397}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Peter Hurleye60d27c2013-07-24 08:29:56 -04001399static inline void
1400n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001401{
1402 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001403
Peter Hurleye60d27c2013-07-24 08:29:56 -04001404 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1405 start_tty(tty);
1406 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001407 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001408 if (L_ECHO(tty)) {
1409 finish_erasing(ldata);
1410 /* Record the column of first canon char. */
1411 if (ldata->canon_head == ldata->read_head)
1412 echo_set_canon_col(ldata);
1413 echo_char(c, tty);
1414 commit_echoes(tty);
1415 }
Peter Hurley001ba922013-12-02 14:24:44 -05001416 /* PARMRK doubling check */
1417 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001418 put_tty_queue(c, ldata);
1419 put_tty_queue(c, ldata);
1420}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001421
Peter Hurleyeb3e4662013-12-02 14:24:42 -05001422static void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
Peter Hurleye60d27c2013-07-24 08:29:56 -04001423{
1424 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001425}
1426
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001427static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001428n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1429{
1430 struct n_tty_data *ldata = tty->disc_data;
1431
Peter Hurleye60d27c2013-07-24 08:29:56 -04001432 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1433 start_tty(tty);
1434 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001435 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001436 if (L_ECHO(tty)) {
1437 finish_erasing(ldata);
1438 /* Record the column of first canon char. */
1439 if (ldata->canon_head == ldata->read_head)
1440 echo_set_canon_col(ldata);
1441 echo_char(c, tty);
1442 commit_echoes(tty);
1443 }
1444 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001445}
1446
Peter Hurley8dc4b252013-12-02 14:24:43 -05001447static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001448{
1449 if (I_ISTRIP(tty))
1450 c &= 0x7f;
1451 if (I_IUCLC(tty) && L_IEXTEN(tty))
1452 c = tolower(c);
1453
1454 if (I_IXON(tty)) {
1455 if (c == STOP_CHAR(tty))
1456 stop_tty(tty);
1457 else if (c == START_CHAR(tty) ||
1458 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1459 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1460 c != SUSP_CHAR(tty))) {
1461 start_tty(tty);
1462 process_echoes(tty);
1463 }
1464 }
1465}
1466
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001467static void
1468n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1469{
1470 char buf[64];
1471
1472 switch (flag) {
1473 case TTY_BREAK:
1474 n_tty_receive_break(tty);
1475 break;
1476 case TTY_PARITY:
1477 case TTY_FRAME:
1478 n_tty_receive_parity_error(tty, c);
1479 break;
1480 case TTY_OVERRUN:
1481 n_tty_receive_overrun(tty);
1482 break;
1483 default:
1484 printk(KERN_ERR "%s: unknown flag %d\n",
1485 tty_name(tty, buf), flag);
1486 break;
1487 }
1488}
1489
Peter Hurleye60d27c2013-07-24 08:29:56 -04001490static void
1491n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1492{
1493 struct n_tty_data *ldata = tty->disc_data;
1494
1495 ldata->lnext = 0;
1496 if (likely(flag == TTY_NORMAL)) {
1497 if (I_ISTRIP(tty))
1498 c &= 0x7f;
1499 if (I_IUCLC(tty) && L_IEXTEN(tty))
1500 c = tolower(c);
1501 n_tty_receive_char(tty, c);
1502 } else
1503 n_tty_receive_char_flagged(tty, c, flag);
1504}
1505
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506/**
1507 * n_tty_receive_buf - data receive
1508 * @tty: terminal device
1509 * @cp: buffer
1510 * @fp: flag buffer
1511 * @count: characters
1512 *
1513 * Called by the terminal driver when a block of characters has
1514 * been received. This function must be called from soft contexts
1515 * not from interrupt context. The driver is responsible for making
1516 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001517 *
1518 * n_tty_receive_buf()/producer path:
1519 * claims non-exclusive termios_rwsem
1520 * publishes read_head and canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 */
Alan Cox4edf1822008-02-08 04:18:44 -08001522
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001523static void
1524n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1525 char *fp, int count)
1526{
1527 struct n_tty_data *ldata = tty->disc_data;
1528 size_t n, head;
1529
1530 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1531 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1532 n = min_t(size_t, count, n);
1533 memcpy(read_buf_addr(ldata, head), cp, n);
1534 ldata->read_head += n;
1535 cp += n;
1536 count -= n;
1537
1538 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1539 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1540 n = min_t(size_t, count, n);
1541 memcpy(read_buf_addr(ldata, head), cp, n);
1542 ldata->read_head += n;
1543}
1544
Peter Hurley554117b2013-06-15 10:21:25 -04001545static void
1546n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1547 char *fp, int count)
1548{
1549 struct n_tty_data *ldata = tty->disc_data;
1550 char flag = TTY_NORMAL;
1551
1552 while (count--) {
1553 if (fp)
1554 flag = *fp++;
1555 if (likely(flag == TTY_NORMAL))
1556 put_tty_queue(*cp++, ldata);
1557 else
1558 n_tty_receive_char_flagged(tty, *cp++, flag);
1559 }
1560}
1561
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001562static void
1563n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1564 char *fp, int count)
1565{
1566 char flag = TTY_NORMAL;
1567
1568 while (count--) {
1569 if (fp)
1570 flag = *fp++;
1571 if (likely(flag == TTY_NORMAL))
1572 n_tty_receive_char_closing(tty, *cp++);
1573 else
1574 n_tty_receive_char_flagged(tty, *cp++, flag);
1575 }
1576}
1577
Peter Hurley7d88d632013-07-24 08:29:49 -04001578static void
1579n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001580 char *fp, int count)
1581{
1582 struct n_tty_data *ldata = tty->disc_data;
1583 char flag = TTY_NORMAL;
1584
1585 while (count--) {
1586 if (fp)
1587 flag = *fp++;
1588 if (likely(flag == TTY_NORMAL)) {
1589 unsigned char c = *cp++;
1590
1591 if (I_ISTRIP(tty))
1592 c &= 0x7f;
1593 if (I_IUCLC(tty) && L_IEXTEN(tty))
1594 c = tolower(c);
1595 if (L_EXTPROC(tty)) {
1596 put_tty_queue(c, ldata);
1597 continue;
1598 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001599 if (!test_bit(c, ldata->char_map))
1600 n_tty_receive_char_inline(tty, c);
1601 else if (n_tty_receive_char_special(tty, c) && count) {
1602 if (fp)
1603 flag = *fp++;
1604 n_tty_receive_char_lnext(tty, *cp++, flag);
1605 count--;
1606 }
Peter Hurley6baad002013-07-24 08:29:52 -04001607 } else
1608 n_tty_receive_char_flagged(tty, *cp++, flag);
1609 }
1610}
1611
1612static void
1613n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1614 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001615{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001616 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001617 char flag = TTY_NORMAL;
1618
1619 while (count--) {
1620 if (fp)
1621 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001622 if (likely(flag == TTY_NORMAL)) {
1623 unsigned char c = *cp++;
1624
1625 if (!test_bit(c, ldata->char_map))
1626 n_tty_receive_char_fast(tty, c);
1627 else if (n_tty_receive_char_special(tty, c) && count) {
1628 if (fp)
1629 flag = *fp++;
1630 n_tty_receive_char_lnext(tty, *cp++, flag);
1631 count--;
1632 }
1633 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001634 n_tty_receive_char_flagged(tty, *cp++, flag);
1635 }
1636}
1637
Peter Hurley24a89d12013-06-15 09:14:15 -04001638static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1639 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001641 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001642 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001644 if (ldata->real_raw)
1645 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001646 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117b2013-06-15 10:21:25 -04001647 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001648 else if (tty->closing && !L_EXTPROC(tty))
1649 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001650 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001651 if (ldata->lnext) {
1652 char flag = TTY_NORMAL;
1653
1654 if (fp)
1655 flag = *fp++;
1656 n_tty_receive_char_lnext(tty, *cp++, flag);
1657 count--;
1658 }
1659
Peter Hurley7de971b2013-07-24 08:29:53 -04001660 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001661 n_tty_receive_buf_fast(tty, cp, fp, count);
1662 else
1663 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001664
1665 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001666 if (tty->ops->flush_chars)
1667 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 }
1669
Peter Hurleyce741172013-06-15 09:14:20 -04001670 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
hyc@symas.com26df6d12010-06-22 10:14:49 -07001671 L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1673 if (waitqueue_active(&tty->read_wait))
1674 wake_up_interruptible(&tty->read_wait);
1675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676}
1677
Peter Hurley5c32d122013-12-02 14:24:41 -05001678static int
1679n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1680 char *fp, int count, int flow)
Peter Hurley24a89d12013-06-15 09:14:15 -04001681{
1682 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley19e2ad62013-07-24 08:29:54 -04001683 int room, n, rcvd = 0;
Peter Hurley24a89d12013-06-15 09:14:15 -04001684
Peter Hurley9356b532013-06-15 09:14:24 -04001685 down_read(&tty->termios_rwsem);
1686
Peter Hurley19e2ad62013-07-24 08:29:54 -04001687 while (1) {
1688 room = receive_room(tty);
1689 n = min(count, room);
1690 if (!n) {
Peter Hurley5c32d122013-12-02 14:24:41 -05001691 if (flow && !room)
Peter Hurley19e2ad62013-07-24 08:29:54 -04001692 ldata->no_room = 1;
1693 break;
1694 }
1695 __receive_buf(tty, cp, fp, n);
1696 cp += n;
1697 if (fp)
1698 fp += n;
1699 count -= n;
1700 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001701 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001702
Peter Hurley19e2ad62013-07-24 08:29:54 -04001703 tty->receive_room = room;
1704 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001705 up_read(&tty->termios_rwsem);
1706
Peter Hurley19e2ad62013-07-24 08:29:54 -04001707 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001708}
1709
Peter Hurley5c32d122013-12-02 14:24:41 -05001710static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1711 char *fp, int count)
1712{
1713 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1714}
1715
1716static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1717 char *fp, int count)
1718{
1719 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1720}
1721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722int is_ignored(int sig)
1723{
1724 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001725 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726}
1727
1728/**
1729 * n_tty_set_termios - termios data changed
1730 * @tty: terminal
1731 * @old: previous data
1732 *
1733 * Called by the tty layer when the user changes termios flags so
1734 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001735 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 * guaranteed that this function will not be re-entered or in progress
1737 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001738 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001739 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 */
Alan Cox4edf1822008-02-08 04:18:44 -08001741
1742static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001744 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001745
Peter Hurleyc786f742013-09-17 12:53:35 -04001746 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001747 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley93a8d412013-09-17 12:34:14 -04001748 ldata->line_start = ldata->canon_head = ldata->read_tail;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001749 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001750 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001751 }
1752
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001753 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1756 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1757 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1758 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001759 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
1761 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001762 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001764 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
1766 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001767 set_bit(ERASE_CHAR(tty), ldata->char_map);
1768 set_bit(KILL_CHAR(tty), ldata->char_map);
1769 set_bit(EOF_CHAR(tty), ldata->char_map);
1770 set_bit('\n', ldata->char_map);
1771 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001773 set_bit(WERASE_CHAR(tty), ldata->char_map);
1774 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1775 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 if (L_ECHO(tty))
1777 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001778 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 }
1780 }
1781 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001782 set_bit(START_CHAR(tty), ldata->char_map);
1783 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
1785 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001786 set_bit(INTR_CHAR(tty), ldata->char_map);
1787 set_bit(QUIT_CHAR(tty), ldata->char_map);
1788 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001790 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001791 ldata->raw = 0;
1792 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001794 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1796 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1797 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001798 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001800 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
Linus Torvalds55db4c62011-06-04 06:33:24 +09001802 n_tty_set_room(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001803 /*
1804 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1805 * been stopped by STOP_CHAR(tty) before it.
1806 */
Peter Hurley103fcbe22013-09-17 12:53:36 -04001807 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped)
Wang YanQingdab73b42013-05-09 14:16:47 +08001808 start_tty(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001809
Alan Coxf34d7a52008-04-30 00:54:13 -07001810 /* The termios change make the tty ready for I/O */
Peter Hurley6c677162013-12-02 14:24:46 -05001811 if (waitqueue_active(&tty->write_wait))
1812 wake_up_interruptible(&tty->write_wait);
1813 if (waitqueue_active(&tty->read_wait))
1814 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815}
1816
1817/**
1818 * n_tty_close - close the ldisc for this tty
1819 * @tty: device
1820 *
Alan Cox4edf1822008-02-08 04:18:44 -08001821 * Called from the terminal layer when this line discipline is
1822 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 * discipline change. The function will not be called while other
1824 * ldisc methods are in progress.
1825 */
Alan Cox4edf1822008-02-08 04:18:44 -08001826
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827static void n_tty_close(struct tty_struct *tty)
1828{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001829 struct n_tty_data *ldata = tty->disc_data;
1830
Peter Hurley79901312013-03-11 16:44:23 -04001831 if (tty->link)
1832 n_tty_packet_mode_flush(tty);
1833
Peter Hurley20bafb32013-06-15 10:21:19 -04001834 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001835 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836}
1837
1838/**
1839 * n_tty_open - open an ldisc
1840 * @tty: terminal to open
1841 *
Alan Cox4edf1822008-02-08 04:18:44 -08001842 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 * terminal device. Can sleep. Called serialized so that no
1844 * other events will occur in parallel. No further open will occur
1845 * until a close.
1846 */
1847
1848static int n_tty_open(struct tty_struct *tty)
1849{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001850 struct n_tty_data *ldata;
1851
Peter Hurley20bafb32013-06-15 10:21:19 -04001852 /* Currently a malloc failure here can panic */
1853 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001854 if (!ldata)
1855 goto err;
1856
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001857 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001858 mutex_init(&ldata->atomic_read_lock);
1859 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001860
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001861 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001862 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001863 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001864 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001865 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001866 ldata->num_overrun = 0;
1867 ldata->no_room = 0;
1868 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001870 /* indicate buffer work may resume */
1871 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1872 n_tty_set_termios(tty, NULL);
1873 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001874
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001876err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001877 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878}
1879
Peter Hurleyeafbe672013-12-02 14:24:45 -05001880static inline int input_available_p(struct tty_struct *tty, int poll)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001882 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleyeafbe672013-12-02 14:24:45 -05001883 int amt = poll && !TIME_CHAR(tty) ? MIN_CHAR(tty) : 1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001884
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001885 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurleya73d3d62013-06-15 09:14:25 -04001886 if (ldata->canon_head != ldata->read_tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 return 1;
Peter Hurleyeafbe672013-12-02 14:24:45 -05001888 } else if (read_cnt(ldata) >= amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 return 1;
1890
1891 return 0;
1892}
1893
1894/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001895 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 * @tty: terminal device
1897 * @b: user data
1898 * @nr: size of data
1899 *
Alan Cox11a96d12008-10-13 10:46:24 +01001900 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 * ICANON is off; it copies characters straight from the tty queue to
1902 * user space directly. It can be profitably called twice; once to
1903 * drain the space from the tail pointer to the (physical) end of the
1904 * buffer, and once to drain the space from the (physical) beginning of
1905 * the buffer to head pointer.
1906 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001907 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001909 * n_tty_read()/consumer path:
1910 * caller holds non-exclusive termios_rwsem
1911 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 */
Alan Cox4edf1822008-02-08 04:18:44 -08001913
Alan Cox33f0f882006-01-09 20:54:13 -08001914static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 unsigned char __user **b,
1916 size_t *nr)
1917
1918{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001919 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 int retval;
1921 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001922 bool is_eof;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001923 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924
1925 retval = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001926 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001929 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001931 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1932 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001933 ldata->icanon);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001934 ldata->read_tail += n;
hyc@symas.com26df6d12010-06-22 10:14:49 -07001935 /* Turn single EOF into zero-length read */
Peter Hurleyce741172013-06-15 09:14:20 -04001936 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001937 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 *b += n;
1939 *nr -= n;
1940 }
1941 return retval;
1942}
1943
Peter Hurley88bb0de2013-06-15 09:14:16 -04001944/**
Peter Hurley32f13522013-06-15 09:14:17 -04001945 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001946 * @tty: terminal device
1947 * @b: user data
1948 * @nr: size of data
1949 *
1950 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001951 * it copies one line of input up to and including the line-delimiting
1952 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001953 *
1954 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001955 *
1956 * n_tty_read()/consumer path:
1957 * caller holds non-exclusive termios_rwsem
1958 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001959 */
1960
Peter Hurley32f13522013-06-15 09:14:17 -04001961static int canon_copy_from_read_buf(struct tty_struct *tty,
1962 unsigned char __user **b,
1963 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001964{
1965 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001966 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001967 size_t eol;
1968 size_t tail;
1969 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001970 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001971
1972 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyce741172013-06-15 09:14:20 -04001973 n = min(*nr, read_cnt(ldata));
Peter Hurley6d76bd22013-06-15 09:14:26 -04001974 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04001975 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001976
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001977 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04001978 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1979
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001980 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04001981 __func__, *nr, tail, n, size);
1982
1983 eol = find_next_bit(ldata->read_flags, size, tail);
1984 more = n - (size - tail);
1985 if (eol == N_TTY_BUF_SIZE && more) {
1986 /* scan wrapped without finding set bit */
1987 eol = find_next_bit(ldata->read_flags, more, 0);
1988 if (eol != more)
1989 found = 1;
1990 } else if (eol != size)
1991 found = 1;
1992
1993 size = N_TTY_BUF_SIZE - tail;
Peter Hurleyc77569d2013-11-22 07:16:25 -05001994 n = eol - tail;
1995 if (n > 4096)
1996 n += 4096;
1997 n += found;
Peter Hurley32f13522013-06-15 09:14:17 -04001998 c = n;
1999
Peter Hurley40d5e092013-06-15 10:21:17 -04002000 if (found && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002001 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002002 eof_push = !n && ldata->read_tail != ldata->line_start;
2003 }
Peter Hurley32f13522013-06-15 09:14:17 -04002004
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002005 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002006 __func__, eol, found, n, c, size, more);
2007
Peter Hurley32f13522013-06-15 09:14:17 -04002008 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002009 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002010 if (ret)
2011 return -EFAULT;
2012 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2013 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002014 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002015
2016 if (ret)
2017 return -EFAULT;
2018 *b += n;
2019 *nr -= n;
2020
Peter Hurleya73d3d62013-06-15 09:14:25 -04002021 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002022 clear_bit(eol, ldata->read_flags);
2023 smp_mb__after_clear_bit();
2024 ldata->read_tail += c;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002025
Peter Hurley40d5e092013-06-15 10:21:17 -04002026 if (found) {
2027 ldata->line_start = ldata->read_tail;
Peter Hurley32f13522013-06-15 09:14:17 -04002028 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002029 }
2030 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002031}
2032
Al Virocc4191d2008-03-29 03:08:48 +00002033extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002034 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
2036/**
2037 * job_control - check job control
2038 * @tty: tty
2039 * @file: file handle
2040 *
2041 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002042 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002044 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002045 * Locking: redirected write test is safe
2046 * current->signal->tty check is safe
2047 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 */
Alan Cox4edf1822008-02-08 04:18:44 -08002049
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050static int job_control(struct tty_struct *tty, struct file *file)
2051{
2052 /* Job control check -- must be done at start and after
2053 every sleep (POSIX.1 7.1.1.4). */
2054 /* NOTE: not yet done after every sleep pending a thorough
2055 check of the logic of this change. -- jlc */
2056 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002057 if (file->f_op->write == redirected_tty_write ||
2058 current->signal->tty != tty)
2059 return 0;
2060
2061 spin_lock_irq(&tty->ctrl_lock);
2062 if (!tty->pgrp)
2063 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2064 else if (task_pgrp(current) != tty->pgrp) {
2065 spin_unlock_irq(&tty->ctrl_lock);
2066 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2067 return -EIO;
2068 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2069 set_thread_flag(TIF_SIGPENDING);
2070 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002072 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 return 0;
2074}
Alan Cox4edf1822008-02-08 04:18:44 -08002075
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076
2077/**
Alan Cox11a96d12008-10-13 10:46:24 +01002078 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 * @tty: tty device
2080 * @file: file object
2081 * @buf: userspace buffer pointer
2082 * @nr: size of I/O
2083 *
2084 * Perform reads for the line discipline. We are guaranteed that the
2085 * line discipline will not be closed under us but we may get multiple
2086 * parallel readers and must handle this ourselves. We may also get
2087 * a hangup. Always called in user context, may sleep.
2088 *
2089 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002090 *
2091 * n_tty_read()/consumer path:
2092 * claims non-exclusive termios_rwsem
2093 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 */
Alan Cox4edf1822008-02-08 04:18:44 -08002095
Alan Cox11a96d12008-10-13 10:46:24 +01002096static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 unsigned char __user *buf, size_t nr)
2098{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002099 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 unsigned char __user *b = buf;
2101 DECLARE_WAITQUEUE(wait, current);
2102 int c;
2103 int minimum, time;
2104 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 long timeout;
2106 unsigned long flags;
Alan Cox04f378b2008-04-30 00:53:29 -07002107 int packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002110 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002112
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002113 /*
2114 * Internal serialization of reads.
2115 */
2116 if (file->f_flags & O_NONBLOCK) {
2117 if (!mutex_trylock(&ldata->atomic_read_lock))
2118 return -EAGAIN;
2119 } else {
2120 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2121 return -ERESTARTSYS;
2122 }
2123
Peter Hurley9356b532013-06-15 09:14:24 -04002124 down_read(&tty->termios_rwsem);
2125
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 minimum = time = 0;
2127 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002128 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 minimum = MIN_CHAR(tty);
2130 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002131 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002133 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002135 (ldata->minimum_to_wake > minimum))
2136 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002138 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002139 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 }
2141 }
2142
Alan Cox04f378b2008-04-30 00:53:29 -07002143 packet = tty->packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144
2145 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 while (nr) {
2147 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002148 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 unsigned char cs;
2150 if (b != buf)
2151 break;
Alan Cox04f378b2008-04-30 00:53:29 -07002152 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 cs = tty->link->ctrl_status;
2154 tty->link->ctrl_status = 0;
Alan Cox04f378b2008-04-30 00:53:29 -07002155 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002156 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 retval = -EFAULT;
2158 b--;
2159 break;
2160 }
2161 nr--;
2162 break;
2163 }
2164 /* This statement must be first before checking for input
2165 so that any interrupt will set the state back to
2166 TASK_RUNNING. */
2167 set_current_state(TASK_INTERRUPTIBLE);
Alan Cox4edf1822008-02-08 04:18:44 -08002168
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002169 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002171 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002172
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 if (!input_available_p(tty, 0)) {
2174 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
Peter Hurleyf8747d42013-09-27 13:27:05 -04002175 up_read(&tty->termios_rwsem);
2176 tty_flush_to_ldisc(tty);
2177 down_read(&tty->termios_rwsem);
2178 if (!input_available_p(tty, 0)) {
2179 retval = -EIO;
2180 break;
2181 }
2182 } else {
2183 if (tty_hung_up_p(file))
2184 break;
2185 if (!timeout)
2186 break;
2187 if (file->f_flags & O_NONBLOCK) {
2188 retval = -EAGAIN;
2189 break;
2190 }
2191 if (signal_pending(current)) {
2192 retval = -ERESTARTSYS;
2193 break;
2194 }
2195 n_tty_set_room(tty);
2196 up_read(&tty->termios_rwsem);
Peter Hurley9356b532013-06-15 09:14:24 -04002197
Peter Hurleyf8747d42013-09-27 13:27:05 -04002198 timeout = schedule_timeout(timeout);
Peter Hurley9356b532013-06-15 09:14:24 -04002199
Peter Hurleyf8747d42013-09-27 13:27:05 -04002200 down_read(&tty->termios_rwsem);
2201 continue;
2202 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 }
2204 __set_current_state(TASK_RUNNING);
2205
2206 /* Deal with packet mode. */
Alan Cox04f378b2008-04-30 00:53:29 -07002207 if (packet && b == buf) {
Miloslav Trmac522ed772007-07-15 23:40:56 -07002208 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 retval = -EFAULT;
2210 b--;
2211 break;
2212 }
2213 nr--;
2214 }
2215
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002216 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002217 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002218 if (retval == -EAGAIN) {
2219 retval = 0;
2220 continue;
2221 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 break;
2223 } else {
2224 int uncopied;
Alan Cox04f378b2008-04-30 00:53:29 -07002225 /* The copy function takes the read lock and handles
2226 locking internally for this case */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 uncopied = copy_from_read_buf(tty, &b, &nr);
2228 uncopied += copy_from_read_buf(tty, &b, &nr);
2229 if (uncopied) {
2230 retval = -EFAULT;
2231 break;
2232 }
2233 }
2234
Peter Hurley6367ca72013-06-15 09:14:33 -04002235 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236
2237 if (b - buf >= minimum)
2238 break;
2239 if (time)
2240 timeout = time;
2241 }
Peter Hurley42458f42013-11-07 13:59:46 -05002242 n_tty_set_room(tty);
2243 up_read(&tty->termios_rwsem);
2244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 remove_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002247 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248
Peter Hurleyaebf04532013-11-07 14:01:57 -05002249 mutex_unlock(&ldata->atomic_read_lock);
2250
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 __set_current_state(TASK_RUNNING);
Peter Hurley40d5e092013-06-15 10:21:17 -04002252 if (b - buf)
2253 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254
2255 return retval;
2256}
2257
2258/**
Alan Cox11a96d12008-10-13 10:46:24 +01002259 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 * @tty: tty device
2261 * @file: file object
2262 * @buf: userspace buffer pointer
2263 * @nr: size of I/O
2264 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002265 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002267 * and other such events. Since the receive code will echo characters,
2268 * thus calling driver write methods, the output_lock is used in
2269 * the output processing functions called here as well as in the
2270 * echo processing function to protect the column state and space
2271 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 *
2273 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002274 *
2275 * Locking: output_lock to protect column state and space left
2276 * (note that the process_output*() functions take this
2277 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 */
Alan Cox4edf1822008-02-08 04:18:44 -08002279
Alan Cox11a96d12008-10-13 10:46:24 +01002280static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002281 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282{
2283 const unsigned char *b = buf;
2284 DECLARE_WAITQUEUE(wait, current);
2285 int c;
2286 ssize_t retval = 0;
2287
2288 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2289 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2290 retval = tty_check_change(tty);
2291 if (retval)
2292 return retval;
2293 }
2294
Peter Hurley9356b532013-06-15 09:14:24 -04002295 down_read(&tty->termios_rwsem);
2296
Joe Petersona88a69c2009-01-02 13:40:53 +00002297 /* Write out any echoed characters that are still pending */
2298 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002299
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 add_wait_queue(&tty->write_wait, &wait);
2301 while (1) {
2302 set_current_state(TASK_INTERRUPTIBLE);
2303 if (signal_pending(current)) {
2304 retval = -ERESTARTSYS;
2305 break;
2306 }
2307 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2308 retval = -EIO;
2309 break;
2310 }
Peter Hurley582f5592013-05-17 12:49:48 -04002311 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002313 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 if (num < 0) {
2315 if (num == -EAGAIN)
2316 break;
2317 retval = num;
2318 goto break_out;
2319 }
2320 b += num;
2321 nr -= num;
2322 if (nr == 0)
2323 break;
2324 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002325 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 break;
2327 b++; nr--;
2328 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002329 if (tty->ops->flush_chars)
2330 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 } else {
Roman Zippeld6afe272005-07-07 17:56:55 -07002332 while (nr > 0) {
Alan Coxf34d7a52008-04-30 00:54:13 -07002333 c = tty->ops->write(tty, b, nr);
Roman Zippeld6afe272005-07-07 17:56:55 -07002334 if (c < 0) {
2335 retval = c;
2336 goto break_out;
2337 }
2338 if (!c)
2339 break;
2340 b += c;
2341 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 }
2344 if (!nr)
2345 break;
2346 if (file->f_flags & O_NONBLOCK) {
2347 retval = -EAGAIN;
2348 break;
2349 }
Peter Hurley9356b532013-06-15 09:14:24 -04002350 up_read(&tty->termios_rwsem);
2351
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 schedule();
Peter Hurley9356b532013-06-15 09:14:24 -04002353
2354 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 }
2356break_out:
2357 __set_current_state(TASK_RUNNING);
2358 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002359 if (b - buf != nr && tty->fasync)
2360 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002361 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 return (b - buf) ? b - buf : retval;
2363}
2364
2365/**
Alan Cox11a96d12008-10-13 10:46:24 +01002366 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 * @tty: terminal device
2368 * @file: file accessing it
2369 * @wait: poll table
2370 *
2371 * Called when the line discipline is asked to poll() for data or
2372 * for special events. This code is not serialized with respect to
2373 * other events save open/close.
2374 *
2375 * This code must be sure never to sleep through a hangup.
2376 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 */
Alan Cox4edf1822008-02-08 04:18:44 -08002378
Alan Cox11a96d12008-10-13 10:46:24 +01002379static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002380 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002382 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 unsigned int mask = 0;
2384
2385 poll_wait(file, &tty->read_wait, wait);
2386 poll_wait(file, &tty->write_wait, wait);
Peter Hurleyeafbe672013-12-02 14:24:45 -05002387 if (input_available_p(tty, 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 mask |= POLLIN | POLLRDNORM;
2389 if (tty->packet && tty->link->ctrl_status)
2390 mask |= POLLPRI | POLLIN | POLLRDNORM;
2391 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2392 mask |= POLLHUP;
2393 if (tty_hung_up_p(file))
2394 mask |= POLLHUP;
2395 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2396 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002397 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002399 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002401 if (tty->ops->write && !tty_is_writelocked(tty) &&
2402 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2403 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404 mask |= POLLOUT | POLLWRNORM;
2405 return mask;
2406}
2407
Jiri Slaby57c94122012-10-18 22:26:43 +02002408static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002409{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002410 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002411
Peter Hurleya73d3d62013-06-15 09:14:25 -04002412 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002413 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002414 head = ldata->canon_head;
2415 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002416 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002417 /* Skip EOF-chars.. */
2418 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002419 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2420 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002421 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002422 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002423 }
2424 return nr;
2425}
2426
2427static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2428 unsigned int cmd, unsigned long arg)
2429{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002430 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002431 int retval;
2432
2433 switch (cmd) {
2434 case TIOCOUTQ:
2435 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2436 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002437 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002438 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002439 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002440 else
2441 retval = read_cnt(ldata);
2442 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002443 return put_user(retval, (unsigned int __user *) arg);
2444 default:
2445 return n_tty_ioctl_helper(tty, file, cmd, arg);
2446 }
2447}
2448
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002449static void n_tty_fasync(struct tty_struct *tty, int on)
2450{
2451 struct n_tty_data *ldata = tty->disc_data;
2452
2453 if (!waitqueue_active(&tty->read_wait)) {
2454 if (on)
2455 ldata->minimum_to_wake = 1;
2456 else if (!tty->fasync)
2457 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2458 }
2459}
2460
Alan Coxa352def2008-07-16 21:53:12 +01002461struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002462 .magic = TTY_LDISC_MAGIC,
2463 .name = "n_tty",
2464 .open = n_tty_open,
2465 .close = n_tty_close,
2466 .flush_buffer = n_tty_flush_buffer,
2467 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002468 .read = n_tty_read,
2469 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002470 .ioctl = n_tty_ioctl,
2471 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002472 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002473 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002474 .write_wakeup = n_tty_write_wakeup,
2475 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002476 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002478
2479/**
2480 * n_tty_inherit_ops - inherit N_TTY methods
2481 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2482 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002483 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002484 * methods.
2485 */
2486
2487void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2488{
2489 *ops = tty_ldisc_N_TTY;
2490 ops->owner = NULL;
2491 ops->refcount = ops->flags = 0;
2492}
2493EXPORT_SYMBOL_GPL(n_tty_inherit_ops);