blob: adc06af3a0754f3f3546b7b31d3559e13e4c30b2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
7 * anyway...)
8 *
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080011 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * This file may be redistributed under the terms of the GNU General Public
19 * License.
20 *
21 * Reduced memory usage for older ARM systems - Russell King.
22 *
Alan Cox4edf1822008-02-08 04:18:44 -080023 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
26 *
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010029 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * EAGAIN
31 */
32
33#include <linux/types.h>
34#include <linux/major.h>
35#include <linux/errno.h>
36#include <linux/signal.h>
37#include <linux/fcntl.h>
38#include <linux/sched.h>
39#include <linux/interrupt.h>
40#include <linux/tty.h>
41#include <linux/timer.h>
42#include <linux/ctype.h>
43#include <linux/mm.h>
44#include <linux/string.h>
45#include <linux/slab.h>
46#include <linux/poll.h>
47#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070048#include <linux/audit.h>
49#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000050#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080051#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050052#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040053#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/* number of characters left in xmit buffer before select has we have room */
57#define WAKEUP_CHARS 256
58
59/*
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
63 */
64#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010065#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Joe Petersona88a69c2009-01-02 13:40:53 +000067/*
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
71 * codes.
72 */
73#define ECHO_OP_START 0xff
74#define ECHO_OP_MOVE_BACK_COL 0x80
75#define ECHO_OP_SET_CANON_COL 0x81
76#define ECHO_OP_ERASE_TAB 0x82
77
Peter Hurleycbfd0342013-06-15 10:04:26 -040078#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
Peter Hurley32f13522013-06-15 09:14:17 -040083#undef N_TTY_TRACE
84#ifdef N_TTY_TRACE
85# define n_tty_trace(f, args...) trace_printk(f, ##args)
86#else
87# define n_tty_trace(f, args...)
88#endif
89
Jiri Slaby70ece7a2012-10-18 22:26:38 +020090struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040091 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040094 size_t echo_head;
95 size_t echo_commit;
Peter Hurley1bb9d562013-06-15 10:21:20 -040096 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040097
98 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +020099 unsigned long overrun_time;
100 int num_overrun;
101
Peter Hurley24a89d12013-06-15 09:14:15 -0400102 /* non-atomic */
103 bool no_room;
104
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400105 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200106 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200107
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400108 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400109 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200110 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400111 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200112
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -0400113 int minimum_to_wake;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200114
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400115 /* consumer-published */
116 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400117 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400118
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400119 /* protected by output lock */
120 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200121 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400122 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200123
124 struct mutex atomic_read_lock;
125 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200126};
127
Peter Hurleyce741172013-06-15 09:14:20 -0400128static inline size_t read_cnt(struct n_tty_data *ldata)
129{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400130 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400131}
132
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400133static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
134{
135 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
136}
137
138static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
139{
140 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
141}
142
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400143static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
144{
145 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
146}
147
148static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
149{
150 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
151}
152
Miloslav Trmac522ed772007-07-15 23:40:56 -0700153static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
154 unsigned char __user *ptr)
155{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200156 struct n_tty_data *ldata = tty->disc_data;
157
158 tty_audit_add_data(tty, &x, 1, ldata->icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700159 return put_user(x, ptr);
160}
161
Peter Hurley24a89d12013-06-15 09:14:15 -0400162static int receive_room(struct tty_struct *tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900163{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200164 struct n_tty_data *ldata = tty->disc_data;
Jaeden Amero090abf72012-07-27 08:43:11 -0500165 int left;
Peter Hurleyb8483052013-06-15 07:28:30 -0400166
Jaeden Amero090abf72012-07-27 08:43:11 -0500167 if (I_PARMRK(tty)) {
168 /* Multiply read_cnt by 3, since each byte might take up to
169 * three times as many spaces when PARMRK is set (depending on
170 * its flags, e.g. parity error). */
Peter Hurleyce741172013-06-15 09:14:20 -0400171 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500172 } else
Peter Hurleyce741172013-06-15 09:14:20 -0400173 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500174
Linus Torvalds55db4c62011-06-04 06:33:24 +0900175 /*
176 * If we are doing input canonicalization, and there are no
177 * pending newlines, let characters through without limit, so
178 * that erase characters will be handled. Other excess
179 * characters will be beeped.
180 */
181 if (left <= 0)
Peter Hurleya73d3d62013-06-15 09:14:25 -0400182 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
Linus Torvalds55db4c62011-06-04 06:33:24 +0900183
Peter Hurley24a89d12013-06-15 09:14:15 -0400184 return left;
Peter Hurley7879a9f2013-06-15 07:28:31 -0400185}
186
Peter Hurley24a89d12013-06-15 09:14:15 -0400187/**
188 * n_tty_set_room - receive space
189 * @tty: terminal
190 *
191 * Re-schedules the flip buffer work if space just became available.
192 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400193 * Caller holds exclusive termios_rwsem
194 * or
195 * n_tty_read()/consumer path:
196 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400197 */
198
Peter Hurley7879a9f2013-06-15 07:28:31 -0400199static void n_tty_set_room(struct tty_struct *tty)
200{
Peter Hurley24a89d12013-06-15 09:14:15 -0400201 struct n_tty_data *ldata = tty->disc_data;
202
Linus Torvalds55db4c62011-06-04 06:33:24 +0900203 /* Did this open up the receive buffer? We may need to flip */
Peter Hurley24a89d12013-06-15 09:14:15 -0400204 if (unlikely(ldata->no_room) && receive_room(tty)) {
205 ldata->no_room = 0;
206
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200207 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400208 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400209 /* see if ldisc has been killed - if so, this means that
210 * even though the ldisc has been halted and ->buf.work
211 * cancelled, ->buf.work is about to be rescheduled
212 */
213 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
214 "scheduling buffer work for halted ldisc\n");
Peter Hurleyf0f947c2013-06-15 09:14:36 -0400215 queue_work(system_unbound_wq, &tty->port->buf.work);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200216 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900217}
218
Peter Hurley9a4aec22013-06-15 09:14:32 -0400219static ssize_t chars_in_buffer(struct tty_struct *tty)
220{
221 struct n_tty_data *ldata = tty->disc_data;
222 ssize_t n = 0;
223
224 if (!ldata->icanon)
225 n = read_cnt(ldata);
226 else
227 n = ldata->canon_head - ldata->read_tail;
228 return n;
229}
230
Peter Hurleyee0bab82013-06-15 09:14:34 -0400231/**
232 * n_tty_write_wakeup - asynchronous I/O notifier
233 * @tty: tty device
234 *
235 * Required for the ptys, serial driver etc. since processes
236 * that attach themselves to the master and rely on ASYNC
237 * IO must be woken up
238 */
239
240static void n_tty_write_wakeup(struct tty_struct *tty)
241{
242 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
243 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
244}
245
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400246static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400247{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400248 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
249 return;
Peter Hurley6367ca72013-06-15 09:14:33 -0400250 /*
251 * Check the remaining room for the input canonicalization
252 * mode. We don't want to throttle the driver if we're in
253 * canonical mode and don't have a newline yet!
254 */
255 while (1) {
256 int throttled;
257 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
258 if (receive_room(tty) >= TTY_THRESHOLD_THROTTLE)
259 break;
260 throttled = tty_throttle_safe(tty);
261 if (!throttled)
262 break;
263 }
264 __tty_set_flow_change(tty, 0);
265}
266
267static inline void n_tty_check_unthrottle(struct tty_struct *tty)
268{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400269 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
270 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
271 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
272 return;
273 if (!tty->count)
274 return;
275 n_tty_set_room(tty);
276 n_tty_write_wakeup(tty->link);
277 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
278 return;
279 }
280
Peter Hurley6367ca72013-06-15 09:14:33 -0400281 /* If there is enough space in the read buffer now, let the
282 * low-level driver know. We use chars_in_buffer() to
283 * check the buffer, as it now knows about canonical mode.
284 * Otherwise, if the driver is throttled and the line is
285 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
286 * we won't get any more characters.
287 */
288
289 while (1) {
290 int unthrottled;
291 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
292 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
293 break;
294 if (!tty->count)
295 break;
296 n_tty_set_room(tty);
297 unthrottled = tty_unthrottle_safe(tty);
298 if (!unthrottled)
299 break;
300 }
301 __tty_set_flow_change(tty, 0);
302}
303
Alan Cox17b82062008-10-13 10:45:06 +0100304/**
305 * put_tty_queue - add character to tty
306 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200307 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100308 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400309 * Add a character to the tty read_buf queue.
310 *
311 * n_tty_receive_buf()/producer path:
312 * caller holds non-exclusive termios_rwsem
313 * modifies read_head
314 *
315 * read_head is only considered 'published' if canonical mode is
316 * not active.
Alan Cox17b82062008-10-13 10:45:06 +0100317 */
318
Jiri Slaby57c94122012-10-18 22:26:43 +0200319static void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400321 if (read_cnt(ldata) < N_TTY_BUF_SIZE) {
322 *read_buf_addr(ldata, ldata->read_head) = c;
323 ldata->read_head++;
324 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325}
326
327/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 * reset_buffer_flags - reset buffer state
329 * @tty: terminal to reset
330 *
Peter Hurley25518c62013-03-11 16:44:31 -0400331 * Reset the read buffer counters and clear the flags.
332 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100333 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400334 * Locking: caller holds exclusive termios_rwsem
335 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000337
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400338static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400340 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley17bd7902013-06-15 10:04:24 -0400341 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400342 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000343
Peter Hurleya73d3d62013-06-15 09:14:25 -0400344 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200345 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
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;
355 wake_up_interruptible(&tty->link->read_wait);
356 }
357 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
358}
359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/**
361 * n_tty_flush_buffer - clean input queue
362 * @tty: terminal device
363 *
Peter Hurley25518c62013-03-11 16:44:31 -0400364 * Flush the input buffer. Called when the tty layer wants the
365 * buffer flushed (eg at hangup) or when the N_TTY line discipline
366 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400368 * Holds termios_rwsem to exclude producer/consumer while
369 * buffer indices are reset.
370 *
371 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 */
Alan Cox4edf1822008-02-08 04:18:44 -0800373
374static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400376 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400377 reset_buffer_flags(tty->disc_data);
378 n_tty_set_room(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800379
Peter Hurleya30737a2013-03-11 16:44:22 -0400380 if (tty->link)
381 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400382 up_write(&tty->termios_rwsem);
383}
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385/**
386 * n_tty_chars_in_buffer - report available bytes
387 * @tty: tty device
388 *
389 * Report the number of characters buffered to be delivered to user
Alan Cox4edf1822008-02-08 04:18:44 -0800390 * at this instant in time.
Alan Cox17b82062008-10-13 10:45:06 +0100391 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400392 * Locking: exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 */
Alan Cox4edf1822008-02-08 04:18:44 -0800394
Peter Hurleya19d0c62013-06-15 09:14:18 -0400395static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
396{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400397 ssize_t n;
398
Peter Hurley47534082013-06-15 09:14:19 -0400399 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400400
401 down_write(&tty->termios_rwsem);
402 n = chars_in_buffer(tty);
403 up_write(&tty->termios_rwsem);
404 return n;
Peter Hurleya19d0c62013-06-15 09:14:18 -0400405}
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/**
408 * is_utf8_continuation - utf8 multibyte check
409 * @c: byte to check
410 *
411 * Returns true if the utf8 character 'c' is a multibyte continuation
412 * character. We use this to correctly compute the on screen size
413 * of the character when printing
414 */
Alan Cox4edf1822008-02-08 04:18:44 -0800415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416static inline int is_utf8_continuation(unsigned char c)
417{
418 return (c & 0xc0) == 0x80;
419}
420
421/**
422 * is_continuation - multibyte check
423 * @c: byte to check
424 *
425 * Returns true if the utf8 character 'c' is a multibyte continuation
426 * character and the terminal is in unicode mode.
427 */
Alan Cox4edf1822008-02-08 04:18:44 -0800428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429static inline int is_continuation(unsigned char c, struct tty_struct *tty)
430{
431 return I_IUTF8(tty) && is_utf8_continuation(c);
432}
433
434/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000435 * do_output_char - output one character
436 * @c: character (or partial unicode symbol)
437 * @tty: terminal device
438 * @space: space available in tty driver write buffer
439 *
440 * This is a helper function that handles one output character
441 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600442 * doing OPOST processing and putting the results in the
443 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000444 *
445 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
446 * and NLDLY. They simply aren't relevant in the world today.
447 * If you ever need them, add them here.
448 *
449 * Returns the number of bytes of buffer space used or -1 if
450 * no space left.
451 *
452 * Locking: should be called under the output_lock to protect
453 * the column state and space left in the buffer
454 */
455
456static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
457{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200458 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000459 int spaces;
460
461 if (!space)
462 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000463
Joe Petersona88a69c2009-01-02 13:40:53 +0000464 switch (c) {
465 case '\n':
466 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200467 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000468 if (O_ONLCR(tty)) {
469 if (space < 2)
470 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200471 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700472 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000473 return 2;
474 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200475 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000476 break;
477 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200478 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000479 return 0;
480 if (O_OCRNL(tty)) {
481 c = '\n';
482 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200483 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000484 break;
485 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200486 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000487 break;
488 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200489 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000490 if (O_TABDLY(tty) == XTABS) {
491 if (space < spaces)
492 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200493 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000494 tty->ops->write(tty, " ", spaces);
495 return spaces;
496 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200497 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000498 break;
499 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200500 if (ldata->column > 0)
501 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000502 break;
503 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000504 if (!iscntrl(c)) {
505 if (O_OLCUC(tty))
506 c = toupper(c);
507 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200508 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000509 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000510 break;
511 }
512
513 tty_put_char(tty, c);
514 return 1;
515}
516
517/**
518 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 * @c: character (or partial unicode symbol)
520 * @tty: terminal device
521 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600522 * Output one character with OPOST processing.
523 * Returns -1 when the output device is full and the character
524 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000526 * Locking: output_lock to protect column state and space left
527 * (also, this is called from n_tty_write under the
528 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 */
Alan Cox4edf1822008-02-08 04:18:44 -0800530
Joe Petersona88a69c2009-01-02 13:40:53 +0000531static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
Jiri Slabybddc7152012-10-18 22:26:42 +0200533 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000534 int space, retval;
535
Jiri Slabybddc7152012-10-18 22:26:42 +0200536 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Alan Coxf34d7a52008-04-30 00:54:13 -0700538 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000539 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Jiri Slabybddc7152012-10-18 22:26:42 +0200541 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000542 if (retval < 0)
543 return -1;
544 else
545 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
547
548/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000549 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600551 * @buf: character buffer
552 * @nr: number of bytes to output
553 *
554 * Output a block of characters with OPOST processing.
555 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 *
557 * This path is used to speed up block console writes, among other
558 * things when processing blocks of output data. It handles only
559 * the simple cases normally found and helps to generate blocks of
560 * symbols for the console driver and thus improve performance.
561 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000562 * Locking: output_lock to protect column state and space left
563 * (also, this is called from n_tty_write under the
564 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 */
Alan Cox4edf1822008-02-08 04:18:44 -0800566
Joe Petersona88a69c2009-01-02 13:40:53 +0000567static ssize_t process_output_block(struct tty_struct *tty,
568 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200570 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100572 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 const unsigned char *cp;
574
Jiri Slabybddc7152012-10-18 22:26:42 +0200575 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000576
Alan Coxf34d7a52008-04-30 00:54:13 -0700577 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000578 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200579 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000581 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 if (nr > space)
583 nr = space;
584
585 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000586 unsigned char c = *cp;
587
588 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 case '\n':
590 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200591 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (O_ONLCR(tty))
593 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200594 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 break;
596 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200597 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 goto break_out;
599 if (O_OCRNL(tty))
600 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200601 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 break;
603 case '\t':
604 goto break_out;
605 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200606 if (ldata->column > 0)
607 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 break;
609 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000610 if (!iscntrl(c)) {
611 if (O_OLCUC(tty))
612 goto break_out;
613 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200614 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000615 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 break;
617 }
618 }
619break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700620 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000621
Jiri Slabybddc7152012-10-18 22:26:42 +0200622 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 return i;
624}
625
Joe Petersona88a69c2009-01-02 13:40:53 +0000626/**
627 * process_echoes - write pending echo characters
628 * @tty: terminal device
629 *
630 * Write previously buffered echo (and other ldisc-generated)
631 * characters to the tty.
632 *
633 * Characters generated by the ldisc (including echoes) need to
634 * be buffered because the driver's write buffer can fill during
635 * heavy program output. Echoing straight to the driver will
636 * often fail under these conditions, causing lost characters and
637 * resulting mismatches of ldisc state information.
638 *
639 * Since the ldisc state must represent the characters actually sent
640 * to the driver at the time of the write, operations like certain
641 * changes in column state are also saved in the buffer and executed
642 * here.
643 *
644 * A circular fifo buffer is used so that the most recent characters
645 * are prioritized. Also, when control characters are echoed with a
646 * prefixed "^", the pair is treated atomically and thus not separated.
647 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400648 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000649 */
650
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400651static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000652{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200653 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400654 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400655 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000656 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000657
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400658 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000659
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400660 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400661 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400662 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000663 if (c == ECHO_OP_START) {
664 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000665 int no_space_left = 0;
666
667 /*
668 * If the buffer byte is the start of a multi-byte
669 * operation, get the next byte, which is either the
670 * op code or a control character value.
671 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400672 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000673
Joe Petersona88a69c2009-01-02 13:40:53 +0000674 switch (op) {
675 unsigned int num_chars, num_bs;
676
677 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400678 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000679
680 /*
681 * Determine how many columns to go back
682 * in order to erase the tab.
683 * This depends on the number of columns
684 * used by other characters within the tab
685 * area. If this (modulo 8) count is from
686 * the start of input rather than from a
687 * previous tab, we offset by canon column.
688 * Otherwise, tab spacing is normal.
689 */
690 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200691 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000692 num_bs = 8 - (num_chars & 7);
693
694 if (num_bs > space) {
695 no_space_left = 1;
696 break;
697 }
698 space -= num_bs;
699 while (num_bs--) {
700 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200701 if (ldata->column > 0)
702 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000703 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400704 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000705 break;
706
707 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200708 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400709 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000710 break;
711
712 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200713 if (ldata->column > 0)
714 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400715 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000716 break;
717
718 case ECHO_OP_START:
719 /* This is an escaped echo op start code */
720 if (!space) {
721 no_space_left = 1;
722 break;
723 }
724 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200725 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000726 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400727 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000728 break;
729
730 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000731 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600732 * If the op is not a special byte code,
733 * it is a ctrl char tagged to be echoed
734 * as "^X" (where X is the letter
735 * representing the control char).
736 * Note that we must ensure there is
737 * enough space for the whole ctrl pair.
738 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000739 */
Joe Peterson62b26352009-09-09 15:03:47 -0600740 if (space < 2) {
741 no_space_left = 1;
742 break;
743 }
744 tty_put_char(tty, '^');
745 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200746 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600747 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400748 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000749 }
750
751 if (no_space_left)
752 break;
753 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400754 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600755 int retval = do_output_char(c, tty, space);
756 if (retval < 0)
757 break;
758 space -= retval;
759 } else {
760 if (!space)
761 break;
762 tty_put_char(tty, c);
763 space -= 1;
764 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400765 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000766 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000767 }
768
Peter Hurleycbfd0342013-06-15 10:04:26 -0400769 /* If the echo buffer is nearly full (so that the possibility exists
770 * of echo overrun before the next commit), then discard enough
771 * data at the tail to prevent a subsequent overrun */
772 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
773 if (echo_buf(ldata, tail == ECHO_OP_START)) {
774 if (echo_buf(ldata, tail) == ECHO_OP_ERASE_TAB)
775 tail += 3;
776 else
777 tail += 2;
778 } else
779 tail++;
780 }
781
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400782 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400783 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000784}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
Peter Hurley17bd7902013-06-15 10:04:24 -0400786static void commit_echoes(struct tty_struct *tty)
787{
788 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400789 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400790 size_t head;
791
792 head = ldata->echo_head;
793 old = ldata->echo_commit - ldata->echo_tail;
794
795 /* Process committed echoes if the accumulated # of bytes
796 * is over the threshold (and try again each time another
797 * block is accumulated) */
798 nr = head - ldata->echo_tail;
799 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
800 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400801
Peter Hurley019ebdf2013-06-15 10:04:25 -0400802 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400803 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400804 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400805 mutex_unlock(&ldata->output_lock);
806
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400807 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400808 tty->ops->flush_chars(tty);
809}
810
811static void process_echoes(struct tty_struct *tty)
812{
813 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400814 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400815
816 if (!L_ECHO(tty) || ldata->echo_commit == ldata->echo_tail)
817 return;
818
819 mutex_lock(&ldata->output_lock);
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400820 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400821 mutex_unlock(&ldata->output_lock);
822
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400823 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400824 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400825}
826
Peter Hurleycbfd0342013-06-15 10:04:26 -0400827static void flush_echoes(struct tty_struct *tty)
828{
829 struct n_tty_data *ldata = tty->disc_data;
830
831 if (!L_ECHO(tty) || ldata->echo_commit == ldata->echo_head)
832 return;
833
834 mutex_lock(&ldata->output_lock);
835 ldata->echo_commit = ldata->echo_head;
836 __process_echoes(tty);
837 mutex_unlock(&ldata->output_lock);
838}
839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000841 * add_echo_byte - add a byte to the echo buffer
842 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200843 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000844 *
845 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000846 */
847
Peter Hurleycbfd0342013-06-15 10:04:26 -0400848static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000849{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400850 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000851}
852
853/**
854 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200855 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000856 *
857 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000858 */
859
Jiri Slaby57c94122012-10-18 22:26:43 +0200860static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000861{
Jiri Slaby57c94122012-10-18 22:26:43 +0200862 add_echo_byte(ECHO_OP_START, ldata);
863 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000864}
865
866/**
867 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200868 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000869 *
870 * Add an operation to the echo buffer to set the canon column
871 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000872 */
873
Jiri Slaby57c94122012-10-18 22:26:43 +0200874static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000875{
Jiri Slaby57c94122012-10-18 22:26:43 +0200876 add_echo_byte(ECHO_OP_START, ldata);
877 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000878}
879
880/**
881 * echo_erase_tab - add operation to erase a tab
882 * @num_chars: number of character columns already used
883 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200884 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000885 *
886 * Add an operation to the echo buffer to erase a tab.
887 *
888 * Called by the eraser function, which knows how many character
889 * columns have been used since either a previous tab or the start
890 * of input. This information will be used later, along with
891 * canon column (if applicable), to go back the correct number
892 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000893 */
894
895static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200896 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000897{
Jiri Slaby57c94122012-10-18 22:26:43 +0200898 add_echo_byte(ECHO_OP_START, ldata);
899 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000900
901 /* We only need to know this modulo 8 (tab spacing) */
902 num_chars &= 7;
903
904 /* Set the high bit as a flag if num_chars is after a previous tab */
905 if (after_tab)
906 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000907
Jiri Slaby57c94122012-10-18 22:26:43 +0200908 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000909}
910
911/**
912 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 * @c: unicode byte to echo
914 * @tty: terminal device
915 *
Alan Cox4edf1822008-02-08 04:18:44 -0800916 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100918 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000919 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000920 */
921
Jiri Slaby57c94122012-10-18 22:26:43 +0200922static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000923{
Joe Petersona88a69c2009-01-02 13:40:53 +0000924 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200925 add_echo_byte(ECHO_OP_START, ldata);
926 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000927 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200928 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000929 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000930}
931
932/**
933 * echo_char - echo a character
934 * @c: unicode byte to echo
935 * @tty: terminal device
936 *
937 * Echo user input back onto the screen. This must be called only when
938 * L_ECHO(tty) is true. Called from the driver receive_buf path.
939 *
Joe Peterson62b26352009-09-09 15:03:47 -0600940 * This variant tags control characters to be echoed as "^X"
941 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 */
943
944static void echo_char(unsigned char c, struct tty_struct *tty)
945{
Jiri Slabybddc7152012-10-18 22:26:42 +0200946 struct n_tty_data *ldata = tty->disc_data;
947
Joe Petersona88a69c2009-01-02 13:40:53 +0000948 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200949 add_echo_byte(ECHO_OP_START, ldata);
950 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000951 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600952 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200953 add_echo_byte(ECHO_OP_START, ldata);
954 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000955 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956}
957
Alan Cox17b82062008-10-13 10:45:06 +0100958/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000959 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200960 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100961 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000962
Jiri Slaby57c94122012-10-18 22:26:43 +0200963static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200965 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200966 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200967 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 }
969}
970
971/**
972 * eraser - handle erase function
973 * @c: character input
974 * @tty: terminal device
975 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200976 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 * present in the stream from the driver layer. Handles the complexities
978 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100979 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400980 * n_tty_receive_buf()/producer path:
981 * caller holds non-exclusive termios_rwsem
982 * modifies read_head
983 *
984 * Modifying the read_head is not considered a publish in this context
985 * because canonical mode is active -- only canon_head publishes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 */
Alan Cox4edf1822008-02-08 04:18:44 -0800987
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988static void eraser(unsigned char c, struct tty_struct *tty)
989{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200990 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400992 size_t head;
993 size_t cnt;
994 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200996 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +0000997 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 return;
999 }
1000 if (c == ERASE_CHAR(tty))
1001 kill_type = ERASE;
1002 else if (c == WERASE_CHAR(tty))
1003 kill_type = WERASE;
1004 else {
1005 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001006 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 return;
1008 }
1009 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001010 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +02001011 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 echo_char(KILL_CHAR(tty), tty);
1013 /* Add a newline if ECHOK is on and ECHOKE is off. */
1014 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001015 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 return;
1017 }
1018 kill_type = KILL;
1019 }
1020
1021 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001022 while (ldata->read_head != ldata->canon_head) {
1023 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024
1025 /* erase a single possibly multibyte character */
1026 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001027 head--;
1028 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001029 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
1031 /* do not partially erase */
1032 if (is_continuation(c, tty))
1033 break;
1034
1035 if (kill_type == WERASE) {
1036 /* Equivalent to BSD's ALTWERASE. */
1037 if (isalnum(c) || c == '_')
1038 seen_alnums++;
1039 else if (seen_alnums)
1040 break;
1041 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001042 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001043 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 if (L_ECHO(tty)) {
1045 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001046 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001047 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001048 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 }
1050 /* if cnt > 1, output a multi-byte character */
1051 echo_char(c, tty);
1052 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001053 head++;
1054 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001055 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
1057 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1058 echo_char(ERASE_CHAR(tty), tty);
1059 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001060 unsigned int num_chars = 0;
1061 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001062 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Joe Petersona88a69c2009-01-02 13:40:53 +00001064 /*
1065 * Count the columns used for characters
1066 * since the start of input or after a
1067 * previous tab.
1068 * This info is used to go back the correct
1069 * number of columns.
1070 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001071 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001072 tail--;
1073 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001074 if (c == '\t') {
1075 after_tab = 1;
1076 break;
Alan Cox300a6202009-01-02 13:41:04 +00001077 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001079 num_chars += 2;
1080 } else if (!is_continuation(c, tty)) {
1081 num_chars++;
1082 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001084 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 } else {
1086 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001087 echo_char_raw('\b', ldata);
1088 echo_char_raw(' ', ldata);
1089 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 }
1091 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001092 echo_char_raw('\b', ldata);
1093 echo_char_raw(' ', ldata);
1094 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 }
1096 }
1097 }
1098 if (kill_type == ERASE)
1099 break;
1100 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001101 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001102 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103}
1104
1105/**
1106 * isig - handle the ISIG optio
1107 * @sig: signal
1108 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001110 * Called when a signal is being sent due to terminal input.
1111 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001112 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001113 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 */
Alan Cox4edf1822008-02-08 04:18:44 -08001115
Peter Hurley8c985d12013-03-06 08:38:19 -05001116static inline void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117{
Peter Hurley8c985d12013-03-06 08:38:19 -05001118 struct pid *tty_pgrp = tty_get_pgrp(tty);
1119 if (tty_pgrp) {
1120 kill_pgrp(tty_pgrp, sig, 1);
1121 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 }
1123}
1124
1125/**
1126 * n_tty_receive_break - handle break
1127 * @tty: terminal
1128 *
1129 * An RS232 break event has been hit in the incoming bitstream. This
1130 * can cause a variety of events depending upon the termios settings.
1131 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001132 * n_tty_receive_buf()/producer path:
1133 * caller holds non-exclusive termios_rwsem
1134 * publishes read_head via put_tty_queue()
1135 *
1136 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 */
Alan Cox4edf1822008-02-08 04:18:44 -08001138
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139static inline void n_tty_receive_break(struct tty_struct *tty)
1140{
Jiri Slaby57c94122012-10-18 22:26:43 +02001141 struct n_tty_data *ldata = tty->disc_data;
1142
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 if (I_IGNBRK(tty))
1144 return;
1145 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001146 isig(SIGINT, tty);
1147 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001148 /* flushing needs exclusive termios_rwsem */
1149 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001150 n_tty_flush_buffer(tty);
1151 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001152 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 return;
1155 }
1156 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001157 put_tty_queue('\377', ldata);
1158 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001160 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 wake_up_interruptible(&tty->read_wait);
1162}
1163
1164/**
1165 * n_tty_receive_overrun - handle overrun reporting
1166 * @tty: terminal
1167 *
1168 * Data arrived faster than we could process it. While the tty
1169 * driver has flagged this the bits that were missed are gone
1170 * forever.
1171 *
1172 * Called from the receive_buf path so single threaded. Does not
1173 * need locking as num_overrun and overrun_time are function
1174 * private.
1175 */
Alan Cox4edf1822008-02-08 04:18:44 -08001176
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177static inline void n_tty_receive_overrun(struct tty_struct *tty)
1178{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001179 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 char buf[64];
1181
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001182 ldata->num_overrun++;
1183 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1184 time_after(ldata->overrun_time, jiffies)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1186 tty_name(tty, buf),
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001187 ldata->num_overrun);
1188 ldata->overrun_time = jiffies;
1189 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 }
1191}
1192
1193/**
1194 * n_tty_receive_parity_error - error notifier
1195 * @tty: terminal device
1196 * @c: character
1197 *
1198 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001199 * the error case if necessary.
1200 *
1201 * n_tty_receive_buf()/producer path:
1202 * caller holds non-exclusive termios_rwsem
1203 * publishes read_head via put_tty_queue()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 */
1205static inline void n_tty_receive_parity_error(struct tty_struct *tty,
1206 unsigned char c)
1207{
Jiri Slaby57c94122012-10-18 22:26:43 +02001208 struct n_tty_data *ldata = tty->disc_data;
1209
Alan Cox4edf1822008-02-08 04:18:44 -08001210 if (I_IGNPAR(tty))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001213 put_tty_queue('\377', ldata);
1214 put_tty_queue('\0', ldata);
1215 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 } else if (I_INPCK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001217 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 else
Jiri Slaby57c94122012-10-18 22:26:43 +02001219 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 wake_up_interruptible(&tty->read_wait);
1221}
1222
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001223static void
1224n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1225{
1226 if (!L_NOFLSH(tty)) {
1227 /* flushing needs exclusive termios_rwsem */
1228 up_read(&tty->termios_rwsem);
1229 n_tty_flush_buffer(tty);
1230 tty_driver_flush_buffer(tty);
1231 down_read(&tty->termios_rwsem);
1232 }
1233 if (I_IXON(tty))
1234 start_tty(tty);
1235 if (L_ECHO(tty)) {
1236 echo_char(c, tty);
1237 commit_echoes(tty);
1238 }
1239 isig(signal, tty);
1240 return;
1241}
1242
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243/**
1244 * n_tty_receive_char - perform processing
1245 * @tty: terminal device
1246 * @c: character
1247 *
1248 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001249 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001251 *
1252 * n_tty_receive_buf()/producer path:
1253 * caller holds non-exclusive termios_rwsem
1254 * publishes canon_head if canonical mode is active
1255 * otherwise, publishes read_head via put_tty_queue()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 */
1257
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001258static void
1259n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001261 struct n_tty_data *ldata = tty->disc_data;
Joe Petersonacc71bb2009-01-02 13:43:32 +00001262 int parmrk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 if (I_IXON(tty)) {
1265 if (c == START_CHAR(tty)) {
1266 start_tty(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001267 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 return;
1269 }
1270 if (c == STOP_CHAR(tty)) {
1271 stop_tty(tty);
1272 return;
1273 }
1274 }
Joe Peterson575537b32008-04-30 00:53:30 -07001275
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001277 if (c == INTR_CHAR(tty)) {
1278 n_tty_receive_signal_char(tty, SIGINT, c);
1279 return;
1280 } else if (c == QUIT_CHAR(tty)) {
1281 n_tty_receive_signal_char(tty, SIGQUIT, c);
1282 return;
1283 } else if (c == SUSP_CHAR(tty)) {
1284 n_tty_receive_signal_char(tty, SIGTSTP, c);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 return;
1286 }
1287 }
Joe Peterson575537b32008-04-30 00:53:30 -07001288
Peter Hurley855df3c2013-07-24 08:29:50 -04001289 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1290 start_tty(tty);
1291 process_echoes(tty);
1292 }
1293
Joe Peterson575537b32008-04-30 00:53:30 -07001294 if (c == '\r') {
1295 if (I_IGNCR(tty))
1296 return;
1297 if (I_ICRNL(tty))
1298 c = '\n';
1299 } else if (c == '\n' && I_INLCR(tty))
1300 c = '\r';
1301
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001302 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1304 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1305 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001306 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 return;
1308 }
1309 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001310 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001312 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001314 echo_char_raw('^', ldata);
1315 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001316 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 }
1318 }
1319 return;
1320 }
1321 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) &&
1322 L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001323 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
Jiri Slaby57c94122012-10-18 22:26:43 +02001325 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001327 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001328 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001329 echo_char(read_buf(ldata, tail), tty);
1330 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001332 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 return;
1334 }
1335 if (c == '\n') {
Peter Hurleyce741172013-06-15 09:14:20 -04001336 if (read_cnt(ldata) >= N_TTY_BUF_SIZE) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +00001337 if (L_ECHO(tty))
1338 process_output('\a', tty);
Joe Petersonacc71bb2009-01-02 13:43:32 +00001339 return;
1340 }
1341 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001342 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001343 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 }
1345 goto handle_newline;
1346 }
1347 if (c == EOF_CHAR(tty)) {
Peter Hurleyce741172013-06-15 09:14:20 -04001348 if (read_cnt(ldata) >= N_TTY_BUF_SIZE)
Joe Petersonacc71bb2009-01-02 13:43:32 +00001349 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 c = __DISABLED_CHAR;
1351 goto handle_newline;
1352 }
1353 if ((c == EOL_CHAR(tty)) ||
1354 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001355 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty))
1356 ? 1 : 0;
Peter Hurleyce741172013-06-15 09:14:20 -04001357 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - parmrk)) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +00001358 if (L_ECHO(tty))
1359 process_output('\a', tty);
Joe Petersonacc71bb2009-01-02 13:43:32 +00001360 return;
1361 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 /*
1363 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1364 */
1365 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001367 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001368 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001370 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 }
1372 /*
1373 * XXX does PARMRK doubling happen for
1374 * EOL_CHAR and EOL2_CHAR?
1375 */
Joe Petersonacc71bb2009-01-02 13:43:32 +00001376 if (parmrk)
Jiri Slaby57c94122012-10-18 22:26:43 +02001377 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Alan Cox4edf1822008-02-08 04:18:44 -08001379handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001380 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001381 put_tty_queue(c, ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001382 ldata->canon_head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1384 if (waitqueue_active(&tty->read_wait))
1385 wake_up_interruptible(&tty->read_wait);
1386 return;
1387 }
1388 }
Alan Cox4edf1822008-02-08 04:18:44 -08001389
Joe Petersonacc71bb2009-01-02 13:43:32 +00001390 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
Peter Hurleyce741172013-06-15 09:14:20 -04001391 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - parmrk - 1)) {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001392 /* beep if no space */
Joe Peterson7e94b1d2009-01-02 13:43:40 +00001393 if (L_ECHO(tty))
1394 process_output('\a', tty);
Joe Petersonacc71bb2009-01-02 13:43:32 +00001395 return;
1396 }
1397 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001398 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001400 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 else {
1402 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001403 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001404 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 echo_char(c, tty);
1406 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001407 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 }
1409
Joe Petersonacc71bb2009-01-02 13:43:32 +00001410 if (parmrk)
Jiri Slaby57c94122012-10-18 22:26:43 +02001411 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Jiri Slaby57c94122012-10-18 22:26:43 +02001413 put_tty_queue(c, ldata);
Alan Cox4edf1822008-02-08 04:18:44 -08001414}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001416static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1417{
1418 struct n_tty_data *ldata = tty->disc_data;
1419 int parmrk;
1420
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001421 /*
1422 * If the previous character was LNEXT, or we know that this
1423 * character is not one of the characters that we'll have to
1424 * handle specially, do shortcut processing to speed things
1425 * up.
1426 */
1427 if (!test_bit(c, ldata->char_map) || ldata->lnext) {
1428 ldata->lnext = 0;
1429
1430 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) &&
1431 I_IXANY(tty)) {
1432 start_tty(tty);
1433 process_echoes(tty);
1434 }
1435
1436 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1437 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - parmrk - 1)) {
1438 /* beep if no space */
1439 if (L_ECHO(tty))
1440 process_output('\a', tty);
1441 return;
1442 }
1443 if (L_ECHO(tty)) {
1444 finish_erasing(ldata);
1445 /* Record the column of first canon char. */
1446 if (ldata->canon_head == ldata->read_head)
1447 echo_set_canon_col(ldata);
1448 echo_char(c, tty);
1449 commit_echoes(tty);
1450 }
1451 if (parmrk)
1452 put_tty_queue(c, ldata);
1453 put_tty_queue(c, ldata);
1454 return;
1455 }
1456
1457 n_tty_receive_char_special(tty, c);
1458}
1459
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001460static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001461n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1462{
1463 struct n_tty_data *ldata = tty->disc_data;
1464
1465 /*
1466 * If the previous character was LNEXT, or we know that this
1467 * character is not one of the characters that we'll have to
1468 * handle specially, do shortcut processing to speed things
1469 * up.
1470 */
1471 if (!test_bit(c, ldata->char_map) || ldata->lnext) {
1472 ldata->lnext = 0;
1473
1474 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) &&
1475 I_IXANY(tty)) {
1476 start_tty(tty);
1477 process_echoes(tty);
1478 }
1479
1480 if (read_cnt(ldata) >= (N_TTY_BUF_SIZE - 1)) {
1481 /* beep if no space */
1482 if (L_ECHO(tty))
1483 process_output('\a', tty);
1484 return;
1485 }
1486 if (L_ECHO(tty)) {
1487 finish_erasing(ldata);
1488 /* Record the column of first canon char. */
1489 if (ldata->canon_head == ldata->read_head)
1490 echo_set_canon_col(ldata);
1491 echo_char(c, tty);
1492 commit_echoes(tty);
1493 }
1494 put_tty_queue(c, ldata);
1495 return;
1496 }
1497
1498 n_tty_receive_char_special(tty, c);
1499}
1500
1501static inline void
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001502n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
1503{
1504 if (I_ISTRIP(tty))
1505 c &= 0x7f;
1506 if (I_IUCLC(tty) && L_IEXTEN(tty))
1507 c = tolower(c);
1508
1509 if (I_IXON(tty)) {
1510 if (c == STOP_CHAR(tty))
1511 stop_tty(tty);
1512 else if (c == START_CHAR(tty) ||
1513 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1514 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1515 c != SUSP_CHAR(tty))) {
1516 start_tty(tty);
1517 process_echoes(tty);
1518 }
1519 }
1520}
1521
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001522static void
1523n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1524{
1525 char buf[64];
1526
1527 switch (flag) {
1528 case TTY_BREAK:
1529 n_tty_receive_break(tty);
1530 break;
1531 case TTY_PARITY:
1532 case TTY_FRAME:
1533 n_tty_receive_parity_error(tty, c);
1534 break;
1535 case TTY_OVERRUN:
1536 n_tty_receive_overrun(tty);
1537 break;
1538 default:
1539 printk(KERN_ERR "%s: unknown flag %d\n",
1540 tty_name(tty, buf), flag);
1541 break;
1542 }
1543}
1544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545/**
1546 * n_tty_receive_buf - data receive
1547 * @tty: terminal device
1548 * @cp: buffer
1549 * @fp: flag buffer
1550 * @count: characters
1551 *
1552 * Called by the terminal driver when a block of characters has
1553 * been received. This function must be called from soft contexts
1554 * not from interrupt context. The driver is responsible for making
1555 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001556 *
1557 * n_tty_receive_buf()/producer path:
1558 * claims non-exclusive termios_rwsem
1559 * publishes read_head and canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 */
Alan Cox4edf1822008-02-08 04:18:44 -08001561
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001562static void
1563n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1564 char *fp, int count)
1565{
1566 struct n_tty_data *ldata = tty->disc_data;
1567 size_t n, head;
1568
1569 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1570 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1571 n = min_t(size_t, count, n);
1572 memcpy(read_buf_addr(ldata, head), cp, n);
1573 ldata->read_head += n;
1574 cp += n;
1575 count -= n;
1576
1577 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1578 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1579 n = min_t(size_t, count, n);
1580 memcpy(read_buf_addr(ldata, head), cp, n);
1581 ldata->read_head += n;
1582}
1583
Peter Hurley554117bd2013-06-15 10:21:25 -04001584static void
1585n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1586 char *fp, int count)
1587{
1588 struct n_tty_data *ldata = tty->disc_data;
1589 char flag = TTY_NORMAL;
1590
1591 while (count--) {
1592 if (fp)
1593 flag = *fp++;
1594 if (likely(flag == TTY_NORMAL))
1595 put_tty_queue(*cp++, ldata);
1596 else
1597 n_tty_receive_char_flagged(tty, *cp++, flag);
1598 }
1599}
1600
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001601static void
1602n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1603 char *fp, int count)
1604{
1605 char flag = TTY_NORMAL;
1606
1607 while (count--) {
1608 if (fp)
1609 flag = *fp++;
1610 if (likely(flag == TTY_NORMAL))
1611 n_tty_receive_char_closing(tty, *cp++);
1612 else
1613 n_tty_receive_char_flagged(tty, *cp++, flag);
1614 }
1615}
1616
Peter Hurley7d88d632013-07-24 08:29:49 -04001617static void
1618n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001619 char *fp, int count)
1620{
1621 struct n_tty_data *ldata = tty->disc_data;
1622 char flag = TTY_NORMAL;
1623
1624 while (count--) {
1625 if (fp)
1626 flag = *fp++;
1627 if (likely(flag == TTY_NORMAL)) {
1628 unsigned char c = *cp++;
1629
1630 if (I_ISTRIP(tty))
1631 c &= 0x7f;
1632 if (I_IUCLC(tty) && L_IEXTEN(tty))
1633 c = tolower(c);
1634 if (L_EXTPROC(tty)) {
1635 put_tty_queue(c, ldata);
1636 continue;
1637 }
1638 n_tty_receive_char(tty, c);
1639 } else
1640 n_tty_receive_char_flagged(tty, *cp++, flag);
1641 }
1642}
1643
1644static void
1645n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1646 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001647{
1648 char flag = TTY_NORMAL;
1649
1650 while (count--) {
1651 if (fp)
1652 flag = *fp++;
1653 if (likely(flag == TTY_NORMAL))
Peter Hurley7de971b2013-07-24 08:29:53 -04001654 n_tty_receive_char_fast(tty, *cp++);
Peter Hurley7d88d632013-07-24 08:29:49 -04001655 else
1656 n_tty_receive_char_flagged(tty, *cp++, flag);
1657 }
1658}
1659
Peter Hurley24a89d12013-06-15 09:14:15 -04001660static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1661 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001663 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001664 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001666 if (ldata->real_raw)
1667 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001668 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117bd2013-06-15 10:21:25 -04001669 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001670 else if (tty->closing && !L_EXTPROC(tty))
1671 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001672 else {
Peter Hurley7de971b2013-07-24 08:29:53 -04001673 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001674 n_tty_receive_buf_fast(tty, cp, fp, count);
1675 else
1676 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001677
1678 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001679 if (tty->ops->flush_chars)
1680 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 }
1682
Peter Hurleyce741172013-06-15 09:14:20 -04001683 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
hyc@symas.com26df6d12010-06-22 10:14:49 -07001684 L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1686 if (waitqueue_active(&tty->read_wait))
1687 wake_up_interruptible(&tty->read_wait);
1688 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689}
1690
Peter Hurley24a89d12013-06-15 09:14:15 -04001691static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1692 char *fp, int count)
1693{
Peter Hurley9356b532013-06-15 09:14:24 -04001694 down_read(&tty->termios_rwsem);
Peter Hurley24a89d12013-06-15 09:14:15 -04001695 __receive_buf(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001696 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001697 up_read(&tty->termios_rwsem);
Peter Hurley24a89d12013-06-15 09:14:15 -04001698}
1699
1700static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1701 char *fp, int count)
1702{
1703 struct n_tty_data *ldata = tty->disc_data;
1704 int room;
1705
Peter Hurley9356b532013-06-15 09:14:24 -04001706 down_read(&tty->termios_rwsem);
1707
Peter Hurley24a89d12013-06-15 09:14:15 -04001708 tty->receive_room = room = receive_room(tty);
1709 if (!room)
1710 ldata->no_room = 1;
1711 count = min(count, room);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001712 if (count) {
Peter Hurley24a89d12013-06-15 09:14:15 -04001713 __receive_buf(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001714 n_tty_check_throttle(tty);
1715 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001716
Peter Hurley9356b532013-06-15 09:14:24 -04001717 up_read(&tty->termios_rwsem);
1718
Peter Hurley24a89d12013-06-15 09:14:15 -04001719 return count;
1720}
1721
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722int is_ignored(int sig)
1723{
1724 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001725 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726}
1727
1728/**
1729 * n_tty_set_termios - termios data changed
1730 * @tty: terminal
1731 * @old: previous data
1732 *
1733 * Called by the tty layer when the user changes termios flags so
1734 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001735 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 * guaranteed that this function will not be re-entered or in progress
1737 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001738 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001739 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 */
Alan Cox4edf1822008-02-08 04:18:44 -08001741
1742static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001744 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001745 int canon_change = 1;
Alan Cox47afa7a2008-10-13 10:44:17 +01001746
1747 if (old)
Alan Coxadc8d742012-07-14 15:31:47 +01001748 canon_change = (old->c_lflag ^ tty->termios.c_lflag) & ICANON;
Alan Cox47afa7a2008-10-13 10:44:17 +01001749 if (canon_change) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001750 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley40d5e092013-06-15 10:21:17 -04001751 ldata->line_start = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001752 ldata->canon_head = ldata->read_tail;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001753 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001754 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001755 }
1756
Peter Hurleyce741172013-06-15 09:14:20 -04001757 if (canon_change && !L_ICANON(tty) && read_cnt(ldata))
Alan Cox47afa7a2008-10-13 10:44:17 +01001758 wake_up_interruptible(&tty->read_wait);
Alan Cox4edf1822008-02-08 04:18:44 -08001759
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001760 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001761
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1763 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1764 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1765 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001766 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
1768 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001769 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001771 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
1773 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001774 set_bit(ERASE_CHAR(tty), ldata->char_map);
1775 set_bit(KILL_CHAR(tty), ldata->char_map);
1776 set_bit(EOF_CHAR(tty), ldata->char_map);
1777 set_bit('\n', ldata->char_map);
1778 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001780 set_bit(WERASE_CHAR(tty), ldata->char_map);
1781 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1782 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 if (L_ECHO(tty))
1784 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001785 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 }
1787 }
1788 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001789 set_bit(START_CHAR(tty), ldata->char_map);
1790 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 }
1792 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001793 set_bit(INTR_CHAR(tty), ldata->char_map);
1794 set_bit(QUIT_CHAR(tty), ldata->char_map);
1795 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001797 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001798 ldata->raw = 0;
1799 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001801 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1803 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1804 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001805 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001807 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 }
Linus Torvalds55db4c62011-06-04 06:33:24 +09001809 n_tty_set_room(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001810 /*
1811 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1812 * been stopped by STOP_CHAR(tty) before it.
1813 */
1814 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
1815 start_tty(tty);
1816 }
1817
Alan Coxf34d7a52008-04-30 00:54:13 -07001818 /* The termios change make the tty ready for I/O */
1819 wake_up_interruptible(&tty->write_wait);
1820 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821}
1822
1823/**
1824 * n_tty_close - close the ldisc for this tty
1825 * @tty: device
1826 *
Alan Cox4edf1822008-02-08 04:18:44 -08001827 * Called from the terminal layer when this line discipline is
1828 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 * discipline change. The function will not be called while other
1830 * ldisc methods are in progress.
1831 */
Alan Cox4edf1822008-02-08 04:18:44 -08001832
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833static void n_tty_close(struct tty_struct *tty)
1834{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001835 struct n_tty_data *ldata = tty->disc_data;
1836
Peter Hurley79901312013-03-11 16:44:23 -04001837 if (tty->link)
1838 n_tty_packet_mode_flush(tty);
1839
Peter Hurley20bafb32013-06-15 10:21:19 -04001840 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001841 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842}
1843
1844/**
1845 * n_tty_open - open an ldisc
1846 * @tty: terminal to open
1847 *
Alan Cox4edf1822008-02-08 04:18:44 -08001848 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 * terminal device. Can sleep. Called serialized so that no
1850 * other events will occur in parallel. No further open will occur
1851 * until a close.
1852 */
1853
1854static int n_tty_open(struct tty_struct *tty)
1855{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001856 struct n_tty_data *ldata;
1857
Peter Hurley20bafb32013-06-15 10:21:19 -04001858 /* Currently a malloc failure here can panic */
1859 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001860 if (!ldata)
1861 goto err;
1862
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001863 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001864 mutex_init(&ldata->atomic_read_lock);
1865 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001866
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001867 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001868 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001869 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001870 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001871 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001872 ldata->num_overrun = 0;
1873 ldata->no_room = 0;
1874 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001876 /* indicate buffer work may resume */
1877 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1878 n_tty_set_termios(tty, NULL);
1879 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001880
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001882err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001883 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884}
1885
1886static inline int input_available_p(struct tty_struct *tty, int amt)
1887{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001888 struct n_tty_data *ldata = tty->disc_data;
1889
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001890 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurleya73d3d62013-06-15 09:14:25 -04001891 if (ldata->canon_head != ldata->read_tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 return 1;
Peter Hurleyce741172013-06-15 09:14:20 -04001893 } else if (read_cnt(ldata) >= (amt ? amt : 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 return 1;
1895
1896 return 0;
1897}
1898
1899/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001900 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 * @tty: terminal device
1902 * @b: user data
1903 * @nr: size of data
1904 *
Alan Cox11a96d12008-10-13 10:46:24 +01001905 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 * ICANON is off; it copies characters straight from the tty queue to
1907 * user space directly. It can be profitably called twice; once to
1908 * drain the space from the tail pointer to the (physical) end of the
1909 * buffer, and once to drain the space from the (physical) beginning of
1910 * the buffer to head pointer.
1911 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001912 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001914 * n_tty_read()/consumer path:
1915 * caller holds non-exclusive termios_rwsem
1916 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 */
Alan Cox4edf1822008-02-08 04:18:44 -08001918
Alan Cox33f0f882006-01-09 20:54:13 -08001919static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 unsigned char __user **b,
1921 size_t *nr)
1922
1923{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001924 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 int retval;
1926 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001927 bool is_eof;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001928 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
1930 retval = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001931 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001934 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001936 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1937 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001938 ldata->icanon);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001939 ldata->read_tail += n;
hyc@symas.com26df6d12010-06-22 10:14:49 -07001940 /* Turn single EOF into zero-length read */
Peter Hurleyce741172013-06-15 09:14:20 -04001941 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001942 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 *b += n;
1944 *nr -= n;
1945 }
1946 return retval;
1947}
1948
Peter Hurley88bb0de2013-06-15 09:14:16 -04001949/**
Peter Hurley32f13522013-06-15 09:14:17 -04001950 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001951 * @tty: terminal device
1952 * @b: user data
1953 * @nr: size of data
1954 *
1955 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001956 * it copies one line of input up to and including the line-delimiting
1957 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001958 *
1959 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001960 *
1961 * n_tty_read()/consumer path:
1962 * caller holds non-exclusive termios_rwsem
1963 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001964 */
1965
Peter Hurley32f13522013-06-15 09:14:17 -04001966static int canon_copy_from_read_buf(struct tty_struct *tty,
1967 unsigned char __user **b,
1968 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001969{
1970 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001971 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001972 size_t eol;
1973 size_t tail;
1974 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001975 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001976
1977 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyce741172013-06-15 09:14:20 -04001978 n = min(*nr, read_cnt(ldata));
Peter Hurley6d76bd22013-06-15 09:14:26 -04001979 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04001980 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001981
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001982 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04001983 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1984
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001985 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04001986 __func__, *nr, tail, n, size);
1987
1988 eol = find_next_bit(ldata->read_flags, size, tail);
1989 more = n - (size - tail);
1990 if (eol == N_TTY_BUF_SIZE && more) {
1991 /* scan wrapped without finding set bit */
1992 eol = find_next_bit(ldata->read_flags, more, 0);
1993 if (eol != more)
1994 found = 1;
1995 } else if (eol != size)
1996 found = 1;
1997
1998 size = N_TTY_BUF_SIZE - tail;
1999 n = (found + eol + size) & (N_TTY_BUF_SIZE - 1);
2000 c = n;
2001
Peter Hurley40d5e092013-06-15 10:21:17 -04002002 if (found && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002003 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002004 eof_push = !n && ldata->read_tail != ldata->line_start;
2005 }
Peter Hurley32f13522013-06-15 09:14:17 -04002006
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002007 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002008 __func__, eol, found, n, c, size, more);
2009
Peter Hurley32f13522013-06-15 09:14:17 -04002010 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002011 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002012 if (ret)
2013 return -EFAULT;
2014 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2015 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002016 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002017
2018 if (ret)
2019 return -EFAULT;
2020 *b += n;
2021 *nr -= n;
2022
Peter Hurleya73d3d62013-06-15 09:14:25 -04002023 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002024 clear_bit(eol, ldata->read_flags);
2025 smp_mb__after_clear_bit();
2026 ldata->read_tail += c;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002027
Peter Hurley40d5e092013-06-15 10:21:17 -04002028 if (found) {
2029 ldata->line_start = ldata->read_tail;
Peter Hurley32f13522013-06-15 09:14:17 -04002030 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002031 }
2032 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002033}
2034
Al Virocc4191d2008-03-29 03:08:48 +00002035extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002036 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
2038/**
2039 * job_control - check job control
2040 * @tty: tty
2041 * @file: file handle
2042 *
2043 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002044 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002046 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002047 * Locking: redirected write test is safe
2048 * current->signal->tty check is safe
2049 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 */
Alan Cox4edf1822008-02-08 04:18:44 -08002051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052static int job_control(struct tty_struct *tty, struct file *file)
2053{
2054 /* Job control check -- must be done at start and after
2055 every sleep (POSIX.1 7.1.1.4). */
2056 /* NOTE: not yet done after every sleep pending a thorough
2057 check of the logic of this change. -- jlc */
2058 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002059 if (file->f_op->write == redirected_tty_write ||
2060 current->signal->tty != tty)
2061 return 0;
2062
2063 spin_lock_irq(&tty->ctrl_lock);
2064 if (!tty->pgrp)
2065 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2066 else if (task_pgrp(current) != tty->pgrp) {
2067 spin_unlock_irq(&tty->ctrl_lock);
2068 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2069 return -EIO;
2070 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2071 set_thread_flag(TIF_SIGPENDING);
2072 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002074 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 return 0;
2076}
Alan Cox4edf1822008-02-08 04:18:44 -08002077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078
2079/**
Alan Cox11a96d12008-10-13 10:46:24 +01002080 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 * @tty: tty device
2082 * @file: file object
2083 * @buf: userspace buffer pointer
2084 * @nr: size of I/O
2085 *
2086 * Perform reads for the line discipline. We are guaranteed that the
2087 * line discipline will not be closed under us but we may get multiple
2088 * parallel readers and must handle this ourselves. We may also get
2089 * a hangup. Always called in user context, may sleep.
2090 *
2091 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002092 *
2093 * n_tty_read()/consumer path:
2094 * claims non-exclusive termios_rwsem
2095 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 */
Alan Cox4edf1822008-02-08 04:18:44 -08002097
Alan Cox11a96d12008-10-13 10:46:24 +01002098static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 unsigned char __user *buf, size_t nr)
2100{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002101 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 unsigned char __user *b = buf;
2103 DECLARE_WAITQUEUE(wait, current);
2104 int c;
2105 int minimum, time;
2106 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 long timeout;
2108 unsigned long flags;
Alan Cox04f378b2008-04-30 00:53:29 -07002109 int packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002112 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002114
Peter Hurley9356b532013-06-15 09:14:24 -04002115 down_read(&tty->termios_rwsem);
2116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 minimum = time = 0;
2118 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002119 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 minimum = MIN_CHAR(tty);
2121 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002122 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002124 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002126 (ldata->minimum_to_wake > minimum))
2127 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002129 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002130 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 }
2132 }
2133
2134 /*
2135 * Internal serialization of reads.
2136 */
2137 if (file->f_flags & O_NONBLOCK) {
Peter Hurley9356b532013-06-15 09:14:24 -04002138 if (!mutex_trylock(&ldata->atomic_read_lock)) {
2139 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 return -EAGAIN;
Peter Hurley9356b532013-06-15 09:14:24 -04002141 }
Alan Cox4edf1822008-02-08 04:18:44 -08002142 } else {
Peter Hurley9356b532013-06-15 09:14:24 -04002143 if (mutex_lock_interruptible(&ldata->atomic_read_lock)) {
2144 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 return -ERESTARTSYS;
Peter Hurley9356b532013-06-15 09:14:24 -04002146 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 }
Alan Cox04f378b2008-04-30 00:53:29 -07002148 packet = tty->packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149
2150 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 while (nr) {
2152 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002153 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 unsigned char cs;
2155 if (b != buf)
2156 break;
Alan Cox04f378b2008-04-30 00:53:29 -07002157 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 cs = tty->link->ctrl_status;
2159 tty->link->ctrl_status = 0;
Alan Cox04f378b2008-04-30 00:53:29 -07002160 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002161 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 retval = -EFAULT;
2163 b--;
2164 break;
2165 }
2166 nr--;
2167 break;
2168 }
2169 /* This statement must be first before checking for input
2170 so that any interrupt will set the state back to
2171 TASK_RUNNING. */
2172 set_current_state(TASK_INTERRUPTIBLE);
Alan Cox4edf1822008-02-08 04:18:44 -08002173
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002174 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002176 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002177
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 if (!input_available_p(tty, 0)) {
2179 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
2180 retval = -EIO;
2181 break;
2182 }
2183 if (tty_hung_up_p(file))
2184 break;
2185 if (!timeout)
2186 break;
2187 if (file->f_flags & O_NONBLOCK) {
2188 retval = -EAGAIN;
2189 break;
2190 }
2191 if (signal_pending(current)) {
2192 retval = -ERESTARTSYS;
2193 break;
2194 }
Linus Torvalds55db4c62011-06-04 06:33:24 +09002195 n_tty_set_room(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04002196 up_read(&tty->termios_rwsem);
2197
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 timeout = schedule_timeout(timeout);
Peter Hurley9356b532013-06-15 09:14:24 -04002199
2200 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 continue;
2202 }
2203 __set_current_state(TASK_RUNNING);
2204
2205 /* Deal with packet mode. */
Alan Cox04f378b2008-04-30 00:53:29 -07002206 if (packet && b == buf) {
Miloslav Trmac522ed772007-07-15 23:40:56 -07002207 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 retval = -EFAULT;
2209 b--;
2210 break;
2211 }
2212 nr--;
2213 }
2214
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002215 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002216 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002217 if (retval == -EAGAIN) {
2218 retval = 0;
2219 continue;
2220 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 break;
2222 } else {
2223 int uncopied;
Alan Cox04f378b2008-04-30 00:53:29 -07002224 /* The copy function takes the read lock and handles
2225 locking internally for this case */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 uncopied = copy_from_read_buf(tty, &b, &nr);
2227 uncopied += copy_from_read_buf(tty, &b, &nr);
2228 if (uncopied) {
2229 retval = -EFAULT;
2230 break;
2231 }
2232 }
2233
Peter Hurley6367ca72013-06-15 09:14:33 -04002234 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
2236 if (b - buf >= minimum)
2237 break;
2238 if (time)
2239 timeout = time;
2240 }
Jiri Slabybddc7152012-10-18 22:26:42 +02002241 mutex_unlock(&ldata->atomic_read_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 remove_wait_queue(&tty->read_wait, &wait);
2243
2244 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002245 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246
2247 __set_current_state(TASK_RUNNING);
Peter Hurley40d5e092013-06-15 10:21:17 -04002248 if (b - buf)
2249 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250
Linus Torvalds55db4c62011-06-04 06:33:24 +09002251 n_tty_set_room(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04002252 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 return retval;
2254}
2255
2256/**
Alan Cox11a96d12008-10-13 10:46:24 +01002257 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 * @tty: tty device
2259 * @file: file object
2260 * @buf: userspace buffer pointer
2261 * @nr: size of I/O
2262 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002263 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002265 * and other such events. Since the receive code will echo characters,
2266 * thus calling driver write methods, the output_lock is used in
2267 * the output processing functions called here as well as in the
2268 * echo processing function to protect the column state and space
2269 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 *
2271 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002272 *
2273 * Locking: output_lock to protect column state and space left
2274 * (note that the process_output*() functions take this
2275 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 */
Alan Cox4edf1822008-02-08 04:18:44 -08002277
Alan Cox11a96d12008-10-13 10:46:24 +01002278static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002279 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280{
2281 const unsigned char *b = buf;
2282 DECLARE_WAITQUEUE(wait, current);
2283 int c;
2284 ssize_t retval = 0;
2285
2286 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2287 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2288 retval = tty_check_change(tty);
2289 if (retval)
2290 return retval;
2291 }
2292
Peter Hurley9356b532013-06-15 09:14:24 -04002293 down_read(&tty->termios_rwsem);
2294
Joe Petersona88a69c2009-01-02 13:40:53 +00002295 /* Write out any echoed characters that are still pending */
2296 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002297
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 add_wait_queue(&tty->write_wait, &wait);
2299 while (1) {
2300 set_current_state(TASK_INTERRUPTIBLE);
2301 if (signal_pending(current)) {
2302 retval = -ERESTARTSYS;
2303 break;
2304 }
2305 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2306 retval = -EIO;
2307 break;
2308 }
Peter Hurley582f5592013-05-17 12:49:48 -04002309 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002311 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 if (num < 0) {
2313 if (num == -EAGAIN)
2314 break;
2315 retval = num;
2316 goto break_out;
2317 }
2318 b += num;
2319 nr -= num;
2320 if (nr == 0)
2321 break;
2322 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002323 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 break;
2325 b++; nr--;
2326 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002327 if (tty->ops->flush_chars)
2328 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 } else {
Roman Zippeld6afe272005-07-07 17:56:55 -07002330 while (nr > 0) {
Alan Coxf34d7a52008-04-30 00:54:13 -07002331 c = tty->ops->write(tty, b, nr);
Roman Zippeld6afe272005-07-07 17:56:55 -07002332 if (c < 0) {
2333 retval = c;
2334 goto break_out;
2335 }
2336 if (!c)
2337 break;
2338 b += c;
2339 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 }
2342 if (!nr)
2343 break;
2344 if (file->f_flags & O_NONBLOCK) {
2345 retval = -EAGAIN;
2346 break;
2347 }
Peter Hurley9356b532013-06-15 09:14:24 -04002348 up_read(&tty->termios_rwsem);
2349
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 schedule();
Peter Hurley9356b532013-06-15 09:14:24 -04002351
2352 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 }
2354break_out:
2355 __set_current_state(TASK_RUNNING);
2356 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002357 if (b - buf != nr && tty->fasync)
2358 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002359 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 return (b - buf) ? b - buf : retval;
2361}
2362
2363/**
Alan Cox11a96d12008-10-13 10:46:24 +01002364 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 * @tty: terminal device
2366 * @file: file accessing it
2367 * @wait: poll table
2368 *
2369 * Called when the line discipline is asked to poll() for data or
2370 * for special events. This code is not serialized with respect to
2371 * other events save open/close.
2372 *
2373 * This code must be sure never to sleep through a hangup.
2374 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 */
Alan Cox4edf1822008-02-08 04:18:44 -08002376
Alan Cox11a96d12008-10-13 10:46:24 +01002377static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002378 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002380 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 unsigned int mask = 0;
2382
2383 poll_wait(file, &tty->read_wait, wait);
2384 poll_wait(file, &tty->write_wait, wait);
2385 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
2386 mask |= POLLIN | POLLRDNORM;
2387 if (tty->packet && tty->link->ctrl_status)
2388 mask |= POLLPRI | POLLIN | POLLRDNORM;
2389 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2390 mask |= POLLHUP;
2391 if (tty_hung_up_p(file))
2392 mask |= POLLHUP;
2393 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2394 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002395 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002397 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002399 if (tty->ops->write && !tty_is_writelocked(tty) &&
2400 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2401 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 mask |= POLLOUT | POLLWRNORM;
2403 return mask;
2404}
2405
Jiri Slaby57c94122012-10-18 22:26:43 +02002406static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002407{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002408 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002409
Peter Hurleya73d3d62013-06-15 09:14:25 -04002410 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002411 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002412 head = ldata->canon_head;
2413 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002414 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002415 /* Skip EOF-chars.. */
2416 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002417 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2418 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002419 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002420 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002421 }
2422 return nr;
2423}
2424
2425static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2426 unsigned int cmd, unsigned long arg)
2427{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002428 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002429 int retval;
2430
2431 switch (cmd) {
2432 case TIOCOUTQ:
2433 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2434 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002435 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002436 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002437 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002438 else
2439 retval = read_cnt(ldata);
2440 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002441 return put_user(retval, (unsigned int __user *) arg);
2442 default:
2443 return n_tty_ioctl_helper(tty, file, cmd, arg);
2444 }
2445}
2446
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002447static void n_tty_fasync(struct tty_struct *tty, int on)
2448{
2449 struct n_tty_data *ldata = tty->disc_data;
2450
2451 if (!waitqueue_active(&tty->read_wait)) {
2452 if (on)
2453 ldata->minimum_to_wake = 1;
2454 else if (!tty->fasync)
2455 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2456 }
2457}
2458
Alan Coxa352def2008-07-16 21:53:12 +01002459struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002460 .magic = TTY_LDISC_MAGIC,
2461 .name = "n_tty",
2462 .open = n_tty_open,
2463 .close = n_tty_close,
2464 .flush_buffer = n_tty_flush_buffer,
2465 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002466 .read = n_tty_read,
2467 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002468 .ioctl = n_tty_ioctl,
2469 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002470 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002471 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002472 .write_wakeup = n_tty_write_wakeup,
2473 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002474 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002476
2477/**
2478 * n_tty_inherit_ops - inherit N_TTY methods
2479 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2480 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002481 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002482 * methods.
2483 */
2484
2485void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2486{
2487 *ops = tty_ldisc_N_TTY;
2488 ops->owner = NULL;
2489 ops->refcount = ops->flags = 0;
2490}
2491EXPORT_SYMBOL_GPL(n_tty_inherit_ops);