blob: 7efabc4673b6a79d8822264a02a4c8afd09a91d8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
7 * anyway...)
8 *
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080011 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * This file may be redistributed under the terms of the GNU General Public
19 * License.
20 *
21 * Reduced memory usage for older ARM systems - Russell King.
22 *
Alan Cox4edf1822008-02-08 04:18:44 -080023 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
26 *
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010029 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * EAGAIN
31 */
32
33#include <linux/types.h>
34#include <linux/major.h>
35#include <linux/errno.h>
36#include <linux/signal.h>
37#include <linux/fcntl.h>
38#include <linux/sched.h>
39#include <linux/interrupt.h>
40#include <linux/tty.h>
41#include <linux/timer.h>
42#include <linux/ctype.h>
43#include <linux/mm.h>
44#include <linux/string.h>
45#include <linux/slab.h>
46#include <linux/poll.h>
47#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070048#include <linux/audit.h>
49#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000050#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080051#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050052#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040053#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/* number of characters left in xmit buffer before select has we have room */
57#define WAKEUP_CHARS 256
58
59/*
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
63 */
64#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010065#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Joe Petersona88a69c2009-01-02 13:40:53 +000067/*
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
71 * codes.
72 */
73#define ECHO_OP_START 0xff
74#define ECHO_OP_MOVE_BACK_COL 0x80
75#define ECHO_OP_SET_CANON_COL 0x81
76#define ECHO_OP_ERASE_TAB 0x82
77
Peter Hurleycbfd0342013-06-15 10:04:26 -040078#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
Peter Hurley32f13522013-06-15 09:14:17 -040083#undef N_TTY_TRACE
84#ifdef N_TTY_TRACE
85# define n_tty_trace(f, args...) trace_printk(f, ##args)
86#else
87# define n_tty_trace(f, args...)
88#endif
89
Jiri Slaby70ece7a2012-10-18 22:26:38 +020090struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040091 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040094 size_t echo_head;
95 size_t echo_commit;
Peter Hurley1075a6e2013-12-09 18:06:07 -050096 size_t echo_mark;
Peter Hurley1bb9d562013-06-15 10:21:20 -040097 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040098
99 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200100 unsigned long overrun_time;
101 int num_overrun;
102
Peter Hurley24a89d12013-06-15 09:14:15 -0400103 /* non-atomic */
104 bool no_room;
105
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400106 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200107 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Peter Hurley4d0ed182013-12-10 17:12:02 -0500108 unsigned char push:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200109
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400110 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400111 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200112 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400113 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200114
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -0400115 int minimum_to_wake;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200116
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400117 /* consumer-published */
118 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400119 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400120
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400121 /* protected by output lock */
122 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200123 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400124 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200125
126 struct mutex atomic_read_lock;
127 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200128};
129
Peter Hurleyce741172013-06-15 09:14:20 -0400130static inline size_t read_cnt(struct n_tty_data *ldata)
131{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400132 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400133}
134
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400135static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
136{
137 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
138}
139
140static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
141{
142 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
143}
144
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400145static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
146{
147 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
148}
149
150static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
151{
152 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
153}
154
Miloslav Trmac522ed772007-07-15 23:40:56 -0700155static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
156 unsigned char __user *ptr)
157{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200158 struct n_tty_data *ldata = tty->disc_data;
159
160 tty_audit_add_data(tty, &x, 1, ldata->icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700161 return put_user(x, ptr);
162}
163
Peter Hurley24a89d12013-06-15 09:14:15 -0400164static int receive_room(struct tty_struct *tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900165{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200166 struct n_tty_data *ldata = tty->disc_data;
Jaeden Amero090abf72012-07-27 08:43:11 -0500167 int left;
Peter Hurleyb8483052013-06-15 07:28:30 -0400168
Jaeden Amero090abf72012-07-27 08:43:11 -0500169 if (I_PARMRK(tty)) {
170 /* Multiply read_cnt by 3, since each byte might take up to
171 * three times as many spaces when PARMRK is set (depending on
172 * its flags, e.g. parity error). */
Peter Hurleyce741172013-06-15 09:14:20 -0400173 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500174 } else
Peter Hurleyce741172013-06-15 09:14:20 -0400175 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500176
Linus Torvalds55db4c62011-06-04 06:33:24 +0900177 /*
178 * If we are doing input canonicalization, and there are no
179 * pending newlines, let characters through without limit, so
180 * that erase characters will be handled. Other excess
181 * characters will be beeped.
182 */
183 if (left <= 0)
Peter Hurleya73d3d62013-06-15 09:14:25 -0400184 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
Linus Torvalds55db4c62011-06-04 06:33:24 +0900185
Peter Hurley24a89d12013-06-15 09:14:15 -0400186 return left;
Peter Hurley7879a9f2013-06-15 07:28:31 -0400187}
188
Peter Hurley24a89d12013-06-15 09:14:15 -0400189/**
Peter Hurley2c5dc462015-01-16 15:05:34 -0500190 * n_tty_kick_worker - start input worker (if required)
Peter Hurley24a89d12013-06-15 09:14:15 -0400191 * @tty: terminal
192 *
Peter Hurley2c5dc462015-01-16 15:05:34 -0500193 * Re-schedules the flip buffer work if it may have stopped
Peter Hurley24a89d12013-06-15 09:14:15 -0400194 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400195 * Caller holds exclusive termios_rwsem
196 * or
197 * n_tty_read()/consumer path:
198 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400199 */
200
Peter Hurley2c5dc462015-01-16 15:05:34 -0500201static void n_tty_kick_worker(struct tty_struct *tty)
Peter Hurley7879a9f2013-06-15 07:28:31 -0400202{
Peter Hurley24a89d12013-06-15 09:14:15 -0400203 struct n_tty_data *ldata = tty->disc_data;
204
Peter Hurley2c5dc462015-01-16 15:05:34 -0500205 /* Did the input worker stop? Restart it */
206 if (unlikely(ldata->no_room)) {
Peter Hurley24a89d12013-06-15 09:14:15 -0400207 ldata->no_room = 0;
208
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200209 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400210 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400211 /* see if ldisc has been killed - if so, this means that
212 * even though the ldisc has been halted and ->buf.work
213 * cancelled, ->buf.work is about to be rescheduled
214 */
215 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
216 "scheduling buffer work for halted ldisc\n");
Peter Hurleyf0f947c2013-06-15 09:14:36 -0400217 queue_work(system_unbound_wq, &tty->port->buf.work);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200218 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900219}
220
Peter Hurley9a4aec22013-06-15 09:14:32 -0400221static ssize_t chars_in_buffer(struct tty_struct *tty)
222{
223 struct n_tty_data *ldata = tty->disc_data;
224 ssize_t n = 0;
225
226 if (!ldata->icanon)
227 n = read_cnt(ldata);
228 else
229 n = ldata->canon_head - ldata->read_tail;
230 return n;
231}
232
Peter Hurleyee0bab82013-06-15 09:14:34 -0400233/**
234 * n_tty_write_wakeup - asynchronous I/O notifier
235 * @tty: tty device
236 *
237 * Required for the ptys, serial driver etc. since processes
238 * that attach themselves to the master and rely on ASYNC
239 * IO must be woken up
240 */
241
242static void n_tty_write_wakeup(struct tty_struct *tty)
243{
244 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
245 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
246}
247
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400248static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400249{
Peter Hurleya3428462015-01-16 15:05:35 -0500250 struct n_tty_data *ldata = tty->disc_data;
251
Peter Hurley3afb1b392013-07-23 08:47:30 -0400252 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
253 return;
Peter Hurley6367ca72013-06-15 09:14:33 -0400254 /*
255 * Check the remaining room for the input canonicalization
256 * mode. We don't want to throttle the driver if we're in
257 * canonical mode and don't have a newline yet!
258 */
Peter Hurleya3428462015-01-16 15:05:35 -0500259 if (ldata->icanon && ldata->canon_head == ldata->read_tail)
260 return;
261
Peter Hurley6367ca72013-06-15 09:14:33 -0400262 while (1) {
263 int throttled;
264 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
Peter Hurley5e28cca2015-01-16 15:05:36 -0500265 if (N_TTY_BUF_SIZE - read_cnt(ldata) >= TTY_THRESHOLD_THROTTLE)
Peter Hurley6367ca72013-06-15 09:14:33 -0400266 break;
267 throttled = tty_throttle_safe(tty);
268 if (!throttled)
269 break;
270 }
271 __tty_set_flow_change(tty, 0);
272}
273
Peter Hurley4b293492013-07-24 08:29:55 -0400274static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400275{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400276 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
277 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
278 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
279 return;
280 if (!tty->count)
281 return;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500282 n_tty_kick_worker(tty);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400283 n_tty_write_wakeup(tty->link);
Peter Hurley6c677162013-12-02 14:24:46 -0500284 if (waitqueue_active(&tty->link->write_wait))
285 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400286 return;
287 }
288
Peter Hurley6367ca72013-06-15 09:14:33 -0400289 /* If there is enough space in the read buffer now, let the
290 * low-level driver know. We use chars_in_buffer() to
291 * check the buffer, as it now knows about canonical mode.
292 * Otherwise, if the driver is throttled and the line is
293 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
294 * we won't get any more characters.
295 */
296
297 while (1) {
298 int unthrottled;
299 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
300 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
301 break;
302 if (!tty->count)
303 break;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500304 n_tty_kick_worker(tty);
Peter Hurley6367ca72013-06-15 09:14:33 -0400305 unthrottled = tty_unthrottle_safe(tty);
306 if (!unthrottled)
307 break;
308 }
309 __tty_set_flow_change(tty, 0);
310}
311
Alan Cox17b82062008-10-13 10:45:06 +0100312/**
313 * put_tty_queue - add character to tty
314 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200315 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100316 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400317 * Add a character to the tty read_buf queue.
318 *
319 * n_tty_receive_buf()/producer path:
320 * caller holds non-exclusive termios_rwsem
321 * modifies read_head
322 *
323 * read_head is only considered 'published' if canonical mode is
324 * not active.
Alan Cox17b82062008-10-13 10:45:06 +0100325 */
326
Peter Hurley19e2ad62013-07-24 08:29:54 -0400327static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
Christian Riesch8bfbe2d2014-11-13 05:53:26 +0100329 *read_buf_addr(ldata, ldata->read_head) = c;
330 ldata->read_head++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
333/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 * reset_buffer_flags - reset buffer state
335 * @tty: terminal to reset
336 *
Peter Hurley25518c62013-03-11 16:44:31 -0400337 * Reset the read buffer counters and clear the flags.
338 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100339 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400340 * Locking: caller holds exclusive termios_rwsem
341 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000343
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400344static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400346 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley17bd7902013-06-15 10:04:24 -0400347 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500348 ldata->echo_mark = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400349 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000350
Peter Hurleya73d3d62013-06-15 09:14:25 -0400351 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200352 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -0500353 ldata->push = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354}
355
Peter Hurleya30737a2013-03-11 16:44:22 -0400356static void n_tty_packet_mode_flush(struct tty_struct *tty)
357{
358 unsigned long flags;
359
Peter Hurleya30737a2013-03-11 16:44:22 -0400360 if (tty->link->packet) {
Peter Hurley54e8e5f2014-10-16 15:33:26 -0400361 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya30737a2013-03-11 16:44:22 -0400362 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
Peter Hurley54e8e5f2014-10-16 15:33:26 -0400363 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Hurley6c677162013-12-02 14:24:46 -0500364 if (waitqueue_active(&tty->link->read_wait))
365 wake_up_interruptible(&tty->link->read_wait);
Peter Hurleya30737a2013-03-11 16:44:22 -0400366 }
Peter Hurleya30737a2013-03-11 16:44:22 -0400367}
368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369/**
370 * n_tty_flush_buffer - clean input queue
371 * @tty: terminal device
372 *
Peter Hurley25518c62013-03-11 16:44:31 -0400373 * Flush the input buffer. Called when the tty layer wants the
374 * buffer flushed (eg at hangup) or when the N_TTY line discipline
375 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400377 * Holds termios_rwsem to exclude producer/consumer while
378 * buffer indices are reset.
379 *
380 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 */
Alan Cox4edf1822008-02-08 04:18:44 -0800382
383static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400385 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400386 reset_buffer_flags(tty->disc_data);
Peter Hurley2c5dc462015-01-16 15:05:34 -0500387 n_tty_kick_worker(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800388
Peter Hurleya30737a2013-03-11 16:44:22 -0400389 if (tty->link)
390 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400391 up_write(&tty->termios_rwsem);
392}
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394/**
395 * n_tty_chars_in_buffer - report available bytes
396 * @tty: tty device
397 *
398 * Report the number of characters buffered to be delivered to user
Alan Cox4edf1822008-02-08 04:18:44 -0800399 * at this instant in time.
Alan Cox17b82062008-10-13 10:45:06 +0100400 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400401 * Locking: exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 */
Alan Cox4edf1822008-02-08 04:18:44 -0800403
Peter Hurleya19d0c62013-06-15 09:14:18 -0400404static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
405{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400406 ssize_t n;
407
Peter Hurley47534082013-06-15 09:14:19 -0400408 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400409
410 down_write(&tty->termios_rwsem);
411 n = chars_in_buffer(tty);
412 up_write(&tty->termios_rwsem);
413 return n;
Peter Hurleya19d0c62013-06-15 09:14:18 -0400414}
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/**
417 * is_utf8_continuation - utf8 multibyte check
418 * @c: byte to check
419 *
420 * Returns true if the utf8 character 'c' is a multibyte continuation
421 * character. We use this to correctly compute the on screen size
422 * of the character when printing
423 */
Alan Cox4edf1822008-02-08 04:18:44 -0800424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425static inline int is_utf8_continuation(unsigned char c)
426{
427 return (c & 0xc0) == 0x80;
428}
429
430/**
431 * is_continuation - multibyte check
432 * @c: byte to check
433 *
434 * Returns true if the utf8 character 'c' is a multibyte continuation
435 * character and the terminal is in unicode mode.
436 */
Alan Cox4edf1822008-02-08 04:18:44 -0800437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438static inline int is_continuation(unsigned char c, struct tty_struct *tty)
439{
440 return I_IUTF8(tty) && is_utf8_continuation(c);
441}
442
443/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000444 * do_output_char - output one character
445 * @c: character (or partial unicode symbol)
446 * @tty: terminal device
447 * @space: space available in tty driver write buffer
448 *
449 * This is a helper function that handles one output character
450 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600451 * doing OPOST processing and putting the results in the
452 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000453 *
454 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
455 * and NLDLY. They simply aren't relevant in the world today.
456 * If you ever need them, add them here.
457 *
458 * Returns the number of bytes of buffer space used or -1 if
459 * no space left.
460 *
461 * Locking: should be called under the output_lock to protect
462 * the column state and space left in the buffer
463 */
464
465static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
466{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200467 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000468 int spaces;
469
470 if (!space)
471 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000472
Joe Petersona88a69c2009-01-02 13:40:53 +0000473 switch (c) {
474 case '\n':
475 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200476 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000477 if (O_ONLCR(tty)) {
478 if (space < 2)
479 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200480 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700481 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000482 return 2;
483 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200484 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000485 break;
486 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200487 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000488 return 0;
489 if (O_OCRNL(tty)) {
490 c = '\n';
491 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200492 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000493 break;
494 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200495 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000496 break;
497 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200498 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000499 if (O_TABDLY(tty) == XTABS) {
500 if (space < spaces)
501 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200502 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000503 tty->ops->write(tty, " ", spaces);
504 return spaces;
505 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200506 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000507 break;
508 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200509 if (ldata->column > 0)
510 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000511 break;
512 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000513 if (!iscntrl(c)) {
514 if (O_OLCUC(tty))
515 c = toupper(c);
516 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200517 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000518 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000519 break;
520 }
521
522 tty_put_char(tty, c);
523 return 1;
524}
525
526/**
527 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 * @c: character (or partial unicode symbol)
529 * @tty: terminal device
530 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600531 * Output one character with OPOST processing.
532 * Returns -1 when the output device is full and the character
533 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000535 * Locking: output_lock to protect column state and space left
536 * (also, this is called from n_tty_write under the
537 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 */
Alan Cox4edf1822008-02-08 04:18:44 -0800539
Joe Petersona88a69c2009-01-02 13:40:53 +0000540static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Jiri Slabybddc7152012-10-18 22:26:42 +0200542 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000543 int space, retval;
544
Jiri Slabybddc7152012-10-18 22:26:42 +0200545 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Alan Coxf34d7a52008-04-30 00:54:13 -0700547 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000548 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Jiri Slabybddc7152012-10-18 22:26:42 +0200550 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000551 if (retval < 0)
552 return -1;
553 else
554 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
556
557/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000558 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600560 * @buf: character buffer
561 * @nr: number of bytes to output
562 *
563 * Output a block of characters with OPOST processing.
564 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 *
566 * This path is used to speed up block console writes, among other
567 * things when processing blocks of output data. It handles only
568 * the simple cases normally found and helps to generate blocks of
569 * symbols for the console driver and thus improve performance.
570 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000571 * Locking: output_lock to protect column state and space left
572 * (also, this is called from n_tty_write under the
573 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 */
Alan Cox4edf1822008-02-08 04:18:44 -0800575
Joe Petersona88a69c2009-01-02 13:40:53 +0000576static ssize_t process_output_block(struct tty_struct *tty,
577 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200579 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100581 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 const unsigned char *cp;
583
Jiri Slabybddc7152012-10-18 22:26:42 +0200584 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000585
Alan Coxf34d7a52008-04-30 00:54:13 -0700586 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000587 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200588 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000590 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 if (nr > space)
592 nr = space;
593
594 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000595 unsigned char c = *cp;
596
597 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 case '\n':
599 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200600 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 if (O_ONLCR(tty))
602 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200603 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 break;
605 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200606 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 goto break_out;
608 if (O_OCRNL(tty))
609 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200610 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 break;
612 case '\t':
613 goto break_out;
614 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200615 if (ldata->column > 0)
616 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 break;
618 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000619 if (!iscntrl(c)) {
620 if (O_OLCUC(tty))
621 goto break_out;
622 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200623 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000624 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 break;
626 }
627 }
628break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700629 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000630
Jiri Slabybddc7152012-10-18 22:26:42 +0200631 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 return i;
633}
634
Joe Petersona88a69c2009-01-02 13:40:53 +0000635/**
636 * process_echoes - write pending echo characters
637 * @tty: terminal device
638 *
639 * Write previously buffered echo (and other ldisc-generated)
640 * characters to the tty.
641 *
642 * Characters generated by the ldisc (including echoes) need to
643 * be buffered because the driver's write buffer can fill during
644 * heavy program output. Echoing straight to the driver will
645 * often fail under these conditions, causing lost characters and
646 * resulting mismatches of ldisc state information.
647 *
648 * Since the ldisc state must represent the characters actually sent
649 * to the driver at the time of the write, operations like certain
650 * changes in column state are also saved in the buffer and executed
651 * here.
652 *
653 * A circular fifo buffer is used so that the most recent characters
654 * are prioritized. Also, when control characters are echoed with a
655 * prefixed "^", the pair is treated atomically and thus not separated.
656 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400657 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000658 */
659
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400660static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000661{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200662 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400663 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400664 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000665 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000666
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400667 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000668
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400669 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400670 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400671 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000672 if (c == ECHO_OP_START) {
673 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000674 int no_space_left = 0;
675
676 /*
677 * If the buffer byte is the start of a multi-byte
678 * operation, get the next byte, which is either the
679 * op code or a control character value.
680 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400681 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000682
Joe Petersona88a69c2009-01-02 13:40:53 +0000683 switch (op) {
684 unsigned int num_chars, num_bs;
685
686 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400687 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000688
689 /*
690 * Determine how many columns to go back
691 * in order to erase the tab.
692 * This depends on the number of columns
693 * used by other characters within the tab
694 * area. If this (modulo 8) count is from
695 * the start of input rather than from a
696 * previous tab, we offset by canon column.
697 * Otherwise, tab spacing is normal.
698 */
699 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200700 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000701 num_bs = 8 - (num_chars & 7);
702
703 if (num_bs > space) {
704 no_space_left = 1;
705 break;
706 }
707 space -= num_bs;
708 while (num_bs--) {
709 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200710 if (ldata->column > 0)
711 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000712 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400713 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000714 break;
715
716 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200717 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400718 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000719 break;
720
721 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200722 if (ldata->column > 0)
723 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400724 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000725 break;
726
727 case ECHO_OP_START:
728 /* This is an escaped echo op start code */
729 if (!space) {
730 no_space_left = 1;
731 break;
732 }
733 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200734 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000735 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400736 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000737 break;
738
739 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000740 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600741 * If the op is not a special byte code,
742 * it is a ctrl char tagged to be echoed
743 * as "^X" (where X is the letter
744 * representing the control char).
745 * Note that we must ensure there is
746 * enough space for the whole ctrl pair.
747 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000748 */
Joe Peterson62b26352009-09-09 15:03:47 -0600749 if (space < 2) {
750 no_space_left = 1;
751 break;
752 }
753 tty_put_char(tty, '^');
754 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200755 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600756 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400757 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000758 }
759
760 if (no_space_left)
761 break;
762 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400763 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600764 int retval = do_output_char(c, tty, space);
765 if (retval < 0)
766 break;
767 space -= retval;
768 } else {
769 if (!space)
770 break;
771 tty_put_char(tty, c);
772 space -= 1;
773 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400774 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000775 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000776 }
777
Peter Hurleycbfd0342013-06-15 10:04:26 -0400778 /* If the echo buffer is nearly full (so that the possibility exists
779 * of echo overrun before the next commit), then discard enough
780 * data at the tail to prevent a subsequent overrun */
781 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
Roel Kluinc476f652013-10-11 22:08:49 +0200782 if (echo_buf(ldata, tail) == ECHO_OP_START) {
Peter Hurley6f222532013-11-08 09:42:18 -0500783 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400784 tail += 3;
785 else
786 tail += 2;
787 } else
788 tail++;
789 }
790
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400791 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400792 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000793}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Peter Hurley17bd7902013-06-15 10:04:24 -0400795static void commit_echoes(struct tty_struct *tty)
796{
797 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400798 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400799 size_t head;
800
801 head = ldata->echo_head;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500802 ldata->echo_mark = head;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400803 old = ldata->echo_commit - ldata->echo_tail;
804
805 /* Process committed echoes if the accumulated # of bytes
806 * is over the threshold (and try again each time another
807 * block is accumulated) */
808 nr = head - ldata->echo_tail;
809 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
810 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400811
Peter Hurley019ebdf2013-06-15 10:04:25 -0400812 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400813 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400814 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400815 mutex_unlock(&ldata->output_lock);
816
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400817 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400818 tty->ops->flush_chars(tty);
819}
820
821static void process_echoes(struct tty_struct *tty)
822{
823 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400824 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400825
Peter Hurleye2613be2014-02-11 16:34:55 -0500826 if (ldata->echo_mark == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400827 return;
828
829 mutex_lock(&ldata->output_lock);
Peter Hurley1075a6e2013-12-09 18:06:07 -0500830 ldata->echo_commit = ldata->echo_mark;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400831 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400832 mutex_unlock(&ldata->output_lock);
833
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400834 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400835 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400836}
837
Peter Hurley1075a6e2013-12-09 18:06:07 -0500838/* NB: echo_mark and echo_head should be equivalent here */
Peter Hurleycbfd0342013-06-15 10:04:26 -0400839static void flush_echoes(struct tty_struct *tty)
840{
841 struct n_tty_data *ldata = tty->disc_data;
842
Peter Hurley39434ab2013-11-29 12:56:10 -0500843 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
844 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400845 return;
846
847 mutex_lock(&ldata->output_lock);
848 ldata->echo_commit = ldata->echo_head;
849 __process_echoes(tty);
850 mutex_unlock(&ldata->output_lock);
851}
852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000854 * add_echo_byte - add a byte to the echo buffer
855 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200856 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000857 *
858 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000859 */
860
Peter Hurleycbfd0342013-06-15 10:04:26 -0400861static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000862{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400863 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000864}
865
866/**
867 * echo_move_back_col - add operation to move back a 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 move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000871 */
872
Jiri Slaby57c94122012-10-18 22:26:43 +0200873static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000874{
Jiri Slaby57c94122012-10-18 22:26:43 +0200875 add_echo_byte(ECHO_OP_START, ldata);
876 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000877}
878
879/**
880 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200881 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000882 *
883 * Add an operation to the echo buffer to set the canon column
884 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000885 */
886
Jiri Slaby57c94122012-10-18 22:26:43 +0200887static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000888{
Jiri Slaby57c94122012-10-18 22:26:43 +0200889 add_echo_byte(ECHO_OP_START, ldata);
890 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000891}
892
893/**
894 * echo_erase_tab - add operation to erase a tab
895 * @num_chars: number of character columns already used
896 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200897 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000898 *
899 * Add an operation to the echo buffer to erase a tab.
900 *
901 * Called by the eraser function, which knows how many character
902 * columns have been used since either a previous tab or the start
903 * of input. This information will be used later, along with
904 * canon column (if applicable), to go back the correct number
905 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000906 */
907
908static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200909 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000910{
Jiri Slaby57c94122012-10-18 22:26:43 +0200911 add_echo_byte(ECHO_OP_START, ldata);
912 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000913
914 /* We only need to know this modulo 8 (tab spacing) */
915 num_chars &= 7;
916
917 /* Set the high bit as a flag if num_chars is after a previous tab */
918 if (after_tab)
919 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000920
Jiri Slaby57c94122012-10-18 22:26:43 +0200921 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000922}
923
924/**
925 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 * @c: unicode byte to echo
927 * @tty: terminal device
928 *
Alan Cox4edf1822008-02-08 04:18:44 -0800929 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100931 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000932 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000933 */
934
Jiri Slaby57c94122012-10-18 22:26:43 +0200935static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000936{
Joe Petersona88a69c2009-01-02 13:40:53 +0000937 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200938 add_echo_byte(ECHO_OP_START, ldata);
939 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000940 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200941 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000942 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000943}
944
945/**
946 * echo_char - echo a character
947 * @c: unicode byte to echo
948 * @tty: terminal device
949 *
950 * Echo user input back onto the screen. This must be called only when
951 * L_ECHO(tty) is true. Called from the driver receive_buf path.
952 *
Joe Peterson62b26352009-09-09 15:03:47 -0600953 * This variant tags control characters to be echoed as "^X"
954 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 */
956
957static void echo_char(unsigned char c, struct tty_struct *tty)
958{
Jiri Slabybddc7152012-10-18 22:26:42 +0200959 struct n_tty_data *ldata = tty->disc_data;
960
Joe Petersona88a69c2009-01-02 13:40:53 +0000961 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200962 add_echo_byte(ECHO_OP_START, ldata);
963 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000964 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600965 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200966 add_echo_byte(ECHO_OP_START, ldata);
967 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000968 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969}
970
Alan Cox17b82062008-10-13 10:45:06 +0100971/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000972 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200973 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100974 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000975
Jiri Slaby57c94122012-10-18 22:26:43 +0200976static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200978 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200979 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200980 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 }
982}
983
984/**
985 * eraser - handle erase function
986 * @c: character input
987 * @tty: terminal device
988 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200989 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 * present in the stream from the driver layer. Handles the complexities
991 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100992 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400993 * n_tty_receive_buf()/producer path:
994 * caller holds non-exclusive termios_rwsem
995 * modifies read_head
996 *
997 * Modifying the read_head is not considered a publish in this context
998 * because canonical mode is active -- only canon_head publishes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 */
Alan Cox4edf1822008-02-08 04:18:44 -08001000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001static void eraser(unsigned char c, struct tty_struct *tty)
1002{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001003 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001005 size_t head;
1006 size_t cnt;
1007 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001009 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +00001010 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 return;
1012 }
1013 if (c == ERASE_CHAR(tty))
1014 kill_type = ERASE;
1015 else if (c == WERASE_CHAR(tty))
1016 kill_type = WERASE;
1017 else {
1018 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001019 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 return;
1021 }
1022 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001023 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +02001024 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 echo_char(KILL_CHAR(tty), tty);
1026 /* Add a newline if ECHOK is on and ECHOKE is off. */
1027 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001028 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 return;
1030 }
1031 kill_type = KILL;
1032 }
1033
1034 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001035 while (ldata->read_head != ldata->canon_head) {
1036 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
1038 /* erase a single possibly multibyte character */
1039 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001040 head--;
1041 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001042 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
1044 /* do not partially erase */
1045 if (is_continuation(c, tty))
1046 break;
1047
1048 if (kill_type == WERASE) {
1049 /* Equivalent to BSD's ALTWERASE. */
1050 if (isalnum(c) || c == '_')
1051 seen_alnums++;
1052 else if (seen_alnums)
1053 break;
1054 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001055 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001056 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 if (L_ECHO(tty)) {
1058 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001059 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001060 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001061 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 }
1063 /* if cnt > 1, output a multi-byte character */
1064 echo_char(c, tty);
1065 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001066 head++;
1067 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001068 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 }
1070 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1071 echo_char(ERASE_CHAR(tty), tty);
1072 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001073 unsigned int num_chars = 0;
1074 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001075 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Joe Petersona88a69c2009-01-02 13:40:53 +00001077 /*
1078 * Count the columns used for characters
1079 * since the start of input or after a
1080 * previous tab.
1081 * This info is used to go back the correct
1082 * number of columns.
1083 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001084 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001085 tail--;
1086 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001087 if (c == '\t') {
1088 after_tab = 1;
1089 break;
Alan Cox300a6202009-01-02 13:41:04 +00001090 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001092 num_chars += 2;
1093 } else if (!is_continuation(c, tty)) {
1094 num_chars++;
1095 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001097 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 } else {
1099 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001100 echo_char_raw('\b', ldata);
1101 echo_char_raw(' ', ldata);
1102 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 }
1104 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001105 echo_char_raw('\b', ldata);
1106 echo_char_raw(' ', ldata);
1107 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 }
1109 }
1110 }
1111 if (kill_type == ERASE)
1112 break;
1113 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001114 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001115 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116}
1117
1118/**
1119 * isig - handle the ISIG optio
1120 * @sig: signal
1121 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001123 * Called when a signal is being sent due to terminal input.
1124 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001125 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001126 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 */
Alan Cox4edf1822008-02-08 04:18:44 -08001128
Peter Hurley4b293492013-07-24 08:29:55 -04001129static void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130{
Peter Hurley8c985d12013-03-06 08:38:19 -05001131 struct pid *tty_pgrp = tty_get_pgrp(tty);
1132 if (tty_pgrp) {
1133 kill_pgrp(tty_pgrp, sig, 1);
1134 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 }
1136}
1137
1138/**
1139 * n_tty_receive_break - handle break
1140 * @tty: terminal
1141 *
1142 * An RS232 break event has been hit in the incoming bitstream. This
1143 * can cause a variety of events depending upon the termios settings.
1144 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001145 * n_tty_receive_buf()/producer path:
1146 * caller holds non-exclusive termios_rwsem
1147 * publishes read_head via put_tty_queue()
1148 *
1149 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 */
Alan Cox4edf1822008-02-08 04:18:44 -08001151
Peter Hurley4b293492013-07-24 08:29:55 -04001152static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153{
Jiri Slaby57c94122012-10-18 22:26:43 +02001154 struct n_tty_data *ldata = tty->disc_data;
1155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 if (I_IGNBRK(tty))
1157 return;
1158 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001159 isig(SIGINT, tty);
1160 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001161 /* flushing needs exclusive termios_rwsem */
1162 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001163 n_tty_flush_buffer(tty);
1164 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001165 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001166 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 return;
1168 }
1169 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001170 put_tty_queue('\377', ldata);
1171 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001173 put_tty_queue('\0', ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001174 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001175 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176}
1177
1178/**
1179 * n_tty_receive_overrun - handle overrun reporting
1180 * @tty: terminal
1181 *
1182 * Data arrived faster than we could process it. While the tty
1183 * driver has flagged this the bits that were missed are gone
1184 * forever.
1185 *
1186 * Called from the receive_buf path so single threaded. Does not
1187 * need locking as num_overrun and overrun_time are function
1188 * private.
1189 */
Alan Cox4edf1822008-02-08 04:18:44 -08001190
Peter Hurley4b293492013-07-24 08:29:55 -04001191static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001193 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 char buf[64];
1195
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001196 ldata->num_overrun++;
1197 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1198 time_after(ldata->overrun_time, jiffies)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1200 tty_name(tty, buf),
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001201 ldata->num_overrun);
1202 ldata->overrun_time = jiffies;
1203 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 }
1205}
1206
1207/**
1208 * n_tty_receive_parity_error - error notifier
1209 * @tty: terminal device
1210 * @c: character
1211 *
1212 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001213 * the error case if necessary.
1214 *
1215 * n_tty_receive_buf()/producer path:
1216 * caller holds non-exclusive termios_rwsem
1217 * publishes read_head via put_tty_queue()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 */
Peter Hurley4b293492013-07-24 08:29:55 -04001219static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220{
Jiri Slaby57c94122012-10-18 22:26:43 +02001221 struct n_tty_data *ldata = tty->disc_data;
1222
Peter Hurley66528f92014-06-16 08:10:42 -04001223 if (I_INPCK(tty)) {
1224 if (I_IGNPAR(tty))
1225 return;
1226 if (I_PARMRK(tty)) {
1227 put_tty_queue('\377', ldata);
1228 put_tty_queue('\0', ldata);
1229 put_tty_queue(c, ldata);
1230 } else
1231 put_tty_queue('\0', ldata);
1232 } else
Jiri Slaby57c94122012-10-18 22:26:43 +02001233 put_tty_queue(c, ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001234 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001235 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236}
1237
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001238static void
1239n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1240{
1241 if (!L_NOFLSH(tty)) {
1242 /* flushing needs exclusive termios_rwsem */
1243 up_read(&tty->termios_rwsem);
1244 n_tty_flush_buffer(tty);
1245 tty_driver_flush_buffer(tty);
1246 down_read(&tty->termios_rwsem);
1247 }
1248 if (I_IXON(tty))
1249 start_tty(tty);
1250 if (L_ECHO(tty)) {
1251 echo_char(c, tty);
1252 commit_echoes(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001253 } else
1254 process_echoes(tty);
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001255 isig(signal, tty);
1256 return;
1257}
1258
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259/**
1260 * n_tty_receive_char - perform processing
1261 * @tty: terminal device
1262 * @c: character
1263 *
1264 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001265 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001267 *
1268 * n_tty_receive_buf()/producer path:
1269 * caller holds non-exclusive termios_rwsem
1270 * publishes canon_head if canonical mode is active
1271 * otherwise, publishes read_head via put_tty_queue()
Peter Hurleye60d27c2013-07-24 08:29:56 -04001272 *
1273 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 */
1275
Peter Hurleye60d27c2013-07-24 08:29:56 -04001276static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001277n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001279 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 if (I_IXON(tty)) {
1282 if (c == START_CHAR(tty)) {
1283 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001284 process_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001285 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 }
1287 if (c == STOP_CHAR(tty)) {
1288 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001289 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 }
1291 }
Joe Peterson575537b32008-04-30 00:53:30 -07001292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001294 if (c == INTR_CHAR(tty)) {
1295 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001296 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001297 } else if (c == QUIT_CHAR(tty)) {
1298 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001299 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001300 } else if (c == SUSP_CHAR(tty)) {
1301 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001302 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 }
1304 }
Joe Peterson575537b32008-04-30 00:53:30 -07001305
Peter Hurley855df3c2013-07-24 08:29:50 -04001306 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1307 start_tty(tty);
1308 process_echoes(tty);
1309 }
1310
Joe Peterson575537b32008-04-30 00:53:30 -07001311 if (c == '\r') {
1312 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001313 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001314 if (I_ICRNL(tty))
1315 c = '\n';
1316 } else if (c == '\n' && I_INLCR(tty))
1317 c = '\r';
1318
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001319 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1321 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1322 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001323 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001324 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 }
1326 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001327 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001329 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001331 echo_char_raw('^', ldata);
1332 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001333 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 }
1335 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001336 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001338 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001339 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340
Jiri Slaby57c94122012-10-18 22:26:43 +02001341 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001343 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001344 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001345 echo_char(read_buf(ldata, tail), tty);
1346 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001348 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001349 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 }
1351 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001352 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001353 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001354 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 }
1356 goto handle_newline;
1357 }
1358 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 c = __DISABLED_CHAR;
1360 goto handle_newline;
1361 }
1362 if ((c == EOL_CHAR(tty)) ||
1363 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1364 /*
1365 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1366 */
1367 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001369 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001370 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001372 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
1374 /*
1375 * XXX does PARMRK doubling happen for
1376 * EOL_CHAR and EOL2_CHAR?
1377 */
Peter Hurley001ba922013-12-02 14:24:44 -05001378 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001379 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
Alan Cox4edf1822008-02-08 04:18:44 -08001381handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001382 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001383 put_tty_queue(c, ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001384 ldata->canon_head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1386 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001387 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001388 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 }
1390 }
Alan Cox4edf1822008-02-08 04:18:44 -08001391
Joe Petersonacc71bb2009-01-02 13:43:32 +00001392 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001393 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001395 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 else {
1397 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001398 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001399 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 echo_char(c, tty);
1401 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001402 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 }
1404
Peter Hurley001ba922013-12-02 14:24:44 -05001405 /* PARMRK doubling check */
1406 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001407 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Jiri Slaby57c94122012-10-18 22:26:43 +02001409 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001410 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001411}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
Peter Hurleye60d27c2013-07-24 08:29:56 -04001413static inline void
1414n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001415{
1416 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001417
Peter Hurleye60d27c2013-07-24 08:29:56 -04001418 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1419 start_tty(tty);
1420 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001421 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001422 if (L_ECHO(tty)) {
1423 finish_erasing(ldata);
1424 /* Record the column of first canon char. */
1425 if (ldata->canon_head == ldata->read_head)
1426 echo_set_canon_col(ldata);
1427 echo_char(c, tty);
1428 commit_echoes(tty);
1429 }
Peter Hurley001ba922013-12-02 14:24:44 -05001430 /* PARMRK doubling check */
1431 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001432 put_tty_queue(c, ldata);
1433 put_tty_queue(c, ldata);
1434}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001435
Peter Hurleyeb3e4662013-12-02 14:24:42 -05001436static void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
Peter Hurleye60d27c2013-07-24 08:29:56 -04001437{
1438 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001439}
1440
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001441static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001442n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1443{
1444 struct n_tty_data *ldata = tty->disc_data;
1445
Peter Hurleye60d27c2013-07-24 08:29:56 -04001446 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1447 start_tty(tty);
1448 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001449 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001450 if (L_ECHO(tty)) {
1451 finish_erasing(ldata);
1452 /* Record the column of first canon char. */
1453 if (ldata->canon_head == ldata->read_head)
1454 echo_set_canon_col(ldata);
1455 echo_char(c, tty);
1456 commit_echoes(tty);
1457 }
1458 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001459}
1460
Peter Hurley8dc4b252013-12-02 14:24:43 -05001461static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001462{
1463 if (I_ISTRIP(tty))
1464 c &= 0x7f;
1465 if (I_IUCLC(tty) && L_IEXTEN(tty))
1466 c = tolower(c);
1467
1468 if (I_IXON(tty)) {
1469 if (c == STOP_CHAR(tty))
1470 stop_tty(tty);
1471 else if (c == START_CHAR(tty) ||
1472 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1473 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1474 c != SUSP_CHAR(tty))) {
1475 start_tty(tty);
1476 process_echoes(tty);
1477 }
1478 }
1479}
1480
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001481static void
1482n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1483{
1484 char buf[64];
1485
1486 switch (flag) {
1487 case TTY_BREAK:
1488 n_tty_receive_break(tty);
1489 break;
1490 case TTY_PARITY:
1491 case TTY_FRAME:
1492 n_tty_receive_parity_error(tty, c);
1493 break;
1494 case TTY_OVERRUN:
1495 n_tty_receive_overrun(tty);
1496 break;
1497 default:
1498 printk(KERN_ERR "%s: unknown flag %d\n",
1499 tty_name(tty, buf), flag);
1500 break;
1501 }
1502}
1503
Peter Hurleye60d27c2013-07-24 08:29:56 -04001504static void
1505n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1506{
1507 struct n_tty_data *ldata = tty->disc_data;
1508
1509 ldata->lnext = 0;
1510 if (likely(flag == TTY_NORMAL)) {
1511 if (I_ISTRIP(tty))
1512 c &= 0x7f;
1513 if (I_IUCLC(tty) && L_IEXTEN(tty))
1514 c = tolower(c);
1515 n_tty_receive_char(tty, c);
1516 } else
1517 n_tty_receive_char_flagged(tty, c, flag);
1518}
1519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520/**
1521 * n_tty_receive_buf - data receive
1522 * @tty: terminal device
1523 * @cp: buffer
1524 * @fp: flag buffer
1525 * @count: characters
1526 *
1527 * Called by the terminal driver when a block of characters has
1528 * been received. This function must be called from soft contexts
1529 * not from interrupt context. The driver is responsible for making
1530 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001531 *
1532 * n_tty_receive_buf()/producer path:
1533 * claims non-exclusive termios_rwsem
1534 * publishes read_head and canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 */
Alan Cox4edf1822008-02-08 04:18:44 -08001536
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001537static void
1538n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1539 char *fp, int count)
1540{
1541 struct n_tty_data *ldata = tty->disc_data;
1542 size_t n, head;
1543
1544 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1545 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1546 n = min_t(size_t, count, n);
1547 memcpy(read_buf_addr(ldata, head), cp, n);
1548 ldata->read_head += n;
1549 cp += n;
1550 count -= n;
1551
1552 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1553 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1554 n = min_t(size_t, count, n);
1555 memcpy(read_buf_addr(ldata, head), cp, n);
1556 ldata->read_head += n;
1557}
1558
Peter Hurley554117bd2013-06-15 10:21:25 -04001559static void
1560n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1561 char *fp, int count)
1562{
1563 struct n_tty_data *ldata = tty->disc_data;
1564 char flag = TTY_NORMAL;
1565
1566 while (count--) {
1567 if (fp)
1568 flag = *fp++;
1569 if (likely(flag == TTY_NORMAL))
1570 put_tty_queue(*cp++, ldata);
1571 else
1572 n_tty_receive_char_flagged(tty, *cp++, flag);
1573 }
1574}
1575
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001576static void
1577n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1578 char *fp, int count)
1579{
1580 char flag = TTY_NORMAL;
1581
1582 while (count--) {
1583 if (fp)
1584 flag = *fp++;
1585 if (likely(flag == TTY_NORMAL))
1586 n_tty_receive_char_closing(tty, *cp++);
1587 else
1588 n_tty_receive_char_flagged(tty, *cp++, flag);
1589 }
1590}
1591
Peter Hurley7d88d632013-07-24 08:29:49 -04001592static void
1593n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001594 char *fp, int count)
1595{
1596 struct n_tty_data *ldata = tty->disc_data;
1597 char flag = TTY_NORMAL;
1598
1599 while (count--) {
1600 if (fp)
1601 flag = *fp++;
1602 if (likely(flag == TTY_NORMAL)) {
1603 unsigned char c = *cp++;
1604
1605 if (I_ISTRIP(tty))
1606 c &= 0x7f;
1607 if (I_IUCLC(tty) && L_IEXTEN(tty))
1608 c = tolower(c);
1609 if (L_EXTPROC(tty)) {
1610 put_tty_queue(c, ldata);
1611 continue;
1612 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001613 if (!test_bit(c, ldata->char_map))
1614 n_tty_receive_char_inline(tty, c);
1615 else if (n_tty_receive_char_special(tty, c) && count) {
1616 if (fp)
1617 flag = *fp++;
1618 n_tty_receive_char_lnext(tty, *cp++, flag);
1619 count--;
1620 }
Peter Hurley6baad002013-07-24 08:29:52 -04001621 } else
1622 n_tty_receive_char_flagged(tty, *cp++, flag);
1623 }
1624}
1625
1626static void
1627n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1628 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001629{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001630 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001631 char flag = TTY_NORMAL;
1632
1633 while (count--) {
1634 if (fp)
1635 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001636 if (likely(flag == TTY_NORMAL)) {
1637 unsigned char c = *cp++;
1638
1639 if (!test_bit(c, ldata->char_map))
1640 n_tty_receive_char_fast(tty, c);
1641 else if (n_tty_receive_char_special(tty, c) && count) {
1642 if (fp)
1643 flag = *fp++;
1644 n_tty_receive_char_lnext(tty, *cp++, flag);
1645 count--;
1646 }
1647 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001648 n_tty_receive_char_flagged(tty, *cp++, flag);
1649 }
1650}
1651
Peter Hurley24a89d12013-06-15 09:14:15 -04001652static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1653 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001655 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001656 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001658 if (ldata->real_raw)
1659 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001660 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117bd2013-06-15 10:21:25 -04001661 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001662 else if (tty->closing && !L_EXTPROC(tty))
1663 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001664 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001665 if (ldata->lnext) {
1666 char flag = TTY_NORMAL;
1667
1668 if (fp)
1669 flag = *fp++;
1670 n_tty_receive_char_lnext(tty, *cp++, flag);
1671 count--;
1672 }
1673
Peter Hurley7de971b2013-07-24 08:29:53 -04001674 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001675 n_tty_receive_buf_fast(tty, cp, fp, count);
1676 else
1677 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001678
1679 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001680 if (tty->ops->flush_chars)
1681 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 }
1683
Peter Hurleyce741172013-06-15 09:14:20 -04001684 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
hyc@symas.com26df6d12010-06-22 10:14:49 -07001685 L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1687 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001688 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690}
1691
Peter Hurley5c32d122013-12-02 14:24:41 -05001692static int
1693n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1694 char *fp, int count, int flow)
Peter Hurley24a89d12013-06-15 09:14:15 -04001695{
1696 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley19e2ad62013-07-24 08:29:54 -04001697 int room, n, rcvd = 0;
Peter Hurley24a89d12013-06-15 09:14:15 -04001698
Peter Hurley9356b532013-06-15 09:14:24 -04001699 down_read(&tty->termios_rwsem);
1700
Peter Hurley19e2ad62013-07-24 08:29:54 -04001701 while (1) {
1702 room = receive_room(tty);
1703 n = min(count, room);
1704 if (!n) {
Peter Hurley5c32d122013-12-02 14:24:41 -05001705 if (flow && !room)
Peter Hurley19e2ad62013-07-24 08:29:54 -04001706 ldata->no_room = 1;
1707 break;
1708 }
1709 __receive_buf(tty, cp, fp, n);
1710 cp += n;
1711 if (fp)
1712 fp += n;
1713 count -= n;
1714 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001715 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001716
Peter Hurley19e2ad62013-07-24 08:29:54 -04001717 tty->receive_room = room;
1718 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001719 up_read(&tty->termios_rwsem);
1720
Peter Hurley19e2ad62013-07-24 08:29:54 -04001721 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001722}
1723
Peter Hurley5c32d122013-12-02 14:24:41 -05001724static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1725 char *fp, int count)
1726{
1727 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1728}
1729
1730static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1731 char *fp, int count)
1732{
1733 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1734}
1735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736int is_ignored(int sig)
1737{
1738 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001739 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740}
1741
1742/**
1743 * n_tty_set_termios - termios data changed
1744 * @tty: terminal
1745 * @old: previous data
1746 *
1747 * Called by the tty layer when the user changes termios flags so
1748 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001749 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 * guaranteed that this function will not be re-entered or in progress
1751 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001752 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001753 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 */
Alan Cox4edf1822008-02-08 04:18:44 -08001755
1756static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001758 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001759
Peter Hurleyc786f742013-09-17 12:53:35 -04001760 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001761 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -05001762 ldata->line_start = ldata->read_tail;
1763 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1764 ldata->canon_head = ldata->read_tail;
1765 ldata->push = 0;
1766 } else {
1767 set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1768 ldata->read_flags);
1769 ldata->canon_head = ldata->read_head;
1770 ldata->push = 1;
1771 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001772 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001773 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001774 }
1775
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001776 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001777
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1779 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1780 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1781 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001782 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
1784 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001785 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001787 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
1789 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001790 set_bit(ERASE_CHAR(tty), ldata->char_map);
1791 set_bit(KILL_CHAR(tty), ldata->char_map);
1792 set_bit(EOF_CHAR(tty), ldata->char_map);
1793 set_bit('\n', ldata->char_map);
1794 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001796 set_bit(WERASE_CHAR(tty), ldata->char_map);
1797 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1798 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 if (L_ECHO(tty))
1800 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001801 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 }
1803 }
1804 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001805 set_bit(START_CHAR(tty), ldata->char_map);
1806 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 }
1808 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001809 set_bit(INTR_CHAR(tty), ldata->char_map);
1810 set_bit(QUIT_CHAR(tty), ldata->char_map);
1811 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001813 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001814 ldata->raw = 0;
1815 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001817 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1819 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1820 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001821 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001823 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001825 /*
1826 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1827 * been stopped by STOP_CHAR(tty) before it.
1828 */
Peter Hurleye2613be2014-02-11 16:34:55 -05001829 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
Wang YanQingdab73b42013-05-09 14:16:47 +08001830 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001831 process_echoes(tty);
1832 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001833
Alan Coxf34d7a52008-04-30 00:54:13 -07001834 /* The termios change make the tty ready for I/O */
Peter Hurley6c677162013-12-02 14:24:46 -05001835 if (waitqueue_active(&tty->write_wait))
1836 wake_up_interruptible(&tty->write_wait);
1837 if (waitqueue_active(&tty->read_wait))
1838 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839}
1840
1841/**
1842 * n_tty_close - close the ldisc for this tty
1843 * @tty: device
1844 *
Alan Cox4edf1822008-02-08 04:18:44 -08001845 * Called from the terminal layer when this line discipline is
1846 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 * discipline change. The function will not be called while other
1848 * ldisc methods are in progress.
1849 */
Alan Cox4edf1822008-02-08 04:18:44 -08001850
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851static void n_tty_close(struct tty_struct *tty)
1852{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001853 struct n_tty_data *ldata = tty->disc_data;
1854
Peter Hurley79901312013-03-11 16:44:23 -04001855 if (tty->link)
1856 n_tty_packet_mode_flush(tty);
1857
Peter Hurley20bafb32013-06-15 10:21:19 -04001858 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001859 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860}
1861
1862/**
1863 * n_tty_open - open an ldisc
1864 * @tty: terminal to open
1865 *
Alan Cox4edf1822008-02-08 04:18:44 -08001866 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 * terminal device. Can sleep. Called serialized so that no
1868 * other events will occur in parallel. No further open will occur
1869 * until a close.
1870 */
1871
1872static int n_tty_open(struct tty_struct *tty)
1873{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001874 struct n_tty_data *ldata;
1875
Peter Hurley20bafb32013-06-15 10:21:19 -04001876 /* Currently a malloc failure here can panic */
1877 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001878 if (!ldata)
1879 goto err;
1880
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001881 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001882 mutex_init(&ldata->atomic_read_lock);
1883 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001884
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001885 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001886 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001887 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001888 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001889 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001890 ldata->num_overrun = 0;
1891 ldata->no_room = 0;
1892 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001894 /* indicate buffer work may resume */
1895 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1896 n_tty_set_termios(tty, NULL);
1897 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001898
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001900err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001901 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902}
1903
Peter Hurleyeafbe672013-12-02 14:24:45 -05001904static inline int input_available_p(struct tty_struct *tty, int poll)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001906 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya5934802014-02-11 11:49:58 -05001907 int amt = poll && !TIME_CHAR(tty) && MIN_CHAR(tty) ? MIN_CHAR(tty) : 1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001908
Peter Hurley25e8d0e2014-02-11 18:55:30 -05001909 if (ldata->icanon && !L_EXTPROC(tty))
1910 return ldata->canon_head != ldata->read_tail;
1911 else
1912 return read_cnt(ldata) >= amt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913}
1914
1915/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001916 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 * @tty: terminal device
1918 * @b: user data
1919 * @nr: size of data
1920 *
Alan Cox11a96d12008-10-13 10:46:24 +01001921 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 * ICANON is off; it copies characters straight from the tty queue to
1923 * user space directly. It can be profitably called twice; once to
1924 * drain the space from the tail pointer to the (physical) end of the
1925 * buffer, and once to drain the space from the (physical) beginning of
1926 * the buffer to head pointer.
1927 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001928 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001930 * n_tty_read()/consumer path:
1931 * caller holds non-exclusive termios_rwsem
1932 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 */
Alan Cox4edf1822008-02-08 04:18:44 -08001934
Alan Cox33f0f882006-01-09 20:54:13 -08001935static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 unsigned char __user **b,
1937 size_t *nr)
1938
1939{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001940 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 int retval;
1942 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001943 bool is_eof;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001944 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945
1946 retval = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001947 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001950 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001952 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1953 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001954 ldata->icanon);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001955 ldata->read_tail += n;
hyc@symas.com26df6d12010-06-22 10:14:49 -07001956 /* Turn single EOF into zero-length read */
Peter Hurleyce741172013-06-15 09:14:20 -04001957 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001958 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 *b += n;
1960 *nr -= n;
1961 }
1962 return retval;
1963}
1964
Peter Hurley88bb0de2013-06-15 09:14:16 -04001965/**
Peter Hurley32f13522013-06-15 09:14:17 -04001966 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001967 * @tty: terminal device
1968 * @b: user data
1969 * @nr: size of data
1970 *
1971 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001972 * it copies one line of input up to and including the line-delimiting
1973 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001974 *
Peter Hurley4d0ed182013-12-10 17:12:02 -05001975 * NB: When termios is changed from non-canonical to canonical mode and
1976 * the read buffer contains data, n_tty_set_termios() simulates an EOF
1977 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
1978 * This causes data already processed as input to be immediately available
1979 * as input although a newline has not been received.
1980 *
Peter Hurley88bb0de2013-06-15 09:14:16 -04001981 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001982 *
1983 * n_tty_read()/consumer path:
1984 * caller holds non-exclusive termios_rwsem
1985 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001986 */
1987
Peter Hurley32f13522013-06-15 09:14:17 -04001988static int canon_copy_from_read_buf(struct tty_struct *tty,
1989 unsigned char __user **b,
1990 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001991{
1992 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001993 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001994 size_t eol;
1995 size_t tail;
1996 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001997 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001998
1999 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyce741172013-06-15 09:14:20 -04002000 n = min(*nr, read_cnt(ldata));
Peter Hurley6d76bd22013-06-15 09:14:26 -04002001 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04002002 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002003
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002004 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04002005 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
2006
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002007 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002008 __func__, *nr, tail, n, size);
2009
2010 eol = find_next_bit(ldata->read_flags, size, tail);
2011 more = n - (size - tail);
2012 if (eol == N_TTY_BUF_SIZE && more) {
2013 /* scan wrapped without finding set bit */
2014 eol = find_next_bit(ldata->read_flags, more, 0);
2015 if (eol != more)
2016 found = 1;
2017 } else if (eol != size)
2018 found = 1;
2019
2020 size = N_TTY_BUF_SIZE - tail;
Peter Hurleyc77569d2013-11-22 07:16:25 -05002021 n = eol - tail;
2022 if (n > 4096)
2023 n += 4096;
2024 n += found;
Peter Hurley32f13522013-06-15 09:14:17 -04002025 c = n;
2026
Peter Hurley4d0ed182013-12-10 17:12:02 -05002027 if (found && !ldata->push && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002028 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002029 eof_push = !n && ldata->read_tail != ldata->line_start;
2030 }
Peter Hurley32f13522013-06-15 09:14:17 -04002031
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002032 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002033 __func__, eol, found, n, c, size, more);
2034
Peter Hurley32f13522013-06-15 09:14:17 -04002035 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002036 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002037 if (ret)
2038 return -EFAULT;
2039 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2040 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002041 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002042
2043 if (ret)
2044 return -EFAULT;
2045 *b += n;
2046 *nr -= n;
2047
Peter Hurleya73d3d62013-06-15 09:14:25 -04002048 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002049 clear_bit(eol, ldata->read_flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +01002050 smp_mb__after_atomic();
Peter Hurley6d76bd22013-06-15 09:14:26 -04002051 ldata->read_tail += c;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002052
Peter Hurley40d5e092013-06-15 10:21:17 -04002053 if (found) {
Peter Hurley4d0ed182013-12-10 17:12:02 -05002054 if (!ldata->push)
2055 ldata->line_start = ldata->read_tail;
2056 else
2057 ldata->push = 0;
Peter Hurley32f13522013-06-15 09:14:17 -04002058 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002059 }
2060 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002061}
2062
Al Virocc4191d2008-03-29 03:08:48 +00002063extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002064 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
2066/**
2067 * job_control - check job control
2068 * @tty: tty
2069 * @file: file handle
2070 *
2071 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002072 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002074 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002075 * Locking: redirected write test is safe
2076 * current->signal->tty check is safe
2077 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 */
Alan Cox4edf1822008-02-08 04:18:44 -08002079
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080static int job_control(struct tty_struct *tty, struct file *file)
2081{
2082 /* Job control check -- must be done at start and after
2083 every sleep (POSIX.1 7.1.1.4). */
2084 /* NOTE: not yet done after every sleep pending a thorough
2085 check of the logic of this change. -- jlc */
2086 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002087 if (file->f_op->write == redirected_tty_write ||
2088 current->signal->tty != tty)
2089 return 0;
2090
2091 spin_lock_irq(&tty->ctrl_lock);
2092 if (!tty->pgrp)
2093 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2094 else if (task_pgrp(current) != tty->pgrp) {
2095 spin_unlock_irq(&tty->ctrl_lock);
2096 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2097 return -EIO;
2098 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2099 set_thread_flag(TIF_SIGPENDING);
2100 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002102 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 return 0;
2104}
Alan Cox4edf1822008-02-08 04:18:44 -08002105
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
2107/**
Alan Cox11a96d12008-10-13 10:46:24 +01002108 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 * @tty: tty device
2110 * @file: file object
2111 * @buf: userspace buffer pointer
2112 * @nr: size of I/O
2113 *
2114 * Perform reads for the line discipline. We are guaranteed that the
2115 * line discipline will not be closed under us but we may get multiple
2116 * parallel readers and must handle this ourselves. We may also get
2117 * a hangup. Always called in user context, may sleep.
2118 *
2119 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002120 *
2121 * n_tty_read()/consumer path:
2122 * claims non-exclusive termios_rwsem
2123 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 */
Alan Cox4edf1822008-02-08 04:18:44 -08002125
Alan Cox11a96d12008-10-13 10:46:24 +01002126static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 unsigned char __user *buf, size_t nr)
2128{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002129 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 unsigned char __user *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002131 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 int c;
2133 int minimum, time;
2134 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 long timeout;
Alan Cox04f378b2008-04-30 00:53:29 -07002136 int packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002137 size_t tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002140 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002142
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002143 /*
2144 * Internal serialization of reads.
2145 */
2146 if (file->f_flags & O_NONBLOCK) {
2147 if (!mutex_trylock(&ldata->atomic_read_lock))
2148 return -EAGAIN;
2149 } else {
2150 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2151 return -ERESTARTSYS;
2152 }
2153
Peter Hurley9356b532013-06-15 09:14:24 -04002154 down_read(&tty->termios_rwsem);
2155
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 minimum = time = 0;
2157 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002158 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 minimum = MIN_CHAR(tty);
2160 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002161 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002163 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002165 (ldata->minimum_to_wake > minimum))
2166 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002168 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002169 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 }
2171 }
2172
Alan Cox04f378b2008-04-30 00:53:29 -07002173 packet = tty->packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002174 tail = ldata->read_tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
2176 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 while (nr) {
2178 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002179 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 unsigned char cs;
2181 if (b != buf)
2182 break;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002183 spin_lock_irq(&tty->link->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 cs = tty->link->ctrl_status;
2185 tty->link->ctrl_status = 0;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002186 spin_unlock_irq(&tty->link->ctrl_lock);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002187 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 retval = -EFAULT;
2189 b--;
2190 break;
2191 }
2192 nr--;
2193 break;
2194 }
Alan Cox4edf1822008-02-08 04:18:44 -08002195
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002196 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002198 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002199
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 if (!input_available_p(tty, 0)) {
2201 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
Peter Hurley52bce7f2014-11-05 12:13:05 -05002202 retval = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 break;
2204 }
Peter Hurley52bce7f2014-11-05 12:13:05 -05002205 if (tty_hung_up_p(file))
2206 break;
2207 if (!timeout)
2208 break;
2209 if (file->f_flags & O_NONBLOCK) {
2210 retval = -EAGAIN;
2211 break;
2212 }
2213 if (signal_pending(current)) {
2214 retval = -ERESTARTSYS;
2215 break;
2216 }
Peter Hurley52bce7f2014-11-05 12:13:05 -05002217 up_read(&tty->termios_rwsem);
2218
Linus Torvalds37da7bb2014-12-14 15:23:32 -08002219 timeout = wait_woken(&wait, TASK_INTERRUPTIBLE,
2220 timeout);
Peter Hurley52bce7f2014-11-05 12:13:05 -05002221
2222 down_read(&tty->termios_rwsem);
2223 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 }
2225
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002226 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002227 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002228 if (retval == -EAGAIN) {
2229 retval = 0;
2230 continue;
2231 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 break;
2233 } else {
2234 int uncopied;
Peter Hurley95ea90d2014-10-16 15:33:30 -04002235
2236 /* Deal with packet mode. */
2237 if (packet && b == buf) {
2238 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
2239 retval = -EFAULT;
2240 b--;
2241 break;
2242 }
2243 nr--;
2244 }
2245
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 uncopied = copy_from_read_buf(tty, &b, &nr);
2247 uncopied += copy_from_read_buf(tty, &b, &nr);
2248 if (uncopied) {
2249 retval = -EFAULT;
2250 break;
2251 }
2252 }
2253
Peter Hurley6367ca72013-06-15 09:14:33 -04002254 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255
2256 if (b - buf >= minimum)
2257 break;
2258 if (time)
2259 timeout = time;
2260 }
Peter Hurley2c5dc462015-01-16 15:05:34 -05002261 if (tail != ldata->read_tail)
2262 n_tty_kick_worker(tty);
Peter Hurley42458f42013-11-07 13:59:46 -05002263 up_read(&tty->termios_rwsem);
2264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 remove_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002267 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
Peter Hurleyaebf04532013-11-07 14:01:57 -05002269 mutex_unlock(&ldata->atomic_read_lock);
2270
Peter Hurley40d5e092013-06-15 10:21:17 -04002271 if (b - buf)
2272 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
2274 return retval;
2275}
2276
2277/**
Alan Cox11a96d12008-10-13 10:46:24 +01002278 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 * @tty: tty device
2280 * @file: file object
2281 * @buf: userspace buffer pointer
2282 * @nr: size of I/O
2283 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002284 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002286 * and other such events. Since the receive code will echo characters,
2287 * thus calling driver write methods, the output_lock is used in
2288 * the output processing functions called here as well as in the
2289 * echo processing function to protect the column state and space
2290 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 *
2292 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002293 *
2294 * Locking: output_lock to protect column state and space left
2295 * (note that the process_output*() functions take this
2296 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 */
Alan Cox4edf1822008-02-08 04:18:44 -08002298
Alan Cox11a96d12008-10-13 10:46:24 +01002299static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002300 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301{
2302 const unsigned char *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002303 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 int c;
2305 ssize_t retval = 0;
2306
2307 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2308 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2309 retval = tty_check_change(tty);
2310 if (retval)
2311 return retval;
2312 }
2313
Peter Hurley9356b532013-06-15 09:14:24 -04002314 down_read(&tty->termios_rwsem);
2315
Joe Petersona88a69c2009-01-02 13:40:53 +00002316 /* Write out any echoed characters that are still pending */
2317 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002318
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 add_wait_queue(&tty->write_wait, &wait);
2320 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 if (signal_pending(current)) {
2322 retval = -ERESTARTSYS;
2323 break;
2324 }
2325 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2326 retval = -EIO;
2327 break;
2328 }
Peter Hurley582f5592013-05-17 12:49:48 -04002329 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002331 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 if (num < 0) {
2333 if (num == -EAGAIN)
2334 break;
2335 retval = num;
2336 goto break_out;
2337 }
2338 b += num;
2339 nr -= num;
2340 if (nr == 0)
2341 break;
2342 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002343 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 break;
2345 b++; nr--;
2346 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002347 if (tty->ops->flush_chars)
2348 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 } else {
Peter Hurley42910862014-05-03 14:04:59 +02002350 struct n_tty_data *ldata = tty->disc_data;
2351
Roman Zippeld6afe272005-07-07 17:56:55 -07002352 while (nr > 0) {
Peter Hurley42910862014-05-03 14:04:59 +02002353 mutex_lock(&ldata->output_lock);
Alan Coxf34d7a52008-04-30 00:54:13 -07002354 c = tty->ops->write(tty, b, nr);
Peter Hurley42910862014-05-03 14:04:59 +02002355 mutex_unlock(&ldata->output_lock);
Roman Zippeld6afe272005-07-07 17:56:55 -07002356 if (c < 0) {
2357 retval = c;
2358 goto break_out;
2359 }
2360 if (!c)
2361 break;
2362 b += c;
2363 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 }
2366 if (!nr)
2367 break;
2368 if (file->f_flags & O_NONBLOCK) {
2369 retval = -EAGAIN;
2370 break;
2371 }
Peter Hurley9356b532013-06-15 09:14:24 -04002372 up_read(&tty->termios_rwsem);
2373
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002374 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
Peter Hurley9356b532013-06-15 09:14:24 -04002375
2376 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 }
2378break_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002380 if (b - buf != nr && tty->fasync)
2381 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002382 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 return (b - buf) ? b - buf : retval;
2384}
2385
2386/**
Alan Cox11a96d12008-10-13 10:46:24 +01002387 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 * @tty: terminal device
2389 * @file: file accessing it
2390 * @wait: poll table
2391 *
2392 * Called when the line discipline is asked to poll() for data or
2393 * for special events. This code is not serialized with respect to
2394 * other events save open/close.
2395 *
2396 * This code must be sure never to sleep through a hangup.
2397 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 */
Alan Cox4edf1822008-02-08 04:18:44 -08002399
Alan Cox11a96d12008-10-13 10:46:24 +01002400static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002401 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002403 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404 unsigned int mask = 0;
2405
2406 poll_wait(file, &tty->read_wait, wait);
2407 poll_wait(file, &tty->write_wait, wait);
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002408 if (input_available_p(tty, 1))
2409 mask |= POLLIN | POLLRDNORM;
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002410 if (tty->packet && tty->link->ctrl_status)
2411 mask |= POLLPRI | POLLIN | POLLRDNORM;
Peter Hurley2ce3c102014-12-30 07:17:09 -05002412 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2413 mask |= POLLHUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 if (tty_hung_up_p(file))
2415 mask |= POLLHUP;
2416 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2417 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002418 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002420 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002422 if (tty->ops->write && !tty_is_writelocked(tty) &&
2423 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2424 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 mask |= POLLOUT | POLLWRNORM;
2426 return mask;
2427}
2428
Jiri Slaby57c94122012-10-18 22:26:43 +02002429static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002430{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002431 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002432
Peter Hurleya73d3d62013-06-15 09:14:25 -04002433 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002434 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002435 head = ldata->canon_head;
2436 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002437 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002438 /* Skip EOF-chars.. */
2439 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002440 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2441 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002442 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002443 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002444 }
2445 return nr;
2446}
2447
2448static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2449 unsigned int cmd, unsigned long arg)
2450{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002451 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002452 int retval;
2453
2454 switch (cmd) {
2455 case TIOCOUTQ:
2456 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2457 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002458 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002459 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002460 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002461 else
2462 retval = read_cnt(ldata);
2463 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002464 return put_user(retval, (unsigned int __user *) arg);
2465 default:
2466 return n_tty_ioctl_helper(tty, file, cmd, arg);
2467 }
2468}
2469
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002470static void n_tty_fasync(struct tty_struct *tty, int on)
2471{
2472 struct n_tty_data *ldata = tty->disc_data;
2473
2474 if (!waitqueue_active(&tty->read_wait)) {
2475 if (on)
2476 ldata->minimum_to_wake = 1;
2477 else if (!tty->fasync)
2478 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2479 }
2480}
2481
Alan Coxa352def2008-07-16 21:53:12 +01002482struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002483 .magic = TTY_LDISC_MAGIC,
2484 .name = "n_tty",
2485 .open = n_tty_open,
2486 .close = n_tty_close,
2487 .flush_buffer = n_tty_flush_buffer,
2488 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002489 .read = n_tty_read,
2490 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002491 .ioctl = n_tty_ioctl,
2492 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002493 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002494 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002495 .write_wakeup = n_tty_write_wakeup,
2496 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002497 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002499
2500/**
2501 * n_tty_inherit_ops - inherit N_TTY methods
2502 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2503 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002504 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002505 * methods.
2506 */
2507
2508void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2509{
2510 *ops = tty_ldisc_N_TTY;
2511 ops->owner = NULL;
2512 ops->refcount = ops->flags = 0;
2513}
2514EXPORT_SYMBOL_GPL(n_tty_inherit_ops);