blob: 5d83fb5412fd55130d9412682c2ebb06e8782f2e [file] [log] [blame]
Greg Kroah-Hartmane3b3d0f2017-11-06 18:11:51 +01001// SPDX-License-Identifier: GPL-1.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * This code used to be in tty_io.c, but things are getting hairy
6 * enough that it made sense to split things off. (The N_TTY
7 * processing has changed so much that it's hardly recognizable,
8 * anyway...)
9 *
10 * Note that the open routine for N_TTY is guaranteed never to return
11 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080012 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
14 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080015 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * This file also contains code originally written by Linus Torvalds,
17 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080018 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * Reduced memory usage for older ARM systems - Russell King.
20 *
Alan Cox4edf1822008-02-08 04:18:44 -080021 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
23 * who actually finally proved there really was a race.
24 *
25 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
26 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010027 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 * EAGAIN
29 */
30
31#include <linux/types.h>
32#include <linux/major.h>
33#include <linux/errno.h>
34#include <linux/signal.h>
35#include <linux/fcntl.h>
36#include <linux/sched.h>
37#include <linux/interrupt.h>
38#include <linux/tty.h>
39#include <linux/timer.h>
40#include <linux/ctype.h>
41#include <linux/mm.h>
42#include <linux/string.h>
43#include <linux/slab.h>
44#include <linux/poll.h>
45#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070046#include <linux/audit.h>
47#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000048#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080049#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050050#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040051#include <linux/vmalloc.h>
Greg Kroah-Hartman98602c02021-04-08 14:51:22 +020052#include "tty.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Valentin Vidica5db4822018-12-29 13:48:29 +010054/*
55 * Until this number of characters is queued in the xmit buffer, select will
56 * return "we have room for writes".
57 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#define WAKEUP_CHARS 256
59
60/*
61 * This defines the low- and high-watermarks for throttling and
62 * unthrottling the TTY driver. These watermarks are used for
63 * controlling the space in the read buffer.
64 */
65#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010066#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Joe Petersona88a69c2009-01-02 13:40:53 +000068/*
69 * Special byte codes used in the echo buffer to represent operations
70 * or special handling of characters. Bytes in the echo buffer that
71 * are not part of such special blocks are treated as normal character
72 * codes.
73 */
74#define ECHO_OP_START 0xff
75#define ECHO_OP_MOVE_BACK_COL 0x80
76#define ECHO_OP_SET_CANON_COL 0x81
77#define ECHO_OP_ERASE_TAB 0x82
78
Peter Hurleycbfd0342013-06-15 10:04:26 -040079#define ECHO_COMMIT_WATERMARK 256
80#define ECHO_BLOCK 256
81#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
82
83
Peter Hurley32f13522013-06-15 09:14:17 -040084#undef N_TTY_TRACE
85#ifdef N_TTY_TRACE
86# define n_tty_trace(f, args...) trace_printk(f, ##args)
87#else
Jiri Slabya2878852020-01-30 12:58:43 +010088# define n_tty_trace(f, args...) no_printk(f, ##args)
Peter Hurley32f13522013-06-15 09:14:17 -040089#endif
90
Jiri Slaby70ece7a2012-10-18 22:26:38 +020091struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040092 /* producer-published */
93 size_t read_head;
Peter Hurley70aca712015-01-16 15:05:37 -050094 size_t commit_head;
Peter Hurleyfb7aa032013-06-15 09:14:30 -040095 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040096 size_t echo_head;
97 size_t echo_commit;
Peter Hurley1075a6e2013-12-09 18:06:07 -050098 size_t echo_mark;
Peter Hurley1bb9d562013-06-15 10:21:20 -040099 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400100
101 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200102 unsigned long overrun_time;
103 int num_overrun;
104
Peter Hurley24a89d12013-06-15 09:14:15 -0400105 /* non-atomic */
106 bool no_room;
107
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400108 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200109 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Peter Hurley4d0ed182013-12-10 17:12:02 -0500110 unsigned char push:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200111
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400112 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400113 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200114 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400115 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200116
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400117 /* consumer-published */
118 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400119 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400120
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400121 /* protected by output lock */
122 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200123 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400124 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200125
126 struct mutex atomic_read_lock;
127 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200128};
129
Tetsuo Handa3d63b7e2018-05-26 09:53:13 +0900130#define MASK(x) ((x) & (N_TTY_BUF_SIZE - 1))
131
Peter Hurleyce741172013-06-15 09:14:20 -0400132static inline size_t read_cnt(struct n_tty_data *ldata)
133{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400134 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400135}
136
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400137static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
138{
139 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
140}
141
142static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
143{
144 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
145}
146
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400147static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
148{
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900149 smp_rmb(); /* Matches smp_wmb() in add_echo_byte(). */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400150 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
151}
152
153static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
154{
155 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
156}
157
Greg KHb97b3d92018-10-04 11:06:14 -0700158/* If we are not echoing the data, perhaps this is a secret so erase it */
159static void zero_buffer(struct tty_struct *tty, u8 *buffer, int size)
160{
161 bool icanon = !!L_ICANON(tty);
162 bool no_echo = !L_ECHO(tty);
163
164 if (icanon && no_echo)
165 memset(buffer, 0x00, size);
166}
167
Linus Torvalds3b830a92021-01-18 13:31:30 -0800168static void tty_copy(struct tty_struct *tty, void *to, size_t tail, size_t n)
Laura Abbott72586c62015-05-14 11:42:17 -0700169{
170 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley679e7c22015-11-27 14:11:02 -0500171 size_t size = N_TTY_BUF_SIZE - tail;
Greg KHb97b3d92018-10-04 11:06:14 -0700172 void *from = read_buf_addr(ldata, tail);
Peter Hurley679e7c22015-11-27 14:11:02 -0500173
174 if (n > size) {
Peter Hurley309426a2016-01-09 22:55:27 -0800175 tty_audit_add_data(tty, from, size);
Linus Torvalds3b830a92021-01-18 13:31:30 -0800176 memcpy(to, from, size);
177 zero_buffer(tty, from, size);
Peter Hurley679e7c22015-11-27 14:11:02 -0500178 to += size;
179 n -= size;
180 from = ldata->read_buf;
181 }
Laura Abbott72586c62015-05-14 11:42:17 -0700182
Peter Hurley309426a2016-01-09 22:55:27 -0800183 tty_audit_add_data(tty, from, n);
Linus Torvalds3b830a92021-01-18 13:31:30 -0800184 memcpy(to, from, n);
185 zero_buffer(tty, from, n);
Laura Abbott72586c62015-05-14 11:42:17 -0700186}
187
Peter Hurley24a89d12013-06-15 09:14:15 -0400188/**
Peter Hurley2c5dc462015-01-16 15:05:34 -0500189 * n_tty_kick_worker - start input worker (if required)
Peter Hurley24a89d12013-06-15 09:14:15 -0400190 * @tty: terminal
191 *
Peter Hurley2c5dc462015-01-16 15:05:34 -0500192 * Re-schedules the flip buffer work if it may have stopped
Peter Hurley24a89d12013-06-15 09:14:15 -0400193 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400194 * Caller holds exclusive termios_rwsem
195 * or
196 * n_tty_read()/consumer path:
197 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400198 */
199
Peter Hurley2c5dc462015-01-16 15:05:34 -0500200static void n_tty_kick_worker(struct tty_struct *tty)
Peter Hurley7879a9f2013-06-15 07:28:31 -0400201{
Peter Hurley24a89d12013-06-15 09:14:15 -0400202 struct n_tty_data *ldata = tty->disc_data;
203
Peter Hurley2c5dc462015-01-16 15:05:34 -0500204 /* Did the input worker stop? Restart it */
205 if (unlikely(ldata->no_room)) {
Peter Hurley24a89d12013-06-15 09:14:15 -0400206 ldata->no_room = 0;
207
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200208 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400209 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400210 /* see if ldisc has been killed - if so, this means that
211 * even though the ldisc has been halted and ->buf.work
212 * cancelled, ->buf.work is about to be rescheduled
213 */
214 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
215 "scheduling buffer work for halted ldisc\n");
Peter Hurleye1760582015-10-17 16:36:23 -0400216 tty_buffer_restart_work(tty->port);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200217 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900218}
219
Peter Hurley9a4aec22013-06-15 09:14:32 -0400220static ssize_t chars_in_buffer(struct tty_struct *tty)
221{
222 struct n_tty_data *ldata = tty->disc_data;
223 ssize_t n = 0;
224
225 if (!ldata->icanon)
Peter Hurley70aca712015-01-16 15:05:37 -0500226 n = ldata->commit_head - ldata->read_tail;
Peter Hurley9a4aec22013-06-15 09:14:32 -0400227 else
228 n = ldata->canon_head - ldata->read_tail;
229 return n;
230}
231
Peter Hurleyee0bab82013-06-15 09:14:34 -0400232/**
233 * n_tty_write_wakeup - asynchronous I/O notifier
234 * @tty: tty device
235 *
236 * Required for the ptys, serial driver etc. since processes
237 * that attach themselves to the master and rely on ASYNC
238 * IO must be woken up
239 */
240
241static void n_tty_write_wakeup(struct tty_struct *tty)
242{
Peter Hurley7bccc362016-01-09 21:45:12 -0800243 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
244 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
Peter Hurleyee0bab82013-06-15 09:14:34 -0400245}
246
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400247static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400248{
Peter Hurleya3428462015-01-16 15:05:35 -0500249 struct n_tty_data *ldata = tty->disc_data;
250
Peter Hurley6367ca72013-06-15 09:14:33 -0400251 /*
252 * Check the remaining room for the input canonicalization
253 * mode. We don't want to throttle the driver if we're in
254 * canonical mode and don't have a newline yet!
255 */
Peter Hurleya3428462015-01-16 15:05:35 -0500256 if (ldata->icanon && ldata->canon_head == ldata->read_tail)
257 return;
258
Peter Hurley6367ca72013-06-15 09:14:33 -0400259 while (1) {
260 int throttled;
261 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
Peter Hurley5e28cca2015-01-16 15:05:36 -0500262 if (N_TTY_BUF_SIZE - read_cnt(ldata) >= TTY_THRESHOLD_THROTTLE)
Peter Hurley6367ca72013-06-15 09:14:33 -0400263 break;
264 throttled = tty_throttle_safe(tty);
265 if (!throttled)
266 break;
267 }
268 __tty_set_flow_change(tty, 0);
269}
270
Peter Hurley4b293492013-07-24 08:29:55 -0400271static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400272{
Peter Hurley6d27a632016-01-10 22:40:56 -0800273 if (tty->driver->type == TTY_DRIVER_TYPE_PTY) {
Peter Hurley3afb1b392013-07-23 08:47:30 -0400274 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
275 return;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500276 n_tty_kick_worker(tty);
Peter Hurley6d27a632016-01-10 22:40:56 -0800277 tty_wakeup(tty->link);
Peter Hurley3afb1b392013-07-23 08:47:30 -0400278 return;
279 }
280
Peter Hurley6367ca72013-06-15 09:14:33 -0400281 /* If there is enough space in the read buffer now, let the
282 * low-level driver know. We use chars_in_buffer() to
283 * check the buffer, as it now knows about canonical mode.
284 * Otherwise, if the driver is throttled and the line is
285 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
286 * we won't get any more characters.
287 */
288
289 while (1) {
290 int unthrottled;
291 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
292 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
293 break;
Peter Hurley2c5dc462015-01-16 15:05:34 -0500294 n_tty_kick_worker(tty);
Peter Hurley6367ca72013-06-15 09:14:33 -0400295 unthrottled = tty_unthrottle_safe(tty);
296 if (!unthrottled)
297 break;
298 }
299 __tty_set_flow_change(tty, 0);
300}
301
Alan Cox17b82062008-10-13 10:45:06 +0100302/**
303 * put_tty_queue - add character to tty
304 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200305 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100306 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400307 * Add a character to the tty read_buf queue.
308 *
309 * n_tty_receive_buf()/producer path:
310 * caller holds non-exclusive termios_rwsem
Alan Cox17b82062008-10-13 10:45:06 +0100311 */
312
Peter Hurley19e2ad62013-07-24 08:29:54 -0400313static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314{
Christian Riesch8bfbe2d2014-11-13 05:53:26 +0100315 *read_buf_addr(ldata, ldata->read_head) = c;
316 ldata->read_head++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317}
318
319/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * reset_buffer_flags - reset buffer state
Jiri Slaby724ac072020-08-18 10:56:52 +0200321 * @ldata: line disc data to reset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 *
Peter Hurley25518c62013-03-11 16:44:31 -0400323 * Reset the read buffer counters and clear the flags.
324 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100325 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400326 * Locking: caller holds exclusive termios_rwsem
327 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000329
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400330static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400332 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley70aca712015-01-16 15:05:37 -0500333 ldata->commit_head = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400334 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000335
Peter Hurleya73d3d62013-06-15 09:14:25 -0400336 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200337 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -0500338 ldata->push = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339}
340
Peter Hurleya30737a2013-03-11 16:44:22 -0400341static void n_tty_packet_mode_flush(struct tty_struct *tty)
342{
343 unsigned long flags;
344
Peter Hurleya30737a2013-03-11 16:44:22 -0400345 if (tty->link->packet) {
Peter Hurley54e8e5f2014-10-16 15:33:26 -0400346 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya30737a2013-03-11 16:44:22 -0400347 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
Peter Hurley54e8e5f2014-10-16 15:33:26 -0400348 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Kosuke Tatsukawae81107d2015-10-02 08:27:05 +0000349 wake_up_interruptible(&tty->link->read_wait);
Peter Hurleya30737a2013-03-11 16:44:22 -0400350 }
Peter Hurleya30737a2013-03-11 16:44:22 -0400351}
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353/**
354 * n_tty_flush_buffer - clean input queue
355 * @tty: terminal device
356 *
Peter Hurley25518c62013-03-11 16:44:31 -0400357 * Flush the input buffer. Called when the tty layer wants the
358 * buffer flushed (eg at hangup) or when the N_TTY line discipline
359 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400361 * Holds termios_rwsem to exclude producer/consumer while
362 * buffer indices are reset.
363 *
364 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 */
Alan Cox4edf1822008-02-08 04:18:44 -0800366
367static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400369 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400370 reset_buffer_flags(tty->disc_data);
Peter Hurley2c5dc462015-01-16 15:05:34 -0500371 n_tty_kick_worker(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800372
Peter Hurleya30737a2013-03-11 16:44:22 -0400373 if (tty->link)
374 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400375 up_write(&tty->termios_rwsem);
376}
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 * is_utf8_continuation - utf8 multibyte check
380 * @c: byte to check
381 *
382 * Returns true if the utf8 character 'c' is a multibyte continuation
383 * character. We use this to correctly compute the on screen size
384 * of the character when printing
385 */
Alan Cox4edf1822008-02-08 04:18:44 -0800386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387static inline int is_utf8_continuation(unsigned char c)
388{
389 return (c & 0xc0) == 0x80;
390}
391
392/**
393 * is_continuation - multibyte check
394 * @c: byte to check
Lee Jones171044a2020-11-04 19:35:23 +0000395 * @tty: terminal device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 *
397 * Returns true if the utf8 character 'c' is a multibyte continuation
398 * character and the terminal is in unicode mode.
399 */
Alan Cox4edf1822008-02-08 04:18:44 -0800400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401static inline int is_continuation(unsigned char c, struct tty_struct *tty)
402{
403 return I_IUTF8(tty) && is_utf8_continuation(c);
404}
405
406/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000407 * do_output_char - output one character
408 * @c: character (or partial unicode symbol)
409 * @tty: terminal device
410 * @space: space available in tty driver write buffer
411 *
412 * This is a helper function that handles one output character
413 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600414 * doing OPOST processing and putting the results in the
415 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000416 *
417 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
418 * and NLDLY. They simply aren't relevant in the world today.
419 * If you ever need them, add them here.
420 *
421 * Returns the number of bytes of buffer space used or -1 if
422 * no space left.
423 *
424 * Locking: should be called under the output_lock to protect
425 * the column state and space left in the buffer
426 */
427
428static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
429{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200430 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000431 int spaces;
432
433 if (!space)
434 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000435
Joe Petersona88a69c2009-01-02 13:40:53 +0000436 switch (c) {
437 case '\n':
438 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200439 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000440 if (O_ONLCR(tty)) {
441 if (space < 2)
442 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200443 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700444 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000445 return 2;
446 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200447 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000448 break;
449 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200450 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000451 return 0;
452 if (O_OCRNL(tty)) {
453 c = '\n';
454 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200455 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000456 break;
457 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200458 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000459 break;
460 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200461 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000462 if (O_TABDLY(tty) == XTABS) {
463 if (space < spaces)
464 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200465 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000466 tty->ops->write(tty, " ", spaces);
467 return spaces;
468 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200469 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000470 break;
471 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200472 if (ldata->column > 0)
473 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000474 break;
475 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000476 if (!iscntrl(c)) {
477 if (O_OLCUC(tty))
478 c = toupper(c);
479 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200480 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000481 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000482 break;
483 }
484
485 tty_put_char(tty, c);
486 return 1;
487}
488
489/**
490 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 * @c: character (or partial unicode symbol)
492 * @tty: terminal device
493 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600494 * Output one character with OPOST processing.
495 * Returns -1 when the output device is full and the character
496 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000498 * Locking: output_lock to protect column state and space left
499 * (also, this is called from n_tty_write under the
500 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 */
Alan Cox4edf1822008-02-08 04:18:44 -0800502
Joe Petersona88a69c2009-01-02 13:40:53 +0000503static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
Jiri Slabybddc7152012-10-18 22:26:42 +0200505 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000506 int space, retval;
507
Jiri Slabybddc7152012-10-18 22:26:42 +0200508 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Alan Coxf34d7a52008-04-30 00:54:13 -0700510 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000511 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Jiri Slabybddc7152012-10-18 22:26:42 +0200513 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000514 if (retval < 0)
515 return -1;
516 else
517 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518}
519
520/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000521 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600523 * @buf: character buffer
524 * @nr: number of bytes to output
525 *
526 * Output a block of characters with OPOST processing.
527 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 *
529 * This path is used to speed up block console writes, among other
530 * things when processing blocks of output data. It handles only
531 * the simple cases normally found and helps to generate blocks of
532 * symbols for the console driver and thus improve performance.
533 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000534 * Locking: output_lock to protect column state and space left
535 * (also, this is called from n_tty_write under the
536 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
Alan Cox4edf1822008-02-08 04:18:44 -0800538
Joe Petersona88a69c2009-01-02 13:40:53 +0000539static ssize_t process_output_block(struct tty_struct *tty,
540 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200542 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100544 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 const unsigned char *cp;
546
Jiri Slabybddc7152012-10-18 22:26:42 +0200547 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000548
Alan Coxf34d7a52008-04-30 00:54:13 -0700549 space = tty_write_room(tty);
Colin Ian King9ef89272019-03-30 00:46:28 +0000550 if (space <= 0) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200551 mutex_unlock(&ldata->output_lock);
Colin Ian King9ef89272019-03-30 00:46:28 +0000552 return space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 if (nr > space)
555 nr = space;
556
557 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000558 unsigned char c = *cp;
559
560 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 case '\n':
562 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200563 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 if (O_ONLCR(tty))
565 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200566 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 break;
568 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200569 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 goto break_out;
571 if (O_OCRNL(tty))
572 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200573 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 break;
575 case '\t':
576 goto break_out;
577 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200578 if (ldata->column > 0)
579 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 break;
581 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000582 if (!iscntrl(c)) {
583 if (O_OLCUC(tty))
584 goto break_out;
585 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200586 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000587 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 break;
589 }
590 }
591break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700592 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000593
Jiri Slabybddc7152012-10-18 22:26:42 +0200594 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 return i;
596}
597
Joe Petersona88a69c2009-01-02 13:40:53 +0000598/**
599 * process_echoes - write pending echo characters
600 * @tty: terminal device
601 *
602 * Write previously buffered echo (and other ldisc-generated)
603 * characters to the tty.
604 *
605 * Characters generated by the ldisc (including echoes) need to
606 * be buffered because the driver's write buffer can fill during
607 * heavy program output. Echoing straight to the driver will
608 * often fail under these conditions, causing lost characters and
609 * resulting mismatches of ldisc state information.
610 *
611 * Since the ldisc state must represent the characters actually sent
612 * to the driver at the time of the write, operations like certain
613 * changes in column state are also saved in the buffer and executed
614 * here.
615 *
616 * A circular fifo buffer is used so that the most recent characters
617 * are prioritized. Also, when control characters are echoed with a
618 * prefixed "^", the pair is treated atomically and thus not separated.
619 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400620 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000621 */
622
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400623static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000624{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200625 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400626 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400627 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000628 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000629
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400630 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000631
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400632 tail = ldata->echo_tail;
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900633 while (MASK(ldata->echo_commit) != MASK(tail)) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400634 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000635 if (c == ECHO_OP_START) {
636 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000637 int no_space_left = 0;
638
639 /*
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900640 * Since add_echo_byte() is called without holding
641 * output_lock, we might see only portion of multi-byte
642 * operation.
643 */
644 if (MASK(ldata->echo_commit) == MASK(tail + 1))
645 goto not_yet_stored;
646 /*
Joe Petersona88a69c2009-01-02 13:40:53 +0000647 * If the buffer byte is the start of a multi-byte
648 * operation, get the next byte, which is either the
649 * op code or a control character value.
650 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400651 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000652
Joe Petersona88a69c2009-01-02 13:40:53 +0000653 switch (op) {
Kees Cooke24cd4e2020-02-19 22:23:13 -0800654 case ECHO_OP_ERASE_TAB: {
Joe Petersona88a69c2009-01-02 13:40:53 +0000655 unsigned int num_chars, num_bs;
656
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900657 if (MASK(ldata->echo_commit) == MASK(tail + 2))
658 goto not_yet_stored;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400659 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000660
661 /*
662 * Determine how many columns to go back
663 * in order to erase the tab.
664 * This depends on the number of columns
665 * used by other characters within the tab
666 * area. If this (modulo 8) count is from
667 * the start of input rather than from a
668 * previous tab, we offset by canon column.
669 * Otherwise, tab spacing is normal.
670 */
671 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200672 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000673 num_bs = 8 - (num_chars & 7);
674
675 if (num_bs > space) {
676 no_space_left = 1;
677 break;
678 }
679 space -= num_bs;
680 while (num_bs--) {
681 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200682 if (ldata->column > 0)
683 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000684 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400685 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000686 break;
Kees Cooke24cd4e2020-02-19 22:23:13 -0800687 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000688 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200689 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400690 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000691 break;
692
693 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200694 if (ldata->column > 0)
695 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400696 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000697 break;
698
699 case ECHO_OP_START:
700 /* This is an escaped echo op start code */
701 if (!space) {
702 no_space_left = 1;
703 break;
704 }
705 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200706 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000707 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400708 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000709 break;
710
711 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000712 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600713 * If the op is not a special byte code,
714 * it is a ctrl char tagged to be echoed
715 * as "^X" (where X is the letter
716 * representing the control char).
717 * Note that we must ensure there is
718 * enough space for the whole ctrl pair.
719 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000720 */
Joe Peterson62b26352009-09-09 15:03:47 -0600721 if (space < 2) {
722 no_space_left = 1;
723 break;
724 }
725 tty_put_char(tty, '^');
726 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200727 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600728 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400729 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000730 }
731
732 if (no_space_left)
733 break;
734 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400735 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600736 int retval = do_output_char(c, tty, space);
737 if (retval < 0)
738 break;
739 space -= retval;
740 } else {
741 if (!space)
742 break;
743 tty_put_char(tty, c);
744 space -= 1;
745 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400746 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000747 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000748 }
749
Peter Hurleycbfd0342013-06-15 10:04:26 -0400750 /* If the echo buffer is nearly full (so that the possibility exists
751 * of echo overrun before the next commit), then discard enough
752 * data at the tail to prevent a subsequent overrun */
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900753 while (ldata->echo_commit > tail &&
754 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
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900764 not_yet_stored:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400765 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400766 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000767}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Peter Hurley17bd7902013-06-15 10:04:24 -0400769static void commit_echoes(struct tty_struct *tty)
770{
771 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400772 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400773 size_t head;
774
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900775 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400776 head = ldata->echo_head;
Peter Hurley1075a6e2013-12-09 18:06:07 -0500777 ldata->echo_mark = head;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400778 old = ldata->echo_commit - ldata->echo_tail;
779
780 /* Process committed echoes if the accumulated # of bytes
781 * is over the threshold (and try again each time another
782 * block is accumulated) */
783 nr = head - ldata->echo_tail;
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900784 if (nr < ECHO_COMMIT_WATERMARK ||
785 (nr % ECHO_BLOCK > old % ECHO_BLOCK)) {
786 mutex_unlock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400787 return;
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900788 }
Peter Hurley17bd7902013-06-15 10:04:24 -0400789
Peter Hurleycbfd0342013-06-15 10:04:26 -0400790 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400791 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400792 mutex_unlock(&ldata->output_lock);
793
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400794 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400795 tty->ops->flush_chars(tty);
796}
797
798static void process_echoes(struct tty_struct *tty)
799{
800 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400801 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400802
Peter Hurleye2613be2014-02-11 16:34:55 -0500803 if (ldata->echo_mark == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400804 return;
805
806 mutex_lock(&ldata->output_lock);
Peter Hurley1075a6e2013-12-09 18:06:07 -0500807 ldata->echo_commit = ldata->echo_mark;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400808 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400809 mutex_unlock(&ldata->output_lock);
810
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400811 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400812 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400813}
814
Peter Hurley1075a6e2013-12-09 18:06:07 -0500815/* NB: echo_mark and echo_head should be equivalent here */
Peter Hurleycbfd0342013-06-15 10:04:26 -0400816static void flush_echoes(struct tty_struct *tty)
817{
818 struct n_tty_data *ldata = tty->disc_data;
819
Peter Hurley39434ab2013-11-29 12:56:10 -0500820 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
821 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400822 return;
823
824 mutex_lock(&ldata->output_lock);
825 ldata->echo_commit = ldata->echo_head;
826 __process_echoes(tty);
827 mutex_unlock(&ldata->output_lock);
828}
829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000831 * add_echo_byte - add a byte to the echo buffer
832 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200833 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000834 *
835 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000836 */
837
Peter Hurleycbfd0342013-06-15 10:04:26 -0400838static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000839{
Tetsuo Handaebec3f82018-05-26 09:53:14 +0900840 *echo_buf_addr(ldata, ldata->echo_head) = c;
841 smp_wmb(); /* Matches smp_rmb() in echo_buf(). */
842 ldata->echo_head++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000843}
844
845/**
846 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200847 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000848 *
849 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000850 */
851
Jiri Slaby57c94122012-10-18 22:26:43 +0200852static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000853{
Jiri Slaby57c94122012-10-18 22:26:43 +0200854 add_echo_byte(ECHO_OP_START, ldata);
855 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000856}
857
858/**
859 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200860 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000861 *
862 * Add an operation to the echo buffer to set the canon column
863 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000864 */
865
Jiri Slaby57c94122012-10-18 22:26:43 +0200866static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000867{
Jiri Slaby57c94122012-10-18 22:26:43 +0200868 add_echo_byte(ECHO_OP_START, ldata);
869 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000870}
871
872/**
873 * echo_erase_tab - add operation to erase a tab
874 * @num_chars: number of character columns already used
875 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200876 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000877 *
878 * Add an operation to the echo buffer to erase a tab.
879 *
880 * Called by the eraser function, which knows how many character
881 * columns have been used since either a previous tab or the start
882 * of input. This information will be used later, along with
883 * canon column (if applicable), to go back the correct number
884 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000885 */
886
887static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200888 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000889{
Jiri Slaby57c94122012-10-18 22:26:43 +0200890 add_echo_byte(ECHO_OP_START, ldata);
891 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000892
893 /* We only need to know this modulo 8 (tab spacing) */
894 num_chars &= 7;
895
896 /* Set the high bit as a flag if num_chars is after a previous tab */
897 if (after_tab)
898 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000899
Jiri Slaby57c94122012-10-18 22:26:43 +0200900 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000901}
902
903/**
904 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 * @c: unicode byte to echo
Jiri Slaby724ac072020-08-18 10:56:52 +0200906 * @ldata: line disc data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 *
Alan Cox4edf1822008-02-08 04:18:44 -0800908 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100910 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000911 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000912 */
913
Jiri Slaby57c94122012-10-18 22:26:43 +0200914static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000915{
Joe Petersona88a69c2009-01-02 13:40:53 +0000916 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200917 add_echo_byte(ECHO_OP_START, ldata);
918 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000919 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200920 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000921 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000922}
923
924/**
925 * echo_char - echo a character
926 * @c: unicode byte to echo
927 * @tty: terminal device
928 *
929 * Echo user input back onto the screen. This must be called only when
930 * L_ECHO(tty) is true. Called from the driver receive_buf path.
931 *
Joe Peterson62b26352009-09-09 15:03:47 -0600932 * This variant tags control characters to be echoed as "^X"
933 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 */
935
936static void echo_char(unsigned char c, struct tty_struct *tty)
937{
Jiri Slabybddc7152012-10-18 22:26:42 +0200938 struct n_tty_data *ldata = tty->disc_data;
939
Joe Petersona88a69c2009-01-02 13:40:53 +0000940 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200941 add_echo_byte(ECHO_OP_START, ldata);
942 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000943 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600944 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200945 add_echo_byte(ECHO_OP_START, ldata);
946 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000947 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948}
949
Alan Cox17b82062008-10-13 10:45:06 +0100950/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000951 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200952 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100953 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000954
Jiri Slaby57c94122012-10-18 22:26:43 +0200955static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200957 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200958 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200959 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 }
961}
962
963/**
964 * eraser - handle erase function
965 * @c: character input
966 * @tty: terminal device
967 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200968 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 * present in the stream from the driver layer. Handles the complexities
970 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100971 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400972 * n_tty_receive_buf()/producer path:
973 * caller holds non-exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 */
Alan Cox4edf1822008-02-08 04:18:44 -0800975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976static void eraser(unsigned char c, struct tty_struct *tty)
977{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200978 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400980 size_t head;
981 size_t cnt;
982 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200984 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +0000985 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 return;
987 }
988 if (c == ERASE_CHAR(tty))
989 kill_type = ERASE;
990 else if (c == WERASE_CHAR(tty))
991 kill_type = WERASE;
992 else {
993 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200994 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 return;
996 }
997 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200998 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +0200999 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 echo_char(KILL_CHAR(tty), tty);
1001 /* Add a newline if ECHOK is on and ECHOKE is off. */
1002 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001003 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 return;
1005 }
1006 kill_type = KILL;
1007 }
1008
1009 seen_alnums = 0;
Tetsuo Handa3d63b7e2018-05-26 09:53:13 +09001010 while (MASK(ldata->read_head) != MASK(ldata->canon_head)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001011 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
1013 /* erase a single possibly multibyte character */
1014 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001015 head--;
1016 c = read_buf(ldata, head);
Tetsuo Handa3d63b7e2018-05-26 09:53:13 +09001017 } while (is_continuation(c, tty) &&
1018 MASK(head) != MASK(ldata->canon_head));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
1020 /* do not partially erase */
1021 if (is_continuation(c, tty))
1022 break;
1023
1024 if (kill_type == WERASE) {
1025 /* Equivalent to BSD's ALTWERASE. */
1026 if (isalnum(c) || c == '_')
1027 seen_alnums++;
1028 else if (seen_alnums)
1029 break;
1030 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001031 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001032 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 if (L_ECHO(tty)) {
1034 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001035 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001036 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001037 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 }
1039 /* if cnt > 1, output a multi-byte character */
1040 echo_char(c, tty);
1041 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001042 head++;
1043 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001044 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 }
1046 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1047 echo_char(ERASE_CHAR(tty), tty);
1048 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001049 unsigned int num_chars = 0;
1050 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001051 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
Joe Petersona88a69c2009-01-02 13:40:53 +00001053 /*
1054 * Count the columns used for characters
1055 * since the start of input or after a
1056 * previous tab.
1057 * This info is used to go back the correct
1058 * number of columns.
1059 */
Tetsuo Handa3d63b7e2018-05-26 09:53:13 +09001060 while (MASK(tail) != MASK(ldata->canon_head)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001061 tail--;
1062 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001063 if (c == '\t') {
1064 after_tab = 1;
1065 break;
Alan Cox300a6202009-01-02 13:41:04 +00001066 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001068 num_chars += 2;
1069 } else if (!is_continuation(c, tty)) {
1070 num_chars++;
1071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001073 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 } else {
1075 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001076 echo_char_raw('\b', ldata);
1077 echo_char_raw(' ', ldata);
1078 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 }
1080 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001081 echo_char_raw('\b', ldata);
1082 echo_char_raw(' ', ldata);
1083 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 }
1085 }
1086 }
1087 if (kill_type == ERASE)
1088 break;
1089 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001090 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001091 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092}
1093
1094/**
1095 * isig - handle the ISIG optio
1096 * @sig: signal
1097 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001099 * Called when a signal is being sent due to terminal input.
1100 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001101 *
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001102 * Performs input and output flush if !NOFLSH. In this context, the echo
1103 * buffer is 'output'. The signal is processed first to alert any current
1104 * readers or writers to discontinue and exit their i/o loops.
1105 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001106 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 */
Alan Cox4edf1822008-02-08 04:18:44 -08001108
Peter Hurley3b19e032015-06-27 09:21:32 -04001109static void __isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110{
Peter Hurley8c985d12013-03-06 08:38:19 -05001111 struct pid *tty_pgrp = tty_get_pgrp(tty);
1112 if (tty_pgrp) {
1113 kill_pgrp(tty_pgrp, sig, 1);
1114 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 }
Peter Hurley3b19e032015-06-27 09:21:32 -04001116}
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001117
Peter Hurley3b19e032015-06-27 09:21:32 -04001118static void isig(int sig, struct tty_struct *tty)
1119{
1120 struct n_tty_data *ldata = tty->disc_data;
1121
1122 if (L_NOFLSH(tty)) {
1123 /* signal only */
1124 __isig(sig, tty);
1125
1126 } else { /* signal and flush */
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001127 up_read(&tty->termios_rwsem);
1128 down_write(&tty->termios_rwsem);
1129
Peter Hurley3b19e032015-06-27 09:21:32 -04001130 __isig(sig, tty);
1131
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001132 /* clear echo buffer */
1133 mutex_lock(&ldata->output_lock);
1134 ldata->echo_head = ldata->echo_tail = 0;
1135 ldata->echo_mark = ldata->echo_commit = 0;
1136 mutex_unlock(&ldata->output_lock);
1137
1138 /* clear output buffer */
1139 tty_driver_flush_buffer(tty);
1140
1141 /* clear input buffer */
1142 reset_buffer_flags(tty->disc_data);
1143
1144 /* notify pty master of flush */
1145 if (tty->link)
1146 n_tty_packet_mode_flush(tty);
1147
1148 up_write(&tty->termios_rwsem);
1149 down_read(&tty->termios_rwsem);
1150 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151}
1152
1153/**
1154 * n_tty_receive_break - handle break
1155 * @tty: terminal
1156 *
1157 * An RS232 break event has been hit in the incoming bitstream. This
1158 * can cause a variety of events depending upon the termios settings.
1159 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001160 * n_tty_receive_buf()/producer path:
1161 * caller holds non-exclusive termios_rwsem
Peter Hurley6d76bd22013-06-15 09:14:26 -04001162 *
1163 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 */
Alan Cox4edf1822008-02-08 04:18:44 -08001165
Peter Hurley4b293492013-07-24 08:29:55 -04001166static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167{
Jiri Slaby57c94122012-10-18 22:26:43 +02001168 struct n_tty_data *ldata = tty->disc_data;
1169
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 if (I_IGNBRK(tty))
1171 return;
1172 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001173 isig(SIGINT, tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 return;
1175 }
1176 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001177 put_tty_queue('\377', ldata);
1178 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001180 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181}
1182
1183/**
1184 * n_tty_receive_overrun - handle overrun reporting
1185 * @tty: terminal
1186 *
1187 * Data arrived faster than we could process it. While the tty
1188 * driver has flagged this the bits that were missed are gone
1189 * forever.
1190 *
1191 * Called from the receive_buf path so single threaded. Does not
1192 * need locking as num_overrun and overrun_time are function
1193 * private.
1194 */
Alan Cox4edf1822008-02-08 04:18:44 -08001195
Peter Hurley4b293492013-07-24 08:29:55 -04001196static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001198 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001200 ldata->num_overrun++;
1201 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1202 time_after(ldata->overrun_time, jiffies)) {
Peter Hurley339f36b2015-11-08 13:01:13 -05001203 tty_warn(tty, "%d input overrun(s)\n", ldata->num_overrun);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001204 ldata->overrun_time = jiffies;
1205 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 }
1207}
1208
1209/**
1210 * n_tty_receive_parity_error - error notifier
1211 * @tty: terminal device
1212 * @c: character
1213 *
1214 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001215 * the error case if necessary.
1216 *
1217 * n_tty_receive_buf()/producer path:
1218 * caller holds non-exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 */
Peter Hurley4b293492013-07-24 08:29:55 -04001220static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221{
Jiri Slaby57c94122012-10-18 22:26:43 +02001222 struct n_tty_data *ldata = tty->disc_data;
1223
Peter Hurley66528f92014-06-16 08:10:42 -04001224 if (I_INPCK(tty)) {
1225 if (I_IGNPAR(tty))
1226 return;
1227 if (I_PARMRK(tty)) {
1228 put_tty_queue('\377', ldata);
1229 put_tty_queue('\0', ldata);
1230 put_tty_queue(c, ldata);
1231 } else
1232 put_tty_queue('\0', ldata);
1233 } else
Jiri Slaby57c94122012-10-18 22:26:43 +02001234 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235}
1236
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001237static void
1238n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1239{
Peter Hurleyd2b6f442015-01-17 15:42:06 -05001240 isig(signal, tty);
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001241 if (I_IXON(tty))
1242 start_tty(tty);
1243 if (L_ECHO(tty)) {
1244 echo_char(c, tty);
1245 commit_echoes(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001246 } else
1247 process_echoes(tty);
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001248 return;
1249}
1250
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251/**
1252 * n_tty_receive_char - perform processing
1253 * @tty: terminal device
1254 * @c: character
1255 *
1256 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001257 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001259 *
1260 * n_tty_receive_buf()/producer path:
1261 * caller holds non-exclusive termios_rwsem
1262 * publishes canon_head if canonical mode is active
Peter Hurleye60d27c2013-07-24 08:29:56 -04001263 *
1264 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 */
1266
Peter Hurleye60d27c2013-07-24 08:29:56 -04001267static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001268n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001270 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 if (I_IXON(tty)) {
1273 if (c == START_CHAR(tty)) {
1274 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001275 process_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001276 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 }
1278 if (c == STOP_CHAR(tty)) {
1279 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001280 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 }
1282 }
Joe Peterson575537b32008-04-30 00:53:30 -07001283
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001285 if (c == INTR_CHAR(tty)) {
1286 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001287 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001288 } else if (c == QUIT_CHAR(tty)) {
1289 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001290 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001291 } else if (c == SUSP_CHAR(tty)) {
1292 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001293 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 }
1295 }
Joe Peterson575537b32008-04-30 00:53:30 -07001296
Peter Hurley855df3c2013-07-24 08:29:50 -04001297 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1298 start_tty(tty);
1299 process_echoes(tty);
1300 }
1301
Joe Peterson575537b32008-04-30 00:53:30 -07001302 if (c == '\r') {
1303 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001304 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001305 if (I_ICRNL(tty))
1306 c = '\n';
1307 } else if (c == '\n' && I_INLCR(tty))
1308 c = '\r';
1309
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001310 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1312 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1313 eraser(c, tty);
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 == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001318 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001320 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001322 echo_char_raw('^', ldata);
1323 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001324 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 }
1326 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001327 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001329 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001330 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Jiri Slaby57c94122012-10-18 22:26:43 +02001332 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001334 echo_char_raw('\n', ldata);
Tetsuo Handa3d63b7e2018-05-26 09:53:13 +09001335 while (MASK(tail) != MASK(ldata->read_head)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001336 echo_char(read_buf(ldata, tail), tty);
1337 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001339 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001340 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 }
1342 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001343 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001344 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001345 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 }
1347 goto handle_newline;
1348 }
1349 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 c = __DISABLED_CHAR;
1351 goto handle_newline;
1352 }
1353 if ((c == EOL_CHAR(tty)) ||
1354 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
1355 /*
1356 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1357 */
1358 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001360 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001361 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001363 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 }
1365 /*
1366 * XXX does PARMRK doubling happen for
1367 * EOL_CHAR and EOL2_CHAR?
1368 */
Peter Hurley001ba922013-12-02 14:24:44 -05001369 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001370 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
Alan Cox4edf1822008-02-08 04:18:44 -08001372handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001373 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001374 put_tty_queue(c, ldata);
Peter Hurley70aca712015-01-16 15:05:37 -05001375 smp_store_release(&ldata->canon_head, ldata->read_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001377 wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001378 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 }
1380 }
Alan Cox4edf1822008-02-08 04:18:44 -08001381
Joe Petersonacc71bb2009-01-02 13:43:32 +00001382 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001383 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001385 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 else {
1387 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001388 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001389 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 echo_char(c, tty);
1391 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001392 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 }
1394
Peter Hurley001ba922013-12-02 14:24:44 -05001395 /* PARMRK doubling check */
1396 if (c == (unsigned char) '\377' && I_PARMRK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001397 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Jiri Slaby57c94122012-10-18 22:26:43 +02001399 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001400 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001401}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Jiri Slaby89bb4a32021-05-05 11:18:56 +02001403static void n_tty_receive_char(struct tty_struct *tty, unsigned char c,
1404 bool parmrk_dbl)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001405{
1406 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001407
Peter Hurleye60d27c2013-07-24 08:29:56 -04001408 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1409 start_tty(tty);
1410 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001411 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001412 if (L_ECHO(tty)) {
1413 finish_erasing(ldata);
1414 /* Record the column of first canon char. */
1415 if (ldata->canon_head == ldata->read_head)
1416 echo_set_canon_col(ldata);
1417 echo_char(c, tty);
1418 commit_echoes(tty);
1419 }
Peter Hurley001ba922013-12-02 14:24:44 -05001420 /* PARMRK doubling check */
Jiri Slaby89bb4a32021-05-05 11:18:56 +02001421 if (parmrk_dbl && c == (unsigned char) '\377' && I_PARMRK(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001422 put_tty_queue(c, ldata);
1423 put_tty_queue(c, ldata);
1424}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001425
Peter Hurley8dc4b252013-12-02 14:24:43 -05001426static void n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001427{
1428 if (I_ISTRIP(tty))
1429 c &= 0x7f;
1430 if (I_IUCLC(tty) && L_IEXTEN(tty))
1431 c = tolower(c);
1432
1433 if (I_IXON(tty)) {
1434 if (c == STOP_CHAR(tty))
1435 stop_tty(tty);
1436 else if (c == START_CHAR(tty) ||
1437 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1438 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1439 c != SUSP_CHAR(tty))) {
1440 start_tty(tty);
1441 process_echoes(tty);
1442 }
1443 }
1444}
1445
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001446static void
1447n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1448{
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001449 switch (flag) {
1450 case TTY_BREAK:
1451 n_tty_receive_break(tty);
1452 break;
1453 case TTY_PARITY:
1454 case TTY_FRAME:
1455 n_tty_receive_parity_error(tty, c);
1456 break;
1457 case TTY_OVERRUN:
1458 n_tty_receive_overrun(tty);
1459 break;
1460 default:
Peter Hurley339f36b2015-11-08 13:01:13 -05001461 tty_err(tty, "unknown flag %d\n", flag);
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001462 break;
1463 }
1464}
1465
Peter Hurleye60d27c2013-07-24 08:29:56 -04001466static void
1467n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1468{
1469 struct n_tty_data *ldata = tty->disc_data;
1470
1471 ldata->lnext = 0;
1472 if (likely(flag == TTY_NORMAL)) {
1473 if (I_ISTRIP(tty))
1474 c &= 0x7f;
1475 if (I_IUCLC(tty) && L_IEXTEN(tty))
1476 c = tolower(c);
Jiri Slaby89bb4a32021-05-05 11:18:56 +02001477 n_tty_receive_char(tty, c, true);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001478 } else
1479 n_tty_receive_char_flagged(tty, c, flag);
1480}
1481
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001482static void
1483n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1484 char *fp, int count)
1485{
1486 struct n_tty_data *ldata = tty->disc_data;
1487 size_t n, head;
1488
1489 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
Peter Hurley70aca712015-01-16 15:05:37 -05001490 n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001491 memcpy(read_buf_addr(ldata, head), cp, n);
1492 ldata->read_head += n;
1493 cp += n;
1494 count -= n;
1495
1496 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
Peter Hurley70aca712015-01-16 15:05:37 -05001497 n = min_t(size_t, count, N_TTY_BUF_SIZE - head);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001498 memcpy(read_buf_addr(ldata, head), cp, n);
1499 ldata->read_head += n;
1500}
1501
Peter Hurley554117bd2013-06-15 10:21:25 -04001502static void
1503n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1504 char *fp, int count)
1505{
1506 struct n_tty_data *ldata = tty->disc_data;
1507 char flag = TTY_NORMAL;
1508
1509 while (count--) {
1510 if (fp)
1511 flag = *fp++;
1512 if (likely(flag == TTY_NORMAL))
1513 put_tty_queue(*cp++, ldata);
1514 else
1515 n_tty_receive_char_flagged(tty, *cp++, flag);
1516 }
1517}
1518
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001519static void
1520n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1521 char *fp, int count)
1522{
1523 char flag = TTY_NORMAL;
1524
1525 while (count--) {
1526 if (fp)
1527 flag = *fp++;
1528 if (likely(flag == TTY_NORMAL))
1529 n_tty_receive_char_closing(tty, *cp++);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001530 }
1531}
1532
Jiri Slaby1ed2dfe2021-05-05 11:18:57 +02001533static void n_tty_receive_buf_standard(struct tty_struct *tty,
1534 const unsigned char *cp, char *fp, int count)
Peter Hurley6baad002013-07-24 08:29:52 -04001535{
1536 struct n_tty_data *ldata = tty->disc_data;
1537 char flag = TTY_NORMAL;
1538
1539 while (count--) {
1540 if (fp)
1541 flag = *fp++;
1542 if (likely(flag == TTY_NORMAL)) {
1543 unsigned char c = *cp++;
1544
1545 if (I_ISTRIP(tty))
1546 c &= 0x7f;
1547 if (I_IUCLC(tty) && L_IEXTEN(tty))
1548 c = tolower(c);
1549 if (L_EXTPROC(tty)) {
1550 put_tty_queue(c, ldata);
1551 continue;
1552 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001553 if (!test_bit(c, ldata->char_map))
Jiri Slaby89bb4a32021-05-05 11:18:56 +02001554 n_tty_receive_char(tty, c, true);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001555 else if (n_tty_receive_char_special(tty, c) && count) {
1556 if (fp)
1557 flag = *fp++;
1558 n_tty_receive_char_lnext(tty, *cp++, flag);
1559 count--;
1560 }
Peter Hurley6baad002013-07-24 08:29:52 -04001561 } else
1562 n_tty_receive_char_flagged(tty, *cp++, flag);
1563 }
1564}
1565
Peter Hurley24a89d12013-06-15 09:14:15 -04001566static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1567 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001569 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001570 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001572 if (ldata->real_raw)
1573 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001574 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117bd2013-06-15 10:21:25 -04001575 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001576 else if (tty->closing && !L_EXTPROC(tty))
1577 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001578 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001579 if (ldata->lnext) {
1580 char flag = TTY_NORMAL;
1581
1582 if (fp)
1583 flag = *fp++;
1584 n_tty_receive_char_lnext(tty, *cp++, flag);
1585 count--;
1586 }
1587
Jiri Slaby1ed2dfe2021-05-05 11:18:57 +02001588 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001589
1590 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001591 if (tty->ops->flush_chars)
1592 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 }
1594
Peter Hurley70aca712015-01-16 15:05:37 -05001595 if (ldata->icanon && !L_EXTPROC(tty))
1596 return;
1597
1598 /* publish read_head to consumer */
1599 smp_store_release(&ldata->commit_head, ldata->read_head);
1600
Peter Hurley33d71362016-01-09 21:45:08 -08001601 if (read_cnt(ldata)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
Linus Torvaldsa9a08842018-02-11 14:34:03 -08001603 wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605}
1606
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001607/**
1608 * n_tty_receive_buf_common - process input
1609 * @tty: device to receive input
1610 * @cp: input chars
1611 * @fp: flags for each char (if NULL, all chars are TTY_NORMAL)
1612 * @count: number of input chars in @cp
Lee Jones171044a2020-11-04 19:35:23 +00001613 * @flow: enable flow control
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001614 *
1615 * Called by the terminal driver when a block of characters has
1616 * been received. This function must be called from soft contexts
1617 * not from interrupt context. The driver is responsible for making
1618 * calls one at a time and in order (or using flush_to_ldisc)
1619 *
1620 * Returns the # of input chars from @cp which were processed.
1621 *
1622 * In canonical mode, the maximum line length is 4096 chars (including
1623 * the line termination char); lines longer than 4096 chars are
1624 * truncated. After 4095 chars, input data is still processed but
1625 * not stored. Overflow processing ensures the tty can always
1626 * receive more input until at least one line can be read.
1627 *
1628 * In non-canonical mode, the read buffer will only accept 4095 chars;
1629 * this provides the necessary space for a newline char if the input
1630 * mode is switched to canonical.
1631 *
1632 * Note it is possible for the read buffer to _contain_ 4096 chars
1633 * in non-canonical mode: the read buffer could already contain the
1634 * maximum canon line of 4096 chars when the mode is switched to
1635 * non-canonical.
1636 *
1637 * n_tty_receive_buf()/producer path:
1638 * claims non-exclusive termios_rwsem
1639 * publishes commit_head or canon_head
1640 */
Peter Hurley5c32d122013-12-02 14:24:41 -05001641static int
1642n_tty_receive_buf_common(struct tty_struct *tty, const unsigned char *cp,
1643 char *fp, int count, int flow)
Peter Hurley24a89d12013-06-15 09:14:15 -04001644{
1645 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001646 int room, n, rcvd = 0, overflow;
Peter Hurley24a89d12013-06-15 09:14:15 -04001647
Peter Hurley9356b532013-06-15 09:14:24 -04001648 down_read(&tty->termios_rwsem);
1649
Dmitry Safonovc96cf922018-11-01 00:24:48 +00001650 do {
Peter Hurley70aca712015-01-16 15:05:37 -05001651 /*
Peter Hurley06c49f92015-01-16 15:05:38 -05001652 * When PARMRK is set, each input char may take up to 3 chars
1653 * in the read buf; reduce the buffer space avail by 3x
Peter Hurley70aca712015-01-16 15:05:37 -05001654 *
1655 * If we are doing input canonicalization, and there are no
1656 * pending newlines, let characters through without limit, so
1657 * that erase characters will be handled. Other excess
1658 * characters will be beeped.
1659 *
1660 * paired with store in *_copy_from_read_buf() -- guarantees
1661 * the consumer has loaded the data in read_buf up to the new
1662 * read_tail (so this producer will not overwrite unread data)
1663 */
1664 size_t tail = smp_load_acquire(&ldata->read_tail);
Peter Hurley70aca712015-01-16 15:05:37 -05001665
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001666 room = N_TTY_BUF_SIZE - (ldata->read_head - tail);
Peter Hurley70aca712015-01-16 15:05:37 -05001667 if (I_PARMRK(tty))
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001668 room = (room + 2) / 3;
1669 room--;
1670 if (room <= 0) {
1671 overflow = ldata->icanon && ldata->canon_head == tail;
1672 if (overflow && room < 0)
1673 ldata->read_head--;
1674 room = overflow;
1675 ldata->no_room = flow && !room;
1676 } else
1677 overflow = 0;
Peter Hurley70aca712015-01-16 15:05:37 -05001678
Peter Hurley19e2ad62013-07-24 08:29:54 -04001679 n = min(count, room);
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001680 if (!n)
Peter Hurley19e2ad62013-07-24 08:29:54 -04001681 break;
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001682
1683 /* ignore parity errors if handling overflow */
1684 if (!overflow || !fp || *fp != TTY_PARITY)
1685 __receive_buf(tty, cp, fp, n);
1686
Peter Hurley19e2ad62013-07-24 08:29:54 -04001687 cp += n;
1688 if (fp)
1689 fp += n;
1690 count -= n;
1691 rcvd += n;
Dmitry Safonovc96cf922018-11-01 00:24:48 +00001692 } while (!test_bit(TTY_LDISC_CHANGING, &tty->flags));
Peter Hurley24a89d12013-06-15 09:14:15 -04001693
Peter Hurley19e2ad62013-07-24 08:29:54 -04001694 tty->receive_room = room;
Peter Hurleyfb5ef9e2015-01-16 15:05:39 -05001695
1696 /* Unthrottle if handling overflow on pty */
1697 if (tty->driver->type == TTY_DRIVER_TYPE_PTY) {
1698 if (overflow) {
1699 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
1700 tty_unthrottle_safe(tty);
1701 __tty_set_flow_change(tty, 0);
1702 }
1703 } else
1704 n_tty_check_throttle(tty);
1705
Peter Hurley9356b532013-06-15 09:14:24 -04001706 up_read(&tty->termios_rwsem);
1707
Peter Hurley19e2ad62013-07-24 08:29:54 -04001708 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001709}
1710
Peter Hurley5c32d122013-12-02 14:24:41 -05001711static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1712 char *fp, int count)
1713{
1714 n_tty_receive_buf_common(tty, cp, fp, count, 0);
1715}
1716
1717static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1718 char *fp, int count)
1719{
1720 return n_tty_receive_buf_common(tty, cp, fp, count, 1);
1721}
1722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723/**
1724 * n_tty_set_termios - termios data changed
1725 * @tty: terminal
1726 * @old: previous data
1727 *
1728 * Called by the tty layer when the user changes termios flags so
1729 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001730 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 * guaranteed that this function will not be re-entered or in progress
1732 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001733 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001734 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 */
Alan Cox4edf1822008-02-08 04:18:44 -08001736
1737static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001739 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001740
Linus Torvalds966031f2017-12-20 17:57:06 -08001741 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & (ICANON | EXTPROC)) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001742 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley4d0ed182013-12-10 17:12:02 -05001743 ldata->line_start = ldata->read_tail;
1744 if (!L_ICANON(tty) || !read_cnt(ldata)) {
1745 ldata->canon_head = ldata->read_tail;
1746 ldata->push = 0;
1747 } else {
1748 set_bit((ldata->read_head - 1) & (N_TTY_BUF_SIZE - 1),
1749 ldata->read_flags);
1750 ldata->canon_head = ldata->read_head;
1751 ldata->push = 1;
1752 }
Peter Hurley70aca712015-01-16 15:05:37 -05001753 ldata->commit_head = ldata->read_head;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001754 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001755 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001756 }
1757
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001758 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001759
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1761 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1762 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1763 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001764 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
1766 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001767 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001769 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770
1771 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001772 set_bit(ERASE_CHAR(tty), ldata->char_map);
1773 set_bit(KILL_CHAR(tty), ldata->char_map);
1774 set_bit(EOF_CHAR(tty), ldata->char_map);
1775 set_bit('\n', ldata->char_map);
1776 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001778 set_bit(WERASE_CHAR(tty), ldata->char_map);
1779 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1780 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 if (L_ECHO(tty))
1782 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001783 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
1785 }
1786 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001787 set_bit(START_CHAR(tty), ldata->char_map);
1788 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 }
1790 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001791 set_bit(INTR_CHAR(tty), ldata->char_map);
1792 set_bit(QUIT_CHAR(tty), ldata->char_map);
1793 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001795 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001796 ldata->raw = 0;
1797 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001799 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1801 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1802 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001803 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001805 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001807 /*
1808 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1809 * been stopped by STOP_CHAR(tty) before it.
1810 */
Peter Hurleye2613be2014-02-11 16:34:55 -05001811 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped) {
Wang YanQingdab73b42013-05-09 14:16:47 +08001812 start_tty(tty);
Peter Hurleye2613be2014-02-11 16:34:55 -05001813 process_echoes(tty);
1814 }
Wang YanQingdab73b42013-05-09 14:16:47 +08001815
Alan Coxf34d7a52008-04-30 00:54:13 -07001816 /* The termios change make the tty ready for I/O */
Kosuke Tatsukawae81107d2015-10-02 08:27:05 +00001817 wake_up_interruptible(&tty->write_wait);
1818 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819}
1820
1821/**
1822 * n_tty_close - close the ldisc for this tty
1823 * @tty: device
1824 *
Alan Cox4edf1822008-02-08 04:18:44 -08001825 * Called from the terminal layer when this line discipline is
1826 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 * discipline change. The function will not be called while other
1828 * ldisc methods are in progress.
1829 */
Alan Cox4edf1822008-02-08 04:18:44 -08001830
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831static void n_tty_close(struct tty_struct *tty)
1832{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001833 struct n_tty_data *ldata = tty->disc_data;
1834
Peter Hurley79901312013-03-11 16:44:23 -04001835 if (tty->link)
1836 n_tty_packet_mode_flush(tty);
1837
Yan.Gaoc9cd57b2020-12-10 10:25:07 +08001838 down_write(&tty->termios_rwsem);
Peter Hurley20bafb32013-06-15 10:21:19 -04001839 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001840 tty->disc_data = NULL;
Yan.Gaoc9cd57b2020-12-10 10:25:07 +08001841 up_write(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842}
1843
1844/**
1845 * n_tty_open - open an ldisc
1846 * @tty: terminal to open
1847 *
Alan Cox4edf1822008-02-08 04:18:44 -08001848 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 * terminal device. Can sleep. Called serialized so that no
1850 * other events will occur in parallel. No further open will occur
1851 * until a close.
1852 */
1853
1854static int n_tty_open(struct tty_struct *tty)
1855{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001856 struct n_tty_data *ldata;
1857
Peter Hurley20bafb32013-06-15 10:21:19 -04001858 /* Currently a malloc failure here can panic */
Tetsuo Handaebec3f82018-05-26 09:53:14 +09001859 ldata = vzalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001860 if (!ldata)
Tetsuo Handaebec3f82018-05-26 09:53:14 +09001861 return -ENOMEM;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001862
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001863 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001864 mutex_init(&ldata->atomic_read_lock);
1865 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001866
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001867 tty->disc_data = ldata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001869 /* indicate buffer work may resume */
1870 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1871 n_tty_set_termios(tty, NULL);
1872 tty_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 return 0;
1874}
1875
Peter Hurleyeafbe672013-12-02 14:24:45 -05001876static inline int input_available_p(struct tty_struct *tty, int poll)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001878 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya5934802014-02-11 11:49:58 -05001879 int amt = poll && !TIME_CHAR(tty) && MIN_CHAR(tty) ? MIN_CHAR(tty) : 1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001880
Peter Hurley25e8d0e2014-02-11 18:55:30 -05001881 if (ldata->icanon && !L_EXTPROC(tty))
1882 return ldata->canon_head != ldata->read_tail;
1883 else
Peter Hurley70aca712015-01-16 15:05:37 -05001884 return ldata->commit_head - ldata->read_tail >= amt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885}
1886
1887/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001888 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 * @tty: terminal device
Linus Torvalds3b830a92021-01-18 13:31:30 -08001890 * @kbp: data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 * @nr: size of data
1892 *
Alan Cox11a96d12008-10-13 10:46:24 +01001893 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds3b830a92021-01-18 13:31:30 -08001894 * ICANON is off; it copies characters straight from the tty queue.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001896 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 *
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08001898 * Returns true if it successfully copied data, but there is still
1899 * more data to be had.
1900 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001901 * n_tty_read()/consumer path:
1902 * caller holds non-exclusive termios_rwsem
1903 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 */
Alan Cox4edf1822008-02-08 04:18:44 -08001905
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08001906static bool copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds3b830a92021-01-18 13:31:30 -08001907 unsigned char **kbp,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 size_t *nr)
1909
1910{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001911 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001913 bool is_eof;
Peter Hurley70aca712015-01-16 15:05:37 -05001914 size_t head = smp_load_acquire(&ldata->commit_head);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001915 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
Peter Hurley70aca712015-01-16 15:05:37 -05001917 n = min(head - ldata->read_tail, N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 if (n) {
Greg KHb97b3d92018-10-04 11:06:14 -07001920 unsigned char *from = read_buf_addr(ldata, tail);
Linus Torvalds3b830a92021-01-18 13:31:30 -08001921 memcpy(*kbp, from, n);
Peter Hurleye661cf72015-11-27 14:11:03 -05001922 is_eof = n == 1 && *from == EOF_CHAR(tty);
Peter Hurley309426a2016-01-09 22:55:27 -08001923 tty_audit_add_data(tty, from, n);
Greg KHb97b3d92018-10-04 11:06:14 -07001924 zero_buffer(tty, from, n);
Peter Hurley70aca712015-01-16 15:05:37 -05001925 smp_store_release(&ldata->read_tail, ldata->read_tail + n);
hyc@symas.com26df6d12010-06-22 10:14:49 -07001926 /* Turn single EOF into zero-length read */
Peter Hurley70aca712015-01-16 15:05:37 -05001927 if (L_EXTPROC(tty) && ldata->icanon && is_eof &&
1928 (head == ldata->read_tail))
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08001929 return false;
Linus Torvalds3b830a92021-01-18 13:31:30 -08001930 *kbp += n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 *nr -= n;
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08001932
1933 /* If we have more to copy, let the caller know */
1934 return head != ldata->read_tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 }
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08001936 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937}
1938
Peter Hurley88bb0de2013-06-15 09:14:16 -04001939/**
Peter Hurley32f13522013-06-15 09:14:17 -04001940 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001941 * @tty: terminal device
Linus Torvalds3b830a92021-01-18 13:31:30 -08001942 * @kbp: data
Peter Hurley88bb0de2013-06-15 09:14:16 -04001943 * @nr: size of data
1944 *
1945 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001946 * it copies one line of input up to and including the line-delimiting
Linus Torvalds3b830a92021-01-18 13:31:30 -08001947 * character into the result buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001948 *
Peter Hurley4d0ed182013-12-10 17:12:02 -05001949 * NB: When termios is changed from non-canonical to canonical mode and
1950 * the read buffer contains data, n_tty_set_termios() simulates an EOF
1951 * push (as if C-d were input) _without_ the DISABLED_CHAR in the buffer.
1952 * This causes data already processed as input to be immediately available
1953 * as input although a newline has not been received.
1954 *
Peter Hurley88bb0de2013-06-15 09:14:16 -04001955 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001956 *
1957 * n_tty_read()/consumer path:
1958 * caller holds non-exclusive termios_rwsem
1959 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001960 */
1961
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08001962static bool canon_copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds64a698922021-01-19 13:46:28 -08001963 unsigned char **kbp,
1964 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001965{
1966 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001967 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001968 size_t eol;
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08001969 size_t tail, canon_head;
Linus Torvalds3b830a92021-01-18 13:31:30 -08001970 int found = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001971
1972 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05001973 if (!*nr)
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08001974 return false;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001975
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08001976 canon_head = smp_load_acquire(&ldata->canon_head);
1977 n = min(*nr + 1, canon_head - ldata->read_tail);
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05001978
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001979 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04001980 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1981
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001982 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04001983 __func__, *nr, tail, n, size);
1984
1985 eol = find_next_bit(ldata->read_flags, size, tail);
1986 more = n - (size - tail);
1987 if (eol == N_TTY_BUF_SIZE && more) {
1988 /* scan wrapped without finding set bit */
1989 eol = find_next_bit(ldata->read_flags, more, 0);
Peter Hurleyb985e9e2015-11-27 14:11:04 -05001990 found = eol != more;
1991 } else
1992 found = eol != size;
Peter Hurley32f13522013-06-15 09:14:17 -04001993
Peter Hurleyc77569d2013-11-22 07:16:25 -05001994 n = eol - tail;
Mark Tomlinsonda555db2015-05-18 12:01:48 +12001995 if (n > N_TTY_BUF_SIZE)
1996 n += N_TTY_BUF_SIZE;
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05001997 c = n + found;
Peter Hurley32f13522013-06-15 09:14:17 -04001998
Peter Hurleyac8f3bf2015-11-27 13:59:20 -05001999 if (!found || read_buf(ldata, eol) != __DISABLED_CHAR) {
2000 c = min(*nr, c);
2001 n = c;
Peter Hurley40d5e092013-06-15 10:21:17 -04002002 }
Peter Hurley32f13522013-06-15 09:14:17 -04002003
Peter Hurley679e7c22015-11-27 14:11:02 -05002004 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu tail:%zu more:%zu\n",
2005 __func__, eol, found, n, c, tail, more);
Peter Hurley32f13522013-06-15 09:14:17 -04002006
Linus Torvalds3b830a92021-01-18 13:31:30 -08002007 tty_copy(tty, *kbp, tail, n);
2008 *kbp += n;
Peter Hurley32f13522013-06-15 09:14:17 -04002009 *nr -= n;
2010
Peter Hurleya73d3d62013-06-15 09:14:25 -04002011 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002012 clear_bit(eol, ldata->read_flags);
Peter Hurley70aca712015-01-16 15:05:37 -05002013 smp_store_release(&ldata->read_tail, ldata->read_tail + c);
Peter Hurley88bb0de2013-06-15 09:14:16 -04002014
Peter Hurley40d5e092013-06-15 10:21:17 -04002015 if (found) {
Peter Hurley4d0ed182013-12-10 17:12:02 -05002016 if (!ldata->push)
2017 ldata->line_start = ldata->read_tail;
2018 else
2019 ldata->push = 0;
Peter Hurleyb50819f2016-01-09 22:55:30 -08002020 tty_audit_push();
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08002021 return false;
Peter Hurley40d5e092013-06-15 10:21:17 -04002022 }
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08002023
2024 /* No EOL found - do a continuation retry if there is more data */
2025 return ldata->read_tail != canon_head;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002026}
2027
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028/**
2029 * job_control - check job control
2030 * @tty: tty
2031 * @file: file handle
2032 *
2033 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002034 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002036 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002037 * Locking: redirected write test is safe
2038 * current->signal->tty check is safe
2039 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 */
Alan Cox4edf1822008-02-08 04:18:44 -08002041
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042static int job_control(struct tty_struct *tty, struct file *file)
2043{
2044 /* Job control check -- must be done at start and after
2045 every sleep (POSIX.1 7.1.1.4). */
2046 /* NOTE: not yet done after every sleep pending a thorough
2047 check of the logic of this change. -- jlc */
2048 /* don't stop on /dev/console */
Sami Tolvanen9f12e372021-01-25 11:09:25 -08002049 if (file->f_op->write_iter == redirected_tty_write)
Peter Hurley01a5e442013-03-06 08:38:20 -05002050 return 0;
2051
Peter Hurley2812d9e2015-10-10 20:28:42 -04002052 return __tty_check_change(tty, SIGTTIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053}
Alan Cox4edf1822008-02-08 04:18:44 -08002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055
2056/**
Alan Cox11a96d12008-10-13 10:46:24 +01002057 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 * @tty: tty device
2059 * @file: file object
2060 * @buf: userspace buffer pointer
2061 * @nr: size of I/O
2062 *
2063 * Perform reads for the line discipline. We are guaranteed that the
2064 * line discipline will not be closed under us but we may get multiple
2065 * parallel readers and must handle this ourselves. We may also get
2066 * a hangup. Always called in user context, may sleep.
2067 *
2068 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002069 *
2070 * n_tty_read()/consumer path:
2071 * claims non-exclusive termios_rwsem
2072 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 */
Alan Cox4edf1822008-02-08 04:18:44 -08002074
Alan Cox11a96d12008-10-13 10:46:24 +01002075static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds3b830a92021-01-18 13:31:30 -08002076 unsigned char *kbuf, size_t nr,
2077 void **cookie, unsigned long offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002079 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds3b830a92021-01-18 13:31:30 -08002080 unsigned char *kb = kbuf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002081 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002082 int c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 int minimum, time;
2084 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 long timeout;
Alan Cox04f378b2008-04-30 00:53:29 -07002086 int packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002087 size_t tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08002089 /*
2090 * Is this a continuation of a read started earler?
2091 *
2092 * If so, we still hold the atomic_read_lock and the
2093 * termios_rwsem, and can just continue to copy data.
2094 */
2095 if (*cookie) {
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08002096 if (ldata->icanon && !L_EXTPROC(tty)) {
2097 if (canon_copy_from_read_buf(tty, &kb, &nr))
2098 return kb - kbuf;
2099 } else {
2100 if (copy_from_read_buf(tty, &kb, &nr))
2101 return kb - kbuf;
2102 }
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08002103
2104 /* No more data - release locks and stop retries */
2105 n_tty_kick_worker(tty);
2106 n_tty_check_unthrottle(tty);
2107 up_read(&tty->termios_rwsem);
2108 mutex_unlock(&ldata->atomic_read_lock);
2109 *cookie = NULL;
2110 return kb - kbuf;
2111 }
2112
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002114 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002116
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002117 /*
2118 * Internal serialization of reads.
2119 */
2120 if (file->f_flags & O_NONBLOCK) {
2121 if (!mutex_trylock(&ldata->atomic_read_lock))
2122 return -EAGAIN;
2123 } else {
2124 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2125 return -ERESTARTSYS;
2126 }
2127
Peter Hurley9356b532013-06-15 09:14:24 -04002128 down_read(&tty->termios_rwsem);
2129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 minimum = time = 0;
2131 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002132 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 minimum = MIN_CHAR(tty);
2134 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002135 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002137 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurley33d71362016-01-09 21:45:08 -08002138 minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 }
2140 }
2141
Alan Cox04f378b2008-04-30 00:53:29 -07002142 packet = tty->packet;
Peter Hurley2c5dc462015-01-16 15:05:34 -05002143 tail = ldata->read_tail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144
2145 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 while (nr) {
2147 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002148 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 unsigned char cs;
Linus Torvalds3b830a92021-01-18 13:31:30 -08002150 if (kb != kbuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 break;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002152 spin_lock_irq(&tty->link->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 cs = tty->link->ctrl_status;
2154 tty->link->ctrl_status = 0;
Peter Hurley6054c16e2014-10-16 15:33:25 -04002155 spin_unlock_irq(&tty->link->ctrl_lock);
Linus Torvalds3b830a92021-01-18 13:31:30 -08002156 *kb++ = cs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 nr--;
2158 break;
2159 }
Alan Cox4edf1822008-02-08 04:18:44 -08002160
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 if (!input_available_p(tty, 0)) {
Peter Hurley52bce7f2014-11-05 12:13:05 -05002162 up_read(&tty->termios_rwsem);
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002163 tty_buffer_flush_work(tty->port);
Peter Hurley52bce7f2014-11-05 12:13:05 -05002164 down_read(&tty->termios_rwsem);
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002165 if (!input_available_p(tty, 0)) {
2166 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
2167 retval = -EIO;
2168 break;
2169 }
2170 if (tty_hung_up_p(file))
2171 break;
Tejun Heo28b0f8a2018-02-13 07:38:08 -08002172 /*
2173 * Abort readers for ttys which never actually
2174 * get hung up. See __tty_hangup().
2175 */
2176 if (test_bit(TTY_HUPPING, &tty->flags))
2177 break;
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002178 if (!timeout)
2179 break;
Dmitry Safonovc96cf922018-11-01 00:24:48 +00002180 if (tty_io_nonblock(tty, file)) {
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002181 retval = -EAGAIN;
2182 break;
2183 }
2184 if (signal_pending(current)) {
2185 retval = -ERESTARTSYS;
2186 break;
2187 }
2188 up_read(&tty->termios_rwsem);
2189
2190 timeout = wait_woken(&wait, TASK_INTERRUPTIBLE,
2191 timeout);
2192
2193 down_read(&tty->termios_rwsem);
2194 continue;
2195 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 }
2197
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002198 if (ldata->icanon && !L_EXTPROC(tty)) {
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08002199 if (canon_copy_from_read_buf(tty, &kb, &nr))
2200 goto more_to_be_read;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 } else {
Peter Hurley95ea90d2014-10-16 15:33:30 -04002202 /* Deal with packet mode. */
Linus Torvalds3b830a92021-01-18 13:31:30 -08002203 if (packet && kb == kbuf) {
2204 *kb++ = TIOCPKT_DATA;
Peter Hurley95ea90d2014-10-16 15:33:30 -04002205 nr--;
2206 }
2207
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08002208 /*
2209 * Copy data, and if there is more to be had
2210 * and we have nothing more to wait for, then
2211 * let's mark us for retries.
2212 *
2213 * NOTE! We return here with both the termios_sem
2214 * and atomic_read_lock still held, the retries
2215 * will release them when done.
2216 */
2217 if (copy_from_read_buf(tty, &kb, &nr) && kb - kbuf >= minimum) {
Linus Torvaldsd7fe75c2021-01-20 15:43:38 -08002218more_to_be_read:
Linus Torvalds15ea8ae2021-01-19 18:14:20 -08002219 remove_wait_queue(&tty->read_wait, &wait);
2220 *cookie = cookie;
2221 return kb - kbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 }
2223 }
2224
Peter Hurley6367ca72013-06-15 09:14:33 -04002225 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226
Linus Torvalds3b830a92021-01-18 13:31:30 -08002227 if (kb - kbuf >= minimum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 break;
2229 if (time)
2230 timeout = time;
2231 }
Peter Hurley2c5dc462015-01-16 15:05:34 -05002232 if (tail != ldata->read_tail)
2233 n_tty_kick_worker(tty);
Peter Hurley42458f42013-11-07 13:59:46 -05002234 up_read(&tty->termios_rwsem);
2235
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 remove_wait_queue(&tty->read_wait, &wait);
Peter Hurleyaebf04532013-11-07 14:01:57 -05002237 mutex_unlock(&ldata->atomic_read_lock);
2238
Linus Torvalds3b830a92021-01-18 13:31:30 -08002239 if (kb - kbuf)
2240 retval = kb - kbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241
2242 return retval;
2243}
2244
2245/**
Alan Cox11a96d12008-10-13 10:46:24 +01002246 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 * @tty: tty device
2248 * @file: file object
2249 * @buf: userspace buffer pointer
2250 * @nr: size of I/O
2251 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002252 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002254 * and other such events. Since the receive code will echo characters,
2255 * thus calling driver write methods, the output_lock is used in
2256 * the output processing functions called here as well as in the
2257 * echo processing function to protect the column state and space
2258 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 *
2260 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002261 *
2262 * Locking: output_lock to protect column state and space left
2263 * (note that the process_output*() functions take this
2264 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 */
Alan Cox4edf1822008-02-08 04:18:44 -08002266
Alan Cox11a96d12008-10-13 10:46:24 +01002267static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002268 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269{
2270 const unsigned char *b = buf;
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002271 DEFINE_WAIT_FUNC(wait, woken_wake_function);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 int c;
2273 ssize_t retval = 0;
2274
2275 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
Sami Tolvanen9f12e372021-01-25 11:09:25 -08002276 if (L_TOSTOP(tty) && file->f_op->write_iter != redirected_tty_write) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 retval = tty_check_change(tty);
2278 if (retval)
2279 return retval;
2280 }
2281
Peter Hurley9356b532013-06-15 09:14:24 -04002282 down_read(&tty->termios_rwsem);
2283
Joe Petersona88a69c2009-01-02 13:40:53 +00002284 /* Write out any echoed characters that are still pending */
2285 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002286
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 add_wait_queue(&tty->write_wait, &wait);
2288 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 if (signal_pending(current)) {
2290 retval = -ERESTARTSYS;
2291 break;
2292 }
2293 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2294 retval = -EIO;
2295 break;
2296 }
Peter Hurley582f5592013-05-17 12:49:48 -04002297 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002299 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 if (num < 0) {
2301 if (num == -EAGAIN)
2302 break;
2303 retval = num;
2304 goto break_out;
2305 }
2306 b += num;
2307 nr -= num;
2308 if (nr == 0)
2309 break;
2310 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002311 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 break;
2313 b++; nr--;
2314 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002315 if (tty->ops->flush_chars)
2316 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 } else {
Peter Hurley42910862014-05-03 14:04:59 +02002318 struct n_tty_data *ldata = tty->disc_data;
2319
Roman Zippeld6afe272005-07-07 17:56:55 -07002320 while (nr > 0) {
Peter Hurley42910862014-05-03 14:04:59 +02002321 mutex_lock(&ldata->output_lock);
Alan Coxf34d7a52008-04-30 00:54:13 -07002322 c = tty->ops->write(tty, b, nr);
Peter Hurley42910862014-05-03 14:04:59 +02002323 mutex_unlock(&ldata->output_lock);
Roman Zippeld6afe272005-07-07 17:56:55 -07002324 if (c < 0) {
2325 retval = c;
2326 goto break_out;
2327 }
2328 if (!c)
2329 break;
2330 b += c;
2331 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 }
2334 if (!nr)
2335 break;
Dmitry Safonovc96cf922018-11-01 00:24:48 +00002336 if (tty_io_nonblock(tty, file)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 retval = -EAGAIN;
2338 break;
2339 }
Peter Hurley9356b532013-06-15 09:14:24 -04002340 up_read(&tty->termios_rwsem);
2341
Peter Zijlstra97d9e282014-09-24 10:18:51 +02002342 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
Peter Hurley9356b532013-06-15 09:14:24 -04002343
2344 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 }
2346break_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 remove_wait_queue(&tty->write_wait, &wait);
Peter Hurley87108bc2016-01-09 21:45:14 -08002348 if (nr && tty->fasync)
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002349 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002350 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 return (b - buf) ? b - buf : retval;
2352}
2353
2354/**
Alan Cox11a96d12008-10-13 10:46:24 +01002355 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 * @tty: terminal device
2357 * @file: file accessing it
2358 * @wait: poll table
2359 *
2360 * Called when the line discipline is asked to poll() for data or
2361 * for special events. This code is not serialized with respect to
2362 * other events save open/close.
2363 *
2364 * This code must be sure never to sleep through a hangup.
2365 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 */
Alan Cox4edf1822008-02-08 04:18:44 -08002367
Al Viroafc9a422017-07-03 06:39:46 -04002368static __poll_t n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002369 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370{
Al Viroafc9a422017-07-03 06:39:46 -04002371 __poll_t mask = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
2373 poll_wait(file, &tty->read_wait, wait);
2374 poll_wait(file, &tty->write_wait, wait);
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002375 if (input_available_p(tty, 1))
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002376 mask |= EPOLLIN | EPOLLRDNORM;
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002377 else {
2378 tty_buffer_flush_work(tty->port);
2379 if (input_available_p(tty, 1))
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002380 mask |= EPOLLIN | EPOLLRDNORM;
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002381 }
Francesco Ruggeric4dc3042014-10-10 13:09:53 -07002382 if (tty->packet && tty->link->ctrl_status)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002383 mask |= EPOLLPRI | EPOLLIN | EPOLLRDNORM;
Brian Bloniarz0f40fbb2016-03-06 13:16:30 -08002384 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002385 mask |= EPOLLHUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 if (tty_hung_up_p(file))
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002387 mask |= EPOLLHUP;
Alan Coxf34d7a52008-04-30 00:54:13 -07002388 if (tty->ops->write && !tty_is_writelocked(tty) &&
2389 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2390 tty_write_room(tty) > 0)
Linus Torvaldsa9a08842018-02-11 14:34:03 -08002391 mask |= EPOLLOUT | EPOLLWRNORM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 return mask;
2393}
2394
Jiri Slaby57c94122012-10-18 22:26:43 +02002395static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002396{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002397 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002398
Peter Hurleya73d3d62013-06-15 09:14:25 -04002399 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002400 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002401 head = ldata->canon_head;
2402 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002403 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002404 /* Skip EOF-chars.. */
Tetsuo Handa3d63b7e2018-05-26 09:53:13 +09002405 while (MASK(head) != MASK(tail)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002406 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2407 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002408 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002409 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002410 }
2411 return nr;
2412}
2413
2414static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2415 unsigned int cmd, unsigned long arg)
2416{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002417 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002418 int retval;
2419
2420 switch (cmd) {
2421 case TIOCOUTQ:
2422 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2423 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002424 down_write(&tty->termios_rwsem);
Linus Torvalds966031f2017-12-20 17:57:06 -08002425 if (L_ICANON(tty) && !L_EXTPROC(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002426 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002427 else
2428 retval = read_cnt(ldata);
2429 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002430 return put_user(retval, (unsigned int __user *) arg);
2431 default:
2432 return n_tty_ioctl_helper(tty, file, cmd, arg);
2433 }
2434}
2435
Peter Hurley27228732016-01-09 21:35:19 -08002436static struct tty_ldisc_ops n_tty_ops = {
Jiri Slaby5e30d3b2021-03-02 07:21:39 +01002437 .owner = THIS_MODULE,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002438 .name = "n_tty",
2439 .open = n_tty_open,
2440 .close = n_tty_close,
2441 .flush_buffer = n_tty_flush_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002442 .read = n_tty_read,
2443 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002444 .ioctl = n_tty_ioctl,
2445 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002446 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002447 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002448 .write_wakeup = n_tty_write_wakeup,
Peter Hurley24a89d12013-06-15 09:14:15 -04002449 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002451
2452/**
2453 * n_tty_inherit_ops - inherit N_TTY methods
2454 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2455 *
Peter Hurley27228732016-01-09 21:35:19 -08002456 * Enables a 'subclass' line discipline to 'inherit' N_TTY methods.
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002457 */
2458
2459void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2460{
Peter Hurley27228732016-01-09 21:35:19 -08002461 *ops = n_tty_ops;
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002462 ops->owner = NULL;
2463 ops->refcount = ops->flags = 0;
2464}
2465EXPORT_SYMBOL_GPL(n_tty_inherit_ops);
Peter Hurley27228732016-01-09 21:35:19 -08002466
2467void __init n_tty_init(void)
2468{
2469 tty_register_ldisc(N_TTY, &n_tty_ops);
2470}