blob: f63b25bbe8958c77baaf11c0cbeed7884f4f945b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
7 * anyway...)
8 *
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080011 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * This file may be redistributed under the terms of the GNU General Public
19 * License.
20 *
21 * Reduced memory usage for older ARM systems - Russell King.
22 *
Alan Cox4edf1822008-02-08 04:18:44 -080023 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
26 *
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010029 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * EAGAIN
31 */
32
33#include <linux/types.h>
34#include <linux/major.h>
35#include <linux/errno.h>
36#include <linux/signal.h>
37#include <linux/fcntl.h>
38#include <linux/sched.h>
39#include <linux/interrupt.h>
40#include <linux/tty.h>
41#include <linux/timer.h>
42#include <linux/ctype.h>
43#include <linux/mm.h>
44#include <linux/string.h>
45#include <linux/slab.h>
46#include <linux/poll.h>
47#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070048#include <linux/audit.h>
49#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000050#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080051#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050052#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040053#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/* number of characters left in xmit buffer before select has we have room */
57#define WAKEUP_CHARS 256
58
59/*
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
63 */
64#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010065#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Joe Petersona88a69c2009-01-02 13:40:53 +000067/*
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
71 * codes.
72 */
73#define ECHO_OP_START 0xff
74#define ECHO_OP_MOVE_BACK_COL 0x80
75#define ECHO_OP_SET_CANON_COL 0x81
76#define ECHO_OP_ERASE_TAB 0x82
77
Peter Hurleycbfd0342013-06-15 10:04:26 -040078#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
Peter Hurley32f13522013-06-15 09:14:17 -040083#undef N_TTY_TRACE
84#ifdef N_TTY_TRACE
85# define n_tty_trace(f, args...) trace_printk(f, ##args)
86#else
87# define n_tty_trace(f, args...)
88#endif
89
Jiri Slaby70ece7a2012-10-18 22:26:38 +020090struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040091 /* producer-published */
92 size_t read_head;
Peter Hurley70aca712015-01-16 15:05:37 -050093 size_t commit_head;
Peter Hurleyfb7aa032013-06-15 09:14:30 -040094 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040095 size_t echo_head;
96 size_t echo_commit;
Peter Hurley1075a6e2013-12-09 18:06:07 -050097 size_t echo_mark;
Peter Hurley1bb9d562013-06-15 10:21:20 -040098 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040099
100 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200101 unsigned long overrun_time;
102 int num_overrun;
103
Peter Hurley24a89d12013-06-15 09:14:15 -0400104 /* non-atomic */
105 bool no_room;
106
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400107 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200108 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Peter Hurley4d0ed182013-12-10 17:12:02 -0500109 unsigned char push:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200110
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400111 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400112 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200113 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400114 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200115
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -0400116 int minimum_to_wake;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200117
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400118 /* consumer-published */
119 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400120 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400121
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400122 /* protected by output lock */
123 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200124 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400125 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200126
127 struct mutex atomic_read_lock;
128 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200129};
130
Peter Hurleyce741172013-06-15 09:14:20 -0400131static inline size_t read_cnt(struct n_tty_data *ldata)
132{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400133 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400134}
135
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400136static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
137{
138 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
139}
140
141static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
142{
143 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
144}
145
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400146static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
147{
148 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
149}
150
151static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
152{
153 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
154}
155
Miloslav Trmac522ed772007-07-15 23:40:56 -0700156static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
157 unsigned char __user *ptr)
158{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200159 struct n_tty_data *ldata = tty->disc_data;
160
161 tty_audit_add_data(tty, &x, 1, ldata->icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700162 return put_user(x, ptr);
163}
164
Peter Hurley24a89d12013-06-15 09:14:15 -0400165/**
Peter Hurley2c5dc462015-01-16 15:05:34 -0500166 * n_tty_kick_worker - start input worker (if required)
Peter Hurley24a89d12013-06-15 09:14:15 -0400167 * @tty: terminal
168 *
Peter Hurley2c5dc462015-01-16 15:05:34 -0500169 * Re-schedules the flip buffer work if it may have stopped
Peter Hurley24a89d12013-06-15 09:14:15 -0400170 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400171 * Caller holds exclusive termios_rwsem
172 * or
173 * n_tty_read()/consumer path:
174 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400175 */
176
Peter Hurley2c5dc462015-01-16 15:05:34 -0500177static void n_tty_kick_worker(struct tty_struct *tty)
Peter Hurley7879a9f2013-06-15 07:28:31 -0400178{
Peter Hurley24a89d12013-06-15 09:14:15 -0400179 struct n_tty_data *ldata = tty->disc_data;
180
Peter Hurley2c5dc462015-01-16 15:05:34 -0500181 /* Did the input worker stop? Restart it */
182 if (unlikely(ldata->no_room)) {
Peter Hurley24a89d12013-06-15 09:14:15 -0400183 ldata->no_room = 0;
184
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200185 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400186 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400187 /* see if ldisc has been killed - if so, this means that
188 * even though the ldisc has been halted and ->buf.work
189 * cancelled, ->buf.work is about to be rescheduled
190 */
191 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
192 "scheduling buffer work for halted ldisc\n");
Peter Hurleyf0f947c2013-06-15 09:14:36 -0400193 queue_work(system_unbound_wq, &tty->port->buf.work);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200194 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900195}
196
Peter Hurley9a4aec22013-06-15 09:14:32 -0400197static ssize_t chars_in_buffer(struct tty_struct *tty)
198{
199 struct n_tty_data *ldata = tty->disc_data;
200 ssize_t n = 0;
201
202 if (!ldata->icanon)
Peter Hurley70aca712015-01-16 15:05:37 -0500203 n = ldata->commit_head - ldata->read_tail;
Peter Hurley9a4aec22013-06-15 09:14:32 -0400204 else
205 n = ldata->canon_head - ldata->read_tail;
206 return n;
207}
208
Peter Hurleyee0bab82013-06-15 09:14:34 -0400209/**
210 * n_tty_write_wakeup - asynchronous I/O notifier
211 * @tty: tty device
212 *
213 * Required for the ptys, serial driver etc. since processes
214 * that attach themselves to the master and rely on ASYNC
215 * IO must be woken up
216 */
217
218static void n_tty_write_wakeup(struct tty_struct *tty)
219{
220 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
221 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
222}
223
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400224static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400225{
Peter Hurleya3428462015-01-16 15:05:35 -0500226 struct n_tty_data *ldata = tty->disc_data;
227
Peter Hurley3afb1b392013-07-23 08:47:30 -0400228 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
229 return;
Peter Hurley6367ca72013-06-15 09:14:33 -0400230 /*
231 * Check the remaining room for the input canonicalization
232 * mode. We don't want to throttle the driver if we're in
233 * canonical mode and don't have a newline yet!
234 */
Peter Hurleya3428462015-01-16 15:05:35 -0500235 if (ldata->icanon && ldata->canon_head == ldata->read_tail)
236 return;
237
Peter Hurley6367ca72013-06-15 09:14:33 -0400238 while (1) {
239 int throttled;
240 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
Peter Hurley5e28cca2015-01-16 15:05:36 -0500241 if (N_TTY_BUF_SIZE - read_cnt(ldata) >= TTY_THRESHOLD_THROTTLE)
Peter Hurley6367ca72013-06-15 09:14:33 -0400242 break;
243 throttled = tty_throttle_safe(tty);
244 if (!throttled)
245 break;
246 }
247 __tty_set_flow_change(tty, 0);
248}
249
Peter Hurley4b293492013-07-24 08:29:55 -0400250static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400251{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400252 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
253 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
254 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
255 return;
256 if (!tty->count)
257 return;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500258 n_tty_kick_worker(tty);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400259 n_tty_write_wakeup(tty->link);
Peter Hurley6c677162013-12-02 14:24:46 -0500260 if (waitqueue_active(&tty->link->write_wait))
261 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400262 return;
263 }
264
Peter Hurley6367ca72013-06-15 09:14:33 -0400265 /* If there is enough space in the read buffer now, let the
266 * low-level driver know. We use chars_in_buffer() to
267 * check the buffer, as it now knows about canonical mode.
268 * Otherwise, if the driver is throttled and the line is
269 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
270 * we won't get any more characters.
271 */
272
273 while (1) {
274 int unthrottled;
275 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
276 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
277 break;
278 if (!tty->count)
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);
Peter Hurley6c677162013-12-02 14:24:46 -0500337 if (waitqueue_active(&tty->link->read_wait))
338 wake_up_interruptible(&tty->link->read_wait);
Peter Hurleya30737a2013-03-11 16:44:22 -0400339 }
Peter Hurleya30737a2013-03-11 16:44:22 -0400340}
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342/**
343 * n_tty_flush_buffer - clean input queue
344 * @tty: terminal device
345 *
Peter Hurley25518c62013-03-11 16:44:31 -0400346 * Flush the input buffer. Called when the tty layer wants the
347 * buffer flushed (eg at hangup) or when the N_TTY line discipline
348 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400350 * Holds termios_rwsem to exclude producer/consumer while
351 * buffer indices are reset.
352 *
353 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 */
Alan Cox4edf1822008-02-08 04:18:44 -0800355
356static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400358 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400359 reset_buffer_flags(tty->disc_data);
Peter Hurley2c5dc462015-01-16 15:05:34 -0500360 n_tty_kick_worker(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800361
Peter Hurleya30737a2013-03-11 16:44:22 -0400362 if (tty->link)
363 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400364 up_write(&tty->termios_rwsem);
365}
366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367/**
368 * n_tty_chars_in_buffer - report available bytes
369 * @tty: tty device
370 *
371 * Report the number of characters buffered to be delivered to user
Alan Cox4edf1822008-02-08 04:18:44 -0800372 * at this instant in time.
Alan Cox17b82062008-10-13 10:45:06 +0100373 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400374 * Locking: exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 */
Alan Cox4edf1822008-02-08 04:18:44 -0800376
Peter Hurleya19d0c62013-06-15 09:14:18 -0400377static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
378{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400379 ssize_t n;
380
Peter Hurley47534082013-06-15 09:14:19 -0400381 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400382
383 down_write(&tty->termios_rwsem);
384 n = chars_in_buffer(tty);
385 up_write(&tty->termios_rwsem);
386 return n;
Peter Hurleya19d0c62013-06-15 09:14:18 -0400387}
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389/**
390 * is_utf8_continuation - utf8 multibyte check
391 * @c: byte to check
392 *
393 * Returns true if the utf8 character 'c' is a multibyte continuation
394 * character. We use this to correctly compute the on screen size
395 * of the character when printing
396 */
Alan Cox4edf1822008-02-08 04:18:44 -0800397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398static inline int is_utf8_continuation(unsigned char c)
399{
400 return (c & 0xc0) == 0x80;
401}
402
403/**
404 * is_continuation - multibyte check
405 * @c: byte to check
406 *
407 * Returns true if the utf8 character 'c' is a multibyte continuation
408 * character and the terminal is in unicode mode.
409 */
Alan Cox4edf1822008-02-08 04:18:44 -0800410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411static inline int is_continuation(unsigned char c, struct tty_struct *tty)
412{
413 return I_IUTF8(tty) && is_utf8_continuation(c);
414}
415
416/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000417 * do_output_char - output one character
418 * @c: character (or partial unicode symbol)
419 * @tty: terminal device
420 * @space: space available in tty driver write buffer
421 *
422 * This is a helper function that handles one output character
423 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600424 * doing OPOST processing and putting the results in the
425 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000426 *
427 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
428 * and NLDLY. They simply aren't relevant in the world today.
429 * If you ever need them, add them here.
430 *
431 * Returns the number of bytes of buffer space used or -1 if
432 * no space left.
433 *
434 * Locking: should be called under the output_lock to protect
435 * the column state and space left in the buffer
436 */
437
438static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
439{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200440 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000441 int spaces;
442
443 if (!space)
444 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000445
Joe Petersona88a69c2009-01-02 13:40:53 +0000446 switch (c) {
447 case '\n':
448 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200449 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000450 if (O_ONLCR(tty)) {
451 if (space < 2)
452 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200453 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700454 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000455 return 2;
456 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200457 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000458 break;
459 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200460 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000461 return 0;
462 if (O_OCRNL(tty)) {
463 c = '\n';
464 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200465 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000466 break;
467 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200468 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000469 break;
470 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200471 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000472 if (O_TABDLY(tty) == XTABS) {
473 if (space < spaces)
474 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200475 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000476 tty->ops->write(tty, " ", spaces);
477 return spaces;
478 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200479 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000480 break;
481 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200482 if (ldata->column > 0)
483 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000484 break;
485 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000486 if (!iscntrl(c)) {
487 if (O_OLCUC(tty))
488 c = toupper(c);
489 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200490 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000491 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000492 break;
493 }
494
495 tty_put_char(tty, c);
496 return 1;
497}
498
499/**
500 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 * @c: character (or partial unicode symbol)
502 * @tty: terminal device
503 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600504 * Output one character with OPOST processing.
505 * Returns -1 when the output device is full and the character
506 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000508 * Locking: output_lock to protect column state and space left
509 * (also, this is called from n_tty_write under the
510 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 */
Alan Cox4edf1822008-02-08 04:18:44 -0800512
Joe Petersona88a69c2009-01-02 13:40:53 +0000513static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514{
Jiri Slabybddc7152012-10-18 22:26:42 +0200515 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000516 int space, retval;
517
Jiri Slabybddc7152012-10-18 22:26:42 +0200518 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Alan Coxf34d7a52008-04-30 00:54:13 -0700520 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000521 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Jiri Slabybddc7152012-10-18 22:26:42 +0200523 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000524 if (retval < 0)
525 return -1;
526 else
527 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528}
529
530/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000531 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600533 * @buf: character buffer
534 * @nr: number of bytes to output
535 *
536 * Output a block of characters with OPOST processing.
537 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 *
539 * This path is used to speed up block console writes, among other
540 * things when processing blocks of output data. It handles only
541 * the simple cases normally found and helps to generate blocks of
542 * symbols for the console driver and thus improve performance.
543 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000544 * Locking: output_lock to protect column state and space left
545 * (also, this is called from n_tty_write under the
546 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 */
Alan Cox4edf1822008-02-08 04:18:44 -0800548
Joe Petersona88a69c2009-01-02 13:40:53 +0000549static ssize_t process_output_block(struct tty_struct *tty,
550 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200552 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100554 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 const unsigned char *cp;
556
Jiri Slabybddc7152012-10-18 22:26:42 +0200557 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000558
Alan Coxf34d7a52008-04-30 00:54:13 -0700559 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000560 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200561 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000563 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 if (nr > space)
565 nr = space;
566
567 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000568 unsigned char c = *cp;
569
570 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 case '\n':
572 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200573 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (O_ONLCR(tty))
575 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200576 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 break;
578 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200579 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 goto break_out;
581 if (O_OCRNL(tty))
582 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200583 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 break;
585 case '\t':
586 goto break_out;
587 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200588 if (ldata->column > 0)
589 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 break;
591 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000592 if (!iscntrl(c)) {
593 if (O_OLCUC(tty))
594 goto break_out;
595 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200596 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 break;
599 }
600 }
601break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700602 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000603
Jiri Slabybddc7152012-10-18 22:26:42 +0200604 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 return i;
606}
607
Joe Petersona88a69c2009-01-02 13:40:53 +0000608/**
609 * process_echoes - write pending echo characters
610 * @tty: terminal device
611 *
612 * Write previously buffered echo (and other ldisc-generated)
613 * characters to the tty.
614 *
615 * Characters generated by the ldisc (including echoes) need to
616 * be buffered because the driver's write buffer can fill during
617 * heavy program output. Echoing straight to the driver will
618 * often fail under these conditions, causing lost characters and
619 * resulting mismatches of ldisc state information.
620 *
621 * Since the ldisc state must represent the characters actually sent
622 * to the driver at the time of the write, operations like certain
623 * changes in column state are also saved in the buffer and executed
624 * here.
625 *
626 * A circular fifo buffer is used so that the most recent characters
627 * are prioritized. Also, when control characters are echoed with a
628 * prefixed "^", the pair is treated atomically and thus not separated.
629 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400630 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000631 */
632
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400633static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000634{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200635 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400636 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400637 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000638 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000639
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400640 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000641
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400642 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400643 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400644 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000645 if (c == ECHO_OP_START) {
646 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000647 int no_space_left = 0;
648
649 /*
650 * If the buffer byte is the start of a multi-byte
651 * operation, get the next byte, which is either the
652 * op code or a control character value.
653 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400654 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000655
Joe Petersona88a69c2009-01-02 13:40:53 +0000656 switch (op) {
657 unsigned int num_chars, num_bs;
658
659 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400660 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000661
662 /*
663 * Determine how many columns to go back
664 * in order to erase the tab.
665 * This depends on the number of columns
666 * used by other characters within the tab
667 * area. If this (modulo 8) count is from
668 * the start of input rather than from a
669 * previous tab, we offset by canon column.
670 * Otherwise, tab spacing is normal.
671 */
672 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200673 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000674 num_bs = 8 - (num_chars & 7);
675
676 if (num_bs > space) {
677 no_space_left = 1;
678 break;
679 }
680 space -= num_bs;
681 while (num_bs--) {
682 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200683 if (ldata->column > 0)
684 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000685 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400686 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000687 break;
688
689 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200690 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400691 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000692 break;
693
694 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200695 if (ldata->column > 0)
696 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400697 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000698 break;
699
700 case ECHO_OP_START:
701 /* This is an escaped echo op start code */
702 if (!space) {
703 no_space_left = 1;
704 break;
705 }
706 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200707 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000708 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400709 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000710 break;
711
712 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000713 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600714 * If the op is not a special byte code,
715 * it is a ctrl char tagged to be echoed
716 * as "^X" (where X is the letter
717 * representing the control char).
718 * Note that we must ensure there is
719 * enough space for the whole ctrl pair.
720 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000721 */
Joe Peterson62b26352009-09-09 15:03:47 -0600722 if (space < 2) {
723 no_space_left = 1;
724 break;
725 }
726 tty_put_char(tty, '^');
727 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200728 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600729 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400730 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000731 }
732
733 if (no_space_left)
734 break;
735 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400736 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600737 int retval = do_output_char(c, tty, space);
738 if (retval < 0)
739 break;
740 space -= retval;
741 } else {
742 if (!space)
743 break;
744 tty_put_char(tty, c);
745 space -= 1;
746 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400747 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000748 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000749 }
750
Peter Hurleycbfd0342013-06-15 10:04:26 -0400751 /* If the echo buffer is nearly full (so that the possibility exists
752 * of echo overrun before the next commit), then discard enough
753 * data at the tail to prevent a subsequent overrun */
754 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
Roel Kluinc476f652013-10-11 22:08:49 +0200755 if (echo_buf(ldata, tail) == ECHO_OP_START) {
Peter Hurley6f222532013-11-08 09:42:18 -0500756 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400757 tail += 3;
758 else
759 tail += 2;
760 } else
761 tail++;
762 }
763
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400764 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400765 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000766}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Peter Hurley17bd7902013-06-15 10:04:24 -0400768static void commit_echoes(struct tty_struct *tty)
769{
770 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400771 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400772 size_t head;
773
774 head = ldata->echo_head;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500775 ldata->echo_mark = head;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400776 old = ldata->echo_commit - ldata->echo_tail;
777
778 /* Process committed echoes if the accumulated # of bytes
779 * is over the threshold (and try again each time another
780 * block is accumulated) */
781 nr = head - ldata->echo_tail;
782 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
783 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400784
Peter Hurley019ebdf2013-06-15 10:04:25 -0400785 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400786 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400787 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400788 mutex_unlock(&ldata->output_lock);
789
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400790 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400791 tty->ops->flush_chars(tty);
792}
793
794static void process_echoes(struct tty_struct *tty)
795{
796 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400797 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400798
Peter Hurleye2613be2014-02-11 16:34:55 -0500799 if (ldata->echo_mark == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400800 return;
801
802 mutex_lock(&ldata->output_lock);
Peter Hurley1075a6e2013-12-09 18:06:07 -0500803 ldata->echo_commit = ldata->echo_mark;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400804 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400805 mutex_unlock(&ldata->output_lock);
806
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400807 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400808 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400809}
810
Peter Hurley1075a6e2013-12-09 18:06:07 -0500811/* NB: echo_mark and echo_head should be equivalent here */
Peter Hurleycbfd0342013-06-15 10:04:26 -0400812static void flush_echoes(struct tty_struct *tty)
813{
814 struct n_tty_data *ldata = tty->disc_data;
815
Peter Hurley39434ab2013-11-29 12:56:10 -0500816 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
817 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400818 return;
819
820 mutex_lock(&ldata->output_lock);
821 ldata->echo_commit = ldata->echo_head;
822 __process_echoes(tty);
823 mutex_unlock(&ldata->output_lock);
824}
825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000827 * add_echo_byte - add a byte to the echo buffer
828 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200829 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000830 *
831 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000832 */
833
Peter Hurleycbfd0342013-06-15 10:04:26 -0400834static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000835{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400836 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000837}
838
839/**
840 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200841 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000842 *
843 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000844 */
845
Jiri Slaby57c94122012-10-18 22:26:43 +0200846static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000847{
Jiri Slaby57c94122012-10-18 22:26:43 +0200848 add_echo_byte(ECHO_OP_START, ldata);
849 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000850}
851
852/**
853 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200854 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000855 *
856 * Add an operation to the echo buffer to set the canon column
857 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000858 */
859
Jiri Slaby57c94122012-10-18 22:26:43 +0200860static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000861{
Jiri Slaby57c94122012-10-18 22:26:43 +0200862 add_echo_byte(ECHO_OP_START, ldata);
863 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000864}
865
866/**
867 * echo_erase_tab - add operation to erase a tab
868 * @num_chars: number of character columns already used
869 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200870 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000871 *
872 * Add an operation to the echo buffer to erase a tab.
873 *
874 * Called by the eraser function, which knows how many character
875 * columns have been used since either a previous tab or the start
876 * of input. This information will be used later, along with
877 * canon column (if applicable), to go back the correct number
878 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000879 */
880
881static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200882 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000883{
Jiri Slaby57c94122012-10-18 22:26:43 +0200884 add_echo_byte(ECHO_OP_START, ldata);
885 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000886
887 /* We only need to know this modulo 8 (tab spacing) */
888 num_chars &= 7;
889
890 /* Set the high bit as a flag if num_chars is after a previous tab */
891 if (after_tab)
892 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000893
Jiri Slaby57c94122012-10-18 22:26:43 +0200894 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000895}
896
897/**
898 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 * @c: unicode byte to echo
900 * @tty: terminal device
901 *
Alan Cox4edf1822008-02-08 04:18:44 -0800902 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100904 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000905 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000906 */
907
Jiri Slaby57c94122012-10-18 22:26:43 +0200908static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000909{
Joe Petersona88a69c2009-01-02 13:40:53 +0000910 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200911 add_echo_byte(ECHO_OP_START, ldata);
912 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000913 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200914 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000915 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000916}
917
918/**
919 * echo_char - echo a character
920 * @c: unicode byte to echo
921 * @tty: terminal device
922 *
923 * Echo user input back onto the screen. This must be called only when
924 * L_ECHO(tty) is true. Called from the driver receive_buf path.
925 *
Joe Peterson62b26352009-09-09 15:03:47 -0600926 * This variant tags control characters to be echoed as "^X"
927 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 */
929
930static void echo_char(unsigned char c, struct tty_struct *tty)
931{
Jiri Slabybddc7152012-10-18 22:26:42 +0200932 struct n_tty_data *ldata = tty->disc_data;
933
Joe Petersona88a69c2009-01-02 13:40:53 +0000934 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200935 add_echo_byte(ECHO_OP_START, ldata);
936 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000937 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600938 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200939 add_echo_byte(ECHO_OP_START, ldata);
940 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000941 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942}
943
Alan Cox17b82062008-10-13 10:45:06 +0100944/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000945 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200946 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100947 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000948
Jiri Slaby57c94122012-10-18 22:26:43 +0200949static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200951 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200952 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200953 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 }
955}
956
957/**
958 * eraser - handle erase function
959 * @c: character input
960 * @tty: terminal device
961 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200962 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 * present in the stream from the driver layer. Handles the complexities
964 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100965 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400966 * n_tty_receive_buf()/producer path:
967 * caller holds non-exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 */
Alan Cox4edf1822008-02-08 04:18:44 -0800969
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970static void eraser(unsigned char c, struct tty_struct *tty)
971{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200972 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400974 size_t head;
975 size_t cnt;
976 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200978 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +0000979 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 return;
981 }
982 if (c == ERASE_CHAR(tty))
983 kill_type = ERASE;
984 else if (c == WERASE_CHAR(tty))
985 kill_type = WERASE;
986 else {
987 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200988 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 return;
990 }
991 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200992 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +0200993 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 echo_char(KILL_CHAR(tty), tty);
995 /* Add a newline if ECHOK is on and ECHOKE is off. */
996 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +0200997 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 return;
999 }
1000 kill_type = KILL;
1001 }
1002
1003 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001004 while (ldata->read_head != ldata->canon_head) {
1005 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
1007 /* erase a single possibly multibyte character */
1008 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001009 head--;
1010 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001011 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 /* do not partially erase */
1014 if (is_continuation(c, tty))
1015 break;
1016
1017 if (kill_type == WERASE) {
1018 /* Equivalent to BSD's ALTWERASE. */
1019 if (isalnum(c) || c == '_')
1020 seen_alnums++;
1021 else if (seen_alnums)
1022 break;
1023 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001024 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001025 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 if (L_ECHO(tty)) {
1027 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001028 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001029 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001030 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 }
1032 /* if cnt > 1, output a multi-byte character */
1033 echo_char(c, tty);
1034 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001035 head++;
1036 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001037 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 }
1039 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1040 echo_char(ERASE_CHAR(tty), tty);
1041 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001042 unsigned int num_chars = 0;
1043 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001044 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
Joe Petersona88a69c2009-01-02 13:40:53 +00001046 /*
1047 * Count the columns used for characters
1048 * since the start of input or after a
1049 * previous tab.
1050 * This info is used to go back the correct
1051 * number of columns.
1052 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001053 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001054 tail--;
1055 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001056 if (c == '\t') {
1057 after_tab = 1;
1058 break;
Alan Cox300a6202009-01-02 13:41:04 +00001059 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001061 num_chars += 2;
1062 } else if (!is_continuation(c, tty)) {
1063 num_chars++;
1064 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001066 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 } else {
1068 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001069 echo_char_raw('\b', ldata);
1070 echo_char_raw(' ', ldata);
1071 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 }
1073 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001074 echo_char_raw('\b', ldata);
1075 echo_char_raw(' ', ldata);
1076 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 }
1078 }
1079 }
1080 if (kill_type == ERASE)
1081 break;
1082 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001083 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001084 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085}
1086
1087/**
1088 * isig - handle the ISIG optio
1089 * @sig: signal
1090 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001092 * Called when a signal is being sent due to terminal input.
1093 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001094 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001095 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 */
Alan Cox4edf1822008-02-08 04:18:44 -08001097
Peter Hurley4b293492013-07-24 08:29:55 -04001098static void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099{
Peter Hurley8c985d12013-03-06 08:38:19 -05001100 struct pid *tty_pgrp = tty_get_pgrp(tty);
1101 if (tty_pgrp) {
1102 kill_pgrp(tty_pgrp, sig, 1);
1103 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 }
1105}
1106
1107/**
1108 * n_tty_receive_break - handle break
1109 * @tty: terminal
1110 *
1111 * An RS232 break event has been hit in the incoming bitstream. This
1112 * can cause a variety of events depending upon the termios settings.
1113 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001114 * n_tty_receive_buf()/producer path:
1115 * caller holds non-exclusive termios_rwsem
Peter Hurley6d76bd22013-06-15 09:14:26 -04001116 *
1117 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 */
Alan Cox4edf1822008-02-08 04:18:44 -08001119
Peter Hurley4b293492013-07-24 08:29:55 -04001120static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121{
Jiri Slaby57c94122012-10-18 22:26:43 +02001122 struct n_tty_data *ldata = tty->disc_data;
1123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 if (I_IGNBRK(tty))
1125 return;
1126 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001127 isig(SIGINT, tty);
1128 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001129 /* flushing needs exclusive termios_rwsem */
1130 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001131 n_tty_flush_buffer(tty);
1132 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001133 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001134 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 return;
1136 }
1137 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001138 put_tty_queue('\377', ldata);
1139 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001141 put_tty_queue('\0', ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001142 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001143 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144}
1145
1146/**
1147 * n_tty_receive_overrun - handle overrun reporting
1148 * @tty: terminal
1149 *
1150 * Data arrived faster than we could process it. While the tty
1151 * driver has flagged this the bits that were missed are gone
1152 * forever.
1153 *
1154 * Called from the receive_buf path so single threaded. Does not
1155 * need locking as num_overrun and overrun_time are function
1156 * private.
1157 */
Alan Cox4edf1822008-02-08 04:18:44 -08001158
Peter Hurley4b293492013-07-24 08:29:55 -04001159static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001161 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 char buf[64];
1163
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001164 ldata->num_overrun++;
1165 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1166 time_after(ldata->overrun_time, jiffies)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1168 tty_name(tty, buf),
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001169 ldata->num_overrun);
1170 ldata->overrun_time = jiffies;
1171 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 }
1173}
1174
1175/**
1176 * n_tty_receive_parity_error - error notifier
1177 * @tty: terminal device
1178 * @c: character
1179 *
1180 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001181 * the error case if necessary.
1182 *
1183 * n_tty_receive_buf()/producer path:
1184 * caller holds non-exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 */
Peter Hurley4b293492013-07-24 08:29:55 -04001186static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
Jiri Slaby57c94122012-10-18 22:26:43 +02001188 struct n_tty_data *ldata = tty->disc_data;
1189
Peter Hurley66528f92014-06-16 08:10:42 -04001190 if (I_INPCK(tty)) {
1191 if (I_IGNPAR(tty))
1192 return;
1193 if (I_PARMRK(tty)) {
1194 put_tty_queue('\377', ldata);
1195 put_tty_queue('\0', ldata);
1196 put_tty_queue(c, ldata);
1197 } else
1198 put_tty_queue('\0', ldata);
1199 } else
Jiri Slaby57c94122012-10-18 22:26:43 +02001200 put_tty_queue(c, ldata);
Peter Hurley6c677162013-12-02 14:24:46 -05001201 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001202 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203}
1204
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001205static void
1206n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1207{
1208 if (!L_NOFLSH(tty)) {
1209 /* flushing needs exclusive termios_rwsem */
1210 up_read(&tty->termios_rwsem);
1211 n_tty_flush_buffer(tty);
1212 tty_driver_flush_buffer(tty);
1213 down_read(&tty->termios_rwsem);
1214 }
1215 if (I_IXON(tty))
1216 start_tty(tty);
1217 if (L_ECHO(tty)) {
1218 echo_char(c, tty);
1219 commit_echoes(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001220 } else
1221 process_echoes(tty);
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001222 isig(signal, tty);
1223 return;
1224}
1225
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226/**
1227 * n_tty_receive_char - perform processing
1228 * @tty: terminal device
1229 * @c: character
1230 *
1231 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001232 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001234 *
1235 * n_tty_receive_buf()/producer path:
1236 * caller holds non-exclusive termios_rwsem
1237 * publishes canon_head if canonical mode is active
Peter Hurleye60d27c2013-07-24 08:29:56 -04001238 *
1239 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 */
1241
Peter Hurleye60d27c2013-07-24 08:29:56 -04001242static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001243n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001245 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 if (I_IXON(tty)) {
1248 if (c == START_CHAR(tty)) {
1249 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001250 process_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001251 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 }
1253 if (c == STOP_CHAR(tty)) {
1254 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001255 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 }
1257 }
Joe Peterson575537b32008-04-30 00:53:30 -07001258
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001260 if (c == INTR_CHAR(tty)) {
1261 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001262 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001263 } else if (c == QUIT_CHAR(tty)) {
1264 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001265 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001266 } else if (c == SUSP_CHAR(tty)) {
1267 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001268 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 }
1270 }
Joe Peterson575537b32008-04-30 00:53:30 -07001271
Peter Hurley855df3c2013-07-24 08:29:50 -04001272 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1273 start_tty(tty);
1274 process_echoes(tty);
1275 }
1276
Joe Peterson575537b32008-04-30 00:53:30 -07001277 if (c == '\r') {
1278 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001279 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001280 if (I_ICRNL(tty))
1281 c = '\n';
1282 } else if (c == '\n' && I_INLCR(tty))
1283 c = '\r';
1284
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001285 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1287 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1288 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001289 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001290 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 }
1292 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001293 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001295 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001297 echo_char_raw('^', ldata);
1298 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001299 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 }
1301 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001302 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001304 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001305 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
Jiri Slaby57c94122012-10-18 22:26:43 +02001307 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001309 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001310 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001311 echo_char(read_buf(ldata, tail), tty);
1312 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001314 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001315 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 }
1317 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001318 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001319 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001320 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 }
1322 goto handle_newline;
1323 }
1324 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 c = __DISABLED_CHAR;
1326 goto handle_newline;
1327 }
1328 if ((c == EOL_CHAR(tty)) ||
1329 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1330 /*
1331 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1332 */
1333 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001335 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001336 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001338 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 }
1340 /*
1341 * XXX does PARMRK doubling happen for
1342 * EOL_CHAR and EOL2_CHAR?
1343 */
Peter Hurley001ba922013-12-02 14:24:44 -05001344 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001345 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Alan Cox4edf1822008-02-08 04:18:44 -08001347handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001348 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001349 put_tty_queue(c, ldata);
Peter Hurley70aca712015-01-16 15:05:37 -05001350 smp_store_release(&ldata->canon_head, ldata->read_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1352 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001353 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001354 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 }
1356 }
Alan Cox4edf1822008-02-08 04:18:44 -08001357
Joe Petersonacc71bb2009-01-02 13:43:32 +00001358 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001359 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001361 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 else {
1363 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001364 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001365 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 echo_char(c, tty);
1367 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001368 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 }
1370
Peter Hurley001ba922013-12-02 14:24:44 -05001371 /* PARMRK doubling check */
1372 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001373 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Jiri Slaby57c94122012-10-18 22:26:43 +02001375 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001376 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001377}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
Peter Hurleye60d27c2013-07-24 08:29:56 -04001379static inline void
1380n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001381{
1382 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001383
Peter Hurleye60d27c2013-07-24 08:29:56 -04001384 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1385 start_tty(tty);
1386 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001387 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001388 if (L_ECHO(tty)) {
1389 finish_erasing(ldata);
1390 /* Record the column of first canon char. */
1391 if (ldata->canon_head == ldata->read_head)
1392 echo_set_canon_col(ldata);
1393 echo_char(c, tty);
1394 commit_echoes(tty);
1395 }
Peter Hurley001ba922013-12-02 14:24:44 -05001396 /* PARMRK doubling check */
1397 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001398 put_tty_queue(c, ldata);
1399 put_tty_queue(c, ldata);
1400}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001401
Peter Hurleyeb3e4662013-12-02 14:24:42 -05001402static void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
Peter Hurleye60d27c2013-07-24 08:29:56 -04001403{
1404 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001405}
1406
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001407static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001408n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1409{
1410 struct n_tty_data *ldata = tty->disc_data;
1411
Peter Hurleye60d27c2013-07-24 08:29:56 -04001412 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1413 start_tty(tty);
1414 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001415 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001416 if (L_ECHO(tty)) {
1417 finish_erasing(ldata);
1418 /* Record the column of first canon char. */
1419 if (ldata->canon_head == ldata->read_head)
1420 echo_set_canon_col(ldata);
1421 echo_char(c, tty);
1422 commit_echoes(tty);
1423 }
1424 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001425}
1426
Peter Hurley8dc4b252013-12-02 14:24:43 -05001427static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001428{
1429 if (I_ISTRIP(tty))
1430 c &= 0x7f;
1431 if (I_IUCLC(tty) && L_IEXTEN(tty))
1432 c = tolower(c);
1433
1434 if (I_IXON(tty)) {
1435 if (c == STOP_CHAR(tty))
1436 stop_tty(tty);
1437 else if (c == START_CHAR(tty) ||
1438 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1439 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1440 c != SUSP_CHAR(tty))) {
1441 start_tty(tty);
1442 process_echoes(tty);
1443 }
1444 }
1445}
1446
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001447static void
1448n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1449{
1450 char buf[64];
1451
1452 switch (flag) {
1453 case TTY_BREAK:
1454 n_tty_receive_break(tty);
1455 break;
1456 case TTY_PARITY:
1457 case TTY_FRAME:
1458 n_tty_receive_parity_error(tty, c);
1459 break;
1460 case TTY_OVERRUN:
1461 n_tty_receive_overrun(tty);
1462 break;
1463 default:
1464 printk(KERN_ERR "%s: unknown flag %d\n",
1465 tty_name(tty, buf), flag);
1466 break;
1467 }
1468}
1469
Peter Hurleye60d27c2013-07-24 08:29:56 -04001470static void
1471n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1472{
1473 struct n_tty_data *ldata = tty->disc_data;
1474
1475 ldata->lnext = 0;
1476 if (likely(flag == TTY_NORMAL)) {
1477 if (I_ISTRIP(tty))
1478 c &= 0x7f;
1479 if (I_IUCLC(tty) && L_IEXTEN(tty))
1480 c = tolower(c);
1481 n_tty_receive_char(tty, c);
1482 } else
1483 n_tty_receive_char_flagged(tty, c, flag);
1484}
1485
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486/**
1487 * n_tty_receive_buf - data receive
1488 * @tty: terminal device
1489 * @cp: buffer
1490 * @fp: flag buffer
1491 * @count: characters
1492 *
1493 * Called by the terminal driver when a block of characters has
1494 * been received. This function must be called from soft contexts
1495 * not from interrupt context. The driver is responsible for making
1496 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001497 *
1498 * n_tty_receive_buf()/producer path:
1499 * claims non-exclusive termios_rwsem
Peter Hurley70aca712015-01-16 15:05:37 -05001500 * publishes commit_head or canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 */
Alan Cox4edf1822008-02-08 04:18:44 -08001502
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001503static void
1504n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1505 char *fp, int count)
1506{
1507 struct n_tty_data *ldata = tty->disc_data;
1508 size_t n, head;
1509
1510 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
Peter Hurley70aca712015-01-16 15:05:37 -05001511 n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001512 memcpy(read_buf_addr(ldata, head), cp, n);
1513 ldata->read_head += n;
1514 cp += n;
1515 count -= n;
1516
1517 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
Peter Hurley70aca712015-01-16 15:05:37 -05001518 n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001519 memcpy(read_buf_addr(ldata, head), cp, n);
1520 ldata->read_head += n;
1521}
1522
Peter Hurley554117b2013-06-15 10:21:25 -04001523static void
1524n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1525 char *fp, int count)
1526{
1527 struct n_tty_data *ldata = tty->disc_data;
1528 char flag = TTY_NORMAL;
1529
1530 while (count--) {
1531 if (fp)
1532 flag = *fp++;
1533 if (likely(flag == TTY_NORMAL))
1534 put_tty_queue(*cp++, ldata);
1535 else
1536 n_tty_receive_char_flagged(tty, *cp++, flag);
1537 }
1538}
1539
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001540static void
1541n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1542 char *fp, int count)
1543{
1544 char flag = TTY_NORMAL;
1545
1546 while (count--) {
1547 if (fp)
1548 flag = *fp++;
1549 if (likely(flag == TTY_NORMAL))
1550 n_tty_receive_char_closing(tty, *cp++);
1551 else
1552 n_tty_receive_char_flagged(tty, *cp++, flag);
1553 }
1554}
1555
Peter Hurley7d88d632013-07-24 08:29:49 -04001556static void
1557n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001558 char *fp, int count)
1559{
1560 struct n_tty_data *ldata = tty->disc_data;
1561 char flag = TTY_NORMAL;
1562
1563 while (count--) {
1564 if (fp)
1565 flag = *fp++;
1566 if (likely(flag == TTY_NORMAL)) {
1567 unsigned char c = *cp++;
1568
1569 if (I_ISTRIP(tty))
1570 c &= 0x7f;
1571 if (I_IUCLC(tty) && L_IEXTEN(tty))
1572 c = tolower(c);
1573 if (L_EXTPROC(tty)) {
1574 put_tty_queue(c, ldata);
1575 continue;
1576 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001577 if (!test_bit(c, ldata->char_map))
1578 n_tty_receive_char_inline(tty, c);
1579 else if (n_tty_receive_char_special(tty, c) && count) {
1580 if (fp)
1581 flag = *fp++;
1582 n_tty_receive_char_lnext(tty, *cp++, flag);
1583 count--;
1584 }
Peter Hurley6baad002013-07-24 08:29:52 -04001585 } else
1586 n_tty_receive_char_flagged(tty, *cp++, flag);
1587 }
1588}
1589
1590static void
1591n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1592 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001593{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001594 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001595 char flag = TTY_NORMAL;
1596
1597 while (count--) {
1598 if (fp)
1599 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001600 if (likely(flag == TTY_NORMAL)) {
1601 unsigned char c = *cp++;
1602
1603 if (!test_bit(c, ldata->char_map))
1604 n_tty_receive_char_fast(tty, c);
1605 else if (n_tty_receive_char_special(tty, c) && count) {
1606 if (fp)
1607 flag = *fp++;
1608 n_tty_receive_char_lnext(tty, *cp++, flag);
1609 count--;
1610 }
1611 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001612 n_tty_receive_char_flagged(tty, *cp++, flag);
1613 }
1614}
1615
Peter Hurley24a89d12013-06-15 09:14:15 -04001616static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1617 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001619 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001620 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001622 if (ldata->real_raw)
1623 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001624 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117b2013-06-15 10:21:25 -04001625 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001626 else if (tty->closing && !L_EXTPROC(tty))
1627 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001628 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001629 if (ldata->lnext) {
1630 char flag = TTY_NORMAL;
1631
1632 if (fp)
1633 flag = *fp++;
1634 n_tty_receive_char_lnext(tty, *cp++, flag);
1635 count--;
1636 }
1637
Peter Hurley7de971b2013-07-24 08:29:53 -04001638 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001639 n_tty_receive_buf_fast(tty, cp, fp, count);
1640 else
1641 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001642
1643 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001644 if (tty->ops->flush_chars)
1645 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 }
1647
Peter Hurley70aca712015-01-16 15:05:37 -05001648 if (ldata->icanon && !L_EXTPROC(tty))
1649 return;
1650
1651 /* publish read_head to consumer */
1652 smp_store_release(&ldata->commit_head, ldata->read_head);
1653
1654 if ((read_cnt(ldata) >= ldata->minimum_to_wake) || L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1656 if (waitqueue_active(&tty->read_wait))
Peter Hurley57087d52014-08-07 07:14:10 -04001657 wake_up_interruptible_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659}
1660
Peter Hurley5c32d122013-12-02 14:24:41 -05001661static int
1662n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1663 char *fp, int count, int flow)
Peter Hurley24a89d12013-06-15 09:14:15 -04001664{
1665 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley19e2ad62013-07-24 08:29:54 -04001666 int room, n, rcvd = 0;
Peter Hurley24a89d12013-06-15 09:14:15 -04001667
Peter Hurley9356b532013-06-15 09:14:24 -04001668 down_read(&tty->termios_rwsem);
1669
Peter Hurley19e2ad62013-07-24 08:29:54 -04001670 while (1) {
Peter Hurley70aca712015-01-16 15:05:37 -05001671 /*
1672 * When PARMRK is set, multiply read_cnt by 3, since each byte
1673 * might take up to three times as many spaces (depending on
1674 * its flags, e.g. parity error). [This calculation is wrong.]
1675 *
1676 * If we are doing input canonicalization, and there are no
1677 * pending newlines, let characters through without limit, so
1678 * that erase characters will be handled. Other excess
1679 * characters will be beeped.
1680 *
1681 * paired with store in *_copy_from_read_buf() -- guarantees
1682 * the consumer has loaded the data in read_buf up to the new
1683 * read_tail (so this producer will not overwrite unread data)
1684 */
1685 size_t tail = smp_load_acquire(&ldata->read_tail);
1686 size_t head = ldata->read_head;
1687
1688 if (I_PARMRK(tty))
1689 room = N_TTY_BUF_SIZE - (head - tail) * 3 - 1;
1690 else
1691 room = N_TTY_BUF_SIZE - (head - tail) - 1;
1692
1693 if (room <= 0)
1694 room = ldata->icanon && ldata->canon_head == tail;
1695
Peter Hurley19e2ad62013-07-24 08:29:54 -04001696 n = min(count, room);
1697 if (!n) {
Peter Hurley5c32d122013-12-02 14:24:41 -05001698 if (flow && !room)
Peter Hurley19e2ad62013-07-24 08:29:54 -04001699 ldata->no_room = 1;
1700 break;
1701 }
1702 __receive_buf(tty, cp, fp, n);
1703 cp += n;
1704 if (fp)
1705 fp += n;
1706 count -= n;
1707 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001708 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001709
Peter Hurley19e2ad62013-07-24 08:29:54 -04001710 tty->receive_room = room;
1711 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001712 up_read(&tty->termios_rwsem);
1713
Peter Hurley19e2ad62013-07-24 08:29:54 -04001714 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001715}
1716
Peter Hurley5c32d122013-12-02 14:24:41 -05001717static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1718 char *fp, int count)
1719{
1720 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1721}
1722
1723static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1724 char *fp, int count)
1725{
1726 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1727}
1728
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729int is_ignored(int sig)
1730{
1731 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001732 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733}
1734
1735/**
1736 * n_tty_set_termios - termios data changed
1737 * @tty: terminal
1738 * @old: previous data
1739 *
1740 * Called by the tty layer when the user changes termios flags so
1741 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001742 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 * guaranteed that this function will not be re-entered or in progress
1744 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001745 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001746 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 */
Alan Cox4edf1822008-02-08 04:18:44 -08001748
1749static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001751 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001752
Peter Hurleyc786f742013-09-17 12:53:35 -04001753 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001754 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -05001755 ldata->line_start = ldata->read_tail;
1756 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1757 ldata->canon_head = ldata->read_tail;
1758 ldata->push = 0;
1759 } else {
1760 set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1761 ldata->read_flags);
1762 ldata->canon_head = ldata->read_head;
1763 ldata->push = 1;
1764 }
Peter Hurley70aca712015-01-16 15:05:37 -05001765 ldata->commit_head = ldata->read_head;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001766 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001767 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001768 }
1769
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001770 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1773 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1774 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1775 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001776 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001779 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001781 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782
1783 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001784 set_bit(ERASE_CHAR(tty), ldata->char_map);
1785 set_bit(KILL_CHAR(tty), ldata->char_map);
1786 set_bit(EOF_CHAR(tty), ldata->char_map);
1787 set_bit('\n', ldata->char_map);
1788 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001790 set_bit(WERASE_CHAR(tty), ldata->char_map);
1791 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1792 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 if (L_ECHO(tty))
1794 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001795 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 }
1797 }
1798 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001799 set_bit(START_CHAR(tty), ldata->char_map);
1800 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
1802 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001803 set_bit(INTR_CHAR(tty), ldata->char_map);
1804 set_bit(QUIT_CHAR(tty), ldata->char_map);
1805 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001807 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001808 ldata->raw = 0;
1809 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001811 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1813 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1814 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001815 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001817 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001819 /*
1820 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1821 * been stopped by STOP_CHAR(tty) before it.
1822 */
Peter Hurleye2613be2014-02-11 16:34:55 -05001823 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
Wang YanQingdab73b42013-05-09 14:16:47 +08001824 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001825 process_echoes(tty);
1826 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001827
Alan Coxf34d7a52008-04-30 00:54:13 -07001828 /* The termios change make the tty ready for I/O */
Peter Hurley6c677162013-12-02 14:24:46 -05001829 if (waitqueue_active(&tty->write_wait))
1830 wake_up_interruptible(&tty->write_wait);
1831 if (waitqueue_active(&tty->read_wait))
1832 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833}
1834
1835/**
1836 * n_tty_close - close the ldisc for this tty
1837 * @tty: device
1838 *
Alan Cox4edf1822008-02-08 04:18:44 -08001839 * Called from the terminal layer when this line discipline is
1840 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 * discipline change. The function will not be called while other
1842 * ldisc methods are in progress.
1843 */
Alan Cox4edf1822008-02-08 04:18:44 -08001844
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845static void n_tty_close(struct tty_struct *tty)
1846{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001847 struct n_tty_data *ldata = tty->disc_data;
1848
Peter Hurley79901312013-03-11 16:44:23 -04001849 if (tty->link)
1850 n_tty_packet_mode_flush(tty);
1851
Peter Hurley20bafb32013-06-15 10:21:19 -04001852 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001853 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854}
1855
1856/**
1857 * n_tty_open - open an ldisc
1858 * @tty: terminal to open
1859 *
Alan Cox4edf1822008-02-08 04:18:44 -08001860 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 * terminal device. Can sleep. Called serialized so that no
1862 * other events will occur in parallel. No further open will occur
1863 * until a close.
1864 */
1865
1866static int n_tty_open(struct tty_struct *tty)
1867{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001868 struct n_tty_data *ldata;
1869
Peter Hurley20bafb32013-06-15 10:21:19 -04001870 /* Currently a malloc failure here can panic */
1871 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001872 if (!ldata)
1873 goto err;
1874
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001875 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001876 mutex_init(&ldata->atomic_read_lock);
1877 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001878
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001879 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001880 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001881 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001882 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001883 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001884 ldata->num_overrun = 0;
1885 ldata->no_room = 0;
1886 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001888 /* indicate buffer work may resume */
1889 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1890 n_tty_set_termios(tty, NULL);
1891 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001892
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001894err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001895 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896}
1897
Peter Hurleyeafbe672013-12-02 14:24:45 -05001898static inline int input_available_p(struct tty_struct *tty, int poll)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001900 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya5934802014-02-11 11:49:58 -05001901 int amt = poll && !TIME_CHAR(tty) && MIN_CHAR(tty) ? MIN_CHAR(tty) : 1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001902
Peter Hurley25e8d0e2014-02-11 18:55:30 -05001903 if (ldata->icanon && !L_EXTPROC(tty))
1904 return ldata->canon_head != ldata->read_tail;
1905 else
Peter Hurley70aca712015-01-16 15:05:37 -05001906 return ldata->commit_head - ldata->read_tail >= amt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907}
1908
1909/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001910 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 * @tty: terminal device
1912 * @b: user data
1913 * @nr: size of data
1914 *
Alan Cox11a96d12008-10-13 10:46:24 +01001915 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 * ICANON is off; it copies characters straight from the tty queue to
1917 * user space directly. It can be profitably called twice; once to
1918 * drain the space from the tail pointer to the (physical) end of the
1919 * buffer, and once to drain the space from the (physical) beginning of
1920 * the buffer to head pointer.
1921 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001922 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001924 * n_tty_read()/consumer path:
1925 * caller holds non-exclusive termios_rwsem
1926 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 */
Alan Cox4edf1822008-02-08 04:18:44 -08001928
Alan Cox33f0f882006-01-09 20:54:13 -08001929static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 unsigned char __user **b,
1931 size_t *nr)
1932
1933{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001934 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 int retval;
1936 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001937 bool is_eof;
Peter Hurley70aca712015-01-16 15:05:37 -05001938 size_t head = smp_load_acquire(&ldata->commit_head);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001939 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
1941 retval = 0;
Peter Hurley70aca712015-01-16 15:05:37 -05001942 n = min(head - ldata->read_tail, N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001945 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001947 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1948 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001949 ldata->icanon);
Peter Hurley70aca712015-01-16 15:05:37 -05001950 smp_store_release(&ldata->read_tail, ldata->read_tail + n);
hyc@symas.com26df6d12010-06-22 10:14:49 -07001951 /* Turn single EOF into zero-length read */
Peter Hurley70aca712015-01-16 15:05:37 -05001952 if (L_EXTPROC(tty) && ldata->icanon && is_eof &&
1953 (head == ldata->read_tail))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001954 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 *b += n;
1956 *nr -= n;
1957 }
1958 return retval;
1959}
1960
Peter Hurley88bb0de2013-06-15 09:14:16 -04001961/**
Peter Hurley32f13522013-06-15 09:14:17 -04001962 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001963 * @tty: terminal device
1964 * @b: user data
1965 * @nr: size of data
1966 *
1967 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001968 * it copies one line of input up to and including the line-delimiting
1969 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001970 *
Peter Hurley4d0ed182013-12-10 17:12:02 -05001971 * NB: When termios is changed from non-canonical to canonical mode and
1972 * the read buffer contains data, n_tty_set_termios() simulates an EOF
1973 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
1974 * This causes data already processed as input to be immediately available
1975 * as input although a newline has not been received.
1976 *
Peter Hurley88bb0de2013-06-15 09:14:16 -04001977 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001978 *
1979 * n_tty_read()/consumer path:
1980 * caller holds non-exclusive termios_rwsem
1981 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001982 */
1983
Peter Hurley32f13522013-06-15 09:14:17 -04001984static int canon_copy_from_read_buf(struct tty_struct *tty,
1985 unsigned char __user **b,
1986 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001987{
1988 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001989 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001990 size_t eol;
1991 size_t tail;
1992 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001993 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001994
1995 /* N.B. avoid overrun if nr == 0 */
Peter Hurley70aca712015-01-16 15:05:37 -05001996 n = min(*nr, smp_load_acquire(&ldata->canon_head) - ldata->read_tail);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001997 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04001998 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001999
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002000 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04002001 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
2002
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002003 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002004 __func__, *nr, tail, n, size);
2005
2006 eol = find_next_bit(ldata->read_flags, size, tail);
2007 more = n - (size - tail);
2008 if (eol == N_TTY_BUF_SIZE && more) {
2009 /* scan wrapped without finding set bit */
2010 eol = find_next_bit(ldata->read_flags, more, 0);
2011 if (eol != more)
2012 found = 1;
2013 } else if (eol != size)
2014 found = 1;
2015
2016 size = N_TTY_BUF_SIZE - tail;
Peter Hurleyc77569d2013-11-22 07:16:25 -05002017 n = eol - tail;
2018 if (n > 4096)
2019 n += 4096;
2020 n += found;
Peter Hurley32f13522013-06-15 09:14:17 -04002021 c = n;
2022
Peter Hurley4d0ed182013-12-10 17:12:02 -05002023 if (found && !ldata->push && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002024 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002025 eof_push = !n && ldata->read_tail != ldata->line_start;
2026 }
Peter Hurley32f13522013-06-15 09:14:17 -04002027
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002028 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002029 __func__, eol, found, n, c, size, more);
2030
Peter Hurley32f13522013-06-15 09:14:17 -04002031 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002032 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002033 if (ret)
2034 return -EFAULT;
2035 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2036 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002037 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002038
2039 if (ret)
2040 return -EFAULT;
2041 *b += n;
2042 *nr -= n;
2043
Peter Hurleya73d3d62013-06-15 09:14:25 -04002044 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002045 clear_bit(eol, ldata->read_flags);
Peter Hurley70aca712015-01-16 15:05:37 -05002046 smp_store_release(&ldata->read_tail, ldata->read_tail + c);
Peter Hurley88bb0de2013-06-15 09:14:16 -04002047
Peter Hurley40d5e092013-06-15 10:21:17 -04002048 if (found) {
Peter Hurley4d0ed182013-12-10 17:12:02 -05002049 if (!ldata->push)
2050 ldata->line_start = ldata->read_tail;
2051 else
2052 ldata->push = 0;
Peter Hurley32f13522013-06-15 09:14:17 -04002053 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002054 }
2055 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002056}
2057
Al Virocc4191d2008-03-29 03:08:48 +00002058extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002059 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060
2061/**
2062 * job_control - check job control
2063 * @tty: tty
2064 * @file: file handle
2065 *
2066 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002067 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002069 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002070 * Locking: redirected write test is safe
2071 * current->signal->tty check is safe
2072 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 */
Alan Cox4edf1822008-02-08 04:18:44 -08002074
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075static int job_control(struct tty_struct *tty, struct file *file)
2076{
2077 /* Job control check -- must be done at start and after
2078 every sleep (POSIX.1 7.1.1.4). */
2079 /* NOTE: not yet done after every sleep pending a thorough
2080 check of the logic of this change. -- jlc */
2081 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002082 if (file->f_op->write == redirected_tty_write ||
2083 current->signal->tty != tty)
2084 return 0;
2085
2086 spin_lock_irq(&tty->ctrl_lock);
2087 if (!tty->pgrp)
2088 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2089 else if (task_pgrp(current) != tty->pgrp) {
2090 spin_unlock_irq(&tty->ctrl_lock);
2091 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2092 return -EIO;
2093 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2094 set_thread_flag(TIF_SIGPENDING);
2095 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002097 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 return 0;
2099}
Alan Cox4edf1822008-02-08 04:18:44 -08002100
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101
2102/**
Alan Cox11a96d12008-10-13 10:46:24 +01002103 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 * @tty: tty device
2105 * @file: file object
2106 * @buf: userspace buffer pointer
2107 * @nr: size of I/O
2108 *
2109 * Perform reads for the line discipline. We are guaranteed that the
2110 * line discipline will not be closed under us but we may get multiple
2111 * parallel readers and must handle this ourselves. We may also get
2112 * a hangup. Always called in user context, may sleep.
2113 *
2114 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002115 *
2116 * n_tty_read()/consumer path:
2117 * claims non-exclusive termios_rwsem
2118 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 */
Alan Cox4edf1822008-02-08 04:18:44 -08002120
Alan Cox11a96d12008-10-13 10:46:24 +01002121static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 unsigned char __user *buf, size_t nr)
2123{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002124 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 unsigned char __user *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002126 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 int c;
2128 int minimum, time;
2129 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 long timeout;
Alan Cox04f378b2008-04-30 00:53:29 -07002131 int packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002132 size_t tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002135 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002137
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002138 /*
2139 * Internal serialization of reads.
2140 */
2141 if (file->f_flags & O_NONBLOCK) {
2142 if (!mutex_trylock(&ldata->atomic_read_lock))
2143 return -EAGAIN;
2144 } else {
2145 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2146 return -ERESTARTSYS;
2147 }
2148
Peter Hurley9356b532013-06-15 09:14:24 -04002149 down_read(&tty->termios_rwsem);
2150
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 minimum = time = 0;
2152 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002153 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 minimum = MIN_CHAR(tty);
2155 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002156 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002158 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002160 (ldata->minimum_to_wake > minimum))
2161 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002163 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002164 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 }
2166 }
2167
Alan Cox04f378b2008-04-30 00:53:29 -07002168 packet = tty->packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002169 tail = ldata->read_tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
2171 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 while (nr) {
2173 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002174 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 unsigned char cs;
2176 if (b != buf)
2177 break;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002178 spin_lock_irq(&tty->link->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 cs = tty->link->ctrl_status;
2180 tty->link->ctrl_status = 0;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002181 spin_unlock_irq(&tty->link->ctrl_lock);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002182 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 retval = -EFAULT;
2184 b--;
2185 break;
2186 }
2187 nr--;
2188 break;
2189 }
Alan Cox4edf1822008-02-08 04:18:44 -08002190
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002191 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002193 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002194
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 if (!input_available_p(tty, 0)) {
2196 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
Peter Hurley52bce7f2014-11-05 12:13:05 -05002197 retval = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 break;
2199 }
Peter Hurley52bce7f2014-11-05 12:13:05 -05002200 if (tty_hung_up_p(file))
2201 break;
2202 if (!timeout)
2203 break;
2204 if (file->f_flags & O_NONBLOCK) {
2205 retval = -EAGAIN;
2206 break;
2207 }
2208 if (signal_pending(current)) {
2209 retval = -ERESTARTSYS;
2210 break;
2211 }
Peter Hurley52bce7f2014-11-05 12:13:05 -05002212 up_read(&tty->termios_rwsem);
2213
Linus Torvalds37da7bb2014-12-14 15:23:32 -08002214 timeout = wait_woken(&wait, TASK_INTERRUPTIBLE,
2215 timeout);
Peter Hurley52bce7f2014-11-05 12:13:05 -05002216
2217 down_read(&tty->termios_rwsem);
2218 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 }
2220
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002221 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002222 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002223 if (retval == -EAGAIN) {
2224 retval = 0;
2225 continue;
2226 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 break;
2228 } else {
2229 int uncopied;
Peter Hurley95ea90d2014-10-16 15:33:30 -04002230
2231 /* Deal with packet mode. */
2232 if (packet && b == buf) {
2233 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
2234 retval = -EFAULT;
2235 b--;
2236 break;
2237 }
2238 nr--;
2239 }
2240
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 uncopied = copy_from_read_buf(tty, &b, &nr);
2242 uncopied += copy_from_read_buf(tty, &b, &nr);
2243 if (uncopied) {
2244 retval = -EFAULT;
2245 break;
2246 }
2247 }
2248
Peter Hurley6367ca72013-06-15 09:14:33 -04002249 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250
2251 if (b - buf >= minimum)
2252 break;
2253 if (time)
2254 timeout = time;
2255 }
Peter Hurley2c5dc462015-01-16 15:05:34 -05002256 if (tail != ldata->read_tail)
2257 n_tty_kick_worker(tty);
Peter Hurley42458f42013-11-07 13:59:46 -05002258 up_read(&tty->termios_rwsem);
2259
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 remove_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002262 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Peter Hurleyaebf04532013-11-07 14:01:57 -05002264 mutex_unlock(&ldata->atomic_read_lock);
2265
Peter Hurley40d5e092013-06-15 10:21:17 -04002266 if (b - buf)
2267 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
2269 return retval;
2270}
2271
2272/**
Alan Cox11a96d12008-10-13 10:46:24 +01002273 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 * @tty: tty device
2275 * @file: file object
2276 * @buf: userspace buffer pointer
2277 * @nr: size of I/O
2278 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002279 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002281 * and other such events. Since the receive code will echo characters,
2282 * thus calling driver write methods, the output_lock is used in
2283 * the output processing functions called here as well as in the
2284 * echo processing function to protect the column state and space
2285 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 *
2287 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002288 *
2289 * Locking: output_lock to protect column state and space left
2290 * (note that the process_output*() functions take this
2291 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 */
Alan Cox4edf1822008-02-08 04:18:44 -08002293
Alan Cox11a96d12008-10-13 10:46:24 +01002294static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002295 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296{
2297 const unsigned char *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002298 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 int c;
2300 ssize_t retval = 0;
2301
2302 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2303 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2304 retval = tty_check_change(tty);
2305 if (retval)
2306 return retval;
2307 }
2308
Peter Hurley9356b532013-06-15 09:14:24 -04002309 down_read(&tty->termios_rwsem);
2310
Joe Petersona88a69c2009-01-02 13:40:53 +00002311 /* Write out any echoed characters that are still pending */
2312 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002313
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 add_wait_queue(&tty->write_wait, &wait);
2315 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 if (signal_pending(current)) {
2317 retval = -ERESTARTSYS;
2318 break;
2319 }
2320 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2321 retval = -EIO;
2322 break;
2323 }
Peter Hurley582f5592013-05-17 12:49:48 -04002324 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002326 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 if (num < 0) {
2328 if (num == -EAGAIN)
2329 break;
2330 retval = num;
2331 goto break_out;
2332 }
2333 b += num;
2334 nr -= num;
2335 if (nr == 0)
2336 break;
2337 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002338 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 break;
2340 b++; nr--;
2341 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002342 if (tty->ops->flush_chars)
2343 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 } else {
Peter Hurley42910862014-05-03 14:04:59 +02002345 struct n_tty_data *ldata = tty->disc_data;
2346
Roman Zippeld6afe272005-07-07 17:56:55 -07002347 while (nr > 0) {
Peter Hurley42910862014-05-03 14:04:59 +02002348 mutex_lock(&ldata->output_lock);
Alan Coxf34d7a52008-04-30 00:54:13 -07002349 c = tty->ops->write(tty, b, nr);
Peter Hurley42910862014-05-03 14:04:59 +02002350 mutex_unlock(&ldata->output_lock);
Roman Zippeld6afe272005-07-07 17:56:55 -07002351 if (c < 0) {
2352 retval = c;
2353 goto break_out;
2354 }
2355 if (!c)
2356 break;
2357 b += c;
2358 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 }
2361 if (!nr)
2362 break;
2363 if (file->f_flags & O_NONBLOCK) {
2364 retval = -EAGAIN;
2365 break;
2366 }
Peter Hurley9356b532013-06-15 09:14:24 -04002367 up_read(&tty->termios_rwsem);
2368
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002369 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
Peter Hurley9356b532013-06-15 09:14:24 -04002370
2371 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 }
2373break_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002375 if (b - buf != nr && tty->fasync)
2376 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002377 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 return (b - buf) ? b - buf : retval;
2379}
2380
2381/**
Alan Cox11a96d12008-10-13 10:46:24 +01002382 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383 * @tty: terminal device
2384 * @file: file accessing it
2385 * @wait: poll table
2386 *
2387 * Called when the line discipline is asked to poll() for data or
2388 * for special events. This code is not serialized with respect to
2389 * other events save open/close.
2390 *
2391 * This code must be sure never to sleep through a hangup.
2392 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 */
Alan Cox4edf1822008-02-08 04:18:44 -08002394
Alan Cox11a96d12008-10-13 10:46:24 +01002395static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002396 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002398 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 unsigned int mask = 0;
2400
2401 poll_wait(file, &tty->read_wait, wait);
2402 poll_wait(file, &tty->write_wait, wait);
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002403 if (input_available_p(tty, 1))
2404 mask |= POLLIN | POLLRDNORM;
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002405 if (tty->packet && tty->link->ctrl_status)
2406 mask |= POLLPRI | POLLIN | POLLRDNORM;
Peter Hurley2ce3c102014-12-30 07:17:09 -05002407 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2408 mask |= POLLHUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 if (tty_hung_up_p(file))
2410 mask |= POLLHUP;
2411 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2412 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002413 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002415 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002417 if (tty->ops->write && !tty_is_writelocked(tty) &&
2418 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2419 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 mask |= POLLOUT | POLLWRNORM;
2421 return mask;
2422}
2423
Jiri Slaby57c94122012-10-18 22:26:43 +02002424static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002425{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002426 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002427
Peter Hurleya73d3d62013-06-15 09:14:25 -04002428 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002429 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002430 head = ldata->canon_head;
2431 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002432 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002433 /* Skip EOF-chars.. */
2434 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002435 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2436 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002437 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002438 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002439 }
2440 return nr;
2441}
2442
2443static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2444 unsigned int cmd, unsigned long arg)
2445{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002446 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002447 int retval;
2448
2449 switch (cmd) {
2450 case TIOCOUTQ:
2451 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2452 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002453 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002454 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002455 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002456 else
2457 retval = read_cnt(ldata);
2458 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002459 return put_user(retval, (unsigned int __user *) arg);
2460 default:
2461 return n_tty_ioctl_helper(tty, file, cmd, arg);
2462 }
2463}
2464
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002465static void n_tty_fasync(struct tty_struct *tty, int on)
2466{
2467 struct n_tty_data *ldata = tty->disc_data;
2468
2469 if (!waitqueue_active(&tty->read_wait)) {
2470 if (on)
2471 ldata->minimum_to_wake = 1;
2472 else if (!tty->fasync)
2473 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2474 }
2475}
2476
Alan Coxa352def2008-07-16 21:53:12 +01002477struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002478 .magic = TTY_LDISC_MAGIC,
2479 .name = "n_tty",
2480 .open = n_tty_open,
2481 .close = n_tty_close,
2482 .flush_buffer = n_tty_flush_buffer,
2483 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002484 .read = n_tty_read,
2485 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002486 .ioctl = n_tty_ioctl,
2487 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002488 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002489 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002490 .write_wakeup = n_tty_write_wakeup,
2491 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002492 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002494
2495/**
2496 * n_tty_inherit_ops - inherit N_TTY methods
2497 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2498 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002499 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002500 * methods.
2501 */
2502
2503void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2504{
2505 *ops = tty_ldisc_N_TTY;
2506 ops->owner = NULL;
2507 ops->refcount = ops->flags = 0;
2508}
2509EXPORT_SYMBOL_GPL(n_tty_inherit_ops);