blob: 34aacaaae14ab9b595ea41744504c2cbc65b9ff3 [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 Hurley1075a6e2013-12-09 18:06:07 -050096 size_t echo_mark;
Peter Hurley1bb9d562013-06-15 10:21:20 -040097 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040098
99 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200100 unsigned long overrun_time;
101 int num_overrun;
102
Peter Hurley24a89d12013-06-15 09:14:15 -0400103 /* non-atomic */
104 bool no_room;
105
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400106 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200107 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200108
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400109 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400110 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200111 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400112 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200113
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -0400114 int minimum_to_wake;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200115
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400116 /* consumer-published */
117 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400118 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400119
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400120 /* protected by output lock */
121 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200122 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400123 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200124
125 struct mutex atomic_read_lock;
126 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200127};
128
Peter Hurleyce741172013-06-15 09:14:20 -0400129static inline size_t read_cnt(struct n_tty_data *ldata)
130{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400131 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400132}
133
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400134static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
135{
136 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
137}
138
139static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
140{
141 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
142}
143
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400144static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
145{
146 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
147}
148
149static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
150{
151 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
152}
153
Miloslav Trmac522ed772007-07-15 23:40:56 -0700154static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
155 unsigned char __user *ptr)
156{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200157 struct n_tty_data *ldata = tty->disc_data;
158
159 tty_audit_add_data(tty, &x, 1, ldata->icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700160 return put_user(x, ptr);
161}
162
Peter Hurley24a89d12013-06-15 09:14:15 -0400163static int receive_room(struct tty_struct *tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900164{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200165 struct n_tty_data *ldata = tty->disc_data;
Jaeden Amero090abf72012-07-27 08:43:11 -0500166 int left;
Peter Hurleyb8483052013-06-15 07:28:30 -0400167
Jaeden Amero090abf72012-07-27 08:43:11 -0500168 if (I_PARMRK(tty)) {
169 /* Multiply read_cnt by 3, since each byte might take up to
170 * three times as many spaces when PARMRK is set (depending on
171 * its flags, e.g. parity error). */
Peter Hurleyce741172013-06-15 09:14:20 -0400172 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500173 } else
Peter Hurleyce741172013-06-15 09:14:20 -0400174 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500175
Linus Torvalds55db4c62011-06-04 06:33:24 +0900176 /*
177 * If we are doing input canonicalization, and there are no
178 * pending newlines, let characters through without limit, so
179 * that erase characters will be handled. Other excess
180 * characters will be beeped.
181 */
182 if (left <= 0)
Peter Hurleya73d3d62013-06-15 09:14:25 -0400183 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
Linus Torvalds55db4c62011-06-04 06:33:24 +0900184
Peter Hurley24a89d12013-06-15 09:14:15 -0400185 return left;
Peter Hurley7879a9f2013-06-15 07:28:31 -0400186}
187
Peter Hurley24a89d12013-06-15 09:14:15 -0400188/**
189 * n_tty_set_room - receive space
190 * @tty: terminal
191 *
192 * Re-schedules the flip buffer work if space just became available.
193 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400194 * Caller holds exclusive termios_rwsem
195 * or
196 * n_tty_read()/consumer path:
197 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400198 */
199
Peter Hurley7879a9f2013-06-15 07:28:31 -0400200static void n_tty_set_room(struct tty_struct *tty)
201{
Peter Hurley24a89d12013-06-15 09:14:15 -0400202 struct n_tty_data *ldata = tty->disc_data;
203
Linus Torvalds55db4c62011-06-04 06:33:24 +0900204 /* Did this open up the receive buffer? We may need to flip */
Peter Hurley24a89d12013-06-15 09:14:15 -0400205 if (unlikely(ldata->no_room) && receive_room(tty)) {
206 ldata->no_room = 0;
207
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200208 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400209 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400210 /* see if ldisc has been killed - if so, this means that
211 * even though the ldisc has been halted and ->buf.work
212 * cancelled, ->buf.work is about to be rescheduled
213 */
214 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
215 "scheduling buffer work for halted ldisc\n");
Peter Hurleyf0f947c2013-06-15 09:14:36 -0400216 queue_work(system_unbound_wq, &tty->port->buf.work);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200217 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900218}
219
Peter Hurley9a4aec22013-06-15 09:14:32 -0400220static ssize_t chars_in_buffer(struct tty_struct *tty)
221{
222 struct n_tty_data *ldata = tty->disc_data;
223 ssize_t n = 0;
224
225 if (!ldata->icanon)
226 n = read_cnt(ldata);
227 else
228 n = ldata->canon_head - ldata->read_tail;
229 return n;
230}
231
Peter Hurleyee0bab82013-06-15 09:14:34 -0400232/**
233 * n_tty_write_wakeup - asynchronous I/O notifier
234 * @tty: tty device
235 *
236 * Required for the ptys, serial driver etc. since processes
237 * that attach themselves to the master and rely on ASYNC
238 * IO must be woken up
239 */
240
241static void n_tty_write_wakeup(struct tty_struct *tty)
242{
243 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
244 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
245}
246
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400247static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400248{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400249 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
250 return;
Peter Hurley6367ca72013-06-15 09:14:33 -0400251 /*
252 * Check the remaining room for the input canonicalization
253 * mode. We don't want to throttle the driver if we're in
254 * canonical mode and don't have a newline yet!
255 */
256 while (1) {
257 int throttled;
258 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
259 if (receive_room(tty) >= TTY_THRESHOLD_THROTTLE)
260 break;
261 throttled = tty_throttle_safe(tty);
262 if (!throttled)
263 break;
264 }
265 __tty_set_flow_change(tty, 0);
266}
267
Peter Hurley4b293492013-07-24 08:29:55 -0400268static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400269{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400270 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
271 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
272 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
273 return;
274 if (!tty->count)
275 return;
276 n_tty_set_room(tty);
277 n_tty_write_wakeup(tty->link);
278 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
279 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 Hurley1075a6e2013-12-09 18:06:07 -0500340 ldata->echo_mark = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400341 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000342
Peter Hurleya73d3d62013-06-15 09:14:25 -0400343 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200344 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345}
346
Peter Hurleya30737a2013-03-11 16:44:22 -0400347static void n_tty_packet_mode_flush(struct tty_struct *tty)
348{
349 unsigned long flags;
350
351 spin_lock_irqsave(&tty->ctrl_lock, flags);
352 if (tty->link->packet) {
353 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
354 wake_up_interruptible(&tty->link->read_wait);
355 }
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;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500792 ldata->echo_mark = head;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400793 old = ldata->echo_commit - ldata->echo_tail;
794
795 /* Process committed echoes if the accumulated # of bytes
796 * is over the threshold (and try again each time another
797 * block is accumulated) */
798 nr = head - ldata->echo_tail;
799 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
800 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400801
Peter Hurley019ebdf2013-06-15 10:04:25 -0400802 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400803 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400804 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400805 mutex_unlock(&ldata->output_lock);
806
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400807 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400808 tty->ops->flush_chars(tty);
809}
810
811static void process_echoes(struct tty_struct *tty)
812{
813 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400814 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400815
Peter Hurley39434ab2013-11-29 12:56:10 -0500816 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
Peter Hurley1075a6e2013-12-09 18:06:07 -0500817 ldata->echo_mark == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400818 return;
819
820 mutex_lock(&ldata->output_lock);
Peter Hurley1075a6e2013-12-09 18:06:07 -0500821 ldata->echo_commit = ldata->echo_mark;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400822 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400823 mutex_unlock(&ldata->output_lock);
824
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400825 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400826 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400827}
828
Peter Hurley1075a6e2013-12-09 18:06:07 -0500829/* NB: echo_mark and echo_head should be equivalent here */
Peter Hurleycbfd0342013-06-15 10:04:26 -0400830static void flush_echoes(struct tty_struct *tty)
831{
832 struct n_tty_data *ldata = tty->disc_data;
833
Peter Hurley39434ab2013-11-29 12:56:10 -0500834 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
835 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400836 return;
837
838 mutex_lock(&ldata->output_lock);
839 ldata->echo_commit = ldata->echo_head;
840 __process_echoes(tty);
841 mutex_unlock(&ldata->output_lock);
842}
843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000845 * add_echo_byte - add a byte to the echo buffer
846 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200847 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000848 *
849 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000850 */
851
Peter Hurleycbfd0342013-06-15 10:04:26 -0400852static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000853{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400854 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000855}
856
857/**
858 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200859 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000860 *
861 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000862 */
863
Jiri Slaby57c94122012-10-18 22:26:43 +0200864static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000865{
Jiri Slaby57c94122012-10-18 22:26:43 +0200866 add_echo_byte(ECHO_OP_START, ldata);
867 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000868}
869
870/**
871 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200872 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000873 *
874 * Add an operation to the echo buffer to set the canon column
875 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000876 */
877
Jiri Slaby57c94122012-10-18 22:26:43 +0200878static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000879{
Jiri Slaby57c94122012-10-18 22:26:43 +0200880 add_echo_byte(ECHO_OP_START, ldata);
881 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000882}
883
884/**
885 * echo_erase_tab - add operation to erase a tab
886 * @num_chars: number of character columns already used
887 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200888 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000889 *
890 * Add an operation to the echo buffer to erase a tab.
891 *
892 * Called by the eraser function, which knows how many character
893 * columns have been used since either a previous tab or the start
894 * of input. This information will be used later, along with
895 * canon column (if applicable), to go back the correct number
896 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000897 */
898
899static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200900 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000901{
Jiri Slaby57c94122012-10-18 22:26:43 +0200902 add_echo_byte(ECHO_OP_START, ldata);
903 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000904
905 /* We only need to know this modulo 8 (tab spacing) */
906 num_chars &= 7;
907
908 /* Set the high bit as a flag if num_chars is after a previous tab */
909 if (after_tab)
910 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000911
Jiri Slaby57c94122012-10-18 22:26:43 +0200912 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000913}
914
915/**
916 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 * @c: unicode byte to echo
918 * @tty: terminal device
919 *
Alan Cox4edf1822008-02-08 04:18:44 -0800920 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100922 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000923 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000924 */
925
Jiri Slaby57c94122012-10-18 22:26:43 +0200926static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000927{
Joe Petersona88a69c2009-01-02 13:40:53 +0000928 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200929 add_echo_byte(ECHO_OP_START, ldata);
930 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000931 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200932 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000933 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000934}
935
936/**
937 * echo_char - echo a character
938 * @c: unicode byte to echo
939 * @tty: terminal device
940 *
941 * Echo user input back onto the screen. This must be called only when
942 * L_ECHO(tty) is true. Called from the driver receive_buf path.
943 *
Joe Peterson62b26352009-09-09 15:03:47 -0600944 * This variant tags control characters to be echoed as "^X"
945 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 */
947
948static void echo_char(unsigned char c, struct tty_struct *tty)
949{
Jiri Slabybddc7152012-10-18 22:26:42 +0200950 struct n_tty_data *ldata = tty->disc_data;
951
Joe Petersona88a69c2009-01-02 13:40:53 +0000952 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200953 add_echo_byte(ECHO_OP_START, ldata);
954 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000955 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600956 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200957 add_echo_byte(ECHO_OP_START, ldata);
958 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000959 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960}
961
Alan Cox17b82062008-10-13 10:45:06 +0100962/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000963 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200964 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100965 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000966
Jiri Slaby57c94122012-10-18 22:26:43 +0200967static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200969 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200970 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200971 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 }
973}
974
975/**
976 * eraser - handle erase function
977 * @c: character input
978 * @tty: terminal device
979 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200980 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 * present in the stream from the driver layer. Handles the complexities
982 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100983 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400984 * n_tty_receive_buf()/producer path:
985 * caller holds non-exclusive termios_rwsem
986 * modifies read_head
987 *
988 * Modifying the read_head is not considered a publish in this context
989 * because canonical mode is active -- only canon_head publishes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 */
Alan Cox4edf1822008-02-08 04:18:44 -0800991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992static void eraser(unsigned char c, struct tty_struct *tty)
993{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200994 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400996 size_t head;
997 size_t cnt;
998 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001000 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +00001001 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 return;
1003 }
1004 if (c == ERASE_CHAR(tty))
1005 kill_type = ERASE;
1006 else if (c == WERASE_CHAR(tty))
1007 kill_type = WERASE;
1008 else {
1009 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001010 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 return;
1012 }
1013 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001014 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +02001015 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 echo_char(KILL_CHAR(tty), tty);
1017 /* Add a newline if ECHOK is on and ECHOKE is off. */
1018 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001019 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 return;
1021 }
1022 kill_type = KILL;
1023 }
1024
1025 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001026 while (ldata->read_head != ldata->canon_head) {
1027 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028
1029 /* erase a single possibly multibyte character */
1030 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001031 head--;
1032 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001033 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
1035 /* do not partially erase */
1036 if (is_continuation(c, tty))
1037 break;
1038
1039 if (kill_type == WERASE) {
1040 /* Equivalent to BSD's ALTWERASE. */
1041 if (isalnum(c) || c == '_')
1042 seen_alnums++;
1043 else if (seen_alnums)
1044 break;
1045 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001046 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001047 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 if (L_ECHO(tty)) {
1049 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001050 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001051 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001052 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 }
1054 /* if cnt > 1, output a multi-byte character */
1055 echo_char(c, tty);
1056 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001057 head++;
1058 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001059 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 }
1061 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1062 echo_char(ERASE_CHAR(tty), tty);
1063 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001064 unsigned int num_chars = 0;
1065 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001066 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Joe Petersona88a69c2009-01-02 13:40:53 +00001068 /*
1069 * Count the columns used for characters
1070 * since the start of input or after a
1071 * previous tab.
1072 * This info is used to go back the correct
1073 * number of columns.
1074 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001075 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001076 tail--;
1077 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001078 if (c == '\t') {
1079 after_tab = 1;
1080 break;
Alan Cox300a6202009-01-02 13:41:04 +00001081 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001083 num_chars += 2;
1084 } else if (!is_continuation(c, tty)) {
1085 num_chars++;
1086 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001088 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 } else {
1090 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001091 echo_char_raw('\b', ldata);
1092 echo_char_raw(' ', ldata);
1093 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 }
1095 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001096 echo_char_raw('\b', ldata);
1097 echo_char_raw(' ', ldata);
1098 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 }
1100 }
1101 }
1102 if (kill_type == ERASE)
1103 break;
1104 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001105 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001106 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107}
1108
1109/**
1110 * isig - handle the ISIG optio
1111 * @sig: signal
1112 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001114 * Called when a signal is being sent due to terminal input.
1115 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001116 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001117 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 */
Alan Cox4edf1822008-02-08 04:18:44 -08001119
Peter Hurley4b293492013-07-24 08:29:55 -04001120static void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121{
Peter Hurley8c985d12013-03-06 08:38:19 -05001122 struct pid *tty_pgrp = tty_get_pgrp(tty);
1123 if (tty_pgrp) {
1124 kill_pgrp(tty_pgrp, sig, 1);
1125 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 }
1127}
1128
1129/**
1130 * n_tty_receive_break - handle break
1131 * @tty: terminal
1132 *
1133 * An RS232 break event has been hit in the incoming bitstream. This
1134 * can cause a variety of events depending upon the termios settings.
1135 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001136 * n_tty_receive_buf()/producer path:
1137 * caller holds non-exclusive termios_rwsem
1138 * publishes read_head via put_tty_queue()
1139 *
1140 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 */
Alan Cox4edf1822008-02-08 04:18:44 -08001142
Peter Hurley4b293492013-07-24 08:29:55 -04001143static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144{
Jiri Slaby57c94122012-10-18 22:26:43 +02001145 struct n_tty_data *ldata = tty->disc_data;
1146
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 if (I_IGNBRK(tty))
1148 return;
1149 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001150 isig(SIGINT, tty);
1151 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001152 /* flushing needs exclusive termios_rwsem */
1153 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001154 n_tty_flush_buffer(tty);
1155 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001156 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001157 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 return;
1159 }
1160 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001161 put_tty_queue('\377', ldata);
1162 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001164 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 wake_up_interruptible(&tty->read_wait);
1166}
1167
1168/**
1169 * n_tty_receive_overrun - handle overrun reporting
1170 * @tty: terminal
1171 *
1172 * Data arrived faster than we could process it. While the tty
1173 * driver has flagged this the bits that were missed are gone
1174 * forever.
1175 *
1176 * Called from the receive_buf path so single threaded. Does not
1177 * need locking as num_overrun and overrun_time are function
1178 * private.
1179 */
Alan Cox4edf1822008-02-08 04:18:44 -08001180
Peter Hurley4b293492013-07-24 08:29:55 -04001181static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001183 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 char buf[64];
1185
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001186 ldata->num_overrun++;
1187 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1188 time_after(ldata->overrun_time, jiffies)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1190 tty_name(tty, buf),
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001191 ldata->num_overrun);
1192 ldata->overrun_time = jiffies;
1193 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 }
1195}
1196
1197/**
1198 * n_tty_receive_parity_error - error notifier
1199 * @tty: terminal device
1200 * @c: character
1201 *
1202 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001203 * the error case if necessary.
1204 *
1205 * n_tty_receive_buf()/producer path:
1206 * caller holds non-exclusive termios_rwsem
1207 * publishes read_head via put_tty_queue()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 */
Peter Hurley4b293492013-07-24 08:29:55 -04001209static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210{
Jiri Slaby57c94122012-10-18 22:26:43 +02001211 struct n_tty_data *ldata = tty->disc_data;
1212
Alan Cox4edf1822008-02-08 04:18:44 -08001213 if (I_IGNPAR(tty))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001216 put_tty_queue('\377', ldata);
1217 put_tty_queue('\0', ldata);
1218 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 } else if (I_INPCK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001220 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 else
Jiri Slaby57c94122012-10-18 22:26:43 +02001222 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 wake_up_interruptible(&tty->read_wait);
1224}
1225
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001226static void
1227n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1228{
1229 if (!L_NOFLSH(tty)) {
1230 /* flushing needs exclusive termios_rwsem */
1231 up_read(&tty->termios_rwsem);
1232 n_tty_flush_buffer(tty);
1233 tty_driver_flush_buffer(tty);
1234 down_read(&tty->termios_rwsem);
1235 }
1236 if (I_IXON(tty))
1237 start_tty(tty);
1238 if (L_ECHO(tty)) {
1239 echo_char(c, tty);
1240 commit_echoes(tty);
1241 }
1242 isig(signal, tty);
1243 return;
1244}
1245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246/**
1247 * n_tty_receive_char - perform processing
1248 * @tty: terminal device
1249 * @c: character
1250 *
1251 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001252 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001254 *
1255 * n_tty_receive_buf()/producer path:
1256 * caller holds non-exclusive termios_rwsem
1257 * publishes canon_head if canonical mode is active
1258 * otherwise, publishes read_head via put_tty_queue()
Peter Hurleye60d27c2013-07-24 08:29:56 -04001259 *
1260 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 */
1262
Peter Hurleye60d27c2013-07-24 08:29:56 -04001263static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001264n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001266 struct n_tty_data *ldata = tty->disc_data;
Joe Petersonacc71bb2009-01-02 13:43:32 +00001267 int parmrk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 if (I_IXON(tty)) {
1270 if (c == START_CHAR(tty)) {
1271 start_tty(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001272 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001273 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 }
1275 if (c == STOP_CHAR(tty)) {
1276 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001277 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 }
1279 }
Joe Peterson575537b32008-04-30 00:53:30 -07001280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001282 if (c == INTR_CHAR(tty)) {
1283 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001284 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001285 } else if (c == QUIT_CHAR(tty)) {
1286 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001287 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001288 } else if (c == SUSP_CHAR(tty)) {
1289 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001290 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 }
1292 }
Joe Peterson575537b32008-04-30 00:53:30 -07001293
Peter Hurley855df3c2013-07-24 08:29:50 -04001294 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1295 start_tty(tty);
1296 process_echoes(tty);
1297 }
1298
Joe Peterson575537b32008-04-30 00:53:30 -07001299 if (c == '\r') {
1300 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001301 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001302 if (I_ICRNL(tty))
1303 c = '\n';
1304 } else if (c == '\n' && I_INLCR(tty))
1305 c = '\r';
1306
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001307 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1309 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1310 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001311 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001312 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 }
1314 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001315 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001317 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001319 echo_char_raw('^', ldata);
1320 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001321 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 }
1323 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001324 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001326 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001327 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Jiri Slaby57c94122012-10-18 22:26:43 +02001329 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001331 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001332 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001333 echo_char(read_buf(ldata, tail), tty);
1334 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001336 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001337 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 }
1339 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001340 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001341 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001342 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 }
1344 goto handle_newline;
1345 }
1346 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 c = __DISABLED_CHAR;
1348 goto handle_newline;
1349 }
1350 if ((c == EOL_CHAR(tty)) ||
1351 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001352 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty))
1353 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 /*
1355 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1356 */
1357 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001359 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001360 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001362 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 }
1364 /*
1365 * XXX does PARMRK doubling happen for
1366 * EOL_CHAR and EOL2_CHAR?
1367 */
Joe Petersonacc71bb2009-01-02 13:43:32 +00001368 if (parmrk)
Jiri Slaby57c94122012-10-18 22:26:43 +02001369 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
Alan Cox4edf1822008-02-08 04:18:44 -08001371handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001372 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001373 put_tty_queue(c, ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001374 ldata->canon_head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1376 if (waitqueue_active(&tty->read_wait))
1377 wake_up_interruptible(&tty->read_wait);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001378 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 }
1380 }
Alan Cox4edf1822008-02-08 04:18:44 -08001381
Joe Petersonacc71bb2009-01-02 13:43:32 +00001382 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
Joe Petersonacc71bb2009-01-02 13:43:32 +00001383 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001384 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001386 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 else {
1388 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001389 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001390 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 echo_char(c, tty);
1392 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001393 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 }
1395
Joe Petersonacc71bb2009-01-02 13:43:32 +00001396 if (parmrk)
Jiri Slaby57c94122012-10-18 22:26:43 +02001397 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Jiri Slaby57c94122012-10-18 22:26:43 +02001399 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001400 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001401}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Peter Hurleye60d27c2013-07-24 08:29:56 -04001403static inline void
1404n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001405{
1406 struct n_tty_data *ldata = tty->disc_data;
1407 int parmrk;
1408
Peter Hurleye60d27c2013-07-24 08:29:56 -04001409 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1410 start_tty(tty);
1411 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001412 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001413 if (L_ECHO(tty)) {
1414 finish_erasing(ldata);
1415 /* Record the column of first canon char. */
1416 if (ldata->canon_head == ldata->read_head)
1417 echo_set_canon_col(ldata);
1418 echo_char(c, tty);
1419 commit_echoes(tty);
1420 }
1421 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1422 if (parmrk)
1423 put_tty_queue(c, ldata);
1424 put_tty_queue(c, ldata);
1425}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001426
Peter Hurleye60d27c2013-07-24 08:29:56 -04001427static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1428{
1429 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001430}
1431
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001432static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001433n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1434{
1435 struct n_tty_data *ldata = tty->disc_data;
1436
Peter Hurleye60d27c2013-07-24 08:29:56 -04001437 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1438 start_tty(tty);
1439 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001440 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001441 if (L_ECHO(tty)) {
1442 finish_erasing(ldata);
1443 /* Record the column of first canon char. */
1444 if (ldata->canon_head == ldata->read_head)
1445 echo_set_canon_col(ldata);
1446 echo_char(c, tty);
1447 commit_echoes(tty);
1448 }
1449 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001450}
1451
1452static inline void
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001453n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
1454{
1455 if (I_ISTRIP(tty))
1456 c &= 0x7f;
1457 if (I_IUCLC(tty) && L_IEXTEN(tty))
1458 c = tolower(c);
1459
1460 if (I_IXON(tty)) {
1461 if (c == STOP_CHAR(tty))
1462 stop_tty(tty);
1463 else if (c == START_CHAR(tty) ||
1464 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1465 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1466 c != SUSP_CHAR(tty))) {
1467 start_tty(tty);
1468 process_echoes(tty);
1469 }
1470 }
1471}
1472
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001473static void
1474n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1475{
1476 char buf[64];
1477
1478 switch (flag) {
1479 case TTY_BREAK:
1480 n_tty_receive_break(tty);
1481 break;
1482 case TTY_PARITY:
1483 case TTY_FRAME:
1484 n_tty_receive_parity_error(tty, c);
1485 break;
1486 case TTY_OVERRUN:
1487 n_tty_receive_overrun(tty);
1488 break;
1489 default:
1490 printk(KERN_ERR "%s: unknown flag %d\n",
1491 tty_name(tty, buf), flag);
1492 break;
1493 }
1494}
1495
Peter Hurleye60d27c2013-07-24 08:29:56 -04001496static void
1497n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1498{
1499 struct n_tty_data *ldata = tty->disc_data;
1500
1501 ldata->lnext = 0;
1502 if (likely(flag == TTY_NORMAL)) {
1503 if (I_ISTRIP(tty))
1504 c &= 0x7f;
1505 if (I_IUCLC(tty) && L_IEXTEN(tty))
1506 c = tolower(c);
1507 n_tty_receive_char(tty, c);
1508 } else
1509 n_tty_receive_char_flagged(tty, c, flag);
1510}
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512/**
1513 * n_tty_receive_buf - data receive
1514 * @tty: terminal device
1515 * @cp: buffer
1516 * @fp: flag buffer
1517 * @count: characters
1518 *
1519 * Called by the terminal driver when a block of characters has
1520 * been received. This function must be called from soft contexts
1521 * not from interrupt context. The driver is responsible for making
1522 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001523 *
1524 * n_tty_receive_buf()/producer path:
1525 * claims non-exclusive termios_rwsem
1526 * publishes read_head and canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 */
Alan Cox4edf1822008-02-08 04:18:44 -08001528
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001529static void
1530n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1531 char *fp, int count)
1532{
1533 struct n_tty_data *ldata = tty->disc_data;
1534 size_t n, head;
1535
1536 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1537 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1538 n = min_t(size_t, count, n);
1539 memcpy(read_buf_addr(ldata, head), cp, n);
1540 ldata->read_head += n;
1541 cp += n;
1542 count -= n;
1543
1544 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1545 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1546 n = min_t(size_t, count, n);
1547 memcpy(read_buf_addr(ldata, head), cp, n);
1548 ldata->read_head += n;
1549}
1550
Peter Hurley554117bd2013-06-15 10:21:25 -04001551static void
1552n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1553 char *fp, int count)
1554{
1555 struct n_tty_data *ldata = tty->disc_data;
1556 char flag = TTY_NORMAL;
1557
1558 while (count--) {
1559 if (fp)
1560 flag = *fp++;
1561 if (likely(flag == TTY_NORMAL))
1562 put_tty_queue(*cp++, ldata);
1563 else
1564 n_tty_receive_char_flagged(tty, *cp++, flag);
1565 }
1566}
1567
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001568static void
1569n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1570 char *fp, int count)
1571{
1572 char flag = TTY_NORMAL;
1573
1574 while (count--) {
1575 if (fp)
1576 flag = *fp++;
1577 if (likely(flag == TTY_NORMAL))
1578 n_tty_receive_char_closing(tty, *cp++);
1579 else
1580 n_tty_receive_char_flagged(tty, *cp++, flag);
1581 }
1582}
1583
Peter Hurley7d88d632013-07-24 08:29:49 -04001584static void
1585n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001586 char *fp, int count)
1587{
1588 struct n_tty_data *ldata = tty->disc_data;
1589 char flag = TTY_NORMAL;
1590
1591 while (count--) {
1592 if (fp)
1593 flag = *fp++;
1594 if (likely(flag == TTY_NORMAL)) {
1595 unsigned char c = *cp++;
1596
1597 if (I_ISTRIP(tty))
1598 c &= 0x7f;
1599 if (I_IUCLC(tty) && L_IEXTEN(tty))
1600 c = tolower(c);
1601 if (L_EXTPROC(tty)) {
1602 put_tty_queue(c, ldata);
1603 continue;
1604 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001605 if (!test_bit(c, ldata->char_map))
1606 n_tty_receive_char_inline(tty, c);
1607 else if (n_tty_receive_char_special(tty, c) && count) {
1608 if (fp)
1609 flag = *fp++;
1610 n_tty_receive_char_lnext(tty, *cp++, flag);
1611 count--;
1612 }
Peter Hurley6baad002013-07-24 08:29:52 -04001613 } else
1614 n_tty_receive_char_flagged(tty, *cp++, flag);
1615 }
1616}
1617
1618static void
1619n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1620 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001621{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001622 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001623 char flag = TTY_NORMAL;
1624
1625 while (count--) {
1626 if (fp)
1627 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001628 if (likely(flag == TTY_NORMAL)) {
1629 unsigned char c = *cp++;
1630
1631 if (!test_bit(c, ldata->char_map))
1632 n_tty_receive_char_fast(tty, c);
1633 else if (n_tty_receive_char_special(tty, c) && count) {
1634 if (fp)
1635 flag = *fp++;
1636 n_tty_receive_char_lnext(tty, *cp++, flag);
1637 count--;
1638 }
1639 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001640 n_tty_receive_char_flagged(tty, *cp++, flag);
1641 }
1642}
1643
Peter Hurley24a89d12013-06-15 09:14:15 -04001644static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1645 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001647 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001648 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001650 if (ldata->real_raw)
1651 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001652 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117bd2013-06-15 10:21:25 -04001653 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001654 else if (tty->closing && !L_EXTPROC(tty))
1655 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001656 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001657 if (ldata->lnext) {
1658 char flag = TTY_NORMAL;
1659
1660 if (fp)
1661 flag = *fp++;
1662 n_tty_receive_char_lnext(tty, *cp++, flag);
1663 count--;
1664 }
1665
Peter Hurley7de971b2013-07-24 08:29:53 -04001666 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001667 n_tty_receive_buf_fast(tty, cp, fp, count);
1668 else
1669 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001670
1671 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001672 if (tty->ops->flush_chars)
1673 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 }
1675
Peter Hurleyce741172013-06-15 09:14:20 -04001676 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
hyc@symas.com26df6d12010-06-22 10:14:49 -07001677 L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1679 if (waitqueue_active(&tty->read_wait))
1680 wake_up_interruptible(&tty->read_wait);
1681 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682}
1683
Peter Hurley24a89d12013-06-15 09:14:15 -04001684static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1685 char *fp, int count)
1686{
Peter Hurley19e2ad62013-07-24 08:29:54 -04001687 int room, n;
1688
Peter Hurley9356b532013-06-15 09:14:24 -04001689 down_read(&tty->termios_rwsem);
Peter Hurley19e2ad62013-07-24 08:29:54 -04001690
1691 while (1) {
1692 room = receive_room(tty);
1693 n = min(count, room);
1694 if (!n)
1695 break;
1696 __receive_buf(tty, cp, fp, n);
1697 cp += n;
1698 if (fp)
1699 fp += n;
1700 count -= n;
1701 }
1702
1703 tty->receive_room = room;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001704 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001705 up_read(&tty->termios_rwsem);
Peter Hurley24a89d12013-06-15 09:14:15 -04001706}
1707
1708static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1709 char *fp, int count)
1710{
1711 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley19e2ad62013-07-24 08:29:54 -04001712 int room, n, rcvd = 0;
Peter Hurley24a89d12013-06-15 09:14:15 -04001713
Peter Hurley9356b532013-06-15 09:14:24 -04001714 down_read(&tty->termios_rwsem);
1715
Peter Hurley19e2ad62013-07-24 08:29:54 -04001716 while (1) {
1717 room = receive_room(tty);
1718 n = min(count, room);
1719 if (!n) {
1720 if (!room)
1721 ldata->no_room = 1;
1722 break;
1723 }
1724 __receive_buf(tty, cp, fp, n);
1725 cp += n;
1726 if (fp)
1727 fp += n;
1728 count -= n;
1729 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001730 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001731
Peter Hurley19e2ad62013-07-24 08:29:54 -04001732 tty->receive_room = room;
1733 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001734 up_read(&tty->termios_rwsem);
1735
Peter Hurley19e2ad62013-07-24 08:29:54 -04001736 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001737}
1738
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739int is_ignored(int sig)
1740{
1741 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001742 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743}
1744
1745/**
1746 * n_tty_set_termios - termios data changed
1747 * @tty: terminal
1748 * @old: previous data
1749 *
1750 * Called by the tty layer when the user changes termios flags so
1751 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001752 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 * guaranteed that this function will not be re-entered or in progress
1754 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001755 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001756 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 */
Alan Cox4edf1822008-02-08 04:18:44 -08001758
1759static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001761 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001762
Peter Hurleyc786f742013-09-17 12:53:35 -04001763 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001764 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley93a8d412013-09-17 12:34:14 -04001765 ldata->line_start = ldata->canon_head = ldata->read_tail;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001766 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001767 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001768 }
1769
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001770 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1773 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1774 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1775 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001776 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001779 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001781 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782
1783 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001784 set_bit(ERASE_CHAR(tty), ldata->char_map);
1785 set_bit(KILL_CHAR(tty), ldata->char_map);
1786 set_bit(EOF_CHAR(tty), ldata->char_map);
1787 set_bit('\n', ldata->char_map);
1788 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001790 set_bit(WERASE_CHAR(tty), ldata->char_map);
1791 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1792 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 if (L_ECHO(tty))
1794 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001795 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 }
1797 }
1798 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001799 set_bit(START_CHAR(tty), ldata->char_map);
1800 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
1802 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001803 set_bit(INTR_CHAR(tty), ldata->char_map);
1804 set_bit(QUIT_CHAR(tty), ldata->char_map);
1805 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001807 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001808 ldata->raw = 0;
1809 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001811 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1813 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1814 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001815 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001817 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 }
Linus Torvalds55db4c62011-06-04 06:33:24 +09001819 n_tty_set_room(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001820 /*
1821 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1822 * been stopped by STOP_CHAR(tty) before it.
1823 */
Peter Hurley103fcbe22013-09-17 12:53:36 -04001824 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped)
Wang YanQingdab73b42013-05-09 14:16:47 +08001825 start_tty(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001826
Alan Coxf34d7a52008-04-30 00:54:13 -07001827 /* The termios change make the tty ready for I/O */
1828 wake_up_interruptible(&tty->write_wait);
1829 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830}
1831
1832/**
1833 * n_tty_close - close the ldisc for this tty
1834 * @tty: device
1835 *
Alan Cox4edf1822008-02-08 04:18:44 -08001836 * Called from the terminal layer when this line discipline is
1837 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 * discipline change. The function will not be called while other
1839 * ldisc methods are in progress.
1840 */
Alan Cox4edf1822008-02-08 04:18:44 -08001841
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842static void n_tty_close(struct tty_struct *tty)
1843{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001844 struct n_tty_data *ldata = tty->disc_data;
1845
Peter Hurley79901312013-03-11 16:44:23 -04001846 if (tty->link)
1847 n_tty_packet_mode_flush(tty);
1848
Peter Hurley20bafb32013-06-15 10:21:19 -04001849 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001850 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851}
1852
1853/**
1854 * n_tty_open - open an ldisc
1855 * @tty: terminal to open
1856 *
Alan Cox4edf1822008-02-08 04:18:44 -08001857 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 * terminal device. Can sleep. Called serialized so that no
1859 * other events will occur in parallel. No further open will occur
1860 * until a close.
1861 */
1862
1863static int n_tty_open(struct tty_struct *tty)
1864{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001865 struct n_tty_data *ldata;
1866
Peter Hurley20bafb32013-06-15 10:21:19 -04001867 /* Currently a malloc failure here can panic */
1868 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001869 if (!ldata)
1870 goto err;
1871
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001872 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001873 mutex_init(&ldata->atomic_read_lock);
1874 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001875
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001876 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001877 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001878 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001879 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001880 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001881 ldata->num_overrun = 0;
1882 ldata->no_room = 0;
1883 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001885 /* indicate buffer work may resume */
1886 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1887 n_tty_set_termios(tty, NULL);
1888 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001889
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001891err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001892 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893}
1894
1895static inline int input_available_p(struct tty_struct *tty, int amt)
1896{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001897 struct n_tty_data *ldata = tty->disc_data;
1898
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001899 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurleya73d3d62013-06-15 09:14:25 -04001900 if (ldata->canon_head != ldata->read_tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 return 1;
Peter Hurleyce741172013-06-15 09:14:20 -04001902 } else if (read_cnt(ldata) >= (amt ? amt : 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 return 1;
1904
1905 return 0;
1906}
1907
1908/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001909 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 * @tty: terminal device
1911 * @b: user data
1912 * @nr: size of data
1913 *
Alan Cox11a96d12008-10-13 10:46:24 +01001914 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 * ICANON is off; it copies characters straight from the tty queue to
1916 * user space directly. It can be profitably called twice; once to
1917 * drain the space from the tail pointer to the (physical) end of the
1918 * buffer, and once to drain the space from the (physical) beginning of
1919 * the buffer to head pointer.
1920 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001921 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001923 * n_tty_read()/consumer path:
1924 * caller holds non-exclusive termios_rwsem
1925 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 */
Alan Cox4edf1822008-02-08 04:18:44 -08001927
Alan Cox33f0f882006-01-09 20:54:13 -08001928static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 unsigned char __user **b,
1930 size_t *nr)
1931
1932{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001933 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 int retval;
1935 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001936 bool is_eof;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001937 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
1939 retval = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001940 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001943 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001945 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1946 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001947 ldata->icanon);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001948 ldata->read_tail += n;
hyc@symas.com26df6d12010-06-22 10:14:49 -07001949 /* Turn single EOF into zero-length read */
Peter Hurleyce741172013-06-15 09:14:20 -04001950 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001951 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 *b += n;
1953 *nr -= n;
1954 }
1955 return retval;
1956}
1957
Peter Hurley88bb0de2013-06-15 09:14:16 -04001958/**
Peter Hurley32f13522013-06-15 09:14:17 -04001959 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001960 * @tty: terminal device
1961 * @b: user data
1962 * @nr: size of data
1963 *
1964 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001965 * it copies one line of input up to and including the line-delimiting
1966 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001967 *
1968 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001969 *
1970 * n_tty_read()/consumer path:
1971 * caller holds non-exclusive termios_rwsem
1972 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001973 */
1974
Peter Hurley32f13522013-06-15 09:14:17 -04001975static int canon_copy_from_read_buf(struct tty_struct *tty,
1976 unsigned char __user **b,
1977 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001978{
1979 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001980 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001981 size_t eol;
1982 size_t tail;
1983 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001984 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001985
1986 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyce741172013-06-15 09:14:20 -04001987 n = min(*nr, read_cnt(ldata));
Peter Hurley6d76bd22013-06-15 09:14:26 -04001988 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04001989 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001990
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001991 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04001992 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1993
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001994 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04001995 __func__, *nr, tail, n, size);
1996
1997 eol = find_next_bit(ldata->read_flags, size, tail);
1998 more = n - (size - tail);
1999 if (eol == N_TTY_BUF_SIZE && more) {
2000 /* scan wrapped without finding set bit */
2001 eol = find_next_bit(ldata->read_flags, more, 0);
2002 if (eol != more)
2003 found = 1;
2004 } else if (eol != size)
2005 found = 1;
2006
2007 size = N_TTY_BUF_SIZE - tail;
Peter Hurleyc77569d2013-11-22 07:16:25 -05002008 n = eol - tail;
2009 if (n > 4096)
2010 n += 4096;
2011 n += found;
Peter Hurley32f13522013-06-15 09:14:17 -04002012 c = n;
2013
Peter Hurley40d5e092013-06-15 10:21:17 -04002014 if (found && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002015 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002016 eof_push = !n && ldata->read_tail != ldata->line_start;
2017 }
Peter Hurley32f13522013-06-15 09:14:17 -04002018
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002019 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002020 __func__, eol, found, n, c, size, more);
2021
Peter Hurley32f13522013-06-15 09:14:17 -04002022 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002023 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002024 if (ret)
2025 return -EFAULT;
2026 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2027 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002028 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002029
2030 if (ret)
2031 return -EFAULT;
2032 *b += n;
2033 *nr -= n;
2034
Peter Hurleya73d3d62013-06-15 09:14:25 -04002035 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002036 clear_bit(eol, ldata->read_flags);
2037 smp_mb__after_clear_bit();
2038 ldata->read_tail += c;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002039
Peter Hurley40d5e092013-06-15 10:21:17 -04002040 if (found) {
2041 ldata->line_start = ldata->read_tail;
Peter Hurley32f13522013-06-15 09:14:17 -04002042 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002043 }
2044 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002045}
2046
Al Virocc4191d2008-03-29 03:08:48 +00002047extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002048 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049
2050/**
2051 * job_control - check job control
2052 * @tty: tty
2053 * @file: file handle
2054 *
2055 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002056 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002058 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002059 * Locking: redirected write test is safe
2060 * current->signal->tty check is safe
2061 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 */
Alan Cox4edf1822008-02-08 04:18:44 -08002063
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064static int job_control(struct tty_struct *tty, struct file *file)
2065{
2066 /* Job control check -- must be done at start and after
2067 every sleep (POSIX.1 7.1.1.4). */
2068 /* NOTE: not yet done after every sleep pending a thorough
2069 check of the logic of this change. -- jlc */
2070 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002071 if (file->f_op->write == redirected_tty_write ||
2072 current->signal->tty != tty)
2073 return 0;
2074
2075 spin_lock_irq(&tty->ctrl_lock);
2076 if (!tty->pgrp)
2077 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2078 else if (task_pgrp(current) != tty->pgrp) {
2079 spin_unlock_irq(&tty->ctrl_lock);
2080 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2081 return -EIO;
2082 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2083 set_thread_flag(TIF_SIGPENDING);
2084 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002086 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 return 0;
2088}
Alan Cox4edf1822008-02-08 04:18:44 -08002089
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
2091/**
Alan Cox11a96d12008-10-13 10:46:24 +01002092 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 * @tty: tty device
2094 * @file: file object
2095 * @buf: userspace buffer pointer
2096 * @nr: size of I/O
2097 *
2098 * Perform reads for the line discipline. We are guaranteed that the
2099 * line discipline will not be closed under us but we may get multiple
2100 * parallel readers and must handle this ourselves. We may also get
2101 * a hangup. Always called in user context, may sleep.
2102 *
2103 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002104 *
2105 * n_tty_read()/consumer path:
2106 * claims non-exclusive termios_rwsem
2107 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 */
Alan Cox4edf1822008-02-08 04:18:44 -08002109
Alan Cox11a96d12008-10-13 10:46:24 +01002110static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 unsigned char __user *buf, size_t nr)
2112{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002113 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 unsigned char __user *b = buf;
2115 DECLARE_WAITQUEUE(wait, current);
2116 int c;
2117 int minimum, time;
2118 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 long timeout;
2120 unsigned long flags;
Alan Cox04f378b2008-04-30 00:53:29 -07002121 int packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002124 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002126
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002127 /*
2128 * Internal serialization of reads.
2129 */
2130 if (file->f_flags & O_NONBLOCK) {
2131 if (!mutex_trylock(&ldata->atomic_read_lock))
2132 return -EAGAIN;
2133 } else {
2134 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2135 return -ERESTARTSYS;
2136 }
2137
Peter Hurley9356b532013-06-15 09:14:24 -04002138 down_read(&tty->termios_rwsem);
2139
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 minimum = time = 0;
2141 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002142 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 minimum = MIN_CHAR(tty);
2144 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002145 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002147 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002149 (ldata->minimum_to_wake > minimum))
2150 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002152 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002153 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 }
2155 }
2156
Alan Cox04f378b2008-04-30 00:53:29 -07002157 packet = tty->packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158
2159 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 while (nr) {
2161 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002162 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163 unsigned char cs;
2164 if (b != buf)
2165 break;
Alan Cox04f378b2008-04-30 00:53:29 -07002166 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 cs = tty->link->ctrl_status;
2168 tty->link->ctrl_status = 0;
Alan Cox04f378b2008-04-30 00:53:29 -07002169 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002170 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 retval = -EFAULT;
2172 b--;
2173 break;
2174 }
2175 nr--;
2176 break;
2177 }
2178 /* This statement must be first before checking for input
2179 so that any interrupt will set the state back to
2180 TASK_RUNNING. */
2181 set_current_state(TASK_INTERRUPTIBLE);
Alan Cox4edf1822008-02-08 04:18:44 -08002182
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002183 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002185 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002186
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 if (!input_available_p(tty, 0)) {
2188 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
Peter Hurleyf8747d42013-09-27 13:27:05 -04002189 up_read(&tty->termios_rwsem);
2190 tty_flush_to_ldisc(tty);
2191 down_read(&tty->termios_rwsem);
2192 if (!input_available_p(tty, 0)) {
2193 retval = -EIO;
2194 break;
2195 }
2196 } else {
2197 if (tty_hung_up_p(file))
2198 break;
2199 if (!timeout)
2200 break;
2201 if (file->f_flags & O_NONBLOCK) {
2202 retval = -EAGAIN;
2203 break;
2204 }
2205 if (signal_pending(current)) {
2206 retval = -ERESTARTSYS;
2207 break;
2208 }
2209 n_tty_set_room(tty);
2210 up_read(&tty->termios_rwsem);
Peter Hurley9356b532013-06-15 09:14:24 -04002211
Peter Hurleyf8747d42013-09-27 13:27:05 -04002212 timeout = schedule_timeout(timeout);
Peter Hurley9356b532013-06-15 09:14:24 -04002213
Peter Hurleyf8747d42013-09-27 13:27:05 -04002214 down_read(&tty->termios_rwsem);
2215 continue;
2216 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 }
2218 __set_current_state(TASK_RUNNING);
2219
2220 /* Deal with packet mode. */
Alan Cox04f378b2008-04-30 00:53:29 -07002221 if (packet && b == buf) {
Miloslav Trmac522ed772007-07-15 23:40:56 -07002222 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 retval = -EFAULT;
2224 b--;
2225 break;
2226 }
2227 nr--;
2228 }
2229
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002230 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002231 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002232 if (retval == -EAGAIN) {
2233 retval = 0;
2234 continue;
2235 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 break;
2237 } else {
2238 int uncopied;
Alan Cox04f378b2008-04-30 00:53:29 -07002239 /* The copy function takes the read lock and handles
2240 locking internally for this case */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 uncopied = copy_from_read_buf(tty, &b, &nr);
2242 uncopied += copy_from_read_buf(tty, &b, &nr);
2243 if (uncopied) {
2244 retval = -EFAULT;
2245 break;
2246 }
2247 }
2248
Peter Hurley6367ca72013-06-15 09:14:33 -04002249 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250
2251 if (b - buf >= minimum)
2252 break;
2253 if (time)
2254 timeout = time;
2255 }
Peter Hurley42458f42013-11-07 13:59:46 -05002256 n_tty_set_room(tty);
2257 up_read(&tty->termios_rwsem);
2258
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 remove_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002261 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262
Peter Hurleyaebf04532013-11-07 14:01:57 -05002263 mutex_unlock(&ldata->atomic_read_lock);
2264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 __set_current_state(TASK_RUNNING);
Peter Hurley40d5e092013-06-15 10:21:17 -04002266 if (b - buf)
2267 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
2269 return retval;
2270}
2271
2272/**
Alan Cox11a96d12008-10-13 10:46:24 +01002273 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 * @tty: tty device
2275 * @file: file object
2276 * @buf: userspace buffer pointer
2277 * @nr: size of I/O
2278 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002279 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002281 * and other such events. Since the receive code will echo characters,
2282 * thus calling driver write methods, the output_lock is used in
2283 * the output processing functions called here as well as in the
2284 * echo processing function to protect the column state and space
2285 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 *
2287 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002288 *
2289 * Locking: output_lock to protect column state and space left
2290 * (note that the process_output*() functions take this
2291 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 */
Alan Cox4edf1822008-02-08 04:18:44 -08002293
Alan Cox11a96d12008-10-13 10:46:24 +01002294static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002295 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296{
2297 const unsigned char *b = buf;
2298 DECLARE_WAITQUEUE(wait, current);
2299 int c;
2300 ssize_t retval = 0;
2301
2302 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2303 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2304 retval = tty_check_change(tty);
2305 if (retval)
2306 return retval;
2307 }
2308
Peter Hurley9356b532013-06-15 09:14:24 -04002309 down_read(&tty->termios_rwsem);
2310
Joe Petersona88a69c2009-01-02 13:40:53 +00002311 /* Write out any echoed characters that are still pending */
2312 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002313
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 add_wait_queue(&tty->write_wait, &wait);
2315 while (1) {
2316 set_current_state(TASK_INTERRUPTIBLE);
2317 if (signal_pending(current)) {
2318 retval = -ERESTARTSYS;
2319 break;
2320 }
2321 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2322 retval = -EIO;
2323 break;
2324 }
Peter Hurley582f5592013-05-17 12:49:48 -04002325 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002327 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 if (num < 0) {
2329 if (num == -EAGAIN)
2330 break;
2331 retval = num;
2332 goto break_out;
2333 }
2334 b += num;
2335 nr -= num;
2336 if (nr == 0)
2337 break;
2338 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002339 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 break;
2341 b++; nr--;
2342 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002343 if (tty->ops->flush_chars)
2344 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 } else {
Roman Zippeld6afe272005-07-07 17:56:55 -07002346 while (nr > 0) {
Alan Coxf34d7a52008-04-30 00:54:13 -07002347 c = tty->ops->write(tty, b, nr);
Roman Zippeld6afe272005-07-07 17:56:55 -07002348 if (c < 0) {
2349 retval = c;
2350 goto break_out;
2351 }
2352 if (!c)
2353 break;
2354 b += c;
2355 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 }
2358 if (!nr)
2359 break;
2360 if (file->f_flags & O_NONBLOCK) {
2361 retval = -EAGAIN;
2362 break;
2363 }
Peter Hurley9356b532013-06-15 09:14:24 -04002364 up_read(&tty->termios_rwsem);
2365
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 schedule();
Peter Hurley9356b532013-06-15 09:14:24 -04002367
2368 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 }
2370break_out:
2371 __set_current_state(TASK_RUNNING);
2372 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002373 if (b - buf != nr && tty->fasync)
2374 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002375 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 return (b - buf) ? b - buf : retval;
2377}
2378
2379/**
Alan Cox11a96d12008-10-13 10:46:24 +01002380 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 * @tty: terminal device
2382 * @file: file accessing it
2383 * @wait: poll table
2384 *
2385 * Called when the line discipline is asked to poll() for data or
2386 * for special events. This code is not serialized with respect to
2387 * other events save open/close.
2388 *
2389 * This code must be sure never to sleep through a hangup.
2390 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 */
Alan Cox4edf1822008-02-08 04:18:44 -08002392
Alan Cox11a96d12008-10-13 10:46:24 +01002393static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002394 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002396 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 unsigned int mask = 0;
2398
2399 poll_wait(file, &tty->read_wait, wait);
2400 poll_wait(file, &tty->write_wait, wait);
2401 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
2402 mask |= POLLIN | POLLRDNORM;
2403 if (tty->packet && tty->link->ctrl_status)
2404 mask |= POLLPRI | POLLIN | POLLRDNORM;
2405 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2406 mask |= POLLHUP;
2407 if (tty_hung_up_p(file))
2408 mask |= POLLHUP;
2409 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2410 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002411 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002413 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002415 if (tty->ops->write && !tty_is_writelocked(tty) &&
2416 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2417 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 mask |= POLLOUT | POLLWRNORM;
2419 return mask;
2420}
2421
Jiri Slaby57c94122012-10-18 22:26:43 +02002422static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002423{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002424 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002425
Peter Hurleya73d3d62013-06-15 09:14:25 -04002426 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002427 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002428 head = ldata->canon_head;
2429 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002430 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002431 /* Skip EOF-chars.. */
2432 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002433 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2434 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002435 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002436 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002437 }
2438 return nr;
2439}
2440
2441static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2442 unsigned int cmd, unsigned long arg)
2443{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002444 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002445 int retval;
2446
2447 switch (cmd) {
2448 case TIOCOUTQ:
2449 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2450 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002451 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002452 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002453 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002454 else
2455 retval = read_cnt(ldata);
2456 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002457 return put_user(retval, (unsigned int __user *) arg);
2458 default:
2459 return n_tty_ioctl_helper(tty, file, cmd, arg);
2460 }
2461}
2462
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002463static void n_tty_fasync(struct tty_struct *tty, int on)
2464{
2465 struct n_tty_data *ldata = tty->disc_data;
2466
2467 if (!waitqueue_active(&tty->read_wait)) {
2468 if (on)
2469 ldata->minimum_to_wake = 1;
2470 else if (!tty->fasync)
2471 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2472 }
2473}
2474
Alan Coxa352def2008-07-16 21:53:12 +01002475struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002476 .magic = TTY_LDISC_MAGIC,
2477 .name = "n_tty",
2478 .open = n_tty_open,
2479 .close = n_tty_close,
2480 .flush_buffer = n_tty_flush_buffer,
2481 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002482 .read = n_tty_read,
2483 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002484 .ioctl = n_tty_ioctl,
2485 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002486 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002487 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002488 .write_wakeup = n_tty_write_wakeup,
2489 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002490 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002492
2493/**
2494 * n_tty_inherit_ops - inherit N_TTY methods
2495 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2496 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002497 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002498 * methods.
2499 */
2500
2501void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2502{
2503 *ops = tty_ldisc_N_TTY;
2504 ops->owner = NULL;
2505 ops->refcount = ops->flags = 0;
2506}
2507EXPORT_SYMBOL_GPL(n_tty_inherit_ops);