blob: 765935b144d63408118343de5b37184c9d88e1e3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (C) 1991, 1992 Linus Torvalds
3 */
4
5/*
6 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
7 * or rs-channels. It also implements echoing, cooked mode etc.
8 *
9 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
10 *
11 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
12 * tty_struct and tty_queue structures. Previously there was an array
13 * of 256 tty_struct's which was statically allocated, and the
14 * tty_queue structures were allocated at boot time. Both are now
15 * dynamically allocated only when the tty is open.
16 *
17 * Also restructured routines so that there is more of a separation
18 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
19 * the low-level tty routines (serial.c, pty.c, console.c). This
Alan Cox37bdfb02008-02-08 04:18:47 -080020 * makes for cleaner and more compact code. -TYT, 9/17/92
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 *
22 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
23 * which can be dynamically activated and de-activated by the line
24 * discipline handling modules (like SLIP).
25 *
26 * NOTE: pay no attention to the line discipline code (yet); its
27 * interface is still subject to change in this version...
28 * -- TYT, 1/31/92
29 *
30 * Added functionality to the OPOST tty handling. No delays, but all
31 * other bits should be there.
32 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
33 *
34 * Rewrote canonical mode and added more termios flags.
35 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
36 *
37 * Reorganized FASYNC support so mouse code can share it.
38 * -- ctm@ardi.com, 9Sep95
39 *
40 * New TIOCLINUX variants added.
41 * -- mj@k332.feld.cvut.cz, 19-Nov-95
Alan Cox37bdfb02008-02-08 04:18:47 -080042 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * Restrict vt switching via ioctl()
44 * -- grif@cs.ucr.edu, 5-Dec-95
45 *
46 * Move console and virtual terminal code to more appropriate files,
47 * implement CONFIG_VT and generalize console device interface.
48 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
49 *
Alan Coxd81ed102008-10-13 10:41:42 +010050 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * -- Bill Hawes <whawes@star.net>, June 97
52 *
53 * Added devfs support.
54 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
55 *
56 * Added support for a Unix98-style ptmx device.
57 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
58 *
59 * Reduced memory usage for older ARM systems
60 * -- Russell King <rmk@arm.linux.org.uk>
61 *
62 * Move do_SAK() into process context. Less stack use in devfs functions.
Alan Cox37bdfb02008-02-08 04:18:47 -080063 * alloc_tty_struct() always uses kmalloc()
64 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 */
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <linux/types.h>
68#include <linux/major.h>
69#include <linux/errno.h>
70#include <linux/signal.h>
71#include <linux/fcntl.h>
72#include <linux/sched.h>
73#include <linux/interrupt.h>
74#include <linux/tty.h>
75#include <linux/tty_driver.h>
76#include <linux/tty_flip.h>
77#include <linux/devpts_fs.h>
78#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040079#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#include <linux/console.h>
81#include <linux/timer.h>
82#include <linux/ctype.h>
83#include <linux/kd.h>
84#include <linux/mm.h>
85#include <linux/string.h>
86#include <linux/slab.h>
87#include <linux/poll.h>
88#include <linux/proc_fs.h>
89#include <linux/init.h>
90#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#include <linux/wait.h>
93#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070094#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010095#include <linux/seq_file.h>
Alan Coxd281da72010-09-16 18:21:24 +010096#include <linux/serial.h>
Manuel Zerpies5a3c6b2512011-06-16 14:07:22 +020097#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Alan Coxa352def2008-07-16 21:53:12 +010099#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101#include <linux/kbd_kern.h>
102#include <linux/vt_kern.h>
103#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700106#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108#undef TTY_DEBUG_HANGUP
Peter Hurleyaccff792015-07-12 22:49:09 -0400109#ifdef TTY_DEBUG_HANGUP
110# define tty_debug_hangup(tty, f, args...) tty_debug(tty, f, ##args)
111#else
112# define tty_debug_hangup(tty, f, args...) do { } while (0)
113#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115#define TTY_PARANOIA_CHECK 1
116#define CHECK_TTY_COUNT 1
117
Alan Coxedc6afc2006-12-08 02:38:44 -0800118struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 .c_iflag = ICRNL | IXON,
120 .c_oflag = OPOST | ONLCR,
121 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
122 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
123 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800124 .c_cc = INIT_C_CC,
125 .c_ispeed = 38400,
126 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128
129EXPORT_SYMBOL(tty_std_termios);
130
131/* This list gets poked at by procfs and various bits of boot up code. This
132 could do with some rationalisation such as pulling the tty proc function
133 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135LIST_HEAD(tty_drivers); /* linked list of tty drivers */
136
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800137/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800139DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700140EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Nick Pigginee2ffa02010-08-18 04:37:35 +1000142/* Spinlock to protect the tty->tty_files list */
143DEFINE_SPINLOCK(tty_files_lock);
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
146static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800147ssize_t redirected_tty_write(struct file *, const char __user *,
148 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149static unsigned int tty_poll(struct file *, poll_table *);
150static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700151long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700152#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800153static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700154 unsigned long arg);
155#else
156#define tty_compat_ioctl NULL
157#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200158static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800159static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800160static void release_tty(struct tty_struct *tty, int idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Alan Coxaf9b8972006-08-27 01:24:01 -0700162/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700163 * free_tty_struct - free a disused tty
164 * @tty: tty struct to free
165 *
166 * Free the write buffers, tty queue and tty memory itself.
167 *
168 * Locking: none. Must be called after tty is definitely unused
169 */
170
Alan Coxbf970ee2008-10-13 10:42:39 +0100171void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Dan Carpenterdc6802a2012-07-24 12:52:04 +0100173 if (!tty)
174 return;
Markus Elfringa211b1a2014-11-21 13:42:29 +0100175 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 kfree(tty->write_buf);
Alan Cox89c8d912012-08-08 16:30:13 +0100177 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 kfree(tty);
179}
180
Nick Piggind996b622010-08-18 04:37:36 +1000181static inline struct tty_struct *file_tty(struct file *file)
182{
183 return ((struct tty_file_private *)file->private_data)->tty;
184}
185
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200186int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000187{
188 struct tty_file_private *priv;
189
Pekka Enbergf573bd12010-08-24 07:48:34 +0300190 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
191 if (!priv)
192 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000193
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200194 file->private_data = priv;
195
196 return 0;
197}
198
199/* Associate a new file with the tty structure */
200void tty_add_file(struct tty_struct *tty, struct file *file)
201{
202 struct tty_file_private *priv = file->private_data;
203
Nick Piggind996b622010-08-18 04:37:36 +1000204 priv->tty = tty;
205 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000206
207 spin_lock(&tty_files_lock);
208 list_add(&priv->list, &tty->tty_files);
209 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200210}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300211
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200212/**
213 * tty_free_file - free file->private_data
214 *
215 * This shall be used only for fail path handling when tty_add_file was not
216 * called yet.
217 */
218void tty_free_file(struct file *file)
219{
220 struct tty_file_private *priv = file->private_data;
221
222 file->private_data = NULL;
223 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000224}
225
226/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800227static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000228{
229 struct tty_file_private *priv = file->private_data;
230
231 spin_lock(&tty_files_lock);
232 list_del(&priv->list);
233 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200234 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000235}
236
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
239
Alan Coxaf9b8972006-08-27 01:24:01 -0700240/**
241 * tty_name - return tty naming
242 * @tty: tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -0700243 *
244 * Convert a tty structure into a name. The name reflects the kernel
245 * naming policy and if udev is in use may not reflect user space
246 *
247 * Locking: none
248 */
249
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200250const char *tty_name(const struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 if (!tty) /* Hmm. NULL pointer. That's fun. */
Rasmus Villemoes917162c2015-03-31 15:55:58 +0200253 return "NULL tty";
254 return tty->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
257EXPORT_SYMBOL(tty_name);
258
Peter Hurley0a083ed2015-11-08 13:01:12 -0500259const char *tty_driver_name(const struct tty_struct *tty)
260{
261 if (!tty || !tty->driver)
262 return "";
263 return tty->driver->name;
264}
265
Peter Hurley82b8f882015-11-08 13:01:09 -0500266static int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 const char *routine)
268{
269#ifdef TTY_PARANOIA_CHECK
270 if (!tty) {
Peter Hurley89222e62015-11-08 13:01:18 -0500271 pr_warn("(%d:%d): %s: NULL tty\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 imajor(inode), iminor(inode), routine);
273 return 1;
274 }
275 if (tty->magic != TTY_MAGIC) {
Peter Hurley89222e62015-11-08 13:01:18 -0500276 pr_warn("(%d:%d): %s: bad magic number\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 imajor(inode), iminor(inode), routine);
278 return 1;
279 }
280#endif
281 return 0;
282}
283
Peter Hurleydeb287e2014-11-05 12:12:55 -0500284/* Caller must hold tty_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285static int check_tty_count(struct tty_struct *tty, const char *routine)
286{
287#ifdef CHECK_TTY_COUNT
288 struct list_head *p;
289 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800290
Nick Pigginee2ffa02010-08-18 04:37:35 +1000291 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 list_for_each(p, &tty->tty_files) {
293 count++;
294 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000295 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
297 tty->driver->subtype == PTY_TYPE_SLAVE &&
298 tty->link && tty->link->count)
299 count++;
300 if (tty->count != count) {
Peter Hurley339f36b2015-11-08 13:01:13 -0500301 tty_warn(tty, "%s: tty->count(%d) != #fd's(%d)\n",
302 routine, tty->count, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800304 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305#endif
306 return 0;
307}
308
Alan Coxaf9b8972006-08-27 01:24:01 -0700309/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700310 * get_tty_driver - find device of a tty
311 * @dev_t: device identifier
312 * @index: returns the index of the tty
313 *
314 * This routine returns a tty driver structure, given a device number
315 * and also passes back the index number.
316 *
317 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320static struct tty_driver *get_tty_driver(dev_t device, int *index)
321{
322 struct tty_driver *p;
323
324 list_for_each_entry(p, &tty_drivers, tty_drivers) {
325 dev_t base = MKDEV(p->major, p->minor_start);
326 if (device < base || device >= base + p->num)
327 continue;
328 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100329 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 }
331 return NULL;
332}
333
Jason Wesself2d937f2008-04-17 20:05:37 +0200334#ifdef CONFIG_CONSOLE_POLL
335
336/**
337 * tty_find_polling_driver - find device of a polled tty
338 * @name: name string to match
339 * @line: pointer to resulting tty line nr
340 *
341 * This routine returns a tty driver structure, given a name
342 * and the condition that the tty driver is capable of polled
343 * operation.
344 */
345struct tty_driver *tty_find_polling_driver(char *name, int *line)
346{
347 struct tty_driver *p, *res = NULL;
348 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500349 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100350 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200351
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500352 for (str = name; *str; str++)
353 if ((*str >= '0' && *str <= '9') || *str == ',')
354 break;
355 if (!*str)
356 return NULL;
357
358 len = str - name;
359 tty_line = simple_strtoul(str, &str, 10);
360
Jason Wesself2d937f2008-04-17 20:05:37 +0200361 mutex_lock(&tty_mutex);
362 /* Search through the tty devices to look for a match */
363 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500364 if (strncmp(name, p->name, len) != 0)
365 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100366 stp = str;
367 if (*stp == ',')
368 stp++;
369 if (*stp == '\0')
370 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200371
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200372 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100373 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100374 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200375 *line = tty_line;
376 break;
377 }
378 }
379 mutex_unlock(&tty_mutex);
380
381 return res;
382}
383EXPORT_SYMBOL_GPL(tty_find_polling_driver);
384#endif
385
Alan Coxaf9b8972006-08-27 01:24:01 -0700386/**
387 * tty_check_change - check for POSIX terminal changes
388 * @tty: tty to check
389 *
390 * If we try to write to, or set the state of, a terminal and we're
391 * not in the foreground, send a SIGTTOU. If the signal is blocked or
392 * ignored, go ahead and perform the operation. (POSIX 7.2)
393 *
Alan Cox978e5952008-04-30 00:53:59 -0700394 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700396
Peter Hurley2812d9e2015-10-10 20:28:42 -0400397int __tty_check_change(struct tty_struct *tty, int sig)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Alan Cox47f86832008-04-30 00:53:30 -0700399 unsigned long flags;
Peter Hurley2812d9e2015-10-10 20:28:42 -0400400 struct pid *pgrp, *tty_pgrp;
Alan Cox47f86832008-04-30 00:53:30 -0700401 int ret = 0;
402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 if (current->signal->tty != tty)
404 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700405
Patrick Donnelly67196932015-07-12 18:51:52 -0400406 rcu_read_lock();
407 pgrp = task_pgrp(current);
408
Alan Cox47f86832008-04-30 00:53:30 -0700409 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurley2812d9e2015-10-10 20:28:42 -0400410 tty_pgrp = tty->pgrp;
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700411 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Patrick Donnelly67196932015-07-12 18:51:52 -0400412
Peter Hurley2812d9e2015-10-10 20:28:42 -0400413 if (tty_pgrp && pgrp != tty->pgrp) {
414 if (is_ignored(sig)) {
415 if (sig == SIGTTIN)
416 ret = -EIO;
417 } else if (is_current_pgrp_orphaned())
418 ret = -EIO;
419 else {
420 kill_pgrp(pgrp, sig, 1);
421 set_thread_flag(TIF_SIGPENDING);
422 ret = -ERESTARTSYS;
423 }
Alan Cox47f86832008-04-30 00:53:30 -0700424 }
Patrick Donnelly67196932015-07-12 18:51:52 -0400425 rcu_read_unlock();
Peter Hurley2812d9e2015-10-10 20:28:42 -0400426
Peter Hurley339f36b2015-11-08 13:01:13 -0500427 if (!tty_pgrp)
428 tty_warn(tty, "sig=%d, tty->pgrp == NULL!\n", sig);
Peter Hurley2812d9e2015-10-10 20:28:42 -0400429
Alan Cox47f86832008-04-30 00:53:30 -0700430 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
Peter Hurley2812d9e2015-10-10 20:28:42 -0400433int tty_check_change(struct tty_struct *tty)
434{
435 return __tty_check_change(tty, SIGTTOU);
436}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437EXPORT_SYMBOL(tty_check_change);
438
Alan Cox37bdfb02008-02-08 04:18:47 -0800439static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 size_t count, loff_t *ppos)
441{
442 return 0;
443}
444
Alan Cox37bdfb02008-02-08 04:18:47 -0800445static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 size_t count, loff_t *ppos)
447{
448 return -EIO;
449}
450
451/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800452static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
454 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
455}
456
Alan Cox04f378b2008-04-30 00:53:29 -0700457static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
458 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700459{
460 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
461}
462
Alan Cox37bdfb02008-02-08 04:18:47 -0800463static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700464 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
466 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
467}
468
Arjan van de Ven62322d22006-07-03 00:24:21 -0700469static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 .llseek = no_llseek,
471 .read = tty_read,
472 .write = tty_write,
473 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700474 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700475 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 .open = tty_open,
477 .release = tty_release,
478 .fasync = tty_fasync,
479};
480
Arjan van de Ven62322d22006-07-03 00:24:21 -0700481static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 .llseek = no_llseek,
483 .read = tty_read,
484 .write = redirected_tty_write,
485 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700486 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700487 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 .open = tty_open,
489 .release = tty_release,
490 .fasync = tty_fasync,
491};
492
Arjan van de Ven62322d22006-07-03 00:24:21 -0700493static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 .llseek = no_llseek,
495 .read = hung_up_tty_read,
496 .write = hung_up_tty_write,
497 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700498 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700499 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 .release = tty_release,
501};
502
503static DEFINE_SPINLOCK(redirect_lock);
504static struct file *redirect;
505
Peter Hurley11d9bef2014-10-16 14:59:42 -0400506
507void proc_clear_tty(struct task_struct *p)
508{
509 unsigned long flags;
510 struct tty_struct *tty;
511 spin_lock_irqsave(&p->sighand->siglock, flags);
512 tty = p->signal->tty;
513 p->signal->tty = NULL;
514 spin_unlock_irqrestore(&p->sighand->siglock, flags);
515 tty_kref_put(tty);
516}
517
Peter Hurley2c411c12014-10-16 14:59:47 -0400518/**
519 * proc_set_tty - set the controlling terminal
520 *
521 * Only callable by the session leader and only if it does not already have
522 * a controlling terminal.
523 *
Peter Hurleye218eb32014-10-16 14:59:49 -0400524 * Caller must hold: tty_lock()
525 * a readlock on tasklist_lock
Peter Hurley2c411c12014-10-16 14:59:47 -0400526 * sighand lock
527 */
Peter Hurleybce65f12014-10-16 14:59:43 -0400528static void __proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400529{
Peter Hurleyae28fa72014-10-16 14:59:46 -0400530 unsigned long flags;
531
Peter Hurleyae28fa72014-10-16 14:59:46 -0400532 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya3618582014-10-16 14:59:50 -0400533 /*
534 * The session and fg pgrp references will be non-NULL if
535 * tiocsctty() is stealing the controlling tty
536 */
Peter Hurleyae28fa72014-10-16 14:59:46 -0400537 put_pid(tty->session);
538 put_pid(tty->pgrp);
539 tty->pgrp = get_pid(task_pgrp(current));
540 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
541 tty->session = get_pid(task_session(current));
542 if (current->signal->tty) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -0400543 tty_debug(tty, "current tty %s not NULL!!\n",
544 current->signal->tty->name);
Peter Hurleyae28fa72014-10-16 14:59:46 -0400545 tty_kref_put(current->signal->tty);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400546 }
Peter Hurleybce65f12014-10-16 14:59:43 -0400547 put_pid(current->signal->tty_old_pgrp);
548 current->signal->tty = tty_kref_get(tty);
549 current->signal->tty_old_pgrp = NULL;
Peter Hurley11d9bef2014-10-16 14:59:42 -0400550}
551
Peter Hurleybce65f12014-10-16 14:59:43 -0400552static void proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400553{
Peter Hurleybce65f12014-10-16 14:59:43 -0400554 spin_lock_irq(&current->sighand->siglock);
555 __proc_set_tty(tty);
556 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400557}
558
559struct tty_struct *get_current_tty(void)
560{
561 struct tty_struct *tty;
562 unsigned long flags;
563
564 spin_lock_irqsave(&current->sighand->siglock, flags);
565 tty = tty_kref_get(current->signal->tty);
566 spin_unlock_irqrestore(&current->sighand->siglock, flags);
567 return tty;
568}
569EXPORT_SYMBOL_GPL(get_current_tty);
570
571static void session_clear_tty(struct pid *session)
572{
573 struct task_struct *p;
574 do_each_pid_task(session, PIDTYPE_SID, p) {
575 proc_clear_tty(p);
576 } while_each_pid_task(session, PIDTYPE_SID, p);
577}
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579/**
580 * tty_wakeup - request more data
581 * @tty: terminal
582 *
583 * Internal and external helper for wakeups of tty. This function
584 * informs the line discipline if present that the driver is ready
585 * to receive more output data.
586 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588void tty_wakeup(struct tty_struct *tty)
589{
590 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
593 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800594 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100595 if (ld->ops->write_wakeup)
596 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 tty_ldisc_deref(ld);
598 }
599 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700600 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601}
602
603EXPORT_SYMBOL_GPL(tty_wakeup);
604
605/**
Peter Hurleyea648a42013-03-06 07:20:53 -0500606 * tty_signal_session_leader - sends SIGHUP to session leader
Peter Hurleyf91e2592013-03-06 07:20:56 -0500607 * @tty controlling tty
608 * @exit_session if non-zero, signal all foreground group processes
Peter Hurleyea648a42013-03-06 07:20:53 -0500609 *
Peter Hurleyf91e2592013-03-06 07:20:56 -0500610 * Send SIGHUP and SIGCONT to the session leader and its process group.
611 * Optionally, signal all processes in the foreground process group.
Peter Hurleyea648a42013-03-06 07:20:53 -0500612 *
613 * Returns the number of processes in the session with this tty
614 * as their controlling terminal. This value is used to drop
615 * tty references for those processes.
616 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500617static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
Peter Hurleyea648a42013-03-06 07:20:53 -0500618{
619 struct task_struct *p;
Peter Hurleyea648a42013-03-06 07:20:53 -0500620 int refs = 0;
Peter Hurleyf91e2592013-03-06 07:20:56 -0500621 struct pid *tty_pgrp = NULL;
Peter Hurleyea648a42013-03-06 07:20:53 -0500622
623 read_lock(&tasklist_lock);
624 if (tty->session) {
625 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
626 spin_lock_irq(&p->sighand->siglock);
627 if (p->signal->tty == tty) {
628 p->signal->tty = NULL;
629 /* We defer the dereferences outside fo
630 the tasklist lock */
631 refs++;
632 }
633 if (!p->signal->leader) {
634 spin_unlock_irq(&p->sighand->siglock);
635 continue;
636 }
637 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
638 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
639 put_pid(p->signal->tty_old_pgrp); /* A noop */
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500640 spin_lock(&tty->ctrl_lock);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500641 tty_pgrp = get_pid(tty->pgrp);
Peter Hurleyea648a42013-03-06 07:20:53 -0500642 if (tty->pgrp)
643 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500644 spin_unlock(&tty->ctrl_lock);
Peter Hurleyea648a42013-03-06 07:20:53 -0500645 spin_unlock_irq(&p->sighand->siglock);
646 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
647 }
648 read_unlock(&tasklist_lock);
649
Peter Hurleyf91e2592013-03-06 07:20:56 -0500650 if (tty_pgrp) {
651 if (exit_session)
652 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
653 put_pid(tty_pgrp);
654 }
655
Peter Hurleyea648a42013-03-06 07:20:53 -0500656 return refs;
657}
658
659/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200660 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000661 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700662 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800663 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700664 * synchronous but doesn't hold any locks, so we need to make sure we
665 * have the appropriate locks for what we're doing.
666 *
667 * The hangup event clears any pending redirections onto the hung up
668 * device. It ensures future writes will error and it does the needed
669 * line discipline hangup and signal delivery. The tty object itself
670 * remains intact.
671 *
672 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200673 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800674 * redirect lock for undoing redirection
675 * file list lock for manipulating list of ttys
Peter Hurley137084b2013-06-15 07:04:46 -0400676 * tty_ldiscs_lock from called functions
Peter Hurley6a1c0682013-06-15 09:14:23 -0400677 * termios_rwsem resetting termios data
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800678 * tasklist_lock to walk task list for hangup event
679 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500681static void __tty_hangup(struct tty_struct *tty, int exit_session)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
Alan Cox37bdfb02008-02-08 04:18:47 -0800683 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 struct file *filp, *f = NULL;
Nick Piggind996b622010-08-18 04:37:36 +1000685 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 int closecount = 0, n;
Peter Hurleyea648a42013-03-06 07:20:53 -0500687 int refs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689 if (!tty)
690 return;
691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
693 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000694 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 f = redirect;
696 redirect = NULL;
697 }
698 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800699
Alan Cox89c8d912012-08-08 16:30:13 +0100700 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200701
Peter Hurleycb50e522013-07-31 14:05:45 -0400702 if (test_bit(TTY_HUPPED, &tty->flags)) {
703 tty_unlock(tty);
704 return;
705 }
706
Arnd Bergmannec79d602010-06-01 22:53:01 +0200707 /* inuse_filps is protected by the single tty lock,
708 this really needs to change if we want to flush the
709 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200710 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000711
Nick Pigginee2ffa02010-08-18 04:37:35 +1000712 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000714 list_for_each_entry(priv, &tty->tty_files, list) {
715 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 if (filp->f_op->write == redirected_tty_write)
717 cons_filp = filp;
718 if (filp->f_op->write != tty_write)
719 continue;
720 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200721 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 filp->f_op = &hung_up_tty_fops;
723 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000724 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800725
Peter Hurley25fdf242013-03-06 07:20:57 -0500726 refs = tty_signal_session_leader(tty, exit_session);
727 /* Account for the p->signal references we killed */
728 while (refs--)
729 tty_kref_put(tty);
730
Alan Coxc65c9bc2009-06-11 12:50:12 +0100731 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800732
Peter Hurley20cc2252013-03-06 07:20:54 -0500733 spin_lock_irq(&tty->ctrl_lock);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100734 clear_bit(TTY_THROTTLED, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100735 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600736 put_pid(tty->session);
737 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800738 tty->session = NULL;
739 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 tty->ctrl_status = 0;
Peter Hurley20cc2252013-03-06 07:20:54 -0500741 spin_unlock_irq(&tty->ctrl_lock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800744 * If one of the devices matches a console pointer, we
745 * cannot just call hangup() because that will cause
746 * tty->count and state->count to go out of sync.
747 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 */
749 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700750 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700752 tty->ops->close(tty, cons_filp);
753 } else if (tty->ops->hangup)
Peter Hurley7c6d3402014-06-16 09:17:08 -0400754 tty->ops->hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800755 /*
756 * We don't want to have driver/ldisc interactions beyond
757 * the ones we did here. The driver layer expects no
758 * calls after ->hangup() from the ldisc side. However we
759 * can't yet guarantee all that.
760 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 set_bit(TTY_HUPPED, &tty->flags);
Alan Cox89c8d912012-08-08 16:30:13 +0100762 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 if (f)
765 fput(f);
766}
767
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200768static void do_tty_hangup(struct work_struct *work)
769{
770 struct tty_struct *tty =
771 container_of(work, struct tty_struct, hangup_work);
772
Peter Hurleyf91e2592013-03-06 07:20:56 -0500773 __tty_hangup(tty, 0);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200774}
775
Alan Coxaf9b8972006-08-27 01:24:01 -0700776/**
777 * tty_hangup - trigger a hangup event
778 * @tty: tty to hangup
779 *
780 * A carrier loss (virtual or otherwise) has occurred on this like
781 * schedule a hangup sequence to run after this event.
782 */
783
Alan Cox37bdfb02008-02-08 04:18:47 -0800784void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
Peter Hurleyd435cef2015-11-08 13:01:19 -0500786 tty_debug_hangup(tty, "hangup\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 schedule_work(&tty->hangup_work);
788}
789
790EXPORT_SYMBOL(tty_hangup);
791
Alan Coxaf9b8972006-08-27 01:24:01 -0700792/**
793 * tty_vhangup - process vhangup
794 * @tty: tty to hangup
795 *
796 * The user has asked via system call for the terminal to be hung up.
797 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200798 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700799 */
800
Alan Cox37bdfb02008-02-08 04:18:47 -0800801void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802{
Peter Hurleyd435cef2015-11-08 13:01:19 -0500803 tty_debug_hangup(tty, "vhangup\n");
Peter Hurleyf91e2592013-03-06 07:20:56 -0500804 __tty_hangup(tty, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805}
Alan Cox37bdfb02008-02-08 04:18:47 -0800806
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807EXPORT_SYMBOL(tty_vhangup);
808
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200809
Alan Coxaf9b8972006-08-27 01:24:01 -0700810/**
Alan Cox2cb59982008-10-13 10:40:30 +0100811 * tty_vhangup_self - process vhangup for own ctty
812 *
813 * Perform a vhangup on the current controlling tty
814 */
815
816void tty_vhangup_self(void)
817{
818 struct tty_struct *tty;
819
Alan Cox2cb59982008-10-13 10:40:30 +0100820 tty = get_current_tty();
821 if (tty) {
822 tty_vhangup(tty);
823 tty_kref_put(tty);
824 }
Alan Cox2cb59982008-10-13 10:40:30 +0100825}
826
827/**
Peter Hurleyf91e2592013-03-06 07:20:56 -0500828 * tty_vhangup_session - hangup session leader exit
829 * @tty: tty to hangup
830 *
831 * The session leader is exiting and hanging up its controlling terminal.
832 * Every process in the foreground process group is signalled SIGHUP.
833 *
834 * We do this synchronously so that when the syscall returns the process
835 * is complete. That guarantee is necessary for security reasons.
836 */
837
Changlong Xie44a459f2013-03-20 08:42:04 +0800838static void tty_vhangup_session(struct tty_struct *tty)
Peter Hurleyf91e2592013-03-06 07:20:56 -0500839{
Peter Hurleyd435cef2015-11-08 13:01:19 -0500840 tty_debug_hangup(tty, "session hangup\n");
Peter Hurleyf91e2592013-03-06 07:20:56 -0500841 __tty_hangup(tty, 1);
842}
843
844/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700845 * tty_hung_up_p - was tty hung up
846 * @filp: file pointer of tty
847 *
848 * Return true if the tty has been subject to a vhangup or a carrier
849 * loss
850 */
851
Alan Cox37bdfb02008-02-08 04:18:47 -0800852int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
854 return (filp->f_op == &hung_up_tty_fops);
855}
856
857EXPORT_SYMBOL(tty_hung_up_p);
858
Alan Coxaf9b8972006-08-27 01:24:01 -0700859/**
860 * disassociate_ctty - disconnect controlling tty
861 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700863 * This function is typically called only by the session leader, when
864 * it wants to disassociate itself from its controlling tty.
865 *
866 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
868 * (2) Clears the tty from being controlling the session
869 * (3) Clears the controlling tty for all processes in the
870 * session group.
871 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700872 * The argument on_exit is set to 1 if called when a process is
873 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
874 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800875 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200876 * BTM is taken for hysterical raisins, and held when
877 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800878 * tty_mutex is taken to protect tty
879 * ->siglock is taken to protect ->signal/->sighand
880 * tasklist_lock is taken to walk process list for sessions
881 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884void disassociate_ctty(int on_exit)
885{
886 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Alan Cox5ec93d12009-11-30 13:18:45 +0000888 if (!current->signal->leader)
889 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800891 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 if (tty) {
Peter Hurleyf91e2592013-03-06 07:20:56 -0500893 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
894 tty_vhangup_session(tty);
895 } else {
896 struct pid *tty_pgrp = tty_get_pgrp(tty);
897 if (tty_pgrp) {
898 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Oleg Nesterov03e12612013-09-15 17:50:26 +0200899 if (!on_exit)
900 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500901 put_pid(tty_pgrp);
902 }
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200903 }
Alan Cox452a00d2008-10-13 10:39:13 +0100904 tty_kref_put(tty);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500905
Eric W. Biederman680a9672007-02-12 00:52:52 -0800906 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800907 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800908 spin_lock_irq(&current->sighand->siglock);
909 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800910 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800911 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800912 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800913 kill_pgrp(old_pgrp, SIGHUP, on_exit);
914 kill_pgrp(old_pgrp, SIGCONT, on_exit);
915 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 return;
918 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800920 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700921 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800922 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800923
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800924 tty = tty_kref_get(current->signal->tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800925 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700926 unsigned long flags;
927 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800928 put_pid(tty->session);
929 put_pid(tty->pgrp);
930 tty->session = NULL;
931 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700932 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100933 tty_kref_put(tty);
Peter Hurleyaccff792015-07-12 22:49:09 -0400934 } else
935 tty_debug_hangup(tty, "no current tty\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800937 spin_unlock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 /* Now clear signal->tty under the lock */
939 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800940 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942}
943
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700944/**
945 *
946 * no_tty - Ensure the current process does not have a controlling tty
947 */
948void no_tty(void)
949{
Alan Cox3af502b2012-05-03 22:21:53 +0100950 /* FIXME: Review locking here. The tty_lock never covered any race
951 between a new association and proc_clear_tty but possible we need
952 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700953 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000954 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700955 proc_clear_tty(tsk);
956}
957
Alan Coxaf9b8972006-08-27 01:24:01 -0700958
959/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200960 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700961 * @tty: tty to stop
962 *
Peter Hurley01adc802014-09-10 15:06:32 -0400963 * Perform flow control to the driver. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700964 * on an already stopped device and will not re-call the driver
965 * method.
966 *
967 * This functionality is used by both the line disciplines for
968 * halting incoming flow and by the driver. It may therefore be
969 * called from any context, may be under the tty atomic_write_lock
970 * but not always.
971 *
972 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400973 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700974 */
975
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400976void __stop_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400978 if (tty->stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 return;
980 tty->stopped = 1;
Alan Coxf34d7a52008-04-30 00:54:13 -0700981 if (tty->ops->stop)
Peter Hurleyc961bfb2014-11-05 12:26:25 -0500982 tty->ops->stop(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983}
984
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400985void stop_tty(struct tty_struct *tty)
986{
987 unsigned long flags;
988
989 spin_lock_irqsave(&tty->flow_lock, flags);
990 __stop_tty(tty);
991 spin_unlock_irqrestore(&tty->flow_lock, flags);
992}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993EXPORT_SYMBOL(stop_tty);
994
Alan Coxaf9b8972006-08-27 01:24:01 -0700995/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200996 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700997 * @tty: tty to start
998 *
Peter Hurley01adc802014-09-10 15:06:32 -0400999 * Start a tty that has been stopped if at all possible. If this
1000 * tty was previous stopped and is now being started, the driver
1001 * start method is invoked and the line discipline woken.
Alan Coxaf9b8972006-08-27 01:24:01 -07001002 *
1003 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001004 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07001005 */
1006
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001007void __start_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001009 if (!tty->stopped || tty->flow_stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 return;
1011 tty->stopped = 0;
Alan Coxf34d7a52008-04-30 00:54:13 -07001012 if (tty->ops->start)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05001013 tty->ops->start(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015}
1016
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001017void start_tty(struct tty_struct *tty)
1018{
1019 unsigned long flags;
1020
1021 spin_lock_irqsave(&tty->flow_lock, flags);
1022 __start_tty(tty);
1023 spin_unlock_irqrestore(&tty->flow_lock, flags);
1024}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025EXPORT_SYMBOL(start_tty);
1026
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001027static void tty_update_time(struct timespec *time)
1028{
Jiri Slabyf0bf0bd2015-02-27 18:40:31 +01001029 unsigned long sec = get_seconds();
Greg Kroah-Hartmanfbf47632015-03-26 23:10:27 +01001030
1031 /*
1032 * We only care if the two values differ in anything other than the
1033 * lower three bits (i.e every 8 seconds). If so, then we can update
1034 * the time of the tty device, otherwise it could be construded as a
1035 * security leak to let userspace know the exact timing of the tty.
1036 */
1037 if ((sec ^ time->tv_sec) & ~7)
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001038 time->tv_sec = sec;
1039}
1040
Alan Coxaf9b8972006-08-27 01:24:01 -07001041/**
1042 * tty_read - read method for tty device files
1043 * @file: pointer to tty file
1044 * @buf: user buffer
1045 * @count: size of user buffer
1046 * @ppos: unused
1047 *
1048 * Perform the read system call function on this terminal device. Checks
1049 * for hung up devices before calling the line discipline method.
1050 *
1051 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -07001052 * Locks the line discipline internally while needed. Multiple
1053 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -07001054 */
1055
Alan Cox37bdfb02008-02-08 04:18:47 -08001056static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 loff_t *ppos)
1058{
1059 int i;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001060 struct inode *inode = file_inode(file);
Nick Piggind996b622010-08-18 04:37:36 +10001061 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 struct tty_ldisc *ld;
1063
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001064 if (tty_paranoia_check(tty, inode, "tty_read"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 return -EIO;
1066 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1067 return -EIO;
1068
1069 /* We want to wait for the line discipline to sort out in this
1070 situation */
1071 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001072 if (ld->ops->read)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05001073 i = ld->ops->read(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 else
1075 i = -EIO;
1076 tty_ldisc_deref(ld);
Jiri Slabyb0de59b2013-02-15 15:25:05 +01001077
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001078 if (i > 0)
1079 tty_update_time(&inode->i_atime);
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 return i;
1082}
1083
Peter Hurley136d5252014-09-10 15:06:34 -04001084static void tty_write_unlock(struct tty_struct *tty)
Alan Cox9c1729d2007-07-15 23:39:43 -07001085{
1086 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -07001087 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -07001088}
1089
Peter Hurley136d5252014-09-10 15:06:34 -04001090static int tty_write_lock(struct tty_struct *tty, int ndelay)
Alan Cox9c1729d2007-07-15 23:39:43 -07001091{
1092 if (!mutex_trylock(&tty->atomic_write_lock)) {
1093 if (ndelay)
1094 return -EAGAIN;
1095 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1096 return -ERESTARTSYS;
1097 }
1098 return 0;
1099}
1100
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101/*
1102 * Split writes up in sane blocksizes to avoid
1103 * denial-of-service type attacks
1104 */
1105static inline ssize_t do_tty_write(
1106 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1107 struct tty_struct *tty,
1108 struct file *file,
1109 const char __user *buf,
1110 size_t count)
1111{
Alan Cox9c1729d2007-07-15 23:39:43 -07001112 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001114
Alan Cox9c1729d2007-07-15 23:39:43 -07001115 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1116 if (ret < 0)
1117 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
1119 /*
1120 * We chunk up writes into a temporary buffer. This
1121 * simplifies low-level drivers immensely, since they
1122 * don't have locking issues and user mode accesses.
1123 *
1124 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1125 * big chunk-size..
1126 *
1127 * The default chunk-size is 2kB, because the NTTY
1128 * layer has problems with bigger chunks. It will
1129 * claim to be able to handle more characters than
1130 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001131 *
1132 * FIXME: This can probably go away now except that 64K chunks
1133 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 */
1135 chunk = 2048;
1136 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1137 chunk = 65536;
1138 if (count < chunk)
1139 chunk = count;
1140
Ingo Molnar70522e12006-03-23 03:00:31 -08001141 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001143 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
1145 if (chunk < 1024)
1146 chunk = 1024;
1147
Jason Wessel402fda92008-10-13 10:45:36 +01001148 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1149 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001150 ret = -ENOMEM;
1151 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 }
1153 kfree(tty->write_buf);
1154 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001155 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 }
1157
1158 /* Do the write .. */
1159 for (;;) {
1160 size_t size = count;
1161 if (size > chunk)
1162 size = chunk;
1163 ret = -EFAULT;
1164 if (copy_from_user(tty->write_buf, buf, size))
1165 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 if (ret <= 0)
1168 break;
1169 written += ret;
1170 buf += ret;
1171 count -= ret;
1172 if (!count)
1173 break;
1174 ret = -ERESTARTSYS;
1175 if (signal_pending(current))
1176 break;
1177 cond_resched();
1178 }
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001179 if (written) {
1180 tty_update_time(&file_inode(file)->i_mtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 ret = written;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001182 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001183out:
1184 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 return ret;
1186}
1187
Alan Cox95f9bfc2008-10-13 10:39:23 +01001188/**
1189 * tty_write_message - write a message to a certain tty, not just the console.
1190 * @tty: the destination tty_struct
1191 * @msg: the message to write
1192 *
1193 * This is used for messages that need to be redirected to a specific tty.
1194 * We don't put it into the syslog queue right now maybe in the future if
1195 * really needed.
1196 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001197 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001198 */
1199
1200void tty_write_message(struct tty_struct *tty, char *msg)
1201{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001202 if (tty) {
1203 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001204 tty_lock(tty);
Peter Hurley4b41b952015-10-10 20:28:44 -04001205 if (tty->ops->write && tty->count > 0)
Alan Cox95f9bfc2008-10-13 10:39:23 +01001206 tty->ops->write(tty, msg, strlen(msg));
Peter Hurley4b41b952015-10-10 20:28:44 -04001207 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001208 tty_write_unlock(tty);
1209 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001210 return;
1211}
1212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Alan Coxaf9b8972006-08-27 01:24:01 -07001214/**
1215 * tty_write - write method for tty device file
1216 * @file: tty file pointer
1217 * @buf: user data to write
1218 * @count: bytes to write
1219 * @ppos: unused
1220 *
1221 * Write data to a tty device via the line discipline.
1222 *
1223 * Locking:
1224 * Locks the line discipline as required
1225 * Writes to the tty driver are serialized by the atomic_write_lock
1226 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001227 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001228 */
1229
Alan Cox37bdfb02008-02-08 04:18:47 -08001230static ssize_t tty_write(struct file *file, const char __user *buf,
1231 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232{
Nick Piggind996b622010-08-18 04:37:36 +10001233 struct tty_struct *tty = file_tty(file);
1234 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001236
Al Viro6131ffa2013-02-27 16:59:05 -05001237 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001239 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001240 (test_bit(TTY_IO_ERROR, &tty->flags)))
1241 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001242 /* Short term debug to catch buggy drivers */
1243 if (tty->ops->write_room == NULL)
Peter Hurley339f36b2015-11-08 13:01:13 -05001244 tty_err(tty, "missing write_room method\n");
Alan Cox37bdfb02008-02-08 04:18:47 -08001245 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001246 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 ret = -EIO;
1248 else
Alan Coxa352def2008-07-16 21:53:12 +01001249 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 tty_ldisc_deref(ld);
1251 return ret;
1252}
1253
Alan Cox37bdfb02008-02-08 04:18:47 -08001254ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1255 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256{
1257 struct file *p = NULL;
1258
1259 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001260 if (redirect)
1261 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 spin_unlock(&redirect_lock);
1263
1264 if (p) {
1265 ssize_t res;
1266 res = vfs_write(p, buf, count, &p->f_pos);
1267 fput(p);
1268 return res;
1269 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 return tty_write(file, buf, count, ppos);
1271}
1272
Peter Hurley136d5252014-09-10 15:06:34 -04001273/**
1274 * tty_send_xchar - send priority character
1275 *
1276 * Send a high priority character to the tty even if stopped
1277 *
1278 * Locking: none for xchar method, write ordering for write method.
1279 */
1280
1281int tty_send_xchar(struct tty_struct *tty, char ch)
1282{
1283 int was_stopped = tty->stopped;
1284
1285 if (tty->ops->send_xchar) {
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001286 down_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001287 tty->ops->send_xchar(tty, ch);
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001288 up_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001289 return 0;
1290 }
1291
1292 if (tty_write_lock(tty, 0) < 0)
1293 return -ERESTARTSYS;
1294
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001295 down_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001296 if (was_stopped)
1297 start_tty(tty);
1298 tty->ops->write(tty, &ch, 1);
1299 if (was_stopped)
1300 stop_tty(tty);
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001301 up_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001302 tty_write_unlock(tty);
1303 return 0;
1304}
1305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306static char ptychar[] = "pqrstuvwxyzabcde";
1307
Alan Coxaf9b8972006-08-27 01:24:01 -07001308/**
1309 * pty_line_name - generate name for a pty
1310 * @driver: the tty driver in use
1311 * @index: the minor number
1312 * @p: output buffer of at least 6 bytes
1313 *
1314 * Generate a name from a driver reference and write it to the output
1315 * buffer.
1316 *
1317 * Locking: None
1318 */
1319static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320{
1321 int i = index + driver->name_base;
1322 /* ->name is initialized to "ttyp", but "tty" is expected */
1323 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001324 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1325 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326}
1327
Alan Coxaf9b8972006-08-27 01:24:01 -07001328/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001329 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001330 * @driver: the tty driver in use
1331 * @index: the minor number
1332 * @p: output buffer of at least 7 bytes
1333 *
1334 * Generate a name from a driver reference and write it to the output
Greg Kroah-Hartman5c0a2452014-02-22 14:31:04 -08001335 * buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07001336 *
1337 * Locking: None
1338 */
Hannes Reinecke723abd82014-02-27 12:30:51 +01001339static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
Jiri Slaby0019b402012-08-08 22:26:43 +02001341 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
Hannes Reinecke723abd82014-02-27 12:30:51 +01001342 return sprintf(p, "%s", driver->name);
Jiri Slaby0019b402012-08-08 22:26:43 +02001343 else
Hannes Reinecke723abd82014-02-27 12:30:51 +01001344 return sprintf(p, "%s%d", driver->name,
1345 index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346}
1347
Alan Cox99f1fe12008-10-13 10:42:00 +01001348/**
1349 * tty_driver_lookup_tty() - find an existing tty, if any
1350 * @driver: the driver for the tty
1351 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001352 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001353 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the
1354 * driver lookup() method returns an error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001355 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001356 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001357 */
Jason Wessela47d5452009-01-02 13:43:04 +00001358static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001359 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001360{
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001361 struct tty_struct *tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001362
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001363 if (driver->ops->lookup)
1364 tty = driver->ops->lookup(driver, inode, idx);
1365 else
1366 tty = driver->ttys[idx];
1367
1368 if (!IS_ERR(tty))
1369 tty_kref_get(tty);
1370 return tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001371}
1372
Alan Cox99f1fe12008-10-13 10:42:00 +01001373/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001374 * tty_init_termios - helper for termios setup
1375 * @tty: the tty to set up
1376 *
1377 * Initialise the termios structures for this tty. Thus runs under
1378 * the tty_mutex currently so we can be relaxed about ordering.
1379 */
1380
1381int tty_init_termios(struct tty_struct *tty)
1382{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001383 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001384 int idx = tty->index;
1385
Alan Cox36b3c072012-07-17 17:06:57 +01001386 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1387 tty->termios = tty->driver->init_termios;
1388 else {
1389 /* Check for lazy saved data */
1390 tp = tty->driver->termios[idx];
1391 if (tp != NULL)
1392 tty->termios = *tp;
1393 else
1394 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001395 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001396 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001397 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1398 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001399 return 0;
1400}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001401EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001402
Jiri Slaby66d450e2012-01-30 21:14:28 +01001403int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1404{
1405 int ret = tty_init_termios(tty);
1406 if (ret)
1407 return ret;
1408
1409 tty_driver_kref_get(driver);
1410 tty->count++;
1411 driver->ttys[tty->index] = tty;
1412 return 0;
1413}
1414EXPORT_SYMBOL_GPL(tty_standard_install);
1415
Alan Coxbf970ee2008-10-13 10:42:39 +01001416/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001417 * tty_driver_install_tty() - install a tty entry in the driver
1418 * @driver: the driver for the tty
1419 * @tty: the tty
1420 *
1421 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001422 * will be set by the time this is called. This method is responsible
1423 * for ensuring any need additional structures are allocated and
1424 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001425 *
1426 * Locking: tty_mutex for now
1427 */
1428static int tty_driver_install_tty(struct tty_driver *driver,
1429 struct tty_struct *tty)
1430{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001431 return driver->ops->install ? driver->ops->install(driver, tty) :
1432 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001433}
1434
1435/**
1436 * tty_driver_remove_tty() - remove a tty from the driver tables
1437 * @driver: the driver for the tty
1438 * @idx: the minor number
1439 *
1440 * Remvoe a tty object from the driver tables. The tty->index field
1441 * will be set by the time this is called.
1442 *
1443 * Locking: tty_mutex for now
1444 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001445void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001446{
1447 if (driver->ops->remove)
1448 driver->ops->remove(driver, tty);
1449 else
1450 driver->ttys[tty->index] = NULL;
1451}
1452
1453/*
1454 * tty_reopen() - fast re-open of an open tty
1455 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001456 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001457 * Return 0 on success, -errno on error.
Peter Hurley5d93e742014-11-05 12:12:47 -05001458 * Re-opens on master ptys are not allowed and return -EIO.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001459 *
Peter Hurley5d93e742014-11-05 12:12:47 -05001460 * Locking: Caller must hold tty_lock
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001461 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001462static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001463{
1464 struct tty_driver *driver = tty->driver;
1465
Peter Hurley216030e2014-11-05 12:12:48 -05001466 if (!tty->count)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001467 return -EIO;
1468
1469 if (driver->type == TTY_DRIVER_TYPE_PTY &&
Peter Hurley5d93e742014-11-05 12:12:47 -05001470 driver->subtype == PTY_TYPE_MASTER)
1471 return -EIO;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001472
Peter Hurley86f2c002014-12-30 10:39:25 -05001473 if (test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
1474 return -EBUSY;
1475
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001476 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001477
Peter Hurley36697522013-06-15 07:04:48 -04001478 WARN_ON(!tty->ldisc);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001479
1480 return 0;
1481}
1482
Alan Coxaf9b8972006-08-27 01:24:01 -07001483/**
Alan Coxd81ed102008-10-13 10:41:42 +01001484 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001485 * @driver: tty driver we are opening a device on
1486 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001487 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001488 *
1489 * Prepare a tty device. This may not be a "new" clean device but
1490 * could also be an active device. The pty drivers require special
1491 * handling because of this.
1492 *
1493 * Locking:
1494 * The function is called under the tty_mutex, which
1495 * protects us from the tty struct or driver itself going away.
1496 *
1497 * On exit the tty device has the line discipline attached and
1498 * a reference count of 1. If a pair was created for pty/tty use
1499 * and the other was a pty master then it too has a reference count of 1.
1500 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001502 * failed open. The new code protects the open with a mutex, so it's
1503 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 * relaxed for the (most common) case of reopening a tty.
1505 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001506
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001507struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
Alan Coxbf970ee2008-10-13 10:42:39 +01001509 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001510 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 /*
1513 * First time open is complex, especially for PTY devices.
1514 * This code guarantees that either everything succeeds and the
1515 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001516 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 * and locked termios may be retained.)
1518 */
1519
Alan Cox73ec06f2008-10-13 10:42:29 +01001520 if (!try_module_get(driver->owner))
1521 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02001523 tty = alloc_tty_struct(driver, idx);
Jiri Slabyd5543502011-03-23 10:48:32 +01001524 if (!tty) {
1525 retval = -ENOMEM;
1526 goto err_module_put;
1527 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Alan Cox89c8d912012-08-08 16:30:13 +01001529 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001530 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001531 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001532 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001533
Jiri Slaby04831dc2012-06-04 13:35:36 +02001534 if (!tty->port)
1535 tty->port = driver->ports[idx];
1536
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001537 WARN_RATELIMIT(!tty->port,
1538 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1539 __func__, tty->driver->name);
1540
Jiri Slaby967fab62012-10-18 22:26:46 +02001541 tty->port->itty = tty;
1542
Alan Cox37bdfb02008-02-08 04:18:47 -08001543 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001545 * If we fail here just call release_tty to clean up. No need
1546 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001548 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001549 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001550 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001551 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001552 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001554err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001555 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001556 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001557 free_tty_struct(tty);
1558err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001560 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001562 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001563err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001564 tty_unlock(tty);
Peter Hurley339f36b2015-11-08 13:01:13 -05001565 tty_info_ratelimited(tty, "ldisc open failed (%d), clearing slot %d\n",
1566 retval, idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001567 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001568 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569}
1570
Alan Coxfeebed62008-10-13 10:41:30 +01001571void tty_free_termios(struct tty_struct *tty)
1572{
1573 struct ktermios *tp;
1574 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001575
1576 /* If the port is going to reset then it has no termios to save */
1577 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1578 return;
1579
1580 /* Stash the termios data */
1581 tp = tty->driver->termios[idx];
1582 if (tp == NULL) {
1583 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
Peter Hurley25080652015-11-08 13:01:11 -05001584 if (tp == NULL)
Alan Cox36b3c072012-07-17 17:06:57 +01001585 return;
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001586 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001587 }
Alan Cox36b3c072012-07-17 17:06:57 +01001588 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001589}
1590EXPORT_SYMBOL(tty_free_termios);
1591
Peter Hurleya2965b72013-03-11 16:44:35 -04001592/**
Peter Hurley949aa642014-11-05 12:12:57 -05001593 * tty_flush_works - flush all works of a tty/pty pair
1594 * @tty: tty device to flush works for (or either end of a pty pair)
Peter Hurleya2965b72013-03-11 16:44:35 -04001595 *
Peter Hurley949aa642014-11-05 12:12:57 -05001596 * Sync flush all works belonging to @tty (and the 'other' tty).
Peter Hurleya2965b72013-03-11 16:44:35 -04001597 */
1598static void tty_flush_works(struct tty_struct *tty)
1599{
1600 flush_work(&tty->SAK_work);
1601 flush_work(&tty->hangup_work);
Peter Hurley949aa642014-11-05 12:12:57 -05001602 if (tty->link) {
1603 flush_work(&tty->link->SAK_work);
1604 flush_work(&tty->link->hangup_work);
1605 }
Peter Hurleya2965b72013-03-11 16:44:35 -04001606}
Alan Coxfeebed62008-10-13 10:41:30 +01001607
Alan Coxaf9b8972006-08-27 01:24:01 -07001608/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001609 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001610 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001611 *
1612 * Releases memory associated with a tty structure, and clears out the
1613 * driver table slots. This function is called when a device is no longer
1614 * in use. It also gets called when setup of a device fails.
1615 *
1616 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001617 * takes the file list lock internally when working on the list
1618 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001619 *
1620 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001621 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 */
Alan Coxb50989d2009-09-19 13:13:22 -07001623static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624{
Alan Coxb50989d2009-09-19 13:13:22 -07001625 struct tty_struct *tty =
1626 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001627 struct tty_driver *driver = tty->driver;
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001628 struct module *owner = driver->owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
Dave Youngf278a2f2009-09-27 16:00:42 +00001630 if (tty->ops->cleanup)
1631 tty->ops->cleanup(tty);
1632
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001634 tty_driver_kref_put(driver);
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001635 module_put(owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001636
Nick Pigginee2ffa02010-08-18 04:37:35 +10001637 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001639 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001640
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001641 put_pid(tty->pgrp);
1642 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 free_tty_struct(tty);
1644}
1645
Alan Coxb50989d2009-09-19 13:13:22 -07001646static void queue_release_one_tty(struct kref *kref)
1647{
1648 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001649
Alan Coxb50989d2009-09-19 13:13:22 -07001650 /* The hangup queue is now free so we can reuse it rather than
1651 waste a chunk of memory for each port */
1652 INIT_WORK(&tty->hangup_work, release_one_tty);
1653 schedule_work(&tty->hangup_work);
1654}
1655
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001656/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001657 * tty_kref_put - release a tty kref
1658 * @tty: tty device
1659 *
1660 * Release a reference to a tty device and if need be let the kref
1661 * layer destruct the object for us
1662 */
1663
1664void tty_kref_put(struct tty_struct *tty)
1665{
1666 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001667 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001668}
1669EXPORT_SYMBOL(tty_kref_put);
1670
1671/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001672 * release_tty - release tty structure memory
1673 *
1674 * Release both @tty and a possible linked partner (think pty pair),
1675 * and decrement the refcount of the backing module.
1676 *
1677 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001678 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001679 * takes the file list lock internally when working on the list
1680 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001681 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001682 */
1683static void release_tty(struct tty_struct *tty, int idx)
1684{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001685 /* This should always be true but check for the moment */
1686 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001687 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001688 if (tty->ops->shutdown)
1689 tty->ops->shutdown(tty);
1690 tty_free_termios(tty);
1691 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001692 tty->port->itty = NULL;
Peter Hurley64e377d2013-06-15 09:01:00 -04001693 if (tty->link)
1694 tty->link->port->itty = NULL;
Peter Hurleye1760582015-10-17 16:36:23 -04001695 tty_buffer_cancel_work(tty->port);
Alan Cox36b3c072012-07-17 17:06:57 +01001696
Markus Elfringa211b1a2014-11-21 13:42:29 +01001697 tty_kref_put(tty->link);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001698 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001699}
1700
Alan Coxeeb89d92009-11-30 13:18:29 +00001701/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001702 * tty_release_checks - check a tty before real release
1703 * @tty: tty to check
1704 * @o_tty: link of @tty (if any)
1705 * @idx: index of the tty
1706 *
1707 * Performs some paranoid checking before true release of the @tty.
1708 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1709 */
Peter Hurley359b9fb2014-11-05 12:12:59 -05001710static int tty_release_checks(struct tty_struct *tty, int idx)
Jiri Slaby955787ca2011-11-11 10:47:23 +01001711{
1712#ifdef TTY_PARANOIA_CHECK
1713 if (idx < 0 || idx >= tty->driver->num) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001714 tty_debug(tty, "bad idx %d\n", idx);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001715 return -1;
1716 }
1717
1718 /* not much to check for devpts */
1719 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1720 return 0;
1721
1722 if (tty != tty->driver->ttys[idx]) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001723 tty_debug(tty, "bad driver table[%d] = %p\n",
1724 idx, tty->driver->ttys[idx]);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001725 return -1;
1726 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001727 if (tty->driver->other) {
Peter Hurley359b9fb2014-11-05 12:12:59 -05001728 struct tty_struct *o_tty = tty->link;
1729
Jiri Slaby955787ca2011-11-11 10:47:23 +01001730 if (o_tty != tty->driver->other->ttys[idx]) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001731 tty_debug(tty, "bad other table[%d] = %p\n",
1732 idx, tty->driver->other->ttys[idx]);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001733 return -1;
1734 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001735 if (o_tty->link != tty) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001736 tty_debug(tty, "bad link = %p\n", o_tty->link);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001737 return -1;
1738 }
1739 }
1740#endif
1741 return 0;
1742}
1743
1744/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001745 * tty_release - vfs callback for close
1746 * @inode: inode of tty
1747 * @filp: file pointer for handle to tty
1748 *
1749 * Called the last time each file handle is closed that references
1750 * this tty. There may however be several such references.
1751 *
1752 * Locking:
1753 * Takes bkl. See tty_release_dev
1754 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 * Even releasing the tty structures is a tricky business.. We have
1756 * to be very careful that the structures are all released at the
1757 * same time, as interrupts might otherwise get the wrong pointers.
1758 *
1759 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1760 * lead to double frees or releasing memory still in use.
1761 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001762
1763int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764{
Nick Piggind996b622010-08-18 04:37:36 +10001765 struct tty_struct *tty = file_tty(filp);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001766 struct tty_struct *o_tty = NULL;
1767 int do_sleep, final;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 int idx;
Peter Hurley37b16452014-10-16 13:51:30 -04001769 long timeout = 0;
Peter Hurley494c1ea2014-10-16 13:54:36 -04001770 int once = 1;
Alan Cox37bdfb02008-02-08 04:18:47 -08001771
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001772 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001773 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Alan Cox89c8d912012-08-08 16:30:13 +01001775 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001776 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
Arnd Bergmannec79d602010-06-01 22:53:01 +02001778 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
1780 idx = tty->index;
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001781 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1782 tty->driver->subtype == PTY_TYPE_MASTER)
1783 o_tty = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Peter Hurley359b9fb2014-11-05 12:12:59 -05001785 if (tty_release_checks(tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001786 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001787 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789
Peter Hurleyd435cef2015-11-08 13:01:19 -05001790 tty_debug_hangup(tty, "releasing (count=%d)\n", tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
Alan Coxf34d7a52008-04-30 00:54:13 -07001792 if (tty->ops->close)
1793 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Peter Hurley2aff5e22014-11-05 12:13:01 -05001795 /* If tty is pty master, lock the slave pty (stable lock order) */
1796 tty_lock_slave(o_tty);
1797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 /*
1799 * Sanity check: if tty->count is going to zero, there shouldn't be
1800 * any waiters on tty->read_wait or tty->write_wait. We test the
1801 * wait queues and kick everyone out _before_ actually starting to
1802 * close. This ensures that we won't block while releasing the tty
1803 * structure.
1804 *
1805 * The test for the o_tty closing is necessary, since the master and
1806 * slave sides may close in any order. If the slave side closes out
1807 * first, its count will be one, since the master side holds an open.
Peter Hurley324c1652014-11-05 12:12:56 -05001808 * Thus this test wouldn't be triggered at the time the slave closed,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 * so we do it now.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 */
1811 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 do_sleep = 0;
1813
Peter Hurley324c1652014-11-05 12:12:56 -05001814 if (tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001816 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 do_sleep++;
1818 }
1819 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001820 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 do_sleep++;
1822 }
1823 }
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001824 if (o_tty && o_tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001826 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 do_sleep++;
1828 }
1829 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001830 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 do_sleep++;
1832 }
1833 }
1834 if (!do_sleep)
1835 break;
1836
Peter Hurley494c1ea2014-10-16 13:54:36 -04001837 if (once) {
1838 once = 0;
Peter Hurley339f36b2015-11-08 13:01:13 -05001839 tty_warn(tty, "read/write wait queue active!\n");
Peter Hurley494c1ea2014-10-16 13:54:36 -04001840 }
Peter Hurley37b16452014-10-16 13:51:30 -04001841 schedule_timeout_killable(timeout);
1842 if (timeout < 120 * HZ)
1843 timeout = 2 * timeout + 1;
1844 else
1845 timeout = MAX_SCHEDULE_TIMEOUT;
Alan Cox37bdfb02008-02-08 04:18:47 -08001846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001848 if (o_tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 if (--o_tty->count < 0) {
Peter Hurley339f36b2015-11-08 13:01:13 -05001850 tty_warn(tty, "bad slave count (%d)\n", o_tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 o_tty->count = 0;
1852 }
1853 }
1854 if (--tty->count < 0) {
Peter Hurley339f36b2015-11-08 13:01:13 -05001855 tty_warn(tty, "bad tty->count (%d)\n", tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 tty->count = 0;
1857 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001858
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 /*
1860 * We've decremented tty->count, so we need to remove this file
1861 * descriptor off the tty->tty_files list; this serves two
1862 * purposes:
1863 * - check_tty_count sees the correct number of file descriptors
1864 * associated with this tty.
1865 * - do_tty_hangup no longer sees this file descriptor as
1866 * something that needs to be handled for hangups.
1867 */
Nick Piggind996b622010-08-18 04:37:36 +10001868 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
1870 /*
1871 * Perform some housekeeping before deciding whether to return.
1872 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 * If _either_ side is closing, make sure there aren't any
1874 * processes that still think tty or o_tty is their controlling
1875 * tty.
1876 */
Peter Hurley324c1652014-11-05 12:12:56 -05001877 if (!tty->count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001879 session_clear_tty(tty->session);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001880 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001881 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 read_unlock(&tasklist_lock);
1883 }
1884
Peter Hurley324c1652014-11-05 12:12:56 -05001885 /* check whether both sides are closing ... */
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001886 final = !tty->count && !(o_tty && o_tty->count);
Peter Hurley324c1652014-11-05 12:12:56 -05001887
Peter Hurley2aff5e22014-11-05 12:13:01 -05001888 tty_unlock_slave(o_tty);
1889 tty_unlock(tty);
1890
Peter Hurley04980702014-11-05 12:12:52 -05001891 /* At this point, the tty->count == 0 should ensure a dead tty
Alan Coxd1552552012-07-27 18:02:54 +01001892 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001893
Peter Hurley324c1652014-11-05 12:12:56 -05001894 if (!final)
Alan Coxeeb89d92009-11-30 13:18:29 +00001895 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001896
Peter Hurleyaccff792015-07-12 22:49:09 -04001897 tty_debug_hangup(tty, "final close\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001899 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 */
Peter Hurley62462ae2014-11-05 12:12:58 -05001901 tty_ldisc_release(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001902
1903 /* Wait for pending work before tty destruction commmences */
1904 tty_flush_works(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001905
Peter Hurleyd435cef2015-11-08 13:01:19 -05001906 tty_debug_hangup(tty, "freeing structure\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001908 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001909 * the slots and preserving the termios structure. The tty_unlock_pair
1910 * should be safe as we keep a kref while the tty is locked (so the
1911 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 */
Alan Coxd1552552012-07-27 18:02:54 +01001913 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001914 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001915 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
Alan Coxeeb89d92009-11-30 13:18:29 +00001917 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918}
1919
Alan Coxaf9b8972006-08-27 01:24:01 -07001920/**
Peter Hurley52494ee2014-11-05 12:12:50 -05001921 * tty_open_current_tty - get locked tty of current task
Jiri Slabyb82154a2011-11-09 21:33:19 +01001922 * @device: device number
1923 * @filp: file pointer to tty
Peter Hurley52494ee2014-11-05 12:12:50 -05001924 * @return: locked tty of the current task iff @device is /dev/tty
1925 *
1926 * Performs a re-open of the current task's controlling tty.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001927 *
1928 * We cannot return driver and index like for the other nodes because
1929 * devpts will not work then. It expects inodes to be from devpts FS.
1930 */
1931static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1932{
1933 struct tty_struct *tty;
Peter Hurley52494ee2014-11-05 12:12:50 -05001934 int retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001935
1936 if (device != MKDEV(TTYAUX_MAJOR, 0))
1937 return NULL;
1938
1939 tty = get_current_tty();
1940 if (!tty)
1941 return ERR_PTR(-ENXIO);
1942
1943 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1944 /* noctty = 1; */
Peter Hurley52494ee2014-11-05 12:12:50 -05001945 tty_lock(tty);
1946 tty_kref_put(tty); /* safe to drop the kref now */
1947
1948 retval = tty_reopen(tty);
1949 if (retval < 0) {
1950 tty_unlock(tty);
1951 tty = ERR_PTR(retval);
1952 }
Jiri Slabyb82154a2011-11-09 21:33:19 +01001953 return tty;
1954}
1955
1956/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001957 * tty_lookup_driver - lookup a tty driver for a given device file
1958 * @device: device number
1959 * @filp: file pointer to tty
1960 * @noctty: set if the device should not become a controlling tty
1961 * @index: index for the device in the @return driver
1962 * @return: driver for this inode (with increased refcount)
1963 *
1964 * If @return is not erroneous, the caller is responsible to decrement the
1965 * refcount by tty_driver_kref_put.
1966 *
1967 * Locking: tty_mutex protects get_tty_driver
1968 */
1969static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1970 int *noctty, int *index)
1971{
1972 struct tty_driver *driver;
1973
Jiri Slaby2cd00502011-11-09 21:33:22 +01001974 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001975#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001976 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001977 extern struct tty_driver *console_driver;
1978 driver = tty_driver_kref_get(console_driver);
1979 *index = fg_console;
1980 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001981 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001982 }
1983#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001984 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001985 struct tty_driver *console_driver = console_device(index);
1986 if (console_driver) {
1987 driver = tty_driver_kref_get(console_driver);
1988 if (driver) {
1989 /* Don't let /dev/console block */
1990 filp->f_flags |= O_NONBLOCK;
1991 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001992 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001993 }
1994 }
1995 return ERR_PTR(-ENODEV);
1996 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01001997 default:
1998 driver = get_tty_driver(device, index);
1999 if (!driver)
2000 return ERR_PTR(-ENODEV);
2001 break;
2002 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002003 return driver;
2004}
2005
2006/**
Alan Coxeeb89d92009-11-30 13:18:29 +00002007 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002008 * @inode: inode of device file
2009 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002011 * tty_open and tty_release keep up the tty count that contains the
2012 * number of opens done on a tty. We cannot use the inode-count, as
2013 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002015 * Open-counting is needed for pty masters, as well as for keeping
2016 * track of serial lines: DTR is dropped when the last close happens.
2017 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2018 *
2019 * The termios state of a pty is reset on first open so that
2020 * settings don't persist across reuse.
2021 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002022 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002023 * tty->count should protect the rest.
2024 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01002025 *
2026 * Note: the tty_unlock/lock cases without a ref are only safe due to
2027 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002029
Alan Coxeeb89d92009-11-30 13:18:29 +00002030static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031{
Jiri Slabyb82154a2011-11-09 21:33:19 +01002032 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01002034 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 int index;
2036 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07002037 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
2039 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08002040
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002042 retval = tty_alloc_file(filp);
2043 if (retval)
2044 return -ENOMEM;
2045
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 noctty = filp->f_flags & O_NOCTTY;
2047 index = -1;
2048 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002049
Jiri Slabyb82154a2011-11-09 21:33:19 +01002050 tty = tty_open_current_tty(device, filp);
Peter Hurley52494ee2014-11-05 12:12:50 -05002051 if (!tty) {
2052 mutex_lock(&tty_mutex);
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002053 driver = tty_lookup_driver(device, filp, &noctty, &index);
2054 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002055 retval = PTR_ERR(driver);
2056 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002059 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01002060 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00002061 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002062 retval = PTR_ERR(tty);
2063 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00002064 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002065
2066 if (tty) {
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002067 mutex_unlock(&tty_mutex);
Peter Hurley0bfd4642016-01-09 21:13:44 -08002068 retval = tty_lock_interruptible(tty);
2069 if (retval) {
2070 if (retval == -EINTR)
2071 retval = -ERESTARTSYS;
2072 goto err_unref;
2073 }
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002074 /* safe to drop the kref from tty_driver_lookup_tty() */
2075 tty_kref_put(tty);
Peter Hurley52494ee2014-11-05 12:12:50 -05002076 retval = tty_reopen(tty);
2077 if (retval < 0) {
2078 tty_unlock(tty);
2079 tty = ERR_PTR(retval);
2080 }
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002081 } else { /* Returns with the tty_lock held for now */
Peter Hurley52494ee2014-11-05 12:12:50 -05002082 tty = tty_init_dev(driver, index);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002083 mutex_unlock(&tty_mutex);
2084 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002085
Peter Hurley52494ee2014-11-05 12:12:50 -05002086 tty_driver_kref_put(driver);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002087 }
2088
Alan Coxeeb89d92009-11-30 13:18:29 +00002089 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002090 retval = PTR_ERR(tty);
2091 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00002092 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002094 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10002095
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002096 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2098 tty->driver->subtype == PTY_TYPE_MASTER)
2099 noctty = 1;
Peter Hurleyaccff792015-07-12 22:49:09 -04002100
Peter Hurleyd435cef2015-11-08 13:01:19 -05002101 tty_debug_hangup(tty, "opening (count=%d)\n", tty->count);
Peter Hurleyaccff792015-07-12 22:49:09 -04002102
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03002103 if (tty->ops->open)
2104 retval = tty->ops->open(tty, filp);
2105 else
2106 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 filp->f_flags = saved_flags;
2108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 if (retval) {
Peter Hurleyd435cef2015-11-08 13:01:19 -05002110 tty_debug_hangup(tty, "open error %d, releasing\n", retval);
Peter Hurleyaccff792015-07-12 22:49:09 -04002111
Alan Cox89c8d912012-08-08 16:30:13 +01002112 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00002113 tty_release(inode, filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02002114 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 return retval;
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02002116
2117 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 return retval;
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02002119
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 schedule();
2121 /*
2122 * Need to reset f_op in case a hangup happened.
2123 */
Peter Hurley12569372014-11-05 12:26:24 -05002124 if (tty_hung_up_p(filp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 filp->f_op = &tty_fops;
2126 goto retry_open;
2127 }
Peter Hurleyd4855e12013-11-19 08:46:27 -05002128 clear_bit(TTY_HUPPED, &tty->flags);
Alan Coxeeb89d92009-11-30 13:18:29 +00002129
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002130
Peter Hurley2c411c12014-10-16 14:59:47 -04002131 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002132 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 if (!noctty &&
2134 current->signal->leader &&
2135 !current->signal->tty &&
Jann Horn0c5562712015-10-04 19:29:12 +02002136 tty->session == NULL) {
2137 /*
2138 * Don't let a process that only has write access to the tty
2139 * obtain the privileges associated with having a tty as
2140 * controlling terminal (being able to reopen it with full
2141 * access through /dev/tty, being able to perform pushback).
2142 * Many distributions set the group of all ttys to "tty" and
2143 * grant write-only access to all terminals for setgid tty
2144 * binaries, which should not imply full privileges on all ttys.
2145 *
2146 * This could theoretically break old code that performs open()
2147 * on a write-only file descriptor. In that case, it might be
2148 * necessary to also permit this if
2149 * inode_permission(inode, MAY_READ) == 0.
2150 */
2151 if (filp->f_mode & FMODE_READ)
2152 __proc_set_tty(tty);
2153 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002154 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley2c411c12014-10-16 14:59:47 -04002155 read_unlock(&tasklist_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01002156 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002158err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002159 mutex_unlock(&tty_mutex);
Peter Hurley0bfd4642016-01-09 21:13:44 -08002160err_unref:
Jiri Slabyba5db442011-11-09 21:33:21 +01002161 /* after locks to avoid deadlock */
2162 if (!IS_ERR_OR_NULL(driver))
2163 tty_driver_kref_put(driver);
2164err_file:
2165 tty_free_file(filp);
2166 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167}
2168
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002169
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
Alan Coxaf9b8972006-08-27 01:24:01 -07002171/**
2172 * tty_poll - check tty status
2173 * @filp: file being polled
2174 * @wait: poll wait structures to update
2175 *
2176 * Call the line discipline polling method to obtain the poll
2177 * status of the device.
2178 *
2179 * Locking: locks called line discipline but ldisc poll method
2180 * may be re-entered freely by other callers.
2181 */
2182
Alan Cox37bdfb02008-02-08 04:18:47 -08002183static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184{
Nick Piggind996b622010-08-18 04:37:36 +10002185 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 struct tty_ldisc *ld;
2187 int ret = 0;
2188
Al Viro6131ffa2013-02-27 16:59:05 -05002189 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002191
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002193 if (ld->ops->poll)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002194 ret = ld->ops->poll(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 tty_ldisc_deref(ld);
2196 return ret;
2197}
2198
Arnd Bergmannec79d602010-06-01 22:53:01 +02002199static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200{
Nick Piggind996b622010-08-18 04:37:36 +10002201 struct tty_struct *tty = file_tty(filp);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002202 struct tty_ldisc *ldisc;
Alan Cox47f86832008-04-30 00:53:30 -07002203 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002204 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205
Al Viro6131ffa2013-02-27 16:59:05 -05002206 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002207 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002208
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 retval = fasync_helper(fd, filp, on, &tty->fasync);
2210 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002211 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002213 ldisc = tty_ldisc_ref(tty);
2214 if (ldisc) {
2215 if (ldisc->ops->fasync)
2216 ldisc->ops->fasync(tty, on);
2217 tty_ldisc_deref(ldisc);
2218 }
2219
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002221 enum pid_type type;
2222 struct pid *pid;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002223
Alan Cox47f86832008-04-30 00:53:30 -07002224 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002225 if (tty->pgrp) {
2226 pid = tty->pgrp;
2227 type = PIDTYPE_PGID;
2228 } else {
2229 pid = task_pid(current);
2230 type = PIDTYPE_PID;
2231 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002232 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002233 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002234 __f_setown(filp, pid, type, 0);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002235 put_pid(pid);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002236 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002238out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002239 return retval;
2240}
2241
2242static int tty_fasync(int fd, struct file *filp, int on)
2243{
Alan Cox89c8d912012-08-08 16:30:13 +01002244 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002245 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002246
2247 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002248 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002249 tty_unlock(tty);
2250
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002251 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252}
2253
Alan Coxaf9b8972006-08-27 01:24:01 -07002254/**
2255 * tiocsti - fake input character
2256 * @tty: tty to fake input into
2257 * @p: pointer to character
2258 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002259 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002260 * input management.
2261 *
2262 * FIXME: does not honour flow control ??
2263 *
2264 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -04002265 * Called functions take tty_ldiscs_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002266 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002267 *
2268 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002269 */
2270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271static int tiocsti(struct tty_struct *tty, char __user *p)
2272{
2273 char ch, mbz = 0;
2274 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002275
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2277 return -EPERM;
2278 if (get_user(ch, p))
2279 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002280 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002282 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 tty_ldisc_deref(ld);
2284 return 0;
2285}
2286
Alan Coxaf9b8972006-08-27 01:24:01 -07002287/**
2288 * tiocgwinsz - implement window query ioctl
2289 * @tty; tty
2290 * @arg: user buffer for result
2291 *
Alan Cox808a0d32006-09-29 02:00:40 -07002292 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002293 *
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002294 * Locking: tty->winsize_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002295 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002296 */
2297
Alan Cox37bdfb02008-02-08 04:18:47 -08002298static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299{
Alan Cox808a0d32006-09-29 02:00:40 -07002300 int err;
2301
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002302 mutex_lock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002303 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002304 mutex_unlock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002305
2306 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307}
2308
Alan Coxaf9b8972006-08-27 01:24:01 -07002309/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002310 * tty_do_resize - resize event
2311 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002312 * @rows: rows (character)
2313 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002314 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002315 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002316 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002317 */
2318
Alan Coxfc6f6232009-01-02 13:43:17 +00002319int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320{
Alan Coxfc6f6232009-01-02 13:43:17 +00002321 struct pid *pgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322
Alan Coxfc6f6232009-01-02 13:43:17 +00002323 /* Lock the tty */
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002324 mutex_lock(&tty->winsize_mutex);
Alan Coxfc6f6232009-01-02 13:43:17 +00002325 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002326 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002327
Peter Hurley5b239542014-10-16 14:59:45 -04002328 /* Signal the foreground process group */
2329 pgrp = tty_get_pgrp(tty);
Alan Cox47f86832008-04-30 00:53:30 -07002330 if (pgrp)
2331 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002332 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002333
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002334 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002335done:
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002336 mutex_unlock(&tty->winsize_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 return 0;
2338}
Martin Schwidefsky4d334fd2013-01-04 14:55:13 +01002339EXPORT_SYMBOL(tty_do_resize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340
Alan Coxaf9b8972006-08-27 01:24:01 -07002341/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002342 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002343 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002344 * @arg: user buffer for result
2345 *
2346 * Copies the user idea of the window size to the kernel. Traditionally
2347 * this is just advisory information but for the Linux console it
2348 * actually has driver level meaning and triggers a VC resize.
2349 *
2350 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002351 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002352 * tty termios mutex and ctrl_lock. The console takes its own lock
2353 * then calls into the default method.
2354 */
2355
Alan Coxfc6f6232009-01-02 13:43:17 +00002356static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002357{
2358 struct winsize tmp_ws;
2359 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2360 return -EFAULT;
2361
2362 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002363 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002364 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002365 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002366}
2367
2368/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002369 * tioccons - allow admin to move logical console
2370 * @file: the file to become console
2371 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002372 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002373 *
2374 * Locking: uses redirect_lock to guard the redirect information
2375 */
2376
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377static int tioccons(struct file *file)
2378{
2379 if (!capable(CAP_SYS_ADMIN))
2380 return -EPERM;
2381 if (file->f_op->write == redirected_tty_write) {
2382 struct file *f;
2383 spin_lock(&redirect_lock);
2384 f = redirect;
2385 redirect = NULL;
2386 spin_unlock(&redirect_lock);
2387 if (f)
2388 fput(f);
2389 return 0;
2390 }
2391 spin_lock(&redirect_lock);
2392 if (redirect) {
2393 spin_unlock(&redirect_lock);
2394 return -EBUSY;
2395 }
Al Virocb0942b2012-08-27 14:48:26 -04002396 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 spin_unlock(&redirect_lock);
2398 return 0;
2399}
2400
Alan Coxaf9b8972006-08-27 01:24:01 -07002401/**
2402 * fionbio - non blocking ioctl
2403 * @file: file to set blocking value
2404 * @p: user parameter
2405 *
2406 * Historical tty interfaces had a blocking control ioctl before
2407 * the generic functionality existed. This piece of history is preserved
2408 * in the expected tty API of posix OS's.
2409 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002410 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002411 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412
2413static int fionbio(struct file *file, int __user *p)
2414{
2415 int nonblock;
2416
2417 if (get_user(nonblock, p))
2418 return -EFAULT;
2419
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002420 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 if (nonblock)
2422 file->f_flags |= O_NONBLOCK;
2423 else
2424 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002425 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 return 0;
2427}
2428
Alan Coxaf9b8972006-08-27 01:24:01 -07002429/**
2430 * tiocsctty - set controlling tty
2431 * @tty: tty structure
2432 * @arg: user argument
2433 *
2434 * This ioctl is used to manage job control. It permits a session
2435 * leader to set this tty as the controlling tty for the session.
2436 *
2437 * Locking:
Peter Hurleye218eb32014-10-16 14:59:49 -04002438 * Takes tty_lock() to serialize proc_set_tty() for this tty
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002439 * Takes tasklist_lock internally to walk sessions
2440 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002441 */
2442
Jann Horn0c5562712015-10-04 19:29:12 +02002443static int tiocsctty(struct tty_struct *tty, struct file *file, int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002445 int ret = 0;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002446
Peter Hurleye218eb32014-10-16 14:59:49 -04002447 tty_lock(tty);
Peter Hurley2c411c12014-10-16 14:59:47 -04002448 read_lock(&tasklist_lock);
2449
2450 if (current->signal->leader && (task_session(current) == tty->session))
2451 goto unlock;
2452
Linus Torvalds1da177e2005-04-16 15:20:36 -07002453 /*
2454 * The process must be a session leader and
2455 * not have a controlling tty already.
2456 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002457 if (!current->signal->leader || current->signal->tty) {
2458 ret = -EPERM;
2459 goto unlock;
2460 }
2461
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002462 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 /*
2464 * This tty is already the controlling
2465 * tty for another session group!
2466 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002467 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 /*
2469 * Steal it away
2470 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002471 session_clear_tty(tty->session);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002472 } else {
2473 ret = -EPERM;
2474 goto unlock;
2475 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 }
Jann Horn0c5562712015-10-04 19:29:12 +02002477
2478 /* See the comment in tty_open(). */
2479 if ((file->f_mode & FMODE_READ) == 0 && !capable(CAP_SYS_ADMIN)) {
2480 ret = -EPERM;
2481 goto unlock;
2482 }
2483
Peter Hurleybce65f12014-10-16 14:59:43 -04002484 proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002485unlock:
Peter Hurley2c411c12014-10-16 14:59:47 -04002486 read_unlock(&tasklist_lock);
Peter Hurleye218eb32014-10-16 14:59:49 -04002487 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002488 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489}
2490
Alan Coxaf9b8972006-08-27 01:24:01 -07002491/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002492 * tty_get_pgrp - return a ref counted pgrp pid
2493 * @tty: tty to read
2494 *
2495 * Returns a refcounted instance of the pid struct for the process
2496 * group controlling the tty.
2497 */
2498
2499struct pid *tty_get_pgrp(struct tty_struct *tty)
2500{
2501 unsigned long flags;
2502 struct pid *pgrp;
2503
2504 spin_lock_irqsave(&tty->ctrl_lock, flags);
2505 pgrp = get_pid(tty->pgrp);
2506 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2507
2508 return pgrp;
2509}
2510EXPORT_SYMBOL_GPL(tty_get_pgrp);
2511
Peter Hurleye1c22962014-10-16 14:59:48 -04002512/*
2513 * This checks not only the pgrp, but falls back on the pid if no
2514 * satisfactory pgrp is found. I dunno - gdb doesn't work correctly
2515 * without this...
2516 *
2517 * The caller must hold rcu lock or the tasklist lock.
2518 */
2519static struct pid *session_of_pgrp(struct pid *pgrp)
2520{
2521 struct task_struct *p;
2522 struct pid *sid = NULL;
2523
2524 p = pid_task(pgrp, PIDTYPE_PGID);
2525 if (p == NULL)
2526 p = pid_task(pgrp, PIDTYPE_PID);
2527 if (p != NULL)
2528 sid = task_session(p);
2529
2530 return sid;
2531}
2532
Alan Cox5d0fdf12008-04-30 00:53:31 -07002533/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002534 * tiocgpgrp - get process group
2535 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002536 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002537 * @p: returned pid
2538 *
2539 * Obtain the process group of the tty. If there is no process group
2540 * return an error.
2541 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002542 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002543 */
2544
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2546{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002547 struct pid *pid;
2548 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 /*
2550 * (tty == real_tty) is a cheap way of
2551 * testing if the tty is NOT a master pty.
2552 */
2553 if (tty == real_tty && current->signal->tty != real_tty)
2554 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002555 pid = tty_get_pgrp(real_tty);
2556 ret = put_user(pid_vnr(pid), p);
2557 put_pid(pid);
2558 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559}
2560
Alan Coxaf9b8972006-08-27 01:24:01 -07002561/**
2562 * tiocspgrp - attempt to set process group
2563 * @tty: tty passed by user
2564 * @real_tty: tty side device matching tty passed by user
2565 * @p: pid pointer
2566 *
2567 * Set the process group of the tty to the session passed. Only
2568 * permitted where the tty session is our session.
2569 *
Alan Cox47f86832008-04-30 00:53:30 -07002570 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002571 */
2572
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2574{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002575 struct pid *pgrp;
2576 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 int retval = tty_check_change(real_tty);
2578
2579 if (retval == -EIO)
2580 return -ENOTTY;
2581 if (retval)
2582 return retval;
2583 if (!current->signal->tty ||
2584 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002585 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002587 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002589 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002591 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002592 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002593 retval = -ESRCH;
2594 if (!pgrp)
2595 goto out_unlock;
2596 retval = -EPERM;
2597 if (session_of_pgrp(pgrp) != task_session(current))
2598 goto out_unlock;
2599 retval = 0;
Peter Hurley1e86b5b2015-10-10 20:28:43 -04002600 spin_lock_irq(&tty->ctrl_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002601 put_pid(real_tty->pgrp);
2602 real_tty->pgrp = get_pid(pgrp);
Peter Hurley1e86b5b2015-10-10 20:28:43 -04002603 spin_unlock_irq(&tty->ctrl_lock);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002604out_unlock:
2605 rcu_read_unlock();
2606 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607}
2608
Alan Coxaf9b8972006-08-27 01:24:01 -07002609/**
2610 * tiocgsid - get session id
2611 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002612 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002613 * @p: pointer to returned session id
2614 *
2615 * Obtain the session id of the tty. If there is no session
2616 * return an error.
2617 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002618 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002619 */
2620
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2622{
2623 /*
2624 * (tty == real_tty) is a cheap way of
2625 * testing if the tty is NOT a master pty.
2626 */
2627 if (tty == real_tty && current->signal->tty != real_tty)
2628 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002629 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002631 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632}
2633
Alan Coxaf9b8972006-08-27 01:24:01 -07002634/**
2635 * tiocsetd - set line discipline
2636 * @tty: tty device
2637 * @p: pointer to user data
2638 *
2639 * Set the line discipline according to user request.
2640 *
2641 * Locking: see tty_set_ldisc, this function is just a helper
2642 */
2643
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644static int tiocsetd(struct tty_struct *tty, int __user *p)
2645{
2646 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002647 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648
2649 if (get_user(ldisc, p))
2650 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002651
Alan Cox04f378b2008-04-30 00:53:29 -07002652 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002653
2654 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655}
2656
Alan Coxaf9b8972006-08-27 01:24:01 -07002657/**
2658 * send_break - performed time break
2659 * @tty: device to break on
2660 * @duration: timeout in mS
2661 *
2662 * Perform a timed break on hardware that lacks its own driver level
2663 * timed break functionality.
2664 *
2665 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002666 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002667 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002668 */
2669
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002670static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671{
Alan Cox9e989662008-07-22 11:18:03 +01002672 int retval;
2673
2674 if (tty->ops->break_ctl == NULL)
2675 return 0;
2676
2677 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2678 retval = tty->ops->break_ctl(tty, duration);
2679 else {
2680 /* Do the work ourselves */
2681 if (tty_write_lock(tty, 0) < 0)
2682 return -EINTR;
2683 retval = tty->ops->break_ctl(tty, -1);
2684 if (retval)
2685 goto out;
2686 if (!signal_pending(current))
2687 msleep_interruptible(duration);
2688 retval = tty->ops->break_ctl(tty, 0);
2689out:
2690 tty_write_unlock(tty);
2691 if (signal_pending(current))
2692 retval = -EINTR;
2693 }
2694 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695}
2696
Alan Coxaf9b8972006-08-27 01:24:01 -07002697/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002698 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002699 * @tty: tty device
2700 * @file: user file pointer
2701 * @p: pointer to result
2702 *
2703 * Obtain the modem status bits from the tty driver if the feature
2704 * is supported. Return -EINVAL if it is not available.
2705 *
2706 * Locking: none (up to the driver)
2707 */
2708
Alan Cox60b33c12011-02-14 16:26:14 +00002709static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710{
2711 int retval = -EINVAL;
2712
Alan Coxf34d7a52008-04-30 00:54:13 -07002713 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002714 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715
2716 if (retval >= 0)
2717 retval = put_user(retval, p);
2718 }
2719 return retval;
2720}
2721
Alan Coxaf9b8972006-08-27 01:24:01 -07002722/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002723 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002724 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002725 * @cmd: command - clear bits, set bits or set all
2726 * @p: pointer to desired bits
2727 *
2728 * Set the modem status bits from the tty driver if the feature
2729 * is supported. Return -EINVAL if it is not available.
2730 *
2731 * Locking: none (up to the driver)
2732 */
2733
Alan Cox20b9d172011-02-14 16:26:50 +00002734static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735 unsigned __user *p)
2736{
Alan Coxae677512008-07-16 21:56:54 +01002737 int retval;
2738 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739
Alan Coxae677512008-07-16 21:56:54 +01002740 if (tty->ops->tiocmset == NULL)
2741 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742
Alan Coxae677512008-07-16 21:56:54 +01002743 retval = get_user(val, p);
2744 if (retval)
2745 return retval;
2746 set = clear = 0;
2747 switch (cmd) {
2748 case TIOCMBIS:
2749 set = val;
2750 break;
2751 case TIOCMBIC:
2752 clear = val;
2753 break;
2754 case TIOCMSET:
2755 set = val;
2756 clear = ~val;
2757 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 }
Alan Coxae677512008-07-16 21:56:54 +01002759 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2760 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002761 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762}
2763
Alan Coxd281da72010-09-16 18:21:24 +01002764static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2765{
2766 int retval = -EINVAL;
2767 struct serial_icounter_struct icount;
2768 memset(&icount, 0, sizeof(icount));
2769 if (tty->ops->get_icount)
2770 retval = tty->ops->get_icount(tty, &icount);
2771 if (retval != 0)
2772 return retval;
2773 if (copy_to_user(arg, &icount, sizeof(icount)))
2774 return -EFAULT;
2775 return 0;
2776}
2777
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002778static void tty_warn_deprecated_flags(struct serial_struct __user *ss)
2779{
2780 static DEFINE_RATELIMIT_STATE(depr_flags,
2781 DEFAULT_RATELIMIT_INTERVAL,
2782 DEFAULT_RATELIMIT_BURST);
2783 char comm[TASK_COMM_LEN];
2784 int flags;
2785
2786 if (get_user(flags, &ss->flags))
2787 return;
2788
2789 flags &= ASYNC_DEPRECATED;
2790
2791 if (flags && __ratelimit(&depr_flags))
2792 pr_warning("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n",
2793 __func__, get_task_comm(comm, current), flags);
2794}
2795
Peter Hurley8f166e02014-10-16 14:59:41 -04002796/*
2797 * if pty, return the slave side (real_tty)
2798 * otherwise, return self
2799 */
2800static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +01002801{
2802 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2803 tty->driver->subtype == PTY_TYPE_MASTER)
2804 tty = tty->link;
2805 return tty;
2806}
Alan Coxe8b70e72009-06-11 12:48:02 +01002807
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808/*
2809 * Split this up, as gcc can choke on it otherwise..
2810 */
Alan Cox04f378b2008-04-30 00:53:29 -07002811long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812{
Nick Piggind996b622010-08-18 04:37:36 +10002813 struct tty_struct *tty = file_tty(file);
2814 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815 void __user *p = (void __user *)arg;
2816 int retval;
2817 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002818
Al Viro6131ffa2013-02-27 16:59:05 -05002819 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 return -EINVAL;
2821
Alan Coxe8b70e72009-06-11 12:48:02 +01002822 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823
2824 /*
2825 * Factor out some common prep work
2826 */
2827 switch (cmd) {
2828 case TIOCSETD:
2829 case TIOCSBRK:
2830 case TIOCCBRK:
2831 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002832 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 retval = tty_check_change(tty);
2834 if (retval)
2835 return retval;
2836 if (cmd != TIOCCBRK) {
2837 tty_wait_until_sent(tty, 0);
2838 if (signal_pending(current))
2839 return -EINTR;
2840 }
2841 break;
2842 }
2843
Alan Cox9e989662008-07-22 11:18:03 +01002844 /*
2845 * Now do the stuff.
2846 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002848 case TIOCSTI:
2849 return tiocsti(tty, p);
2850 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002851 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002852 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002853 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002854 case TIOCCONS:
2855 return real_tty != tty ? -EINVAL : tioccons(file);
2856 case FIONBIO:
2857 return fionbio(file, p);
2858 case TIOCEXCL:
2859 set_bit(TTY_EXCLUSIVE, &tty->flags);
2860 return 0;
2861 case TIOCNXCL:
2862 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2863 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002864 case TIOCGEXCL:
2865 {
2866 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2867 return put_user(excl, (int __user *)p);
2868 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002869 case TIOCNOTTY:
2870 if (current->signal->tty != tty)
2871 return -ENOTTY;
2872 no_tty();
2873 return 0;
2874 case TIOCSCTTY:
Peter Hurleyd1d3a0f2015-11-08 09:06:05 -05002875 return tiocsctty(real_tty, file, arg);
Alan Cox37bdfb02008-02-08 04:18:47 -08002876 case TIOCGPGRP:
2877 return tiocgpgrp(tty, real_tty, p);
2878 case TIOCSPGRP:
2879 return tiocspgrp(tty, real_tty, p);
2880 case TIOCGSID:
2881 return tiocgsid(tty, real_tty, p);
2882 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002883 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002884 case TIOCSETD:
2885 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002886 case TIOCVHANGUP:
2887 if (!capable(CAP_SYS_ADMIN))
2888 return -EPERM;
2889 tty_vhangup(tty);
2890 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002891 case TIOCGDEV:
2892 {
2893 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2894 return put_user(ret, (unsigned int __user *)p);
2895 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002896 /*
2897 * Break handling
2898 */
2899 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002900 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002901 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002902 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002903 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002904 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002905 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002906 return 0;
2907 case TCSBRK: /* SVID version: non-zero arg --> no break */
2908 /* non-zero arg means wait for all output data
2909 * to be sent (performed above) but don't send break.
2910 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002912 if (!arg)
2913 return send_break(tty, 250);
2914 return 0;
2915 case TCSBRKP: /* support for POSIX tcsendbreak() */
2916 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917
Alan Cox37bdfb02008-02-08 04:18:47 -08002918 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002919 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002920 case TIOCMSET:
2921 case TIOCMBIC:
2922 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002923 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002924 case TIOCGICOUNT:
2925 retval = tty_tiocgicount(tty, p);
2926 /* For the moment allow fall through to the old method */
2927 if (retval != -EINVAL)
2928 return retval;
2929 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002930 case TCFLSH:
2931 switch (arg) {
2932 case TCIFLUSH:
2933 case TCIOFLUSH:
2934 /* flush tty buffer and allow ldisc to process ioctl */
Peter Hurley86c80a82014-11-05 12:13:09 -05002935 tty_buffer_flush(tty, NULL);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002936 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002937 }
2938 break;
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002939 case TIOCSSERIAL:
2940 tty_warn_deprecated_flags(p);
2941 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002943 if (tty->ops->ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002944 retval = tty->ops->ioctl(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002945 if (retval != -ENOIOCTLCMD)
2946 return retval;
2947 }
2948 ld = tty_ldisc_ref_wait(tty);
2949 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002950 if (ld->ops->ioctl) {
2951 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002953 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954 }
2955 tty_ldisc_deref(ld);
2956 return retval;
2957}
2958
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002959#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002960static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002961 unsigned long arg)
2962{
Nick Piggind996b622010-08-18 04:37:36 +10002963 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002964 struct tty_ldisc *ld;
2965 int retval = -ENOIOCTLCMD;
2966
Al Viro6131ffa2013-02-27 16:59:05 -05002967 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002968 return -EINVAL;
2969
Alan Coxf34d7a52008-04-30 00:54:13 -07002970 if (tty->ops->compat_ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002971 retval = tty->ops->compat_ioctl(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002972 if (retval != -ENOIOCTLCMD)
2973 return retval;
2974 }
2975
2976 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002977 if (ld->ops->compat_ioctl)
2978 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002979 else
2980 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002981 tty_ldisc_deref(ld);
2982
2983 return retval;
2984}
2985#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986
Al Viroc3c073f2012-08-21 22:32:06 -04002987static int this_tty(const void *t, struct file *file, unsigned fd)
2988{
2989 if (likely(file->f_op->read != tty_read))
2990 return 0;
2991 return file_tty(file) != t ? 0 : fd + 1;
2992}
2993
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994/*
2995 * This implements the "Secure Attention Key" --- the idea is to
2996 * prevent trojan horses by killing all processes associated with this
2997 * tty when the user hits the "Secure Attention Key". Required for
2998 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002999 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000 * This code could be nicer; ideally it should send a HUP, wait a few
3001 * seconds, then send a INT, and then a KILL signal. But you then
3002 * have to coordinate with the init process, since all processes associated
3003 * with the current tty must be dead before the new getty is allowed
3004 * to spawn.
3005 *
3006 * Now, if it would be correct ;-/ The current code has a nasty hole -
3007 * it doesn't catch files in flight. We may send the descriptor to ourselves
3008 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3009 *
3010 * Nasty bug: do_SAK is being called in interrupt context. This can
3011 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3012 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003013void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014{
3015#ifdef TTY_SOFT_SAK
3016 tty_hangup(tty);
3017#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08003018 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003019 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08003021
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022 if (!tty)
3023 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003024 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08003025
Dan Carpenterb3f13de2006-12-13 00:35:09 -08003026 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027
Alan Coxf34d7a52008-04-30 00:54:13 -07003028 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08003029
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003031 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003032 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Hurley9b42bb72015-11-08 13:01:14 -05003033 tty_notice(tty, "SAK: killed process %d (%s): by session\n",
3034 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003035 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003036 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Hurley9b42bb72015-11-08 13:01:14 -05003037
3038 /* Now kill any processes that happen to have the tty open */
Eric W. Biederman652486f2006-03-28 16:11:02 -08003039 do_each_thread(g, p) {
3040 if (p->signal->tty == tty) {
Peter Hurley9b42bb72015-11-08 13:01:14 -05003041 tty_notice(tty, "SAK: killed process %d (%s): by controlling tty\n",
3042 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 send_sig(SIGKILL, p, 1);
3044 continue;
3045 }
3046 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04003047 i = iterate_fd(p->files, 0, this_tty, tty);
3048 if (i != 0) {
Peter Hurley9b42bb72015-11-08 13:01:14 -05003049 tty_notice(tty, "SAK: killed process %d (%s): by fd#%d\n",
3050 task_pid_nr(p), p->comm, i - 1);
Al Viroc3c073f2012-08-21 22:32:06 -04003051 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052 }
3053 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003054 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055 read_unlock(&tasklist_lock);
3056#endif
3057}
3058
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003059static void do_SAK_work(struct work_struct *work)
3060{
3061 struct tty_struct *tty =
3062 container_of(work, struct tty_struct, SAK_work);
3063 __do_SAK(tty);
3064}
3065
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066/*
3067 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3068 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3069 * the values which we write to it will be identical to the values which it
3070 * already has. --akpm
3071 */
3072void do_SAK(struct tty_struct *tty)
3073{
3074 if (!tty)
3075 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076 schedule_work(&tty->SAK_work);
3077}
3078
3079EXPORT_SYMBOL(do_SAK);
3080
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003081static int dev_match_devt(struct device *dev, const void *data)
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003082{
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003083 const dev_t *devt = data;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003084 return dev->devt == *devt;
3085}
3086
3087/* Must put_device() after it's unused! */
3088static struct device *tty_get_device(struct tty_struct *tty)
3089{
3090 dev_t devt = tty_devnum(tty);
3091 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3092}
3093
3094
Alan Coxaf9b8972006-08-27 01:24:01 -07003095/**
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003096 * alloc_tty_struct
Alan Coxaf9b8972006-08-27 01:24:01 -07003097 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003098 * This subroutine allocates and initializes a tty structure.
Alan Coxaf9b8972006-08-27 01:24:01 -07003099 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003100 * Locking: none - tty in question is not exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003102
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003103struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104{
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003105 struct tty_struct *tty;
3106
3107 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
3108 if (!tty)
3109 return NULL;
3110
Alan Cox9c9f4de2008-10-13 10:37:26 +01003111 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01003113 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003114 tty->session = NULL;
3115 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01003116 mutex_init(&tty->legacy_mutex);
Peter Hurleyd8c1f922013-06-15 09:14:31 -04003117 mutex_init(&tty->throttle_mutex);
Peter Hurley6a1c0682013-06-15 09:14:23 -04003118 init_rwsem(&tty->termios_rwsem);
Peter Hurleydee4a0b2013-07-24 16:43:51 -04003119 mutex_init(&tty->winsize_mutex);
Peter Hurley36697522013-06-15 07:04:48 -04003120 init_ldsem(&tty->ldisc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121 init_waitqueue_head(&tty->write_wait);
3122 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003123 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003124 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07003125 spin_lock_init(&tty->ctrl_lock);
Peter Hurleyf9e053d2014-09-10 15:06:31 -04003126 spin_lock_init(&tty->flow_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003128 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01003129
3130 tty->driver = driver;
3131 tty->ops = driver->ops;
3132 tty->index = idx;
3133 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003134 tty->dev = tty_get_device(tty);
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003135
3136 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003137}
3138
Alan Coxf34d7a52008-04-30 00:54:13 -07003139/**
Jiri Slaby67166712011-03-23 10:48:35 +01003140 * deinitialize_tty_struct
3141 * @tty: tty to deinitialize
3142 *
3143 * This subroutine deinitializes a tty structure that has been newly
3144 * allocated but tty_release cannot be called on that yet.
3145 *
3146 * Locking: none - tty in question must not be exposed at this point
3147 */
3148void deinitialize_tty_struct(struct tty_struct *tty)
3149{
3150 tty_ldisc_deinit(tty);
3151}
3152
3153/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003154 * tty_put_char - write one character to a tty
3155 * @tty: tty
3156 * @ch: character
3157 *
3158 * Write one byte to the tty using the provided put_char method
3159 * if present. Returns the number of characters successfully output.
3160 *
3161 * Note: the specific put_char operation in the driver layer may go
3162 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003164
Alan Coxf34d7a52008-04-30 00:54:13 -07003165int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166{
Alan Coxf34d7a52008-04-30 00:54:13 -07003167 if (tty->ops->put_char)
3168 return tty->ops->put_char(tty, ch);
3169 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170}
Alan Coxf34d7a52008-04-30 00:54:13 -07003171EXPORT_SYMBOL_GPL(tty_put_char);
3172
Alan Coxd81ed102008-10-13 10:41:42 +01003173struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003175static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3176 unsigned int index, unsigned int count)
3177{
Leon Yuc1a752b2015-09-07 13:08:37 +00003178 int err;
3179
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003180 /* init here, since reused cdevs cause crashes */
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003181 driver->cdevs[index] = cdev_alloc();
3182 if (!driver->cdevs[index])
3183 return -ENOMEM;
Leon Yuc1a752b2015-09-07 13:08:37 +00003184 driver->cdevs[index]->ops = &tty_fops;
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003185 driver->cdevs[index]->owner = driver->owner;
Leon Yuc1a752b2015-09-07 13:08:37 +00003186 err = cdev_add(driver->cdevs[index], dev, count);
3187 if (err)
3188 kobject_put(&driver->cdevs[index]->kobj);
3189 return err;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003190}
3191
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003193 * tty_register_device - register a tty device
3194 * @driver: the tty driver that describes the tty device
3195 * @index: the index in the tty driver for this tty device
3196 * @device: a struct device that is associated with this tty device.
3197 * This field is optional, if there is no known struct device
3198 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003200 * Returns a pointer to the struct device for this tty device
3201 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003202 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003203 * This call is required to be made to register an individual tty device
3204 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3205 * that bit is not set, this function should not be called by a tty
3206 * driver.
3207 *
3208 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003209 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003210
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003211struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3212 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003214 return tty_register_device_attr(driver, index, device, NULL, NULL);
3215}
3216EXPORT_SYMBOL(tty_register_device);
3217
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003218static void tty_device_create_release(struct device *dev)
3219{
Peter Hurley83db1df2015-11-08 13:01:21 -05003220 dev_dbg(dev, "releasing...\n");
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003221 kfree(dev);
3222}
3223
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003224/**
3225 * tty_register_device_attr - register a tty device
3226 * @driver: the tty driver that describes the tty device
3227 * @index: the index in the tty driver for this tty device
3228 * @device: a struct device that is associated with this tty device.
3229 * This field is optional, if there is no known struct device
3230 * for this tty device it can be set to NULL safely.
3231 * @drvdata: Driver data to be set to device.
3232 * @attr_grp: Attribute group to be set on device.
3233 *
3234 * Returns a pointer to the struct device for this tty device
3235 * (or ERR_PTR(-EFOO) on error).
3236 *
3237 * This call is required to be made to register an individual tty device
3238 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3239 * that bit is not set, this function should not be called by a tty
3240 * driver.
3241 *
3242 * Locking: ??
3243 */
3244struct device *tty_register_device_attr(struct tty_driver *driver,
3245 unsigned index, struct device *device,
3246 void *drvdata,
3247 const struct attribute_group **attr_grp)
3248{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003250 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3251 struct device *dev = NULL;
3252 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003253 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
3255 if (index >= driver->num) {
Peter Hurley656fb862015-11-08 13:01:15 -05003256 pr_err("%s: Attempt to register invalid tty line number (%d)\n",
3257 driver->name, index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003258 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 }
3260
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 if (driver->type == TTY_DRIVER_TYPE_PTY)
3262 pty_line_name(driver, index, name);
3263 else
3264 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003265
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003266 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003267 retval = tty_cdev_add(driver, devt, index, 1);
3268 if (retval)
3269 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003270 cdev = true;
3271 }
3272
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003273 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3274 if (!dev) {
3275 retval = -ENOMEM;
3276 goto error;
3277 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003278
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003279 dev->devt = devt;
3280 dev->class = tty_class;
3281 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003282 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003283 dev_set_name(dev, "%s", name);
3284 dev->groups = attr_grp;
3285 dev_set_drvdata(dev, drvdata);
3286
3287 retval = device_register(dev);
3288 if (retval)
3289 goto error;
3290
3291 return dev;
3292
3293error:
3294 put_device(dev);
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003295 if (cdev) {
3296 cdev_del(driver->cdevs[index]);
3297 driver->cdevs[index] = NULL;
3298 }
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003299 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003301EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302
3303/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003304 * tty_unregister_device - unregister a tty device
3305 * @driver: the tty driver that describes the tty device
3306 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003308 * If a tty device is registered with a call to tty_register_device() then
3309 * this function must be called when the tty device is gone.
3310 *
3311 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003312 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003313
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314void tty_unregister_device(struct tty_driver *driver, unsigned index)
3315{
Alan Cox37bdfb02008-02-08 04:18:47 -08003316 device_destroy(tty_class,
3317 MKDEV(driver->major, driver->minor_start) + index);
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003318 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3319 cdev_del(driver->cdevs[index]);
3320 driver->cdevs[index] = NULL;
3321 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003322}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323EXPORT_SYMBOL(tty_unregister_device);
3324
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003325/**
3326 * __tty_alloc_driver -- allocate tty driver
3327 * @lines: count of lines this driver can handle at most
3328 * @owner: module which is repsonsible for this driver
3329 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3330 *
3331 * This should not be called directly, some of the provided macros should be
3332 * used instead. Use IS_ERR and friends on @retval.
3333 */
3334struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3335 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336{
3337 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003338 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003339 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003340
Jiri Slaby0019b402012-08-08 22:26:43 +02003341 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003342 return ERR_PTR(-EINVAL);
3343
Jean Delvare506eb992007-07-15 23:40:14 -07003344 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003345 if (!driver)
3346 return ERR_PTR(-ENOMEM);
3347
3348 kref_init(&driver->kref);
3349 driver->magic = TTY_DRIVER_MAGIC;
3350 driver->num = lines;
3351 driver->owner = owner;
3352 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003353
3354 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3355 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3356 GFP_KERNEL);
3357 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3358 GFP_KERNEL);
3359 if (!driver->ttys || !driver->termios) {
3360 err = -ENOMEM;
3361 goto err_free_all;
3362 }
3363 }
3364
3365 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3366 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3367 GFP_KERNEL);
3368 if (!driver->ports) {
3369 err = -ENOMEM;
3370 goto err_free_all;
3371 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003372 cdevs = lines;
3373 }
3374
3375 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3376 if (!driver->cdevs) {
3377 err = -ENOMEM;
3378 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003379 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003380
Linus Torvalds1da177e2005-04-16 15:20:36 -07003381 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003382err_free_all:
3383 kfree(driver->ports);
3384 kfree(driver->ttys);
3385 kfree(driver->termios);
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003386 kfree(driver->cdevs);
Jiri Slaby16a02082012-08-08 22:26:42 +02003387 kfree(driver);
3388 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003389}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003390EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003391
Alan Cox7d7b93c2008-10-13 10:42:09 +01003392static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003394 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3395 int i;
3396 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003397
3398 if (driver->flags & TTY_DRIVER_INSTALLED) {
3399 /*
3400 * Free the termios and termios_locked structures because
3401 * we don't want to get memory leaks when modular tty
3402 * drivers are removed from the kernel.
3403 */
3404 for (i = 0; i < driver->num; i++) {
3405 tp = driver->termios[i];
3406 if (tp) {
3407 driver->termios[i] = NULL;
3408 kfree(tp);
3409 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003410 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3411 tty_unregister_device(driver, i);
3412 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003413 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003414 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003415 cdev_del(driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003416 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003417 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003418 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003419 kfree(driver->termios);
3420 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421 kfree(driver);
3422}
3423
Alan Cox7d7b93c2008-10-13 10:42:09 +01003424void tty_driver_kref_put(struct tty_driver *driver)
3425{
3426 kref_put(&driver->kref, destruct_tty_driver);
3427}
3428EXPORT_SYMBOL(tty_driver_kref_put);
3429
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003430void tty_set_operations(struct tty_driver *driver,
3431 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003432{
Alan Coxf34d7a52008-04-30 00:54:13 -07003433 driver->ops = op;
3434};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435EXPORT_SYMBOL(tty_set_operations);
3436
Alan Cox7d7b93c2008-10-13 10:42:09 +01003437void put_tty_driver(struct tty_driver *d)
3438{
3439 tty_driver_kref_put(d);
3440}
3441EXPORT_SYMBOL(put_tty_driver);
3442
Linus Torvalds1da177e2005-04-16 15:20:36 -07003443/*
3444 * Called by a tty driver to register itself.
3445 */
3446int tty_register_driver(struct tty_driver *driver)
3447{
3448 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003449 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003451 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003454 error = alloc_chrdev_region(&dev, driver->minor_start,
3455 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456 if (!error) {
3457 driver->major = MAJOR(dev);
3458 driver->minor_start = MINOR(dev);
3459 }
3460 } else {
3461 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003462 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003464 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003465 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003467 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3468 error = tty_cdev_add(driver, dev, 0, driver->num);
3469 if (error)
3470 goto err_unreg_char;
3471 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003472
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003473 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003475 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003476
3477 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003478 for (i = 0; i < driver->num; i++) {
3479 d = tty_register_device(driver, i, NULL);
3480 if (IS_ERR(d)) {
3481 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003482 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003483 }
3484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 }
3486 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003487 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003488 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003489
Jiri Slaby16a02082012-08-08 22:26:42 +02003490err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003491 for (i--; i >= 0; i--)
3492 tty_unregister_device(driver, i);
3493
3494 mutex_lock(&tty_mutex);
3495 list_del(&driver->tty_drivers);
3496 mutex_unlock(&tty_mutex);
3497
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003498err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003499 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003500err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003501 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503EXPORT_SYMBOL(tty_register_driver);
3504
3505/*
3506 * Called by a tty driver to unregister itself.
3507 */
3508int tty_unregister_driver(struct tty_driver *driver)
3509{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003510#if 0
3511 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 if (driver->refcount)
3513 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003514#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3516 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003517 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003519 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520 return 0;
3521}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003522
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523EXPORT_SYMBOL(tty_unregister_driver);
3524
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003525dev_t tty_devnum(struct tty_struct *tty)
3526{
3527 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3528}
3529EXPORT_SYMBOL(tty_devnum);
3530
Alan Coxd81ed102008-10-13 10:41:42 +01003531void tty_default_fops(struct file_operations *fops)
3532{
3533 *fops = tty_fops;
3534}
3535
Linus Torvalds1da177e2005-04-16 15:20:36 -07003536/*
3537 * Initialize the console device. This is called *early*, so
3538 * we can't necessarily depend on lots of kernel help here.
3539 * Just do some early initializations, and do the complex setup
3540 * later.
3541 */
3542void __init console_init(void)
3543{
3544 initcall_t *call;
3545
3546 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003547 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548
3549 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003550 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 * inform about problems etc..
3552 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553 call = __con_initcall_start;
3554 while (call < __con_initcall_end) {
3555 (*call)();
3556 call++;
3557 }
3558}
3559
Al Viro2c9ede52011-07-23 20:24:48 -04003560static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003561{
3562 if (!mode)
3563 return NULL;
3564 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3565 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3566 *mode = 0666;
3567 return NULL;
3568}
3569
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570static int __init tty_class_init(void)
3571{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003572 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 if (IS_ERR(tty_class))
3574 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003575 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003576 return 0;
3577}
3578
3579postcore_initcall(tty_class_init);
3580
3581/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583
Kay Sieversfbc92a32010-12-01 18:51:05 +01003584static ssize_t show_cons_active(struct device *dev,
3585 struct device_attribute *attr, char *buf)
3586{
3587 struct console *cs[16];
3588 int i = 0;
3589 struct console *c;
3590 ssize_t count = 0;
3591
Torben Hohnac751ef2011-01-25 15:07:35 -08003592 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003593 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003594 if (!c->device)
3595 continue;
3596 if (!c->write)
3597 continue;
3598 if ((c->flags & CON_ENABLED) == 0)
3599 continue;
3600 cs[i++] = c;
3601 if (i >= ARRAY_SIZE(cs))
3602 break;
3603 }
Hannes Reinecke723abd82014-02-27 12:30:51 +01003604 while (i--) {
3605 int index = cs[i]->index;
3606 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3607
3608 /* don't resolve tty0 as some programs depend on it */
3609 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3610 count += tty_line_name(drv, index, buf + count);
3611 else
3612 count += sprintf(buf + count, "%s%d",
3613 cs[i]->name, cs[i]->index);
3614
3615 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3616 }
Torben Hohnac751ef2011-01-25 15:07:35 -08003617 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003618
3619 return count;
3620}
3621static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3622
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003623static struct attribute *cons_dev_attrs[] = {
3624 &dev_attr_active.attr,
3625 NULL
3626};
3627
3628ATTRIBUTE_GROUPS(cons_dev);
3629
Kay Sieversfbc92a32010-12-01 18:51:05 +01003630static struct device *consdev;
3631
3632void console_sysfs_notify(void)
3633{
3634 if (consdev)
3635 sysfs_notify(&consdev->kobj, NULL, "active");
3636}
3637
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638/*
3639 * Ok, now we can initialize the rest of the tty devices and can count
3640 * on memory allocations, interrupts etc..
3641 */
David Howells31d1d482010-08-06 16:34:43 +01003642int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003643{
3644 cdev_init(&tty_cdev, &tty_fops);
3645 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3646 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3647 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003648 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003649
3650 cdev_init(&console_cdev, &console_fops);
3651 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3652 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3653 panic("Couldn't register /dev/console driver\n");
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003654 consdev = device_create_with_groups(tty_class, NULL,
3655 MKDEV(TTYAUX_MAJOR, 1), NULL,
3656 cons_dev_groups, "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003657 if (IS_ERR(consdev))
3658 consdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003659
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003661 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003662#endif
3663 return 0;
3664}
David Howells31d1d482010-08-06 16:34:43 +01003665