blob: 539b49adb6afd41190eee97f6eaf1950c8a1ac3f [file] [log] [blame]
Greg Kroah-Hartmane3b3d0f2017-11-06 18:11:51 +01001// SPDX-License-Identifier: GPL-1.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * This code used to be in tty_io.c, but things are getting hairy
6 * enough that it made sense to split things off. (The N_TTY
7 * processing has changed so much that it's hardly recognizable,
8 * anyway...)
9 *
10 * Note that the open routine for N_TTY is guaranteed never to return
11 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080012 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
14 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080015 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * This file also contains code originally written by Linus Torvalds,
17 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080018 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * Reduced memory usage for older ARM systems - Russell King.
20 *
Alan Cox4edf1822008-02-08 04:18:44 -080021 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
23 * who actually finally proved there really was a race.
24 *
25 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
26 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010027 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * EAGAIN
29 */
30
31#include <linux/types.h>
32#include <linux/major.h>
33#include <linux/errno.h>
34#include <linux/signal.h>
35#include <linux/fcntl.h>
36#include <linux/sched.h>
37#include <linux/interrupt.h>
38#include <linux/tty.h>
39#include <linux/timer.h>
40#include <linux/ctype.h>
41#include <linux/mm.h>
42#include <linux/string.h>
43#include <linux/slab.h>
44#include <linux/poll.h>
45#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070046#include <linux/audit.h>
47#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000048#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080049#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050050#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040051#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/* number of characters left in xmit buffer before select has we have room */
55#define WAKEUP_CHARS 256
56
57/*
58 * This defines the low- and high-watermarks for throttling and
59 * unthrottling the TTY driver. These watermarks are used for
60 * controlling the space in the read buffer.
61 */
62#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010063#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Joe Petersona88a69c2009-01-02 13:40:53 +000065/*
66 * Special byte codes used in the echo buffer to represent operations
67 * or special handling of characters. Bytes in the echo buffer that
68 * are not part of such special blocks are treated as normal character
69 * codes.
70 */
71#define ECHO_OP_START 0xff
72#define ECHO_OP_MOVE_BACK_COL 0x80
73#define ECHO_OP_SET_CANON_COL 0x81
74#define ECHO_OP_ERASE_TAB 0x82
75
Peter Hurleycbfd0342013-06-15 10:04:26 -040076#define ECHO_COMMIT_WATERMARK 256
77#define ECHO_BLOCK 256
78#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
79
80
Peter Hurley32f13522013-06-15 09:14:17 -040081#undef N_TTY_TRACE
82#ifdef N_TTY_TRACE
83# define n_tty_trace(f, args...) trace_printk(f, ##args)
84#else
85# define n_tty_trace(f, args...)
86#endif
87
Jiri Slaby70ece7a2012-10-18 22:26:38 +020088struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040089 /* producer-published */
90 size_t read_head;
Peter Hurley70aca712015-01-16 15:05:37 -050091 size_t commit_head;
Peter Hurleyfb7aa032013-06-15 09:14:30 -040092 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040093 size_t echo_head;
94 size_t echo_commit;
Peter Hurley1075a6e2013-12-09 18:06:07 -050095 size_t echo_mark;
Peter Hurley1bb9d562013-06-15 10:21:20 -040096 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040097
98 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +020099 unsigned long overrun_time;
100 int num_overrun;
101
Peter Hurley24a89d12013-06-15 09:14:15 -0400102 /* non-atomic */
103 bool no_room;
104
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400105 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200106 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Peter Hurley4d0ed182013-12-10 17:12:02 -0500107 unsigned char push:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200108
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400109 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400110 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200111 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400112 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200113
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400114 /* consumer-published */
115 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400116 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400117
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400118 /* protected by output lock */
119 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200120 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400121 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200122
123 struct mutex atomic_read_lock;
124 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200125};
126
Peter Hurleyce741172013-06-15 09:14:20 -0400127static inline size_t read_cnt(struct n_tty_data *ldata)
128{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400129 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400130}
131
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400132static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
133{
134 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
135}
136
137static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
138{
139 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
140}
141
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400142static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
143{
144 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
145}
146
147static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
148{
149 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
150}
151
Peter Hurley679e7c22015-11-27 14:11:02 -0500152static int tty_copy_to_user(struct tty_struct *tty, void __user *to,
153 size_t tail, size_t n)
Laura Abbott72586c62015-05-14 11:42:17 -0700154{
155 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley679e7c22015-11-27 14:11:02 -0500156 size_t size = N_TTY_BUF_SIZE - tail;
157 const void *from = read_buf_addr(ldata, tail);
158 int uncopied;
159
160 if (n > size) {
Peter Hurley309426a2016-01-09 22:55:27 -0800161 tty_audit_add_data(tty, from, size);
Peter Hurley679e7c22015-11-27 14:11:02 -0500162 uncopied = copy_to_user(to, from, size);
163 if (uncopied)
164 return uncopied;
165 to += size;
166 n -= size;
167 from = ldata->read_buf;
168 }
Laura Abbott72586c62015-05-14 11:42:17 -0700169
Peter Hurley309426a2016-01-09 22:55:27 -0800170 tty_audit_add_data(tty, from, n);
Laura Abbott72586c62015-05-14 11:42:17 -0700171 return copy_to_user(to, from, n);
172}
173
Peter Hurley24a89d12013-06-15 09:14:15 -0400174/**
Peter Hurley2c5dc462015-01-16 15:05:34 -0500175 * n_tty_kick_worker - start input worker (if required)
Peter Hurley24a89d12013-06-15 09:14:15 -0400176 * @tty: terminal
177 *
Peter Hurley2c5dc462015-01-16 15:05:34 -0500178 * Re-schedules the flip buffer work if it may have stopped
Peter Hurley24a89d12013-06-15 09:14:15 -0400179 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400180 * Caller holds exclusive termios_rwsem
181 * or
182 * n_tty_read()/consumer path:
183 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400184 */
185
Peter Hurley2c5dc462015-01-16 15:05:34 -0500186static void n_tty_kick_worker(struct tty_struct *tty)
Peter Hurley7879a9f2013-06-15 07:28:31 -0400187{
Peter Hurley24a89d12013-06-15 09:14:15 -0400188 struct n_tty_data *ldata = tty->disc_data;
189
Peter Hurley2c5dc462015-01-16 15:05:34 -0500190 /* Did the input worker stop? Restart it */
191 if (unlikely(ldata->no_room)) {
Peter Hurley24a89d12013-06-15 09:14:15 -0400192 ldata->no_room = 0;
193
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200194 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400195 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400196 /* see if ldisc has been killed - if so, this means that
197 * even though the ldisc has been halted and ->buf.work
198 * cancelled, ->buf.work is about to be rescheduled
199 */
200 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
201 "scheduling buffer work for halted ldisc\n");
Peter Hurleye1760582015-10-17 16:36:23 -0400202 tty_buffer_restart_work(tty->port);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200203 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900204}
205
Peter Hurley9a4aec22013-06-15 09:14:32 -0400206static ssize_t chars_in_buffer(struct tty_struct *tty)
207{
208 struct n_tty_data *ldata = tty->disc_data;
209 ssize_t n = 0;
210
211 if (!ldata->icanon)
Peter Hurley70aca712015-01-16 15:05:37 -0500212 n = ldata->commit_head - ldata->read_tail;
Peter Hurley9a4aec22013-06-15 09:14:32 -0400213 else
214 n = ldata->canon_head - ldata->read_tail;
215 return n;
216}
217
Peter Hurleyee0bab82013-06-15 09:14:34 -0400218/**
219 * n_tty_write_wakeup - asynchronous I/O notifier
220 * @tty: tty device
221 *
222 * Required for the ptys, serial driver etc. since processes
223 * that attach themselves to the master and rely on ASYNC
224 * IO must be woken up
225 */
226
227static void n_tty_write_wakeup(struct tty_struct *tty)
228{
Peter Hurley7bccc362016-01-09 21:45:12 -0800229 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
230 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
Peter Hurleyee0bab82013-06-15 09:14:34 -0400231}
232
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400233static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400234{
Peter Hurleya3428462015-01-16 15:05:35 -0500235 struct n_tty_data *ldata = tty->disc_data;
236
Peter Hurley6367ca72013-06-15 09:14:33 -0400237 /*
238 * Check the remaining room for the input canonicalization
239 * mode. We don't want to throttle the driver if we're in
240 * canonical mode and don't have a newline yet!
241 */
Peter Hurleya3428462015-01-16 15:05:35 -0500242 if (ldata->icanon && ldata->canon_head == ldata->read_tail)
243 return;
244
Peter Hurley6367ca72013-06-15 09:14:33 -0400245 while (1) {
246 int throttled;
247 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
Peter Hurley5e28cca2015-01-16 15:05:36 -0500248 if (N_TTY_BUF_SIZE - read_cnt(ldata) >= TTY_THRESHOLD_THROTTLE)
Peter Hurley6367ca72013-06-15 09:14:33 -0400249 break;
250 throttled = tty_throttle_safe(tty);
251 if (!throttled)
252 break;
253 }
254 __tty_set_flow_change(tty, 0);
255}
256
Peter Hurley4b293492013-07-24 08:29:55 -0400257static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400258{
Peter Hurley6d27a632016-01-10 22:40:56 -0800259 if (tty->driver->type == TTY_DRIVER_TYPE_PTY) {
Peter Hurley3afb1b392013-07-23 08:47:30 -0400260 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
261 return;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500262 n_tty_kick_worker(tty);
Peter Hurley6d27a632016-01-10 22:40:56 -0800263 tty_wakeup(tty->link);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400264 return;
265 }
266
Peter Hurley6367ca72013-06-15 09:14:33 -0400267 /* If there is enough space in the read buffer now, let the
268 * low-level driver know. We use chars_in_buffer() to
269 * check the buffer, as it now knows about canonical mode.
270 * Otherwise, if the driver is throttled and the line is
271 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
272 * we won't get any more characters.
273 */
274
275 while (1) {
276 int unthrottled;
277 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
278 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
279 break;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500280 n_tty_kick_worker(tty);
Peter Hurley6367ca72013-06-15 09:14:33 -0400281 unthrottled = tty_unthrottle_safe(tty);
282 if (!unthrottled)
283 break;
284 }
285 __tty_set_flow_change(tty, 0);
286}
287
Alan Cox17b82062008-10-13 10:45:06 +0100288/**
289 * put_tty_queue - add character to tty
290 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200291 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100292 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400293 * Add a character to the tty read_buf queue.
294 *
295 * n_tty_receive_buf()/producer path:
296 * caller holds non-exclusive termios_rwsem
Alan Cox17b82062008-10-13 10:45:06 +0100297 */
298
Peter Hurley19e2ad62013-07-24 08:29:54 -0400299static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Christian Riesch8bfbe2d2014-11-13 05:53:26 +0100301 *read_buf_addr(ldata, ldata->read_head) = c;
302 ldata->read_head++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
304
305/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 * reset_buffer_flags - reset buffer state
307 * @tty: terminal to reset
308 *
Peter Hurley25518c62013-03-11 16:44:31 -0400309 * Reset the read buffer counters and clear the flags.
310 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100311 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400312 * Locking: caller holds exclusive termios_rwsem
313 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000315
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400316static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400318 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley17bd7902013-06-15 10:04:24 -0400319 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
Peter Hurley70aca712015-01-16 15:05:37 -0500320 ldata->commit_head = 0;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500321 ldata->echo_mark = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400322 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000323
Peter Hurleya73d3d62013-06-15 09:14:25 -0400324 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200325 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -0500326 ldata->push = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327}
328
Peter Hurleya30737a2013-03-11 16:44:22 -0400329static void n_tty_packet_mode_flush(struct tty_struct *tty)
330{
331 unsigned long flags;
332
Peter Hurleya30737a2013-03-11 16:44:22 -0400333 if (tty->link->packet) {
Peter Hurley54e8e5f2014-10-16 15:33:26 -0400334 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya30737a2013-03-11 16:44:22 -0400335 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
Peter Hurley54e8e5f2014-10-16 15:33:26 -0400336 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Kosuke Tatsukawae81107d2015-10-02 08:27:05 +0000337 wake_up_interruptible(&tty->link->read_wait);
Peter Hurleya30737a2013-03-11 16:44:22 -0400338 }
Peter Hurleya30737a2013-03-11 16:44:22 -0400339}
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/**
342 * n_tty_flush_buffer - clean input queue
343 * @tty: terminal device
344 *
Peter Hurley25518c62013-03-11 16:44:31 -0400345 * Flush the input buffer. Called when the tty layer wants the
346 * buffer flushed (eg at hangup) or when the N_TTY line discipline
347 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400349 * Holds termios_rwsem to exclude producer/consumer while
350 * buffer indices are reset.
351 *
352 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 */
Alan Cox4edf1822008-02-08 04:18:44 -0800354
355static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400357 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400358 reset_buffer_flags(tty->disc_data);
Peter Hurley2c5dc462015-01-16 15:05:34 -0500359 n_tty_kick_worker(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800360
Peter Hurleya30737a2013-03-11 16:44:22 -0400361 if (tty->link)
362 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400363 up_write(&tty->termios_rwsem);
364}
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 * is_utf8_continuation - utf8 multibyte check
368 * @c: byte to check
369 *
370 * Returns true if the utf8 character 'c' is a multibyte continuation
371 * character. We use this to correctly compute the on screen size
372 * of the character when printing
373 */
Alan Cox4edf1822008-02-08 04:18:44 -0800374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375static inline int is_utf8_continuation(unsigned char c)
376{
377 return (c & 0xc0) == 0x80;
378}
379
380/**
381 * is_continuation - multibyte check
382 * @c: byte to check
383 *
384 * Returns true if the utf8 character 'c' is a multibyte continuation
385 * character and the terminal is in unicode mode.
386 */
Alan Cox4edf1822008-02-08 04:18:44 -0800387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388static inline int is_continuation(unsigned char c, struct tty_struct *tty)
389{
390 return I_IUTF8(tty) && is_utf8_continuation(c);
391}
392
393/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000394 * do_output_char - output one character
395 * @c: character (or partial unicode symbol)
396 * @tty: terminal device
397 * @space: space available in tty driver write buffer
398 *
399 * This is a helper function that handles one output character
400 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600401 * doing OPOST processing and putting the results in the
402 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000403 *
404 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
405 * and NLDLY. They simply aren't relevant in the world today.
406 * If you ever need them, add them here.
407 *
408 * Returns the number of bytes of buffer space used or -1 if
409 * no space left.
410 *
411 * Locking: should be called under the output_lock to protect
412 * the column state and space left in the buffer
413 */
414
415static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
416{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200417 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000418 int spaces;
419
420 if (!space)
421 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000422
Joe Petersona88a69c2009-01-02 13:40:53 +0000423 switch (c) {
424 case '\n':
425 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200426 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000427 if (O_ONLCR(tty)) {
428 if (space < 2)
429 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200430 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700431 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000432 return 2;
433 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200434 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000435 break;
436 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200437 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000438 return 0;
439 if (O_OCRNL(tty)) {
440 c = '\n';
441 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200442 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000443 break;
444 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200445 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000446 break;
447 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200448 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000449 if (O_TABDLY(tty) == XTABS) {
450 if (space < spaces)
451 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200452 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000453 tty->ops->write(tty, " ", spaces);
454 return spaces;
455 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200456 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000457 break;
458 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200459 if (ldata->column > 0)
460 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000461 break;
462 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000463 if (!iscntrl(c)) {
464 if (O_OLCUC(tty))
465 c = toupper(c);
466 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200467 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000468 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000469 break;
470 }
471
472 tty_put_char(tty, c);
473 return 1;
474}
475
476/**
477 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 * @c: character (or partial unicode symbol)
479 * @tty: terminal device
480 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600481 * Output one character with OPOST processing.
482 * Returns -1 when the output device is full and the character
483 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000485 * Locking: output_lock to protect column state and space left
486 * (also, this is called from n_tty_write under the
487 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 */
Alan Cox4edf1822008-02-08 04:18:44 -0800489
Joe Petersona88a69c2009-01-02 13:40:53 +0000490static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491{
Jiri Slabybddc7152012-10-18 22:26:42 +0200492 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000493 int space, retval;
494
Jiri Slabybddc7152012-10-18 22:26:42 +0200495 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Alan Coxf34d7a52008-04-30 00:54:13 -0700497 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000498 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
Jiri Slabybddc7152012-10-18 22:26:42 +0200500 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000501 if (retval < 0)
502 return -1;
503 else
504 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505}
506
507/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000508 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600510 * @buf: character buffer
511 * @nr: number of bytes to output
512 *
513 * Output a block of characters with OPOST processing.
514 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 *
516 * This path is used to speed up block console writes, among other
517 * things when processing blocks of output data. It handles only
518 * the simple cases normally found and helps to generate blocks of
519 * symbols for the console driver and thus improve performance.
520 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000521 * Locking: output_lock to protect column state and space left
522 * (also, this is called from n_tty_write under the
523 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 */
Alan Cox4edf1822008-02-08 04:18:44 -0800525
Joe Petersona88a69c2009-01-02 13:40:53 +0000526static ssize_t process_output_block(struct tty_struct *tty,
527 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200529 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100531 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 const unsigned char *cp;
533
Jiri Slabybddc7152012-10-18 22:26:42 +0200534 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000535
Alan Coxf34d7a52008-04-30 00:54:13 -0700536 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000537 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200538 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000540 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 if (nr > space)
542 nr = space;
543
544 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000545 unsigned char c = *cp;
546
547 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 case '\n':
549 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200550 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 if (O_ONLCR(tty))
552 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200553 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 break;
555 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200556 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 goto break_out;
558 if (O_OCRNL(tty))
559 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200560 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 break;
562 case '\t':
563 goto break_out;
564 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200565 if (ldata->column > 0)
566 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 break;
568 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000569 if (!iscntrl(c)) {
570 if (O_OLCUC(tty))
571 goto break_out;
572 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200573 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 break;
576 }
577 }
578break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700579 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000580
Jiri Slabybddc7152012-10-18 22:26:42 +0200581 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 return i;
583}
584
Joe Petersona88a69c2009-01-02 13:40:53 +0000585/**
586 * process_echoes - write pending echo characters
587 * @tty: terminal device
588 *
589 * Write previously buffered echo (and other ldisc-generated)
590 * characters to the tty.
591 *
592 * Characters generated by the ldisc (including echoes) need to
593 * be buffered because the driver's write buffer can fill during
594 * heavy program output. Echoing straight to the driver will
595 * often fail under these conditions, causing lost characters and
596 * resulting mismatches of ldisc state information.
597 *
598 * Since the ldisc state must represent the characters actually sent
599 * to the driver at the time of the write, operations like certain
600 * changes in column state are also saved in the buffer and executed
601 * here.
602 *
603 * A circular fifo buffer is used so that the most recent characters
604 * are prioritized. Also, when control characters are echoed with a
605 * prefixed "^", the pair is treated atomically and thus not separated.
606 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400607 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000608 */
609
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400610static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000611{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200612 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400613 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400614 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000615 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000616
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400617 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000618
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400619 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400620 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400621 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000622 if (c == ECHO_OP_START) {
623 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000624 int no_space_left = 0;
625
626 /*
627 * If the buffer byte is the start of a multi-byte
628 * operation, get the next byte, which is either the
629 * op code or a control character value.
630 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400631 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000632
Joe Petersona88a69c2009-01-02 13:40:53 +0000633 switch (op) {
634 unsigned int num_chars, num_bs;
635
636 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400637 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000638
639 /*
640 * Determine how many columns to go back
641 * in order to erase the tab.
642 * This depends on the number of columns
643 * used by other characters within the tab
644 * area. If this (modulo 8) count is from
645 * the start of input rather than from a
646 * previous tab, we offset by canon column.
647 * Otherwise, tab spacing is normal.
648 */
649 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200650 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000651 num_bs = 8 - (num_chars & 7);
652
653 if (num_bs > space) {
654 no_space_left = 1;
655 break;
656 }
657 space -= num_bs;
658 while (num_bs--) {
659 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200660 if (ldata->column > 0)
661 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000662 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400663 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000664 break;
665
666 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200667 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400668 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000669 break;
670
671 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200672 if (ldata->column > 0)
673 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400674 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000675 break;
676
677 case ECHO_OP_START:
678 /* This is an escaped echo op start code */
679 if (!space) {
680 no_space_left = 1;
681 break;
682 }
683 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200684 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000685 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400686 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000687 break;
688
689 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000690 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600691 * If the op is not a special byte code,
692 * it is a ctrl char tagged to be echoed
693 * as "^X" (where X is the letter
694 * representing the control char).
695 * Note that we must ensure there is
696 * enough space for the whole ctrl pair.
697 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000698 */
Joe Peterson62b26352009-09-09 15:03:47 -0600699 if (space < 2) {
700 no_space_left = 1;
701 break;
702 }
703 tty_put_char(tty, '^');
704 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200705 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600706 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400707 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000708 }
709
710 if (no_space_left)
711 break;
712 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400713 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600714 int retval = do_output_char(c, tty, space);
715 if (retval < 0)
716 break;
717 space -= retval;
718 } else {
719 if (!space)
720 break;
721 tty_put_char(tty, c);
722 space -= 1;
723 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400724 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000725 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000726 }
727
Peter Hurleycbfd0342013-06-15 10:04:26 -0400728 /* If the echo buffer is nearly full (so that the possibility exists
729 * of echo overrun before the next commit), then discard enough
730 * data at the tail to prevent a subsequent overrun */
731 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
Roel Kluinc476f652013-10-11 22:08:49 +0200732 if (echo_buf(ldata, tail) == ECHO_OP_START) {
Peter Hurley6f222532013-11-08 09:42:18 -0500733 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400734 tail += 3;
735 else
736 tail += 2;
737 } else
738 tail++;
739 }
740
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400741 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400742 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000743}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Peter Hurley17bd7902013-06-15 10:04:24 -0400745static void commit_echoes(struct tty_struct *tty)
746{
747 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400748 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400749 size_t head;
750
751 head = ldata->echo_head;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500752 ldata->echo_mark = head;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400753 old = ldata->echo_commit - ldata->echo_tail;
754
755 /* Process committed echoes if the accumulated # of bytes
756 * is over the threshold (and try again each time another
757 * block is accumulated) */
758 nr = head - ldata->echo_tail;
759 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
760 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400761
Peter Hurley019ebdf2013-06-15 10:04:25 -0400762 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400763 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400764 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400765 mutex_unlock(&ldata->output_lock);
766
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400767 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400768 tty->ops->flush_chars(tty);
769}
770
771static void process_echoes(struct tty_struct *tty)
772{
773 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400774 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400775
Peter Hurleye2613be2014-02-11 16:34:55 -0500776 if (ldata->echo_mark == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400777 return;
778
779 mutex_lock(&ldata->output_lock);
Peter Hurley1075a6e2013-12-09 18:06:07 -0500780 ldata->echo_commit = ldata->echo_mark;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400781 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400782 mutex_unlock(&ldata->output_lock);
783
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400784 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400785 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400786}
787
Peter Hurley1075a6e2013-12-09 18:06:07 -0500788/* NB: echo_mark and echo_head should be equivalent here */
Peter Hurleycbfd0342013-06-15 10:04:26 -0400789static void flush_echoes(struct tty_struct *tty)
790{
791 struct n_tty_data *ldata = tty->disc_data;
792
Peter Hurley39434ab2013-11-29 12:56:10 -0500793 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
794 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400795 return;
796
797 mutex_lock(&ldata->output_lock);
798 ldata->echo_commit = ldata->echo_head;
799 __process_echoes(tty);
800 mutex_unlock(&ldata->output_lock);
801}
802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000804 * add_echo_byte - add a byte to the echo buffer
805 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200806 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000807 *
808 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000809 */
810
Peter Hurleycbfd0342013-06-15 10:04:26 -0400811static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000812{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400813 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000814}
815
816/**
817 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200818 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000819 *
820 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000821 */
822
Jiri Slaby57c94122012-10-18 22:26:43 +0200823static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000824{
Jiri Slaby57c94122012-10-18 22:26:43 +0200825 add_echo_byte(ECHO_OP_START, ldata);
826 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000827}
828
829/**
830 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200831 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000832 *
833 * Add an operation to the echo buffer to set the canon column
834 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000835 */
836
Jiri Slaby57c94122012-10-18 22:26:43 +0200837static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000838{
Jiri Slaby57c94122012-10-18 22:26:43 +0200839 add_echo_byte(ECHO_OP_START, ldata);
840 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000841}
842
843/**
844 * echo_erase_tab - add operation to erase a tab
845 * @num_chars: number of character columns already used
846 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200847 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000848 *
849 * Add an operation to the echo buffer to erase a tab.
850 *
851 * Called by the eraser function, which knows how many character
852 * columns have been used since either a previous tab or the start
853 * of input. This information will be used later, along with
854 * canon column (if applicable), to go back the correct number
855 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000856 */
857
858static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200859 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000860{
Jiri Slaby57c94122012-10-18 22:26:43 +0200861 add_echo_byte(ECHO_OP_START, ldata);
862 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000863
864 /* We only need to know this modulo 8 (tab spacing) */
865 num_chars &= 7;
866
867 /* Set the high bit as a flag if num_chars is after a previous tab */
868 if (after_tab)
869 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000870
Jiri Slaby57c94122012-10-18 22:26:43 +0200871 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000872}
873
874/**
875 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * @c: unicode byte to echo
877 * @tty: terminal device
878 *
Alan Cox4edf1822008-02-08 04:18:44 -0800879 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100881 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000882 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000883 */
884
Jiri Slaby57c94122012-10-18 22:26:43 +0200885static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000886{
Joe Petersona88a69c2009-01-02 13:40:53 +0000887 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200888 add_echo_byte(ECHO_OP_START, ldata);
889 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000890 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200891 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000892 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000893}
894
895/**
896 * echo_char - echo a character
897 * @c: unicode byte to echo
898 * @tty: terminal device
899 *
900 * Echo user input back onto the screen. This must be called only when
901 * L_ECHO(tty) is true. Called from the driver receive_buf path.
902 *
Joe Peterson62b26352009-09-09 15:03:47 -0600903 * This variant tags control characters to be echoed as "^X"
904 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 */
906
907static void echo_char(unsigned char c, struct tty_struct *tty)
908{
Jiri Slabybddc7152012-10-18 22:26:42 +0200909 struct n_tty_data *ldata = tty->disc_data;
910
Joe Petersona88a69c2009-01-02 13:40:53 +0000911 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200912 add_echo_byte(ECHO_OP_START, ldata);
913 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000914 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600915 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200916 add_echo_byte(ECHO_OP_START, ldata);
917 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000918 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919}
920
Alan Cox17b82062008-10-13 10:45:06 +0100921/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000922 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200923 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100924 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000925
Jiri Slaby57c94122012-10-18 22:26:43 +0200926static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200928 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200929 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200930 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 }
932}
933
934/**
935 * eraser - handle erase function
936 * @c: character input
937 * @tty: terminal device
938 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200939 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 * present in the stream from the driver layer. Handles the complexities
941 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100942 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400943 * n_tty_receive_buf()/producer path:
944 * caller holds non-exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 */
Alan Cox4edf1822008-02-08 04:18:44 -0800946
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947static void eraser(unsigned char c, struct tty_struct *tty)
948{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200949 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400951 size_t head;
952 size_t cnt;
953 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200955 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +0000956 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 return;
958 }
959 if (c == ERASE_CHAR(tty))
960 kill_type = ERASE;
961 else if (c == WERASE_CHAR(tty))
962 kill_type = WERASE;
963 else {
964 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200965 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 return;
967 }
968 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200969 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +0200970 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 echo_char(KILL_CHAR(tty), tty);
972 /* Add a newline if ECHOK is on and ECHOKE is off. */
973 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +0200974 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975 return;
976 }
977 kill_type = KILL;
978 }
979
980 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200981 while (ldata->read_head != ldata->canon_head) {
982 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
984 /* erase a single possibly multibyte character */
985 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400986 head--;
987 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200988 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
990 /* do not partially erase */
991 if (is_continuation(c, tty))
992 break;
993
994 if (kill_type == WERASE) {
995 /* Equivalent to BSD's ALTWERASE. */
996 if (isalnum(c) || c == '_')
997 seen_alnums++;
998 else if (seen_alnums)
999 break;
1000 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001001 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001002 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 if (L_ECHO(tty)) {
1004 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001005 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001006 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001007 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 }
1009 /* if cnt > 1, output a multi-byte character */
1010 echo_char(c, tty);
1011 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001012 head++;
1013 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001014 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 }
1016 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1017 echo_char(ERASE_CHAR(tty), tty);
1018 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001019 unsigned int num_chars = 0;
1020 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001021 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Joe Petersona88a69c2009-01-02 13:40:53 +00001023 /*
1024 * Count the columns used for characters
1025 * since the start of input or after a
1026 * previous tab.
1027 * This info is used to go back the correct
1028 * number of columns.
1029 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001030 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001031 tail--;
1032 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001033 if (c == '\t') {
1034 after_tab = 1;
1035 break;
Alan Cox300a6202009-01-02 13:41:04 +00001036 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001038 num_chars += 2;
1039 } else if (!is_continuation(c, tty)) {
1040 num_chars++;
1041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001043 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 } else {
1045 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001046 echo_char_raw('\b', ldata);
1047 echo_char_raw(' ', ldata);
1048 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 }
1050 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001051 echo_char_raw('\b', ldata);
1052 echo_char_raw(' ', ldata);
1053 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 }
1055 }
1056 }
1057 if (kill_type == ERASE)
1058 break;
1059 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001060 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001061 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062}
1063
1064/**
1065 * isig - handle the ISIG optio
1066 * @sig: signal
1067 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001069 * Called when a signal is being sent due to terminal input.
1070 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001071 *
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001072 * Performs input and output flush if !NOFLSH. In this context, the echo
1073 * buffer is 'output'. The signal is processed first to alert any current
1074 * readers or writers to discontinue and exit their i/o loops.
1075 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001076 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 */
Alan Cox4edf1822008-02-08 04:18:44 -08001078
Peter Hurley3b19e032015-06-27 09:21:32 -04001079static void __isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080{
Peter Hurley8c985d12013-03-06 08:38:19 -05001081 struct pid *tty_pgrp = tty_get_pgrp(tty);
1082 if (tty_pgrp) {
1083 kill_pgrp(tty_pgrp, sig, 1);
1084 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 }
Peter Hurley3b19e032015-06-27 09:21:32 -04001086}
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001087
Peter Hurley3b19e032015-06-27 09:21:32 -04001088static void isig(int sig, struct tty_struct *tty)
1089{
1090 struct n_tty_data *ldata = tty->disc_data;
1091
1092 if (L_NOFLSH(tty)) {
1093 /* signal only */
1094 __isig(sig, tty);
1095
1096 } else { /* signal and flush */
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001097 up_read(&tty->termios_rwsem);
1098 down_write(&tty->termios_rwsem);
1099
Peter Hurley3b19e032015-06-27 09:21:32 -04001100 __isig(sig, tty);
1101
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001102 /* clear echo buffer */
1103 mutex_lock(&ldata->output_lock);
1104 ldata->echo_head = ldata->echo_tail = 0;
1105 ldata->echo_mark = ldata->echo_commit = 0;
1106 mutex_unlock(&ldata->output_lock);
1107
1108 /* clear output buffer */
1109 tty_driver_flush_buffer(tty);
1110
1111 /* clear input buffer */
1112 reset_buffer_flags(tty->disc_data);
1113
1114 /* notify pty master of flush */
1115 if (tty->link)
1116 n_tty_packet_mode_flush(tty);
1117
1118 up_write(&tty->termios_rwsem);
1119 down_read(&tty->termios_rwsem);
1120 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121}
1122
1123/**
1124 * n_tty_receive_break - handle break
1125 * @tty: terminal
1126 *
1127 * An RS232 break event has been hit in the incoming bitstream. This
1128 * can cause a variety of events depending upon the termios settings.
1129 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001130 * n_tty_receive_buf()/producer path:
1131 * caller holds non-exclusive termios_rwsem
Peter Hurley6d76bd22013-06-15 09:14:26 -04001132 *
1133 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 */
Alan Cox4edf1822008-02-08 04:18:44 -08001135
Peter Hurley4b293492013-07-24 08:29:55 -04001136static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137{
Jiri Slaby57c94122012-10-18 22:26:43 +02001138 struct n_tty_data *ldata = tty->disc_data;
1139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 if (I_IGNBRK(tty))
1141 return;
1142 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001143 isig(SIGINT, tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 return;
1145 }
1146 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001147 put_tty_queue('\377', ldata);
1148 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001150 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151}
1152
1153/**
1154 * n_tty_receive_overrun - handle overrun reporting
1155 * @tty: terminal
1156 *
1157 * Data arrived faster than we could process it. While the tty
1158 * driver has flagged this the bits that were missed are gone
1159 * forever.
1160 *
1161 * Called from the receive_buf path so single threaded. Does not
1162 * need locking as num_overrun and overrun_time are function
1163 * private.
1164 */
Alan Cox4edf1822008-02-08 04:18:44 -08001165
Peter Hurley4b293492013-07-24 08:29:55 -04001166static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001168 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001170 ldata->num_overrun++;
1171 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1172 time_after(ldata->overrun_time, jiffies)) {
Peter Hurley339f36b2015-11-08 13:01:13 -05001173 tty_warn(tty, "%d input overrun(s)\n", ldata->num_overrun);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001174 ldata->overrun_time = jiffies;
1175 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 }
1177}
1178
1179/**
1180 * n_tty_receive_parity_error - error notifier
1181 * @tty: terminal device
1182 * @c: character
1183 *
1184 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001185 * the error case if necessary.
1186 *
1187 * n_tty_receive_buf()/producer path:
1188 * caller holds non-exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 */
Peter Hurley4b293492013-07-24 08:29:55 -04001190static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
Jiri Slaby57c94122012-10-18 22:26:43 +02001192 struct n_tty_data *ldata = tty->disc_data;
1193
Peter Hurley66528f92014-06-16 08:10:42 -04001194 if (I_INPCK(tty)) {
1195 if (I_IGNPAR(tty))
1196 return;
1197 if (I_PARMRK(tty)) {
1198 put_tty_queue('\377', ldata);
1199 put_tty_queue('\0', ldata);
1200 put_tty_queue(c, ldata);
1201 } else
1202 put_tty_queue('\0', ldata);
1203 } else
Jiri Slaby57c94122012-10-18 22:26:43 +02001204 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205}
1206
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001207static void
1208n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1209{
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001210 isig(signal, tty);
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001211 if (I_IXON(tty))
1212 start_tty(tty);
1213 if (L_ECHO(tty)) {
1214 echo_char(c, tty);
1215 commit_echoes(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001216 } else
1217 process_echoes(tty);
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001218 return;
1219}
1220
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221/**
1222 * n_tty_receive_char - perform processing
1223 * @tty: terminal device
1224 * @c: character
1225 *
1226 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001227 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001229 *
1230 * n_tty_receive_buf()/producer path:
1231 * caller holds non-exclusive termios_rwsem
1232 * publishes canon_head if canonical mode is active
Peter Hurleye60d27c2013-07-24 08:29:56 -04001233 *
1234 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 */
1236
Peter Hurleye60d27c2013-07-24 08:29:56 -04001237static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001238n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001240 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 if (I_IXON(tty)) {
1243 if (c == START_CHAR(tty)) {
1244 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001245 process_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001246 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 }
1248 if (c == STOP_CHAR(tty)) {
1249 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001250 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 }
1252 }
Joe Peterson575537b32008-04-30 00:53:30 -07001253
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001255 if (c == INTR_CHAR(tty)) {
1256 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001257 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001258 } else if (c == QUIT_CHAR(tty)) {
1259 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001260 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001261 } else if (c == SUSP_CHAR(tty)) {
1262 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001263 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 }
1265 }
Joe Peterson575537b32008-04-30 00:53:30 -07001266
Peter Hurley855df3c2013-07-24 08:29:50 -04001267 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1268 start_tty(tty);
1269 process_echoes(tty);
1270 }
1271
Joe Peterson575537b32008-04-30 00:53:30 -07001272 if (c == '\r') {
1273 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001274 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001275 if (I_ICRNL(tty))
1276 c = '\n';
1277 } else if (c == '\n' && I_INLCR(tty))
1278 c = '\r';
1279
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001280 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1282 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1283 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001284 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001285 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 }
1287 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001288 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001290 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001292 echo_char_raw('^', ldata);
1293 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001294 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 }
1296 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001297 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001299 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001300 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301
Jiri Slaby57c94122012-10-18 22:26:43 +02001302 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001304 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001305 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001306 echo_char(read_buf(ldata, tail), tty);
1307 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001309 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001310 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 }
1312 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001313 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001314 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001315 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 }
1317 goto handle_newline;
1318 }
1319 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 c = __DISABLED_CHAR;
1321 goto handle_newline;
1322 }
1323 if ((c == EOL_CHAR(tty)) ||
1324 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1325 /*
1326 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1327 */
1328 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001330 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001331 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001333 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 }
1335 /*
1336 * XXX does PARMRK doubling happen for
1337 * EOL_CHAR and EOL2_CHAR?
1338 */
Peter Hurley001ba922013-12-02 14:24:44 -05001339 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001340 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Alan Cox4edf1822008-02-08 04:18:44 -08001342handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001343 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001344 put_tty_queue(c, ldata);
Peter Hurley70aca712015-01-16 15:05:37 -05001345 smp_store_release(&ldata->canon_head, ldata->read_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
Kosuke Tatsukawae81107d2015-10-02 08:27:05 +00001347 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001348 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 }
1350 }
Alan Cox4edf1822008-02-08 04:18:44 -08001351
Joe Petersonacc71bb2009-01-02 13:43:32 +00001352 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001353 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001355 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 else {
1357 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001358 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001359 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 echo_char(c, tty);
1361 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001362 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 }
1364
Peter Hurley001ba922013-12-02 14:24:44 -05001365 /* PARMRK doubling check */
1366 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001367 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
Jiri Slaby57c94122012-10-18 22:26:43 +02001369 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001370 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001371}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
Peter Hurleye60d27c2013-07-24 08:29:56 -04001373static inline void
1374n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001375{
1376 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001377
Peter Hurleye60d27c2013-07-24 08:29:56 -04001378 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1379 start_tty(tty);
1380 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001381 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001382 if (L_ECHO(tty)) {
1383 finish_erasing(ldata);
1384 /* Record the column of first canon char. */
1385 if (ldata->canon_head == ldata->read_head)
1386 echo_set_canon_col(ldata);
1387 echo_char(c, tty);
1388 commit_echoes(tty);
1389 }
Peter Hurley001ba922013-12-02 14:24:44 -05001390 /* PARMRK doubling check */
1391 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001392 put_tty_queue(c, ldata);
1393 put_tty_queue(c, ldata);
1394}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001395
Peter Hurleyeb3e4662013-12-02 14:24:42 -05001396static void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
Peter Hurleye60d27c2013-07-24 08:29:56 -04001397{
1398 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001399}
1400
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001401static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001402n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1403{
1404 struct n_tty_data *ldata = tty->disc_data;
1405
Peter Hurleye60d27c2013-07-24 08:29:56 -04001406 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1407 start_tty(tty);
1408 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001409 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001410 if (L_ECHO(tty)) {
1411 finish_erasing(ldata);
1412 /* Record the column of first canon char. */
1413 if (ldata->canon_head == ldata->read_head)
1414 echo_set_canon_col(ldata);
1415 echo_char(c, tty);
1416 commit_echoes(tty);
1417 }
1418 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001419}
1420
Peter Hurley8dc4b252013-12-02 14:24:43 -05001421static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001422{
1423 if (I_ISTRIP(tty))
1424 c &= 0x7f;
1425 if (I_IUCLC(tty) && L_IEXTEN(tty))
1426 c = tolower(c);
1427
1428 if (I_IXON(tty)) {
1429 if (c == STOP_CHAR(tty))
1430 stop_tty(tty);
1431 else if (c == START_CHAR(tty) ||
1432 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1433 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1434 c != SUSP_CHAR(tty))) {
1435 start_tty(tty);
1436 process_echoes(tty);
1437 }
1438 }
1439}
1440
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001441static void
1442n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1443{
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001444 switch (flag) {
1445 case TTY_BREAK:
1446 n_tty_receive_break(tty);
1447 break;
1448 case TTY_PARITY:
1449 case TTY_FRAME:
1450 n_tty_receive_parity_error(tty, c);
1451 break;
1452 case TTY_OVERRUN:
1453 n_tty_receive_overrun(tty);
1454 break;
1455 default:
Peter Hurley339f36b2015-11-08 13:01:13 -05001456 tty_err(tty, "unknown flag %d\n", flag);
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001457 break;
1458 }
1459}
1460
Peter Hurleye60d27c2013-07-24 08:29:56 -04001461static void
1462n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1463{
1464 struct n_tty_data *ldata = tty->disc_data;
1465
1466 ldata->lnext = 0;
1467 if (likely(flag == TTY_NORMAL)) {
1468 if (I_ISTRIP(tty))
1469 c &= 0x7f;
1470 if (I_IUCLC(tty) && L_IEXTEN(tty))
1471 c = tolower(c);
1472 n_tty_receive_char(tty, c);
1473 } else
1474 n_tty_receive_char_flagged(tty, c, flag);
1475}
1476
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001477static void
1478n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1479 char *fp, int count)
1480{
1481 struct n_tty_data *ldata = tty->disc_data;
1482 size_t n, head;
1483
1484 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
Peter Hurley70aca712015-01-16 15:05:37 -05001485 n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001486 memcpy(read_buf_addr(ldata, head), cp, n);
1487 ldata->read_head += n;
1488 cp += n;
1489 count -= n;
1490
1491 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
Peter Hurley70aca712015-01-16 15:05:37 -05001492 n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001493 memcpy(read_buf_addr(ldata, head), cp, n);
1494 ldata->read_head += n;
1495}
1496
Peter Hurley554117bd2013-06-15 10:21:25 -04001497static void
1498n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1499 char *fp, int count)
1500{
1501 struct n_tty_data *ldata = tty->disc_data;
1502 char flag = TTY_NORMAL;
1503
1504 while (count--) {
1505 if (fp)
1506 flag = *fp++;
1507 if (likely(flag == TTY_NORMAL))
1508 put_tty_queue(*cp++, ldata);
1509 else
1510 n_tty_receive_char_flagged(tty, *cp++, flag);
1511 }
1512}
1513
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001514static void
1515n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1516 char *fp, int count)
1517{
1518 char flag = TTY_NORMAL;
1519
1520 while (count--) {
1521 if (fp)
1522 flag = *fp++;
1523 if (likely(flag == TTY_NORMAL))
1524 n_tty_receive_char_closing(tty, *cp++);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001525 }
1526}
1527
Peter Hurley7d88d632013-07-24 08:29:49 -04001528static void
1529n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001530 char *fp, int count)
1531{
1532 struct n_tty_data *ldata = tty->disc_data;
1533 char flag = TTY_NORMAL;
1534
1535 while (count--) {
1536 if (fp)
1537 flag = *fp++;
1538 if (likely(flag == TTY_NORMAL)) {
1539 unsigned char c = *cp++;
1540
1541 if (I_ISTRIP(tty))
1542 c &= 0x7f;
1543 if (I_IUCLC(tty) && L_IEXTEN(tty))
1544 c = tolower(c);
1545 if (L_EXTPROC(tty)) {
1546 put_tty_queue(c, ldata);
1547 continue;
1548 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001549 if (!test_bit(c, ldata->char_map))
1550 n_tty_receive_char_inline(tty, c);
1551 else if (n_tty_receive_char_special(tty, c) && count) {
1552 if (fp)
1553 flag = *fp++;
1554 n_tty_receive_char_lnext(tty, *cp++, flag);
1555 count--;
1556 }
Peter Hurley6baad002013-07-24 08:29:52 -04001557 } else
1558 n_tty_receive_char_flagged(tty, *cp++, flag);
1559 }
1560}
1561
1562static void
1563n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1564 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001565{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001566 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001567 char flag = TTY_NORMAL;
1568
1569 while (count--) {
1570 if (fp)
1571 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001572 if (likely(flag == TTY_NORMAL)) {
1573 unsigned char c = *cp++;
1574
1575 if (!test_bit(c, ldata->char_map))
1576 n_tty_receive_char_fast(tty, c);
1577 else if (n_tty_receive_char_special(tty, c) && count) {
1578 if (fp)
1579 flag = *fp++;
1580 n_tty_receive_char_lnext(tty, *cp++, flag);
1581 count--;
1582 }
1583 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001584 n_tty_receive_char_flagged(tty, *cp++, flag);
1585 }
1586}
1587
Peter Hurley24a89d12013-06-15 09:14:15 -04001588static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1589 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001591 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001592 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001594 if (ldata->real_raw)
1595 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001596 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117bd2013-06-15 10:21:25 -04001597 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001598 else if (tty->closing && !L_EXTPROC(tty))
1599 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001600 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001601 if (ldata->lnext) {
1602 char flag = TTY_NORMAL;
1603
1604 if (fp)
1605 flag = *fp++;
1606 n_tty_receive_char_lnext(tty, *cp++, flag);
1607 count--;
1608 }
1609
Peter Hurley7de971b2013-07-24 08:29:53 -04001610 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001611 n_tty_receive_buf_fast(tty, cp, fp, count);
1612 else
1613 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001614
1615 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001616 if (tty->ops->flush_chars)
1617 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 }
1619
Peter Hurley70aca712015-01-16 15:05:37 -05001620 if (ldata->icanon && !L_EXTPROC(tty))
1621 return;
1622
1623 /* publish read_head to consumer */
1624 smp_store_release(&ldata->commit_head, ldata->read_head);
1625
Peter Hurley33d71362016-01-09 21:45:08 -08001626 if (read_cnt(ldata)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
Kosuke Tatsukawae81107d2015-10-02 08:27:05 +00001628 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630}
1631
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001632/**
1633 * n_tty_receive_buf_common - process input
1634 * @tty: device to receive input
1635 * @cp: input chars
1636 * @fp: flags for each char (if NULL, all chars are TTY_NORMAL)
1637 * @count: number of input chars in @cp
1638 *
1639 * Called by the terminal driver when a block of characters has
1640 * been received. This function must be called from soft contexts
1641 * not from interrupt context. The driver is responsible for making
1642 * calls one at a time and in order (or using flush_to_ldisc)
1643 *
1644 * Returns the # of input chars from @cp which were processed.
1645 *
1646 * In canonical mode, the maximum line length is 4096 chars (including
1647 * the line termination char); lines longer than 4096 chars are
1648 * truncated. After 4095 chars, input data is still processed but
1649 * not stored. Overflow processing ensures the tty can always
1650 * receive more input until at least one line can be read.
1651 *
1652 * In non-canonical mode, the read buffer will only accept 4095 chars;
1653 * this provides the necessary space for a newline char if the input
1654 * mode is switched to canonical.
1655 *
1656 * Note it is possible for the read buffer to _contain_ 4096 chars
1657 * in non-canonical mode: the read buffer could already contain the
1658 * maximum canon line of 4096 chars when the mode is switched to
1659 * non-canonical.
1660 *
1661 * n_tty_receive_buf()/producer path:
1662 * claims non-exclusive termios_rwsem
1663 * publishes commit_head or canon_head
1664 */
Peter Hurley5c32d122013-12-02 14:24:41 -05001665static int
1666n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1667 char *fp, int count, int flow)
Peter Hurley24a89d12013-06-15 09:14:15 -04001668{
1669 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001670 int room, n, rcvd = 0, overflow;
Peter Hurley24a89d12013-06-15 09:14:15 -04001671
Peter Hurley9356b532013-06-15 09:14:24 -04001672 down_read(&tty->termios_rwsem);
1673
Peter Hurley19e2ad62013-07-24 08:29:54 -04001674 while (1) {
Peter Hurley70aca712015-01-16 15:05:37 -05001675 /*
Peter Hurley06c49f92015-01-16 15:05:38 -05001676 * When PARMRK is set, each input char may take up to 3 chars
1677 * in the read buf; reduce the buffer space avail by 3x
Peter Hurley70aca712015-01-16 15:05:37 -05001678 *
1679 * If we are doing input canonicalization, and there are no
1680 * pending newlines, let characters through without limit, so
1681 * that erase characters will be handled. Other excess
1682 * characters will be beeped.
1683 *
1684 * paired with store in *_copy_from_read_buf() -- guarantees
1685 * the consumer has loaded the data in read_buf up to the new
1686 * read_tail (so this producer will not overwrite unread data)
1687 */
1688 size_t tail = smp_load_acquire(&ldata->read_tail);
Peter Hurley70aca712015-01-16 15:05:37 -05001689
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001690 room = N_TTY_BUF_SIZE - (ldata->read_head - tail);
Peter Hurley70aca712015-01-16 15:05:37 -05001691 if (I_PARMRK(tty))
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001692 room = (room + 2) / 3;
1693 room--;
1694 if (room <= 0) {
1695 overflow = ldata->icanon && ldata->canon_head == tail;
1696 if (overflow && room < 0)
1697 ldata->read_head--;
1698 room = overflow;
1699 ldata->no_room = flow && !room;
1700 } else
1701 overflow = 0;
Peter Hurley70aca712015-01-16 15:05:37 -05001702
Peter Hurley19e2ad62013-07-24 08:29:54 -04001703 n = min(count, room);
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001704 if (!n)
Peter Hurley19e2ad62013-07-24 08:29:54 -04001705 break;
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001706
1707 /* ignore parity errors if handling overflow */
1708 if (!overflow || !fp || *fp != TTY_PARITY)
1709 __receive_buf(tty, cp, fp, n);
1710
Peter Hurley19e2ad62013-07-24 08:29:54 -04001711 cp += n;
1712 if (fp)
1713 fp += n;
1714 count -= n;
1715 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001716 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001717
Peter Hurley19e2ad62013-07-24 08:29:54 -04001718 tty->receive_room = room;
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001719
1720 /* Unthrottle if handling overflow on pty */
1721 if (tty->driver->type == TTY_DRIVER_TYPE_PTY) {
1722 if (overflow) {
1723 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
1724 tty_unthrottle_safe(tty);
1725 __tty_set_flow_change(tty, 0);
1726 }
1727 } else
1728 n_tty_check_throttle(tty);
1729
Peter Hurley9356b532013-06-15 09:14:24 -04001730 up_read(&tty->termios_rwsem);
1731
Peter Hurley19e2ad62013-07-24 08:29:54 -04001732 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001733}
1734
Peter Hurley5c32d122013-12-02 14:24:41 -05001735static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1736 char *fp, int count)
1737{
1738 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1739}
1740
1741static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1742 char *fp, int count)
1743{
1744 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1745}
1746
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747/**
1748 * n_tty_set_termios - termios data changed
1749 * @tty: terminal
1750 * @old: previous data
1751 *
1752 * Called by the tty layer when the user changes termios flags so
1753 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001754 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 * guaranteed that this function will not be re-entered or in progress
1756 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001757 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001758 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 */
Alan Cox4edf1822008-02-08 04:18:44 -08001760
1761static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001763 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001764
Linus Torvalds966031f2017-12-20 17:57:06 -08001765 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & (ICANON | EXTPROC)) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001766 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -05001767 ldata->line_start = ldata->read_tail;
1768 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1769 ldata->canon_head = ldata->read_tail;
1770 ldata->push = 0;
1771 } else {
1772 set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1773 ldata->read_flags);
1774 ldata->canon_head = ldata->read_head;
1775 ldata->push = 1;
1776 }
Peter Hurley70aca712015-01-16 15:05:37 -05001777 ldata->commit_head = ldata->read_head;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001778 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001779 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001780 }
1781
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001782 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001783
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1785 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1786 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1787 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001788 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789
1790 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001791 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001793 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
1795 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001796 set_bit(ERASE_CHAR(tty), ldata->char_map);
1797 set_bit(KILL_CHAR(tty), ldata->char_map);
1798 set_bit(EOF_CHAR(tty), ldata->char_map);
1799 set_bit('\n', ldata->char_map);
1800 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001802 set_bit(WERASE_CHAR(tty), ldata->char_map);
1803 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1804 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 if (L_ECHO(tty))
1806 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001807 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 }
1809 }
1810 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001811 set_bit(START_CHAR(tty), ldata->char_map);
1812 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 }
1814 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001815 set_bit(INTR_CHAR(tty), ldata->char_map);
1816 set_bit(QUIT_CHAR(tty), ldata->char_map);
1817 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001819 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001820 ldata->raw = 0;
1821 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001823 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1825 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1826 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001827 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001829 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001831 /*
1832 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1833 * been stopped by STOP_CHAR(tty) before it.
1834 */
Peter Hurleye2613be2014-02-11 16:34:55 -05001835 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
Wang YanQingdab73b42013-05-09 14:16:47 +08001836 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001837 process_echoes(tty);
1838 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001839
Alan Coxf34d7a52008-04-30 00:54:13 -07001840 /* The termios change make the tty ready for I/O */
Kosuke Tatsukawae81107d2015-10-02 08:27:05 +00001841 wake_up_interruptible(&tty->write_wait);
1842 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843}
1844
1845/**
1846 * n_tty_close - close the ldisc for this tty
1847 * @tty: device
1848 *
Alan Cox4edf1822008-02-08 04:18:44 -08001849 * Called from the terminal layer when this line discipline is
1850 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 * discipline change. The function will not be called while other
1852 * ldisc methods are in progress.
1853 */
Alan Cox4edf1822008-02-08 04:18:44 -08001854
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855static void n_tty_close(struct tty_struct *tty)
1856{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001857 struct n_tty_data *ldata = tty->disc_data;
1858
Peter Hurley79901312013-03-11 16:44:23 -04001859 if (tty->link)
1860 n_tty_packet_mode_flush(tty);
1861
Peter Hurley20bafb32013-06-15 10:21:19 -04001862 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001863 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864}
1865
1866/**
1867 * n_tty_open - open an ldisc
1868 * @tty: terminal to open
1869 *
Alan Cox4edf1822008-02-08 04:18:44 -08001870 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 * terminal device. Can sleep. Called serialized so that no
1872 * other events will occur in parallel. No further open will occur
1873 * until a close.
1874 */
1875
1876static int n_tty_open(struct tty_struct *tty)
1877{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001878 struct n_tty_data *ldata;
1879
Peter Hurley20bafb32013-06-15 10:21:19 -04001880 /* Currently a malloc failure here can panic */
1881 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001882 if (!ldata)
1883 goto err;
1884
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001885 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001886 mutex_init(&ldata->atomic_read_lock);
1887 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001888
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001889 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001890 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001891 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001892 ldata->canon_column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001893 ldata->num_overrun = 0;
1894 ldata->no_room = 0;
1895 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001897 /* indicate buffer work may resume */
1898 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1899 n_tty_set_termios(tty, NULL);
1900 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001901
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001903err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001904 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905}
1906
Peter Hurleyeafbe672013-12-02 14:24:45 -05001907static inline int input_available_p(struct tty_struct *tty, int poll)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001909 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya5934802014-02-11 11:49:58 -05001910 int amt = poll && !TIME_CHAR(tty) && MIN_CHAR(tty) ? MIN_CHAR(tty) : 1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001911
Peter Hurley25e8d0e2014-02-11 18:55:30 -05001912 if (ldata->icanon && !L_EXTPROC(tty))
1913 return ldata->canon_head != ldata->read_tail;
1914 else
Peter Hurley70aca712015-01-16 15:05:37 -05001915 return ldata->commit_head - ldata->read_tail >= amt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916}
1917
1918/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001919 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 * @tty: terminal device
1921 * @b: user data
1922 * @nr: size of data
1923 *
Alan Cox11a96d12008-10-13 10:46:24 +01001924 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 * ICANON is off; it copies characters straight from the tty queue to
1926 * user space directly. It can be profitably called twice; once to
1927 * drain the space from the tail pointer to the (physical) end of the
1928 * buffer, and once to drain the space from the (physical) beginning of
1929 * the buffer to head pointer.
1930 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001931 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001933 * n_tty_read()/consumer path:
1934 * caller holds non-exclusive termios_rwsem
1935 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 */
Alan Cox4edf1822008-02-08 04:18:44 -08001937
Alan Cox33f0f882006-01-09 20:54:13 -08001938static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 unsigned char __user **b,
1940 size_t *nr)
1941
1942{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001943 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 int retval;
1945 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001946 bool is_eof;
Peter Hurley70aca712015-01-16 15:05:37 -05001947 size_t head = smp_load_acquire(&ldata->commit_head);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001948 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
1950 retval = 0;
Peter Hurley70aca712015-01-16 15:05:37 -05001951 n = min(head - ldata->read_tail, N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 if (n) {
Peter Hurleye661cf72015-11-27 14:11:03 -05001954 const unsigned char *from = read_buf_addr(ldata, tail);
1955 retval = copy_to_user(*b, from, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 n -= retval;
Peter Hurleye661cf72015-11-27 14:11:03 -05001957 is_eof = n == 1 && *from == EOF_CHAR(tty);
Peter Hurley309426a2016-01-09 22:55:27 -08001958 tty_audit_add_data(tty, from, n);
Peter Hurley70aca712015-01-16 15:05:37 -05001959 smp_store_release(&ldata->read_tail, ldata->read_tail + n);
hyc@symas.com26df6d12010-06-22 10:14:49 -07001960 /* Turn single EOF into zero-length read */
Peter Hurley70aca712015-01-16 15:05:37 -05001961 if (L_EXTPROC(tty) && ldata->icanon && is_eof &&
1962 (head == ldata->read_tail))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001963 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 *b += n;
1965 *nr -= n;
1966 }
1967 return retval;
1968}
1969
Peter Hurley88bb0de2013-06-15 09:14:16 -04001970/**
Peter Hurley32f13522013-06-15 09:14:17 -04001971 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001972 * @tty: terminal device
1973 * @b: user data
1974 * @nr: size of data
1975 *
1976 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001977 * it copies one line of input up to and including the line-delimiting
1978 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001979 *
Peter Hurley4d0ed182013-12-10 17:12:02 -05001980 * NB: When termios is changed from non-canonical to canonical mode and
1981 * the read buffer contains data, n_tty_set_termios() simulates an EOF
1982 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
1983 * This causes data already processed as input to be immediately available
1984 * as input although a newline has not been received.
1985 *
Peter Hurley88bb0de2013-06-15 09:14:16 -04001986 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001987 *
1988 * n_tty_read()/consumer path:
1989 * caller holds non-exclusive termios_rwsem
1990 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001991 */
1992
Peter Hurley32f13522013-06-15 09:14:17 -04001993static int canon_copy_from_read_buf(struct tty_struct *tty,
1994 unsigned char __user **b,
1995 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001996{
1997 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001998 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001999 size_t eol;
2000 size_t tail;
2001 int ret, found = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002002
2003 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05002004 if (!*nr)
Peter Hurley32f13522013-06-15 09:14:17 -04002005 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002006
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05002007 n = min(*nr + 1, smp_load_acquire(&ldata->canon_head) - ldata->read_tail);
2008
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002009 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04002010 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
2011
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002012 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002013 __func__, *nr, tail, n, size);
2014
2015 eol = find_next_bit(ldata->read_flags, size, tail);
2016 more = n - (size - tail);
2017 if (eol == N_TTY_BUF_SIZE && more) {
2018 /* scan wrapped without finding set bit */
2019 eol = find_next_bit(ldata->read_flags, more, 0);
Peter Hurleyb985e9e2015-11-27 14:11:04 -05002020 found = eol != more;
2021 } else
2022 found = eol != size;
Peter Hurley32f13522013-06-15 09:14:17 -04002023
Peter Hurleyc77569d2013-11-22 07:16:25 -05002024 n = eol - tail;
Mark Tomlinsonda555db2015-05-18 12:01:48 +12002025 if (n > N_TTY_BUF_SIZE)
2026 n += N_TTY_BUF_SIZE;
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05002027 c = n + found;
Peter Hurley32f13522013-06-15 09:14:17 -04002028
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05002029 if (!found || read_buf(ldata, eol) != __DISABLED_CHAR) {
2030 c = min(*nr, c);
2031 n = c;
Peter Hurley40d5e092013-06-15 10:21:17 -04002032 }
Peter Hurley32f13522013-06-15 09:14:17 -04002033
Peter Hurley679e7c22015-11-27 14:11:02 -05002034 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu tail:%zu more:%zu\n",
2035 __func__, eol, found, n, c, tail, more);
Peter Hurley32f13522013-06-15 09:14:17 -04002036
Peter Hurley679e7c22015-11-27 14:11:02 -05002037 ret = tty_copy_to_user(tty, *b, tail, n);
Peter Hurley32f13522013-06-15 09:14:17 -04002038 if (ret)
2039 return -EFAULT;
2040 *b += n;
2041 *nr -= n;
2042
Peter Hurleya73d3d62013-06-15 09:14:25 -04002043 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002044 clear_bit(eol, ldata->read_flags);
Peter Hurley70aca712015-01-16 15:05:37 -05002045 smp_store_release(&ldata->read_tail, ldata->read_tail + c);
Peter Hurley88bb0de2013-06-15 09:14:16 -04002046
Peter Hurley40d5e092013-06-15 10:21:17 -04002047 if (found) {
Peter Hurley4d0ed182013-12-10 17:12:02 -05002048 if (!ldata->push)
2049 ldata->line_start = ldata->read_tail;
2050 else
2051 ldata->push = 0;
Peter Hurleyb50819f2016-01-09 22:55:30 -08002052 tty_audit_push();
Peter Hurley40d5e092013-06-15 10:21:17 -04002053 }
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05002054 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002055}
2056
Al Virocc4191d2008-03-29 03:08:48 +00002057extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002058 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059
2060/**
2061 * job_control - check job control
2062 * @tty: tty
2063 * @file: file handle
2064 *
2065 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002066 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002068 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002069 * Locking: redirected write test is safe
2070 * current->signal->tty check is safe
2071 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 */
Alan Cox4edf1822008-02-08 04:18:44 -08002073
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074static int job_control(struct tty_struct *tty, struct file *file)
2075{
2076 /* Job control check -- must be done at start and after
2077 every sleep (POSIX.1 7.1.1.4). */
2078 /* NOTE: not yet done after every sleep pending a thorough
2079 check of the logic of this change. -- jlc */
2080 /* don't stop on /dev/console */
Peter Hurley2812d9e2015-10-10 20:28:42 -04002081 if (file->f_op->write == redirected_tty_write)
Peter Hurley01a5e442013-03-06 08:38:20 -05002082 return 0;
2083
Peter Hurley2812d9e2015-10-10 20:28:42 -04002084 return __tty_check_change(tty, SIGTTIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085}
Alan Cox4edf1822008-02-08 04:18:44 -08002086
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
2088/**
Alan Cox11a96d12008-10-13 10:46:24 +01002089 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 * @tty: tty device
2091 * @file: file object
2092 * @buf: userspace buffer pointer
2093 * @nr: size of I/O
2094 *
2095 * Perform reads for the line discipline. We are guaranteed that the
2096 * line discipline will not be closed under us but we may get multiple
2097 * parallel readers and must handle this ourselves. We may also get
2098 * a hangup. Always called in user context, may sleep.
2099 *
2100 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002101 *
2102 * n_tty_read()/consumer path:
2103 * claims non-exclusive termios_rwsem
2104 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 */
Alan Cox4edf1822008-02-08 04:18:44 -08002106
Alan Cox11a96d12008-10-13 10:46:24 +01002107static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 unsigned char __user *buf, size_t nr)
2109{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002110 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 unsigned char __user *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002112 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002113 int c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 int minimum, time;
2115 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 long timeout;
Alan Cox04f378b2008-04-30 00:53:29 -07002117 int packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002118 size_t tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002121 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002123
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002124 /*
2125 * Internal serialization of reads.
2126 */
2127 if (file->f_flags & O_NONBLOCK) {
2128 if (!mutex_trylock(&ldata->atomic_read_lock))
2129 return -EAGAIN;
2130 } else {
2131 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2132 return -ERESTARTSYS;
2133 }
2134
Peter Hurley9356b532013-06-15 09:14:24 -04002135 down_read(&tty->termios_rwsem);
2136
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 minimum = time = 0;
2138 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002139 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 minimum = MIN_CHAR(tty);
2141 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002142 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002144 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurley33d71362016-01-09 21:45:08 -08002145 minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 }
2147 }
2148
Alan Cox04f378b2008-04-30 00:53:29 -07002149 packet = tty->packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002150 tail = ldata->read_tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151
2152 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 while (nr) {
2154 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002155 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 unsigned char cs;
2157 if (b != buf)
2158 break;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002159 spin_lock_irq(&tty->link->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 cs = tty->link->ctrl_status;
2161 tty->link->ctrl_status = 0;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002162 spin_unlock_irq(&tty->link->ctrl_lock);
Peter Hurleyeab25a52016-01-09 22:55:26 -08002163 if (put_user(cs, b)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 retval = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 break;
2166 }
Peter Hurleyeab25a52016-01-09 22:55:26 -08002167 b++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 nr--;
2169 break;
2170 }
Alan Cox4edf1822008-02-08 04:18:44 -08002171
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 if (!input_available_p(tty, 0)) {
Peter Hurley52bce7f2014-11-05 12:13:05 -05002173 up_read(&tty->termios_rwsem);
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002174 tty_buffer_flush_work(tty->port);
Peter Hurley52bce7f2014-11-05 12:13:05 -05002175 down_read(&tty->termios_rwsem);
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002176 if (!input_available_p(tty, 0)) {
2177 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
2178 retval = -EIO;
2179 break;
2180 }
2181 if (tty_hung_up_p(file))
2182 break;
2183 if (!timeout)
2184 break;
2185 if (file->f_flags & O_NONBLOCK) {
2186 retval = -EAGAIN;
2187 break;
2188 }
2189 if (signal_pending(current)) {
2190 retval = -ERESTARTSYS;
2191 break;
2192 }
2193 up_read(&tty->termios_rwsem);
2194
2195 timeout = wait_woken(&wait, TASK_INTERRUPTIBLE,
2196 timeout);
2197
2198 down_read(&tty->termios_rwsem);
2199 continue;
2200 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 }
2202
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002203 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002204 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05002205 if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 break;
2207 } else {
2208 int uncopied;
Peter Hurley95ea90d2014-10-16 15:33:30 -04002209
2210 /* Deal with packet mode. */
2211 if (packet && b == buf) {
Peter Hurleyeab25a52016-01-09 22:55:26 -08002212 if (put_user(TIOCPKT_DATA, b)) {
Peter Hurley95ea90d2014-10-16 15:33:30 -04002213 retval = -EFAULT;
Peter Hurley95ea90d2014-10-16 15:33:30 -04002214 break;
2215 }
Peter Hurleyeab25a52016-01-09 22:55:26 -08002216 b++;
Peter Hurley95ea90d2014-10-16 15:33:30 -04002217 nr--;
2218 }
2219
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 uncopied = copy_from_read_buf(tty, &b, &nr);
2221 uncopied += copy_from_read_buf(tty, &b, &nr);
2222 if (uncopied) {
2223 retval = -EFAULT;
2224 break;
2225 }
2226 }
2227
Peter Hurley6367ca72013-06-15 09:14:33 -04002228 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
2230 if (b - buf >= minimum)
2231 break;
2232 if (time)
2233 timeout = time;
2234 }
Peter Hurley2c5dc462015-01-16 15:05:34 -05002235 if (tail != ldata->read_tail)
2236 n_tty_kick_worker(tty);
Peter Hurley42458f42013-11-07 13:59:46 -05002237 up_read(&tty->termios_rwsem);
2238
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 remove_wait_queue(&tty->read_wait, &wait);
Peter Hurleyaebf04532013-11-07 14:01:57 -05002240 mutex_unlock(&ldata->atomic_read_lock);
2241
Peter Hurley40d5e092013-06-15 10:21:17 -04002242 if (b - buf)
2243 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244
2245 return retval;
2246}
2247
2248/**
Alan Cox11a96d12008-10-13 10:46:24 +01002249 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 * @tty: tty device
2251 * @file: file object
2252 * @buf: userspace buffer pointer
2253 * @nr: size of I/O
2254 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002255 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002257 * and other such events. Since the receive code will echo characters,
2258 * thus calling driver write methods, the output_lock is used in
2259 * the output processing functions called here as well as in the
2260 * echo processing function to protect the column state and space
2261 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 *
2263 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002264 *
2265 * Locking: output_lock to protect column state and space left
2266 * (note that the process_output*() functions take this
2267 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 */
Alan Cox4edf1822008-02-08 04:18:44 -08002269
Alan Cox11a96d12008-10-13 10:46:24 +01002270static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002271 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272{
2273 const unsigned char *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002274 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 int c;
2276 ssize_t retval = 0;
2277
2278 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2279 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2280 retval = tty_check_change(tty);
2281 if (retval)
2282 return retval;
2283 }
2284
Peter Hurley9356b532013-06-15 09:14:24 -04002285 down_read(&tty->termios_rwsem);
2286
Joe Petersona88a69c2009-01-02 13:40:53 +00002287 /* Write out any echoed characters that are still pending */
2288 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002289
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290 add_wait_queue(&tty->write_wait, &wait);
2291 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 if (signal_pending(current)) {
2293 retval = -ERESTARTSYS;
2294 break;
2295 }
2296 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2297 retval = -EIO;
2298 break;
2299 }
Peter Hurley582f5592013-05-17 12:49:48 -04002300 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002302 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 if (num < 0) {
2304 if (num == -EAGAIN)
2305 break;
2306 retval = num;
2307 goto break_out;
2308 }
2309 b += num;
2310 nr -= num;
2311 if (nr == 0)
2312 break;
2313 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002314 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 break;
2316 b++; nr--;
2317 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002318 if (tty->ops->flush_chars)
2319 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 } else {
Peter Hurley42910862014-05-03 14:04:59 +02002321 struct n_tty_data *ldata = tty->disc_data;
2322
Roman Zippeld6afe272005-07-07 17:56:55 -07002323 while (nr > 0) {
Peter Hurley42910862014-05-03 14:04:59 +02002324 mutex_lock(&ldata->output_lock);
Alan Coxf34d7a52008-04-30 00:54:13 -07002325 c = tty->ops->write(tty, b, nr);
Peter Hurley42910862014-05-03 14:04:59 +02002326 mutex_unlock(&ldata->output_lock);
Roman Zippeld6afe272005-07-07 17:56:55 -07002327 if (c < 0) {
2328 retval = c;
2329 goto break_out;
2330 }
2331 if (!c)
2332 break;
2333 b += c;
2334 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 }
2337 if (!nr)
2338 break;
2339 if (file->f_flags & O_NONBLOCK) {
2340 retval = -EAGAIN;
2341 break;
2342 }
Peter Hurley9356b532013-06-15 09:14:24 -04002343 up_read(&tty->termios_rwsem);
2344
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002345 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
Peter Hurley9356b532013-06-15 09:14:24 -04002346
2347 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 }
2349break_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 remove_wait_queue(&tty->write_wait, &wait);
Peter Hurley87108bc2016-01-09 21:45:14 -08002351 if (nr && tty->fasync)
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002352 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002353 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 return (b - buf) ? b - buf : retval;
2355}
2356
2357/**
Alan Cox11a96d12008-10-13 10:46:24 +01002358 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 * @tty: terminal device
2360 * @file: file accessing it
2361 * @wait: poll table
2362 *
2363 * Called when the line discipline is asked to poll() for data or
2364 * for special events. This code is not serialized with respect to
2365 * other events save open/close.
2366 *
2367 * This code must be sure never to sleep through a hangup.
2368 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 */
Alan Cox4edf1822008-02-08 04:18:44 -08002370
Alan Cox11a96d12008-10-13 10:46:24 +01002371static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002372 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373{
2374 unsigned int mask = 0;
2375
2376 poll_wait(file, &tty->read_wait, wait);
2377 poll_wait(file, &tty->write_wait, wait);
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002378 if (input_available_p(tty, 1))
2379 mask |= POLLIN | POLLRDNORM;
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002380 else {
2381 tty_buffer_flush_work(tty->port);
2382 if (input_available_p(tty, 1))
2383 mask |= POLLIN | POLLRDNORM;
2384 }
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002385 if (tty->packet && tty->link->ctrl_status)
2386 mask |= POLLPRI | POLLIN | POLLRDNORM;
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002387 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2388 mask |= POLLHUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 if (tty_hung_up_p(file))
2390 mask |= POLLHUP;
Alan Coxf34d7a52008-04-30 00:54:13 -07002391 if (tty->ops->write && !tty_is_writelocked(tty) &&
2392 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2393 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 mask |= POLLOUT | POLLWRNORM;
2395 return mask;
2396}
2397
Jiri Slaby57c94122012-10-18 22:26:43 +02002398static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002399{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002400 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002401
Peter Hurleya73d3d62013-06-15 09:14:25 -04002402 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002403 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002404 head = ldata->canon_head;
2405 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002406 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002407 /* Skip EOF-chars.. */
2408 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002409 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2410 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002411 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002412 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002413 }
2414 return nr;
2415}
2416
2417static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2418 unsigned int cmd, unsigned long arg)
2419{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002420 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002421 int retval;
2422
2423 switch (cmd) {
2424 case TIOCOUTQ:
2425 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2426 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002427 down_write(&tty->termios_rwsem);
Linus Torvalds966031f2017-12-20 17:57:06 -08002428 if (L_ICANON(tty) && !L_EXTPROC(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002429 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002430 else
2431 retval = read_cnt(ldata);
2432 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002433 return put_user(retval, (unsigned int __user *) arg);
2434 default:
2435 return n_tty_ioctl_helper(tty, file, cmd, arg);
2436 }
2437}
2438
Peter Hurley27228732016-01-09 21:35:19 -08002439static struct tty_ldisc_ops n_tty_ops = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002440 .magic = TTY_LDISC_MAGIC,
2441 .name = "n_tty",
2442 .open = n_tty_open,
2443 .close = n_tty_close,
2444 .flush_buffer = n_tty_flush_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002445 .read = n_tty_read,
2446 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002447 .ioctl = n_tty_ioctl,
2448 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002449 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002450 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002451 .write_wakeup = n_tty_write_wakeup,
Peter Hurley24a89d12013-06-15 09:14:15 -04002452 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002454
2455/**
2456 * n_tty_inherit_ops - inherit N_TTY methods
2457 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2458 *
Peter Hurley27228732016-01-09 21:35:19 -08002459 * Enables a 'subclass' line discipline to 'inherit' N_TTY methods.
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002460 */
2461
2462void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2463{
Peter Hurley27228732016-01-09 21:35:19 -08002464 *ops = n_tty_ops;
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002465 ops->owner = NULL;
2466 ops->refcount = ops->flags = 0;
2467}
2468EXPORT_SYMBOL_GPL(n_tty_inherit_ops);
Peter Hurley27228732016-01-09 21:35:19 -08002469
2470void __init n_tty_init(void)
2471{
2472 tty_register_ldisc(N_TTY, &n_tty_ops);
2473}