blob: 961e6a996dff8834e72dce4c3f496401a6c4c27b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
7 * anyway...)
8 *
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080011 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * This file may be redistributed under the terms of the GNU General Public
19 * License.
20 *
21 * Reduced memory usage for older ARM systems - Russell King.
22 *
Alan Cox4edf1822008-02-08 04:18:44 -080023 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
26 *
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010029 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * EAGAIN
31 */
32
33#include <linux/types.h>
34#include <linux/major.h>
35#include <linux/errno.h>
36#include <linux/signal.h>
37#include <linux/fcntl.h>
38#include <linux/sched.h>
39#include <linux/interrupt.h>
40#include <linux/tty.h>
41#include <linux/timer.h>
42#include <linux/ctype.h>
43#include <linux/mm.h>
44#include <linux/string.h>
45#include <linux/slab.h>
46#include <linux/poll.h>
47#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070048#include <linux/audit.h>
49#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000050#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080051#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050052#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040053#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/* number of characters left in xmit buffer before select has we have room */
57#define WAKEUP_CHARS 256
58
59/*
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
63 */
64#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010065#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Joe Petersona88a69c2009-01-02 13:40:53 +000067/*
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
71 * codes.
72 */
73#define ECHO_OP_START 0xff
74#define ECHO_OP_MOVE_BACK_COL 0x80
75#define ECHO_OP_SET_CANON_COL 0x81
76#define ECHO_OP_ERASE_TAB 0x82
77
Peter Hurleycbfd0342013-06-15 10:04:26 -040078#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
Peter Hurley32f13522013-06-15 09:14:17 -040083#undef N_TTY_TRACE
84#ifdef N_TTY_TRACE
85# define n_tty_trace(f, args...) trace_printk(f, ##args)
86#else
87# define n_tty_trace(f, args...)
88#endif
89
Jiri Slaby70ece7a2012-10-18 22:26:38 +020090struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040091 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040094 size_t echo_head;
95 size_t echo_commit;
Peter Hurley1bb9d562013-06-15 10:21:20 -040096 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040097
98 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +020099 unsigned long overrun_time;
100 int num_overrun;
101
Peter Hurley24a89d12013-06-15 09:14:15 -0400102 /* non-atomic */
103 bool no_room;
104
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400105 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200106 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Peter Hurley4d0ed182013-12-10 17:12:02 -0500107 unsigned char push: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);
Peter Hurley6c677162013-12-02 14:24:46 -0500278 if (waitqueue_active(&tty->link->write_wait))
279 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400280 return;
281 }
282
Peter Hurley6367ca72013-06-15 09:14:33 -0400283 /* If there is enough space in the read buffer now, let the
284 * low-level driver know. We use chars_in_buffer() to
285 * check the buffer, as it now knows about canonical mode.
286 * Otherwise, if the driver is throttled and the line is
287 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
288 * we won't get any more characters.
289 */
290
291 while (1) {
292 int unthrottled;
293 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
294 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
295 break;
296 if (!tty->count)
297 break;
298 n_tty_set_room(tty);
299 unthrottled = tty_unthrottle_safe(tty);
300 if (!unthrottled)
301 break;
302 }
303 __tty_set_flow_change(tty, 0);
304}
305
Alan Cox17b82062008-10-13 10:45:06 +0100306/**
307 * put_tty_queue - add character to tty
308 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200309 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100310 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400311 * Add a character to the tty read_buf queue.
312 *
313 * n_tty_receive_buf()/producer path:
314 * caller holds non-exclusive termios_rwsem
315 * modifies read_head
316 *
317 * read_head is only considered 'published' if canonical mode is
318 * not active.
Alan Cox17b82062008-10-13 10:45:06 +0100319 */
320
Peter Hurley19e2ad62013-07-24 08:29:54 -0400321static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322{
Peter Hurley19e2ad62013-07-24 08:29:54 -0400323 *read_buf_addr(ldata, ldata->read_head++) = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324}
325
326/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 * reset_buffer_flags - reset buffer state
328 * @tty: terminal to reset
329 *
Peter Hurley25518c62013-03-11 16:44:31 -0400330 * Reset the read buffer counters and clear the flags.
331 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100332 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400333 * Locking: caller holds exclusive termios_rwsem
334 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000336
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400337static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400339 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley17bd7902013-06-15 10:04:24 -0400340 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 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);
Peter Hurley4d0ed182013-12-10 17:12:02 -0500345 ldata->push = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346}
347
Peter Hurleya30737a2013-03-11 16:44:22 -0400348static void n_tty_packet_mode_flush(struct tty_struct *tty)
349{
350 unsigned long flags;
351
352 spin_lock_irqsave(&tty->ctrl_lock, flags);
353 if (tty->link->packet) {
354 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
Peter Hurley6c677162013-12-02 14:24:46 -0500355 if (waitqueue_active(&tty->link->read_wait))
356 wake_up_interruptible(&tty->link->read_wait);
Peter Hurleya30737a2013-03-11 16:44:22 -0400357 }
358 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
359}
360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361/**
362 * n_tty_flush_buffer - clean input queue
363 * @tty: terminal device
364 *
Peter Hurley25518c62013-03-11 16:44:31 -0400365 * Flush the input buffer. Called when the tty layer wants the
366 * buffer flushed (eg at hangup) or when the N_TTY line discipline
367 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400369 * Holds termios_rwsem to exclude producer/consumer while
370 * buffer indices are reset.
371 *
372 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 */
Alan Cox4edf1822008-02-08 04:18:44 -0800374
375static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400377 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400378 reset_buffer_flags(tty->disc_data);
379 n_tty_set_room(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800380
Peter Hurleya30737a2013-03-11 16:44:22 -0400381 if (tty->link)
382 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400383 up_write(&tty->termios_rwsem);
384}
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386/**
387 * n_tty_chars_in_buffer - report available bytes
388 * @tty: tty device
389 *
390 * Report the number of characters buffered to be delivered to user
Alan Cox4edf1822008-02-08 04:18:44 -0800391 * at this instant in time.
Alan Cox17b82062008-10-13 10:45:06 +0100392 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400393 * Locking: exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 */
Alan Cox4edf1822008-02-08 04:18:44 -0800395
Peter Hurleya19d0c62013-06-15 09:14:18 -0400396static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
397{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400398 ssize_t n;
399
Peter Hurley47534082013-06-15 09:14:19 -0400400 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400401
402 down_write(&tty->termios_rwsem);
403 n = chars_in_buffer(tty);
404 up_write(&tty->termios_rwsem);
405 return n;
Peter Hurleya19d0c62013-06-15 09:14:18 -0400406}
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/**
409 * is_utf8_continuation - utf8 multibyte check
410 * @c: byte to check
411 *
412 * Returns true if the utf8 character 'c' is a multibyte continuation
413 * character. We use this to correctly compute the on screen size
414 * of the character when printing
415 */
Alan Cox4edf1822008-02-08 04:18:44 -0800416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417static inline int is_utf8_continuation(unsigned char c)
418{
419 return (c & 0xc0) == 0x80;
420}
421
422/**
423 * is_continuation - multibyte check
424 * @c: byte to check
425 *
426 * Returns true if the utf8 character 'c' is a multibyte continuation
427 * character and the terminal is in unicode mode.
428 */
Alan Cox4edf1822008-02-08 04:18:44 -0800429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430static inline int is_continuation(unsigned char c, struct tty_struct *tty)
431{
432 return I_IUTF8(tty) && is_utf8_continuation(c);
433}
434
435/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000436 * do_output_char - output one character
437 * @c: character (or partial unicode symbol)
438 * @tty: terminal device
439 * @space: space available in tty driver write buffer
440 *
441 * This is a helper function that handles one output character
442 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600443 * doing OPOST processing and putting the results in the
444 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000445 *
446 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
447 * and NLDLY. They simply aren't relevant in the world today.
448 * If you ever need them, add them here.
449 *
450 * Returns the number of bytes of buffer space used or -1 if
451 * no space left.
452 *
453 * Locking: should be called under the output_lock to protect
454 * the column state and space left in the buffer
455 */
456
457static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
458{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200459 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000460 int spaces;
461
462 if (!space)
463 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000464
Joe Petersona88a69c2009-01-02 13:40:53 +0000465 switch (c) {
466 case '\n':
467 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200468 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000469 if (O_ONLCR(tty)) {
470 if (space < 2)
471 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200472 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700473 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000474 return 2;
475 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200476 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000477 break;
478 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200479 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000480 return 0;
481 if (O_OCRNL(tty)) {
482 c = '\n';
483 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200484 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000485 break;
486 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200487 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000488 break;
489 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200490 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000491 if (O_TABDLY(tty) == XTABS) {
492 if (space < spaces)
493 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200494 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000495 tty->ops->write(tty, " ", spaces);
496 return spaces;
497 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200498 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000499 break;
500 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200501 if (ldata->column > 0)
502 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000503 break;
504 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000505 if (!iscntrl(c)) {
506 if (O_OLCUC(tty))
507 c = toupper(c);
508 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200509 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000510 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000511 break;
512 }
513
514 tty_put_char(tty, c);
515 return 1;
516}
517
518/**
519 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 * @c: character (or partial unicode symbol)
521 * @tty: terminal device
522 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600523 * Output one character with OPOST processing.
524 * Returns -1 when the output device is full and the character
525 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000527 * Locking: output_lock to protect column state and space left
528 * (also, this is called from n_tty_write under the
529 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 */
Alan Cox4edf1822008-02-08 04:18:44 -0800531
Joe Petersona88a69c2009-01-02 13:40:53 +0000532static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
Jiri Slabybddc7152012-10-18 22:26:42 +0200534 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000535 int space, retval;
536
Jiri Slabybddc7152012-10-18 22:26:42 +0200537 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Alan Coxf34d7a52008-04-30 00:54:13 -0700539 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000540 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Jiri Slabybddc7152012-10-18 22:26:42 +0200542 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000543 if (retval < 0)
544 return -1;
545 else
546 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
548
549/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000550 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600552 * @buf: character buffer
553 * @nr: number of bytes to output
554 *
555 * Output a block of characters with OPOST processing.
556 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 *
558 * This path is used to speed up block console writes, among other
559 * things when processing blocks of output data. It handles only
560 * the simple cases normally found and helps to generate blocks of
561 * symbols for the console driver and thus improve performance.
562 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000563 * Locking: output_lock to protect column state and space left
564 * (also, this is called from n_tty_write under the
565 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 */
Alan Cox4edf1822008-02-08 04:18:44 -0800567
Joe Petersona88a69c2009-01-02 13:40:53 +0000568static ssize_t process_output_block(struct tty_struct *tty,
569 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200571 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100573 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 const unsigned char *cp;
575
Jiri Slabybddc7152012-10-18 22:26:42 +0200576 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000577
Alan Coxf34d7a52008-04-30 00:54:13 -0700578 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000579 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200580 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000582 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 if (nr > space)
584 nr = space;
585
586 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000587 unsigned char c = *cp;
588
589 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 case '\n':
591 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200592 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 if (O_ONLCR(tty))
594 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200595 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 break;
597 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200598 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 goto break_out;
600 if (O_OCRNL(tty))
601 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200602 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 break;
604 case '\t':
605 goto break_out;
606 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200607 if (ldata->column > 0)
608 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 break;
610 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000611 if (!iscntrl(c)) {
612 if (O_OLCUC(tty))
613 goto break_out;
614 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200615 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000616 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 break;
618 }
619 }
620break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700621 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000622
Jiri Slabybddc7152012-10-18 22:26:42 +0200623 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 return i;
625}
626
Joe Petersona88a69c2009-01-02 13:40:53 +0000627/**
628 * process_echoes - write pending echo characters
629 * @tty: terminal device
630 *
631 * Write previously buffered echo (and other ldisc-generated)
632 * characters to the tty.
633 *
634 * Characters generated by the ldisc (including echoes) need to
635 * be buffered because the driver's write buffer can fill during
636 * heavy program output. Echoing straight to the driver will
637 * often fail under these conditions, causing lost characters and
638 * resulting mismatches of ldisc state information.
639 *
640 * Since the ldisc state must represent the characters actually sent
641 * to the driver at the time of the write, operations like certain
642 * changes in column state are also saved in the buffer and executed
643 * here.
644 *
645 * A circular fifo buffer is used so that the most recent characters
646 * are prioritized. Also, when control characters are echoed with a
647 * prefixed "^", the pair is treated atomically and thus not separated.
648 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400649 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000650 */
651
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400652static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000653{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200654 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400655 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400656 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000657 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000658
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400659 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000660
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400661 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400662 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400663 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000664 if (c == ECHO_OP_START) {
665 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000666 int no_space_left = 0;
667
668 /*
669 * If the buffer byte is the start of a multi-byte
670 * operation, get the next byte, which is either the
671 * op code or a control character value.
672 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400673 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000674
Joe Petersona88a69c2009-01-02 13:40:53 +0000675 switch (op) {
676 unsigned int num_chars, num_bs;
677
678 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400679 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000680
681 /*
682 * Determine how many columns to go back
683 * in order to erase the tab.
684 * This depends on the number of columns
685 * used by other characters within the tab
686 * area. If this (modulo 8) count is from
687 * the start of input rather than from a
688 * previous tab, we offset by canon column.
689 * Otherwise, tab spacing is normal.
690 */
691 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200692 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000693 num_bs = 8 - (num_chars & 7);
694
695 if (num_bs > space) {
696 no_space_left = 1;
697 break;
698 }
699 space -= num_bs;
700 while (num_bs--) {
701 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200702 if (ldata->column > 0)
703 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000704 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400705 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000706 break;
707
708 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200709 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400710 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000711 break;
712
713 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200714 if (ldata->column > 0)
715 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400716 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000717 break;
718
719 case ECHO_OP_START:
720 /* This is an escaped echo op start code */
721 if (!space) {
722 no_space_left = 1;
723 break;
724 }
725 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200726 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000727 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400728 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000729 break;
730
731 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000732 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600733 * If the op is not a special byte code,
734 * it is a ctrl char tagged to be echoed
735 * as "^X" (where X is the letter
736 * representing the control char).
737 * Note that we must ensure there is
738 * enough space for the whole ctrl pair.
739 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000740 */
Joe Peterson62b26352009-09-09 15:03:47 -0600741 if (space < 2) {
742 no_space_left = 1;
743 break;
744 }
745 tty_put_char(tty, '^');
746 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200747 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600748 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400749 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000750 }
751
752 if (no_space_left)
753 break;
754 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400755 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600756 int retval = do_output_char(c, tty, space);
757 if (retval < 0)
758 break;
759 space -= retval;
760 } else {
761 if (!space)
762 break;
763 tty_put_char(tty, c);
764 space -= 1;
765 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400766 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000767 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000768 }
769
Peter Hurleycbfd0342013-06-15 10:04:26 -0400770 /* If the echo buffer is nearly full (so that the possibility exists
771 * of echo overrun before the next commit), then discard enough
772 * data at the tail to prevent a subsequent overrun */
773 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
Roel Kluinc476f652013-10-11 22:08:49 +0200774 if (echo_buf(ldata, tail) == ECHO_OP_START) {
Peter Hurley6f222532013-11-08 09:42:18 -0500775 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400776 tail += 3;
777 else
778 tail += 2;
779 } else
780 tail++;
781 }
782
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400783 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400784 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000785}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Peter Hurley17bd7902013-06-15 10:04:24 -0400787static void commit_echoes(struct tty_struct *tty)
788{
789 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400790 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400791 size_t head;
792
793 head = ldata->echo_head;
794 old = ldata->echo_commit - ldata->echo_tail;
795
796 /* Process committed echoes if the accumulated # of bytes
797 * is over the threshold (and try again each time another
798 * block is accumulated) */
799 nr = head - ldata->echo_tail;
800 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
801 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400802
Peter Hurley019ebdf2013-06-15 10:04:25 -0400803 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400804 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400805 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400806 mutex_unlock(&ldata->output_lock);
807
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400808 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400809 tty->ops->flush_chars(tty);
810}
811
812static void process_echoes(struct tty_struct *tty)
813{
814 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400815 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400816
Peter Hurley39434ab2013-11-29 12:56:10 -0500817 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
818 ldata->echo_commit == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400819 return;
820
821 mutex_lock(&ldata->output_lock);
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 Hurleycbfd0342013-06-15 10:04:26 -0400829static void flush_echoes(struct tty_struct *tty)
830{
831 struct n_tty_data *ldata = tty->disc_data;
832
Peter Hurley39434ab2013-11-29 12:56:10 -0500833 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
834 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400835 return;
836
837 mutex_lock(&ldata->output_lock);
838 ldata->echo_commit = ldata->echo_head;
839 __process_echoes(tty);
840 mutex_unlock(&ldata->output_lock);
841}
842
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000844 * add_echo_byte - add a byte to the echo buffer
845 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200846 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000847 *
848 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000849 */
850
Peter Hurleycbfd0342013-06-15 10:04:26 -0400851static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000852{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400853 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000854}
855
856/**
857 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200858 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000859 *
860 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000861 */
862
Jiri Slaby57c94122012-10-18 22:26:43 +0200863static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000864{
Jiri Slaby57c94122012-10-18 22:26:43 +0200865 add_echo_byte(ECHO_OP_START, ldata);
866 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000867}
868
869/**
870 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200871 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000872 *
873 * Add an operation to the echo buffer to set the canon column
874 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000875 */
876
Jiri Slaby57c94122012-10-18 22:26:43 +0200877static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000878{
Jiri Slaby57c94122012-10-18 22:26:43 +0200879 add_echo_byte(ECHO_OP_START, ldata);
880 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000881}
882
883/**
884 * echo_erase_tab - add operation to erase a tab
885 * @num_chars: number of character columns already used
886 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200887 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000888 *
889 * Add an operation to the echo buffer to erase a tab.
890 *
891 * Called by the eraser function, which knows how many character
892 * columns have been used since either a previous tab or the start
893 * of input. This information will be used later, along with
894 * canon column (if applicable), to go back the correct number
895 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000896 */
897
898static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200899 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000900{
Jiri Slaby57c94122012-10-18 22:26:43 +0200901 add_echo_byte(ECHO_OP_START, ldata);
902 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000903
904 /* We only need to know this modulo 8 (tab spacing) */
905 num_chars &= 7;
906
907 /* Set the high bit as a flag if num_chars is after a previous tab */
908 if (after_tab)
909 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000910
Jiri Slaby57c94122012-10-18 22:26:43 +0200911 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000912}
913
914/**
915 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 * @c: unicode byte to echo
917 * @tty: terminal device
918 *
Alan Cox4edf1822008-02-08 04:18:44 -0800919 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100921 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000922 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000923 */
924
Jiri Slaby57c94122012-10-18 22:26:43 +0200925static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000926{
Joe Petersona88a69c2009-01-02 13:40:53 +0000927 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200928 add_echo_byte(ECHO_OP_START, ldata);
929 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000930 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200931 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000932 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000933}
934
935/**
936 * echo_char - echo a character
937 * @c: unicode byte to echo
938 * @tty: terminal device
939 *
940 * Echo user input back onto the screen. This must be called only when
941 * L_ECHO(tty) is true. Called from the driver receive_buf path.
942 *
Joe Peterson62b26352009-09-09 15:03:47 -0600943 * This variant tags control characters to be echoed as "^X"
944 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 */
946
947static void echo_char(unsigned char c, struct tty_struct *tty)
948{
Jiri Slabybddc7152012-10-18 22:26:42 +0200949 struct n_tty_data *ldata = tty->disc_data;
950
Joe Petersona88a69c2009-01-02 13:40:53 +0000951 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200952 add_echo_byte(ECHO_OP_START, ldata);
953 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000954 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600955 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200956 add_echo_byte(ECHO_OP_START, ldata);
957 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000958 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959}
960
Alan Cox17b82062008-10-13 10:45:06 +0100961/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000962 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200963 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100964 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000965
Jiri Slaby57c94122012-10-18 22:26:43 +0200966static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200968 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200969 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200970 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 }
972}
973
974/**
975 * eraser - handle erase function
976 * @c: character input
977 * @tty: terminal device
978 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200979 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 * present in the stream from the driver layer. Handles the complexities
981 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100982 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400983 * n_tty_receive_buf()/producer path:
984 * caller holds non-exclusive termios_rwsem
985 * modifies read_head
986 *
987 * Modifying the read_head is not considered a publish in this context
988 * because canonical mode is active -- only canon_head publishes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 */
Alan Cox4edf1822008-02-08 04:18:44 -0800990
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991static void eraser(unsigned char c, struct tty_struct *tty)
992{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200993 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400995 size_t head;
996 size_t cnt;
997 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200999 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +00001000 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 return;
1002 }
1003 if (c == ERASE_CHAR(tty))
1004 kill_type = ERASE;
1005 else if (c == WERASE_CHAR(tty))
1006 kill_type = WERASE;
1007 else {
1008 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001009 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 return;
1011 }
1012 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001013 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +02001014 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 echo_char(KILL_CHAR(tty), tty);
1016 /* Add a newline if ECHOK is on and ECHOKE is off. */
1017 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001018 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 return;
1020 }
1021 kill_type = KILL;
1022 }
1023
1024 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001025 while (ldata->read_head != ldata->canon_head) {
1026 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
1028 /* erase a single possibly multibyte character */
1029 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001030 head--;
1031 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001032 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
1034 /* do not partially erase */
1035 if (is_continuation(c, tty))
1036 break;
1037
1038 if (kill_type == WERASE) {
1039 /* Equivalent to BSD's ALTWERASE. */
1040 if (isalnum(c) || c == '_')
1041 seen_alnums++;
1042 else if (seen_alnums)
1043 break;
1044 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001045 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001046 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 if (L_ECHO(tty)) {
1048 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001049 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001050 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001051 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 }
1053 /* if cnt > 1, output a multi-byte character */
1054 echo_char(c, tty);
1055 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001056 head++;
1057 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001058 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 }
1060 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1061 echo_char(ERASE_CHAR(tty), tty);
1062 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001063 unsigned int num_chars = 0;
1064 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001065 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
Joe Petersona88a69c2009-01-02 13:40:53 +00001067 /*
1068 * Count the columns used for characters
1069 * since the start of input or after a
1070 * previous tab.
1071 * This info is used to go back the correct
1072 * number of columns.
1073 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001074 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001075 tail--;
1076 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001077 if (c == '\t') {
1078 after_tab = 1;
1079 break;
Alan Cox300a6202009-01-02 13:41:04 +00001080 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001082 num_chars += 2;
1083 } else if (!is_continuation(c, tty)) {
1084 num_chars++;
1085 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001087 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 } else {
1089 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001090 echo_char_raw('\b', ldata);
1091 echo_char_raw(' ', ldata);
1092 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 }
1094 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001095 echo_char_raw('\b', ldata);
1096 echo_char_raw(' ', ldata);
1097 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 }
1099 }
1100 }
1101 if (kill_type == ERASE)
1102 break;
1103 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001104 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001105 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106}
1107
1108/**
1109 * isig - handle the ISIG optio
1110 * @sig: signal
1111 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001113 * Called when a signal is being sent due to terminal input.
1114 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001115 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001116 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 */
Alan Cox4edf1822008-02-08 04:18:44 -08001118
Peter Hurley4b293492013-07-24 08:29:55 -04001119static void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120{
Peter Hurley8c985d12013-03-06 08:38:19 -05001121 struct pid *tty_pgrp = tty_get_pgrp(tty);
1122 if (tty_pgrp) {
1123 kill_pgrp(tty_pgrp, sig, 1);
1124 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 }
1126}
1127
1128/**
1129 * n_tty_receive_break - handle break
1130 * @tty: terminal
1131 *
1132 * An RS232 break event has been hit in the incoming bitstream. This
1133 * can cause a variety of events depending upon the termios settings.
1134 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001135 * n_tty_receive_buf()/producer path:
1136 * caller holds non-exclusive termios_rwsem
1137 * publishes read_head via put_tty_queue()
1138 *
1139 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 */
Alan Cox4edf1822008-02-08 04:18:44 -08001141
Peter Hurley4b293492013-07-24 08:29:55 -04001142static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143{
Jiri Slaby57c94122012-10-18 22:26:43 +02001144 struct n_tty_data *ldata = tty->disc_data;
1145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 if (I_IGNBRK(tty))
1147 return;
1148 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001149 isig(SIGINT, tty);
1150 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001151 /* flushing needs exclusive termios_rwsem */
1152 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001153 n_tty_flush_buffer(tty);
1154 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001155 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001156 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 return;
1158 }
1159 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001160 put_tty_queue('\377', ldata);
1161 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001163 put_tty_queue('\0', ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001164 if (waitqueue_active(&tty->read_wait))
1165 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166}
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);
Peter Hurley6c677162013-12-02 14:24:46 -05001223 if (waitqueue_active(&tty->read_wait))
1224 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225}
1226
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001227static void
1228n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1229{
1230 if (!L_NOFLSH(tty)) {
1231 /* flushing needs exclusive termios_rwsem */
1232 up_read(&tty->termios_rwsem);
1233 n_tty_flush_buffer(tty);
1234 tty_driver_flush_buffer(tty);
1235 down_read(&tty->termios_rwsem);
1236 }
1237 if (I_IXON(tty))
1238 start_tty(tty);
1239 if (L_ECHO(tty)) {
1240 echo_char(c, tty);
1241 commit_echoes(tty);
1242 }
1243 isig(signal, tty);
1244 return;
1245}
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247/**
1248 * n_tty_receive_char - perform processing
1249 * @tty: terminal device
1250 * @c: character
1251 *
1252 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001253 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001255 *
1256 * n_tty_receive_buf()/producer path:
1257 * caller holds non-exclusive termios_rwsem
1258 * publishes canon_head if canonical mode is active
1259 * otherwise, publishes read_head via put_tty_queue()
Peter Hurleye60d27c2013-07-24 08:29:56 -04001260 *
1261 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 */
1263
Peter Hurleye60d27c2013-07-24 08:29:56 -04001264static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001265n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001267 struct n_tty_data *ldata = tty->disc_data;
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))) {
1352 /*
1353 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1354 */
1355 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001357 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001358 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001360 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 }
1362 /*
1363 * XXX does PARMRK doubling happen for
1364 * EOL_CHAR and EOL2_CHAR?
1365 */
Peter Hurley001ba922013-12-02 14:24:44 -05001366 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001367 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
Alan Cox4edf1822008-02-08 04:18:44 -08001369handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001370 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001371 put_tty_queue(c, ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001372 ldata->canon_head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1374 if (waitqueue_active(&tty->read_wait))
1375 wake_up_interruptible(&tty->read_wait);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001376 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 }
1378 }
Alan Cox4edf1822008-02-08 04:18:44 -08001379
Joe Petersonacc71bb2009-01-02 13:43:32 +00001380 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001381 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001383 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 else {
1385 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001386 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001387 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 echo_char(c, tty);
1389 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001390 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 }
1392
Peter Hurley001ba922013-12-02 14:24:44 -05001393 /* PARMRK doubling check */
1394 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001395 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
Jiri Slaby57c94122012-10-18 22:26:43 +02001397 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001398 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001399}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Peter Hurleye60d27c2013-07-24 08:29:56 -04001401static inline void
1402n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001403{
1404 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001405
Peter Hurleye60d27c2013-07-24 08:29:56 -04001406 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1407 start_tty(tty);
1408 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001409 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001410 if (L_ECHO(tty)) {
1411 finish_erasing(ldata);
1412 /* Record the column of first canon char. */
1413 if (ldata->canon_head == ldata->read_head)
1414 echo_set_canon_col(ldata);
1415 echo_char(c, tty);
1416 commit_echoes(tty);
1417 }
Peter Hurley001ba922013-12-02 14:24:44 -05001418 /* PARMRK doubling check */
1419 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001420 put_tty_queue(c, ldata);
1421 put_tty_queue(c, ldata);
1422}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001423
Peter Hurleyeb3e4662013-12-02 14:24:42 -05001424static void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
Peter Hurleye60d27c2013-07-24 08:29:56 -04001425{
1426 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001427}
1428
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001429static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001430n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1431{
1432 struct n_tty_data *ldata = tty->disc_data;
1433
Peter Hurleye60d27c2013-07-24 08:29:56 -04001434 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1435 start_tty(tty);
1436 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001437 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001438 if (L_ECHO(tty)) {
1439 finish_erasing(ldata);
1440 /* Record the column of first canon char. */
1441 if (ldata->canon_head == ldata->read_head)
1442 echo_set_canon_col(ldata);
1443 echo_char(c, tty);
1444 commit_echoes(tty);
1445 }
1446 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001447}
1448
Peter Hurley8dc4b252013-12-02 14:24:43 -05001449static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001450{
1451 if (I_ISTRIP(tty))
1452 c &= 0x7f;
1453 if (I_IUCLC(tty) && L_IEXTEN(tty))
1454 c = tolower(c);
1455
1456 if (I_IXON(tty)) {
1457 if (c == STOP_CHAR(tty))
1458 stop_tty(tty);
1459 else if (c == START_CHAR(tty) ||
1460 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1461 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1462 c != SUSP_CHAR(tty))) {
1463 start_tty(tty);
1464 process_echoes(tty);
1465 }
1466 }
1467}
1468
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001469static void
1470n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1471{
1472 char buf[64];
1473
1474 switch (flag) {
1475 case TTY_BREAK:
1476 n_tty_receive_break(tty);
1477 break;
1478 case TTY_PARITY:
1479 case TTY_FRAME:
1480 n_tty_receive_parity_error(tty, c);
1481 break;
1482 case TTY_OVERRUN:
1483 n_tty_receive_overrun(tty);
1484 break;
1485 default:
1486 printk(KERN_ERR "%s: unknown flag %d\n",
1487 tty_name(tty, buf), flag);
1488 break;
1489 }
1490}
1491
Peter Hurleye60d27c2013-07-24 08:29:56 -04001492static void
1493n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1494{
1495 struct n_tty_data *ldata = tty->disc_data;
1496
1497 ldata->lnext = 0;
1498 if (likely(flag == TTY_NORMAL)) {
1499 if (I_ISTRIP(tty))
1500 c &= 0x7f;
1501 if (I_IUCLC(tty) && L_IEXTEN(tty))
1502 c = tolower(c);
1503 n_tty_receive_char(tty, c);
1504 } else
1505 n_tty_receive_char_flagged(tty, c, flag);
1506}
1507
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508/**
1509 * n_tty_receive_buf - data receive
1510 * @tty: terminal device
1511 * @cp: buffer
1512 * @fp: flag buffer
1513 * @count: characters
1514 *
1515 * Called by the terminal driver when a block of characters has
1516 * been received. This function must be called from soft contexts
1517 * not from interrupt context. The driver is responsible for making
1518 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001519 *
1520 * n_tty_receive_buf()/producer path:
1521 * claims non-exclusive termios_rwsem
1522 * publishes read_head and canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 */
Alan Cox4edf1822008-02-08 04:18:44 -08001524
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001525static void
1526n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1527 char *fp, int count)
1528{
1529 struct n_tty_data *ldata = tty->disc_data;
1530 size_t n, head;
1531
1532 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1533 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1534 n = min_t(size_t, count, n);
1535 memcpy(read_buf_addr(ldata, head), cp, n);
1536 ldata->read_head += n;
1537 cp += n;
1538 count -= n;
1539
1540 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1541 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1542 n = min_t(size_t, count, n);
1543 memcpy(read_buf_addr(ldata, head), cp, n);
1544 ldata->read_head += n;
1545}
1546
Peter Hurley554117b2013-06-15 10:21:25 -04001547static void
1548n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1549 char *fp, int count)
1550{
1551 struct n_tty_data *ldata = tty->disc_data;
1552 char flag = TTY_NORMAL;
1553
1554 while (count--) {
1555 if (fp)
1556 flag = *fp++;
1557 if (likely(flag == TTY_NORMAL))
1558 put_tty_queue(*cp++, ldata);
1559 else
1560 n_tty_receive_char_flagged(tty, *cp++, flag);
1561 }
1562}
1563
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001564static void
1565n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1566 char *fp, int count)
1567{
1568 char flag = TTY_NORMAL;
1569
1570 while (count--) {
1571 if (fp)
1572 flag = *fp++;
1573 if (likely(flag == TTY_NORMAL))
1574 n_tty_receive_char_closing(tty, *cp++);
1575 else
1576 n_tty_receive_char_flagged(tty, *cp++, flag);
1577 }
1578}
1579
Peter Hurley7d88d632013-07-24 08:29:49 -04001580static void
1581n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001582 char *fp, int count)
1583{
1584 struct n_tty_data *ldata = tty->disc_data;
1585 char flag = TTY_NORMAL;
1586
1587 while (count--) {
1588 if (fp)
1589 flag = *fp++;
1590 if (likely(flag == TTY_NORMAL)) {
1591 unsigned char c = *cp++;
1592
1593 if (I_ISTRIP(tty))
1594 c &= 0x7f;
1595 if (I_IUCLC(tty) && L_IEXTEN(tty))
1596 c = tolower(c);
1597 if (L_EXTPROC(tty)) {
1598 put_tty_queue(c, ldata);
1599 continue;
1600 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001601 if (!test_bit(c, ldata->char_map))
1602 n_tty_receive_char_inline(tty, c);
1603 else if (n_tty_receive_char_special(tty, c) && count) {
1604 if (fp)
1605 flag = *fp++;
1606 n_tty_receive_char_lnext(tty, *cp++, flag);
1607 count--;
1608 }
Peter Hurley6baad002013-07-24 08:29:52 -04001609 } else
1610 n_tty_receive_char_flagged(tty, *cp++, flag);
1611 }
1612}
1613
1614static void
1615n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1616 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001617{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001618 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001619 char flag = TTY_NORMAL;
1620
1621 while (count--) {
1622 if (fp)
1623 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001624 if (likely(flag == TTY_NORMAL)) {
1625 unsigned char c = *cp++;
1626
1627 if (!test_bit(c, ldata->char_map))
1628 n_tty_receive_char_fast(tty, c);
1629 else if (n_tty_receive_char_special(tty, c) && count) {
1630 if (fp)
1631 flag = *fp++;
1632 n_tty_receive_char_lnext(tty, *cp++, flag);
1633 count--;
1634 }
1635 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001636 n_tty_receive_char_flagged(tty, *cp++, flag);
1637 }
1638}
1639
Peter Hurley24a89d12013-06-15 09:14:15 -04001640static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1641 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001643 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001644 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001646 if (ldata->real_raw)
1647 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001648 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117b2013-06-15 10:21:25 -04001649 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001650 else if (tty->closing && !L_EXTPROC(tty))
1651 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001652 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001653 if (ldata->lnext) {
1654 char flag = TTY_NORMAL;
1655
1656 if (fp)
1657 flag = *fp++;
1658 n_tty_receive_char_lnext(tty, *cp++, flag);
1659 count--;
1660 }
1661
Peter Hurley7de971b2013-07-24 08:29:53 -04001662 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001663 n_tty_receive_buf_fast(tty, cp, fp, count);
1664 else
1665 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001666
1667 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001668 if (tty->ops->flush_chars)
1669 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 }
1671
Peter Hurleyce741172013-06-15 09:14:20 -04001672 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
hyc@symas.com26df6d12010-06-22 10:14:49 -07001673 L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1675 if (waitqueue_active(&tty->read_wait))
1676 wake_up_interruptible(&tty->read_wait);
1677 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
Peter Hurley5c32d122013-12-02 14:24:41 -05001680static int
1681n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1682 char *fp, int count, int flow)
Peter Hurley24a89d12013-06-15 09:14:15 -04001683{
1684 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley19e2ad62013-07-24 08:29:54 -04001685 int room, n, rcvd = 0;
Peter Hurley24a89d12013-06-15 09:14:15 -04001686
Peter Hurley9356b532013-06-15 09:14:24 -04001687 down_read(&tty->termios_rwsem);
1688
Peter Hurley19e2ad62013-07-24 08:29:54 -04001689 while (1) {
1690 room = receive_room(tty);
1691 n = min(count, room);
1692 if (!n) {
Peter Hurley5c32d122013-12-02 14:24:41 -05001693 if (flow && !room)
Peter Hurley19e2ad62013-07-24 08:29:54 -04001694 ldata->no_room = 1;
1695 break;
1696 }
1697 __receive_buf(tty, cp, fp, n);
1698 cp += n;
1699 if (fp)
1700 fp += n;
1701 count -= n;
1702 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001703 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001704
Peter Hurley19e2ad62013-07-24 08:29:54 -04001705 tty->receive_room = room;
1706 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001707 up_read(&tty->termios_rwsem);
1708
Peter Hurley19e2ad62013-07-24 08:29:54 -04001709 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001710}
1711
Peter Hurley5c32d122013-12-02 14:24:41 -05001712static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1713 char *fp, int count)
1714{
1715 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1716}
1717
1718static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1719 char *fp, int count)
1720{
1721 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1722}
1723
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724int is_ignored(int sig)
1725{
1726 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001727 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728}
1729
1730/**
1731 * n_tty_set_termios - termios data changed
1732 * @tty: terminal
1733 * @old: previous data
1734 *
1735 * Called by the tty layer when the user changes termios flags so
1736 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001737 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 * guaranteed that this function will not be re-entered or in progress
1739 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001740 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001741 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 */
Alan Cox4edf1822008-02-08 04:18:44 -08001743
1744static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001746 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001747
Peter Hurleyc786f742013-09-17 12:53:35 -04001748 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001749 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -05001750 ldata->line_start = ldata->read_tail;
1751 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1752 ldata->canon_head = ldata->read_tail;
1753 ldata->push = 0;
1754 } else {
1755 set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1756 ldata->read_flags);
1757 ldata->canon_head = ldata->read_head;
1758 ldata->push = 1;
1759 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001760 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001761 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001762 }
1763
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001764 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001765
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1767 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1768 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1769 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001770 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
1772 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001773 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001775 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
1777 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001778 set_bit(ERASE_CHAR(tty), ldata->char_map);
1779 set_bit(KILL_CHAR(tty), ldata->char_map);
1780 set_bit(EOF_CHAR(tty), ldata->char_map);
1781 set_bit('\n', ldata->char_map);
1782 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001784 set_bit(WERASE_CHAR(tty), ldata->char_map);
1785 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1786 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 if (L_ECHO(tty))
1788 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001789 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 }
1791 }
1792 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001793 set_bit(START_CHAR(tty), ldata->char_map);
1794 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 }
1796 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001797 set_bit(INTR_CHAR(tty), ldata->char_map);
1798 set_bit(QUIT_CHAR(tty), ldata->char_map);
1799 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001801 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001802 ldata->raw = 0;
1803 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001805 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1807 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1808 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001809 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001811 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 }
Linus Torvalds55db4c62011-06-04 06:33:24 +09001813 n_tty_set_room(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001814 /*
1815 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1816 * been stopped by STOP_CHAR(tty) before it.
1817 */
Peter Hurley103fcbe22013-09-17 12:53:36 -04001818 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped)
Wang YanQingdab73b42013-05-09 14:16:47 +08001819 start_tty(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001820
Alan Coxf34d7a52008-04-30 00:54:13 -07001821 /* The termios change make the tty ready for I/O */
Peter Hurley6c677162013-12-02 14:24:46 -05001822 if (waitqueue_active(&tty->write_wait))
1823 wake_up_interruptible(&tty->write_wait);
1824 if (waitqueue_active(&tty->read_wait))
1825 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
1827
1828/**
1829 * n_tty_close - close the ldisc for this tty
1830 * @tty: device
1831 *
Alan Cox4edf1822008-02-08 04:18:44 -08001832 * Called from the terminal layer when this line discipline is
1833 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 * discipline change. The function will not be called while other
1835 * ldisc methods are in progress.
1836 */
Alan Cox4edf1822008-02-08 04:18:44 -08001837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838static void n_tty_close(struct tty_struct *tty)
1839{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001840 struct n_tty_data *ldata = tty->disc_data;
1841
Peter Hurley79901312013-03-11 16:44:23 -04001842 if (tty->link)
1843 n_tty_packet_mode_flush(tty);
1844
Peter Hurley20bafb32013-06-15 10:21:19 -04001845 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001846 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847}
1848
1849/**
1850 * n_tty_open - open an ldisc
1851 * @tty: terminal to open
1852 *
Alan Cox4edf1822008-02-08 04:18:44 -08001853 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 * terminal device. Can sleep. Called serialized so that no
1855 * other events will occur in parallel. No further open will occur
1856 * until a close.
1857 */
1858
1859static int n_tty_open(struct tty_struct *tty)
1860{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001861 struct n_tty_data *ldata;
1862
Peter Hurley20bafb32013-06-15 10:21:19 -04001863 /* Currently a malloc failure here can panic */
1864 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001865 if (!ldata)
1866 goto err;
1867
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001868 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001869 mutex_init(&ldata->atomic_read_lock);
1870 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001871
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001872 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001873 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001874 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001875 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001876 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001877 ldata->num_overrun = 0;
1878 ldata->no_room = 0;
1879 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001881 /* indicate buffer work may resume */
1882 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1883 n_tty_set_termios(tty, NULL);
1884 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001885
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001887err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001888 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889}
1890
Peter Hurleyeafbe672013-12-02 14:24:45 -05001891static inline int input_available_p(struct tty_struct *tty, int poll)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001893 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleyeafbe672013-12-02 14:24:45 -05001894 int amt = poll && !TIME_CHAR(tty) ? MIN_CHAR(tty) : 1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001895
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001896 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurleya73d3d62013-06-15 09:14:25 -04001897 if (ldata->canon_head != ldata->read_tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 return 1;
Peter Hurleyeafbe672013-12-02 14:24:45 -05001899 } else if (read_cnt(ldata) >= amt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 return 1;
1901
1902 return 0;
1903}
1904
1905/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001906 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 * @tty: terminal device
1908 * @b: user data
1909 * @nr: size of data
1910 *
Alan Cox11a96d12008-10-13 10:46:24 +01001911 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 * ICANON is off; it copies characters straight from the tty queue to
1913 * user space directly. It can be profitably called twice; once to
1914 * drain the space from the tail pointer to the (physical) end of the
1915 * buffer, and once to drain the space from the (physical) beginning of
1916 * the buffer to head pointer.
1917 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001918 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001920 * n_tty_read()/consumer path:
1921 * caller holds non-exclusive termios_rwsem
1922 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 */
Alan Cox4edf1822008-02-08 04:18:44 -08001924
Alan Cox33f0f882006-01-09 20:54:13 -08001925static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 unsigned char __user **b,
1927 size_t *nr)
1928
1929{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001930 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 int retval;
1932 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001933 bool is_eof;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001934 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
1936 retval = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001937 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001940 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001942 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1943 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001944 ldata->icanon);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001945 ldata->read_tail += n;
hyc@symas.com26df6d12010-06-22 10:14:49 -07001946 /* Turn single EOF into zero-length read */
Peter Hurleyce741172013-06-15 09:14:20 -04001947 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001948 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 *b += n;
1950 *nr -= n;
1951 }
1952 return retval;
1953}
1954
Peter Hurley88bb0de2013-06-15 09:14:16 -04001955/**
Peter Hurley32f13522013-06-15 09:14:17 -04001956 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001957 * @tty: terminal device
1958 * @b: user data
1959 * @nr: size of data
1960 *
1961 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001962 * it copies one line of input up to and including the line-delimiting
1963 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001964 *
Peter Hurley4d0ed182013-12-10 17:12:02 -05001965 * NB: When termios is changed from non-canonical to canonical mode and
1966 * the read buffer contains data, n_tty_set_termios() simulates an EOF
1967 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
1968 * This causes data already processed as input to be immediately available
1969 * as input although a newline has not been received.
1970 *
Peter Hurley88bb0de2013-06-15 09:14:16 -04001971 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001972 *
1973 * n_tty_read()/consumer path:
1974 * caller holds non-exclusive termios_rwsem
1975 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001976 */
1977
Peter Hurley32f13522013-06-15 09:14:17 -04001978static int canon_copy_from_read_buf(struct tty_struct *tty,
1979 unsigned char __user **b,
1980 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001981{
1982 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001983 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001984 size_t eol;
1985 size_t tail;
1986 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001987 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001988
1989 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyce741172013-06-15 09:14:20 -04001990 n = min(*nr, read_cnt(ldata));
Peter Hurley6d76bd22013-06-15 09:14:26 -04001991 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04001992 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001993
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001994 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04001995 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1996
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001997 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04001998 __func__, *nr, tail, n, size);
1999
2000 eol = find_next_bit(ldata->read_flags, size, tail);
2001 more = n - (size - tail);
2002 if (eol == N_TTY_BUF_SIZE && more) {
2003 /* scan wrapped without finding set bit */
2004 eol = find_next_bit(ldata->read_flags, more, 0);
2005 if (eol != more)
2006 found = 1;
2007 } else if (eol != size)
2008 found = 1;
2009
2010 size = N_TTY_BUF_SIZE - tail;
Peter Hurleyc77569d2013-11-22 07:16:25 -05002011 n = eol - tail;
2012 if (n > 4096)
2013 n += 4096;
2014 n += found;
Peter Hurley32f13522013-06-15 09:14:17 -04002015 c = n;
2016
Peter Hurley4d0ed182013-12-10 17:12:02 -05002017 if (found && !ldata->push && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002018 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002019 eof_push = !n && ldata->read_tail != ldata->line_start;
2020 }
Peter Hurley32f13522013-06-15 09:14:17 -04002021
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002022 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002023 __func__, eol, found, n, c, size, more);
2024
Peter Hurley32f13522013-06-15 09:14:17 -04002025 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002026 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002027 if (ret)
2028 return -EFAULT;
2029 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2030 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002031 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002032
2033 if (ret)
2034 return -EFAULT;
2035 *b += n;
2036 *nr -= n;
2037
Peter Hurleya73d3d62013-06-15 09:14:25 -04002038 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002039 clear_bit(eol, ldata->read_flags);
2040 smp_mb__after_clear_bit();
2041 ldata->read_tail += c;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002042
Peter Hurley40d5e092013-06-15 10:21:17 -04002043 if (found) {
Peter Hurley4d0ed182013-12-10 17:12:02 -05002044 if (!ldata->push)
2045 ldata->line_start = ldata->read_tail;
2046 else
2047 ldata->push = 0;
Peter Hurley32f13522013-06-15 09:14:17 -04002048 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002049 }
2050 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002051}
2052
Al Virocc4191d2008-03-29 03:08:48 +00002053extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002054 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055
2056/**
2057 * job_control - check job control
2058 * @tty: tty
2059 * @file: file handle
2060 *
2061 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002062 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002064 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002065 * Locking: redirected write test is safe
2066 * current->signal->tty check is safe
2067 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 */
Alan Cox4edf1822008-02-08 04:18:44 -08002069
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070static int job_control(struct tty_struct *tty, struct file *file)
2071{
2072 /* Job control check -- must be done at start and after
2073 every sleep (POSIX.1 7.1.1.4). */
2074 /* NOTE: not yet done after every sleep pending a thorough
2075 check of the logic of this change. -- jlc */
2076 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002077 if (file->f_op->write == redirected_tty_write ||
2078 current->signal->tty != tty)
2079 return 0;
2080
2081 spin_lock_irq(&tty->ctrl_lock);
2082 if (!tty->pgrp)
2083 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2084 else if (task_pgrp(current) != tty->pgrp) {
2085 spin_unlock_irq(&tty->ctrl_lock);
2086 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2087 return -EIO;
2088 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2089 set_thread_flag(TIF_SIGPENDING);
2090 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002092 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 return 0;
2094}
Alan Cox4edf1822008-02-08 04:18:44 -08002095
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096
2097/**
Alan Cox11a96d12008-10-13 10:46:24 +01002098 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 * @tty: tty device
2100 * @file: file object
2101 * @buf: userspace buffer pointer
2102 * @nr: size of I/O
2103 *
2104 * Perform reads for the line discipline. We are guaranteed that the
2105 * line discipline will not be closed under us but we may get multiple
2106 * parallel readers and must handle this ourselves. We may also get
2107 * a hangup. Always called in user context, may sleep.
2108 *
2109 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002110 *
2111 * n_tty_read()/consumer path:
2112 * claims non-exclusive termios_rwsem
2113 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 */
Alan Cox4edf1822008-02-08 04:18:44 -08002115
Alan Cox11a96d12008-10-13 10:46:24 +01002116static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 unsigned char __user *buf, size_t nr)
2118{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002119 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 unsigned char __user *b = buf;
2121 DECLARE_WAITQUEUE(wait, current);
2122 int c;
2123 int minimum, time;
2124 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 long timeout;
2126 unsigned long flags;
Alan Cox04f378b2008-04-30 00:53:29 -07002127 int packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002130 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002132
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002133 /*
2134 * Internal serialization of reads.
2135 */
2136 if (file->f_flags & O_NONBLOCK) {
2137 if (!mutex_trylock(&ldata->atomic_read_lock))
2138 return -EAGAIN;
2139 } else {
2140 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2141 return -ERESTARTSYS;
2142 }
2143
Peter Hurley9356b532013-06-15 09:14:24 -04002144 down_read(&tty->termios_rwsem);
2145
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 minimum = time = 0;
2147 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002148 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 minimum = MIN_CHAR(tty);
2150 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002151 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002153 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002155 (ldata->minimum_to_wake > minimum))
2156 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002158 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002159 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 }
2161 }
2162
Alan Cox04f378b2008-04-30 00:53:29 -07002163 packet = tty->packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164
2165 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 while (nr) {
2167 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002168 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 unsigned char cs;
2170 if (b != buf)
2171 break;
Alan Cox04f378b2008-04-30 00:53:29 -07002172 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 cs = tty->link->ctrl_status;
2174 tty->link->ctrl_status = 0;
Alan Cox04f378b2008-04-30 00:53:29 -07002175 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002176 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 retval = -EFAULT;
2178 b--;
2179 break;
2180 }
2181 nr--;
2182 break;
2183 }
2184 /* This statement must be first before checking for input
2185 so that any interrupt will set the state back to
2186 TASK_RUNNING. */
2187 set_current_state(TASK_INTERRUPTIBLE);
Alan Cox4edf1822008-02-08 04:18:44 -08002188
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002189 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002191 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002192
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 if (!input_available_p(tty, 0)) {
2194 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
Peter Hurleyf8747d42013-09-27 13:27:05 -04002195 up_read(&tty->termios_rwsem);
2196 tty_flush_to_ldisc(tty);
2197 down_read(&tty->termios_rwsem);
2198 if (!input_available_p(tty, 0)) {
2199 retval = -EIO;
2200 break;
2201 }
2202 } else {
2203 if (tty_hung_up_p(file))
2204 break;
2205 if (!timeout)
2206 break;
2207 if (file->f_flags & O_NONBLOCK) {
2208 retval = -EAGAIN;
2209 break;
2210 }
2211 if (signal_pending(current)) {
2212 retval = -ERESTARTSYS;
2213 break;
2214 }
2215 n_tty_set_room(tty);
2216 up_read(&tty->termios_rwsem);
Peter Hurley9356b532013-06-15 09:14:24 -04002217
Peter Hurleyf8747d42013-09-27 13:27:05 -04002218 timeout = schedule_timeout(timeout);
Peter Hurley9356b532013-06-15 09:14:24 -04002219
Peter Hurleyf8747d42013-09-27 13:27:05 -04002220 down_read(&tty->termios_rwsem);
2221 continue;
2222 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 }
2224 __set_current_state(TASK_RUNNING);
2225
2226 /* Deal with packet mode. */
Alan Cox04f378b2008-04-30 00:53:29 -07002227 if (packet && b == buf) {
Miloslav Trmac522ed772007-07-15 23:40:56 -07002228 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 retval = -EFAULT;
2230 b--;
2231 break;
2232 }
2233 nr--;
2234 }
2235
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002236 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002237 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002238 if (retval == -EAGAIN) {
2239 retval = 0;
2240 continue;
2241 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 break;
2243 } else {
2244 int uncopied;
Alan Cox04f378b2008-04-30 00:53:29 -07002245 /* The copy function takes the read lock and handles
2246 locking internally for this case */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 uncopied = copy_from_read_buf(tty, &b, &nr);
2248 uncopied += copy_from_read_buf(tty, &b, &nr);
2249 if (uncopied) {
2250 retval = -EFAULT;
2251 break;
2252 }
2253 }
2254
Peter Hurley6367ca72013-06-15 09:14:33 -04002255 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256
2257 if (b - buf >= minimum)
2258 break;
2259 if (time)
2260 timeout = time;
2261 }
Peter Hurley42458f42013-11-07 13:59:46 -05002262 n_tty_set_room(tty);
2263 up_read(&tty->termios_rwsem);
2264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 remove_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002267 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
Peter Hurleyaebf04532013-11-07 14:01:57 -05002269 mutex_unlock(&ldata->atomic_read_lock);
2270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 __set_current_state(TASK_RUNNING);
Peter Hurley40d5e092013-06-15 10:21:17 -04002272 if (b - buf)
2273 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
2275 return retval;
2276}
2277
2278/**
Alan Cox11a96d12008-10-13 10:46:24 +01002279 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 * @tty: tty device
2281 * @file: file object
2282 * @buf: userspace buffer pointer
2283 * @nr: size of I/O
2284 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002285 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002287 * and other such events. Since the receive code will echo characters,
2288 * thus calling driver write methods, the output_lock is used in
2289 * the output processing functions called here as well as in the
2290 * echo processing function to protect the column state and space
2291 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 *
2293 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002294 *
2295 * Locking: output_lock to protect column state and space left
2296 * (note that the process_output*() functions take this
2297 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 */
Alan Cox4edf1822008-02-08 04:18:44 -08002299
Alan Cox11a96d12008-10-13 10:46:24 +01002300static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002301 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302{
2303 const unsigned char *b = buf;
2304 DECLARE_WAITQUEUE(wait, current);
2305 int c;
2306 ssize_t retval = 0;
2307
2308 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2309 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2310 retval = tty_check_change(tty);
2311 if (retval)
2312 return retval;
2313 }
2314
Peter Hurley9356b532013-06-15 09:14:24 -04002315 down_read(&tty->termios_rwsem);
2316
Joe Petersona88a69c2009-01-02 13:40:53 +00002317 /* Write out any echoed characters that are still pending */
2318 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002319
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 add_wait_queue(&tty->write_wait, &wait);
2321 while (1) {
2322 set_current_state(TASK_INTERRUPTIBLE);
2323 if (signal_pending(current)) {
2324 retval = -ERESTARTSYS;
2325 break;
2326 }
2327 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2328 retval = -EIO;
2329 break;
2330 }
Peter Hurley582f5592013-05-17 12:49:48 -04002331 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002333 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 if (num < 0) {
2335 if (num == -EAGAIN)
2336 break;
2337 retval = num;
2338 goto break_out;
2339 }
2340 b += num;
2341 nr -= num;
2342 if (nr == 0)
2343 break;
2344 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002345 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 break;
2347 b++; nr--;
2348 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002349 if (tty->ops->flush_chars)
2350 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 } else {
Roman Zippeld6afe272005-07-07 17:56:55 -07002352 while (nr > 0) {
Alan Coxf34d7a52008-04-30 00:54:13 -07002353 c = tty->ops->write(tty, b, nr);
Roman Zippeld6afe272005-07-07 17:56:55 -07002354 if (c < 0) {
2355 retval = c;
2356 goto break_out;
2357 }
2358 if (!c)
2359 break;
2360 b += c;
2361 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002363 }
2364 if (!nr)
2365 break;
2366 if (file->f_flags & O_NONBLOCK) {
2367 retval = -EAGAIN;
2368 break;
2369 }
Peter Hurley9356b532013-06-15 09:14:24 -04002370 up_read(&tty->termios_rwsem);
2371
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 schedule();
Peter Hurley9356b532013-06-15 09:14:24 -04002373
2374 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 }
2376break_out:
2377 __set_current_state(TASK_RUNNING);
2378 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002379 if (b - buf != nr && tty->fasync)
2380 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002381 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 return (b - buf) ? b - buf : retval;
2383}
2384
2385/**
Alan Cox11a96d12008-10-13 10:46:24 +01002386 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 * @tty: terminal device
2388 * @file: file accessing it
2389 * @wait: poll table
2390 *
2391 * Called when the line discipline is asked to poll() for data or
2392 * for special events. This code is not serialized with respect to
2393 * other events save open/close.
2394 *
2395 * This code must be sure never to sleep through a hangup.
2396 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 */
Alan Cox4edf1822008-02-08 04:18:44 -08002398
Alan Cox11a96d12008-10-13 10:46:24 +01002399static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002400 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002402 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 unsigned int mask = 0;
2404
2405 poll_wait(file, &tty->read_wait, wait);
2406 poll_wait(file, &tty->write_wait, wait);
Peter Hurleyeafbe672013-12-02 14:24:45 -05002407 if (input_available_p(tty, 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 mask |= POLLIN | POLLRDNORM;
2409 if (tty->packet && tty->link->ctrl_status)
2410 mask |= POLLPRI | POLLIN | POLLRDNORM;
2411 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2412 mask |= POLLHUP;
2413 if (tty_hung_up_p(file))
2414 mask |= POLLHUP;
2415 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2416 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002417 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002419 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002421 if (tty->ops->write && !tty_is_writelocked(tty) &&
2422 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2423 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 mask |= POLLOUT | POLLWRNORM;
2425 return mask;
2426}
2427
Jiri Slaby57c94122012-10-18 22:26:43 +02002428static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002429{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002430 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002431
Peter Hurleya73d3d62013-06-15 09:14:25 -04002432 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002433 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002434 head = ldata->canon_head;
2435 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002436 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002437 /* Skip EOF-chars.. */
2438 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002439 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2440 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002441 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002442 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002443 }
2444 return nr;
2445}
2446
2447static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2448 unsigned int cmd, unsigned long arg)
2449{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002450 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002451 int retval;
2452
2453 switch (cmd) {
2454 case TIOCOUTQ:
2455 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2456 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002457 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002458 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002459 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002460 else
2461 retval = read_cnt(ldata);
2462 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002463 return put_user(retval, (unsigned int __user *) arg);
2464 default:
2465 return n_tty_ioctl_helper(tty, file, cmd, arg);
2466 }
2467}
2468
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002469static void n_tty_fasync(struct tty_struct *tty, int on)
2470{
2471 struct n_tty_data *ldata = tty->disc_data;
2472
2473 if (!waitqueue_active(&tty->read_wait)) {
2474 if (on)
2475 ldata->minimum_to_wake = 1;
2476 else if (!tty->fasync)
2477 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2478 }
2479}
2480
Alan Coxa352def2008-07-16 21:53:12 +01002481struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002482 .magic = TTY_LDISC_MAGIC,
2483 .name = "n_tty",
2484 .open = n_tty_open,
2485 .close = n_tty_close,
2486 .flush_buffer = n_tty_flush_buffer,
2487 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002488 .read = n_tty_read,
2489 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002490 .ioctl = n_tty_ioctl,
2491 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002492 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002493 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002494 .write_wakeup = n_tty_write_wakeup,
2495 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002496 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002498
2499/**
2500 * n_tty_inherit_ops - inherit N_TTY methods
2501 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2502 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002503 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002504 * methods.
2505 */
2506
2507void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2508{
2509 *ops = tty_ldisc_N_TTY;
2510 ops->owner = NULL;
2511 ops->refcount = ops->flags = 0;
2512}
2513EXPORT_SYMBOL_GPL(n_tty_inherit_ops);