blob: 6bdfb98bf020e70a3b8464550dc06326a18a2103 [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 Zerpies5a3c6b22011-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
109
110#define TTY_PARANOIA_CHECK 1
111#define CHECK_TTY_COUNT 1
112
Alan Coxedc6afc2006-12-08 02:38:44 -0800113struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 .c_iflag = ICRNL | IXON,
115 .c_oflag = OPOST | ONLCR,
116 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
117 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
118 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800119 .c_cc = INIT_C_CC,
120 .c_ispeed = 38400,
121 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122};
123
124EXPORT_SYMBOL(tty_std_termios);
125
126/* This list gets poked at by procfs and various bits of boot up code. This
127 could do with some rationalisation such as pulling the tty proc function
128 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130LIST_HEAD(tty_drivers); /* linked list of tty drivers */
131
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800132/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800134DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700135EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Nick Pigginee2ffa02010-08-18 04:37:35 +1000137/* Spinlock to protect the tty->tty_files list */
138DEFINE_SPINLOCK(tty_files_lock);
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
141static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800142ssize_t redirected_tty_write(struct file *, const char __user *,
143 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static unsigned int tty_poll(struct file *, poll_table *);
145static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700146long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700147#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800148static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700149 unsigned long arg);
150#else
151#define tty_compat_ioctl NULL
152#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200153static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800154static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800155static void release_tty(struct tty_struct *tty, int idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Alan Coxaf9b8972006-08-27 01:24:01 -0700157/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700158 * free_tty_struct - free a disused tty
159 * @tty: tty struct to free
160 *
161 * Free the write buffers, tty queue and tty memory itself.
162 *
163 * Locking: none. Must be called after tty is definitely unused
164 */
165
Alan Coxbf970ee2008-10-13 10:42:39 +0100166void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Dan Carpenterdc6802a2012-07-24 12:52:04 +0100168 if (!tty)
169 return;
Markus Elfringa211b1a2014-11-21 13:42:29 +0100170 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 kfree(tty->write_buf);
Alan Cox89c8d912012-08-08 16:30:13 +0100172 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 kfree(tty);
174}
175
Nick Piggind996b622010-08-18 04:37:36 +1000176static inline struct tty_struct *file_tty(struct file *file)
177{
178 return ((struct tty_file_private *)file->private_data)->tty;
179}
180
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200181int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000182{
183 struct tty_file_private *priv;
184
Pekka Enbergf573bd12010-08-24 07:48:34 +0300185 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
186 if (!priv)
187 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000188
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200189 file->private_data = priv;
190
191 return 0;
192}
193
194/* Associate a new file with the tty structure */
195void tty_add_file(struct tty_struct *tty, struct file *file)
196{
197 struct tty_file_private *priv = file->private_data;
198
Nick Piggind996b622010-08-18 04:37:36 +1000199 priv->tty = tty;
200 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000201
202 spin_lock(&tty_files_lock);
203 list_add(&priv->list, &tty->tty_files);
204 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200205}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300206
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200207/**
208 * tty_free_file - free file->private_data
209 *
210 * This shall be used only for fail path handling when tty_add_file was not
211 * called yet.
212 */
213void tty_free_file(struct file *file)
214{
215 struct tty_file_private *priv = file->private_data;
216
217 file->private_data = NULL;
218 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000219}
220
221/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800222static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000223{
224 struct tty_file_private *priv = file->private_data;
225
226 spin_lock(&tty_files_lock);
227 list_del(&priv->list);
228 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200229 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000230}
231
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
234
Alan Coxaf9b8972006-08-27 01:24:01 -0700235/**
236 * tty_name - return tty naming
237 * @tty: tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -0700238 *
239 * Convert a tty structure into a name. The name reflects the kernel
240 * naming policy and if udev is in use may not reflect user space
241 *
242 * Locking: none
243 */
244
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200245const char *tty_name(const struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246{
247 if (!tty) /* Hmm. NULL pointer. That's fun. */
Rasmus Villemoes917162c2015-03-31 15:55:58 +0200248 return "NULL tty";
249 return tty->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
252EXPORT_SYMBOL(tty_name);
253
Andrew Mortond769a662005-05-05 16:15:50 -0700254int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 const char *routine)
256{
257#ifdef TTY_PARANOIA_CHECK
258 if (!tty) {
259 printk(KERN_WARNING
260 "null TTY for (%d:%d) in %s\n",
261 imajor(inode), iminor(inode), routine);
262 return 1;
263 }
264 if (tty->magic != TTY_MAGIC) {
265 printk(KERN_WARNING
266 "bad magic number for tty struct (%d:%d) in %s\n",
267 imajor(inode), iminor(inode), routine);
268 return 1;
269 }
270#endif
271 return 0;
272}
273
Peter Hurleydeb287e2014-11-05 12:12:55 -0500274/* Caller must hold tty_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275static int check_tty_count(struct tty_struct *tty, const char *routine)
276{
277#ifdef CHECK_TTY_COUNT
278 struct list_head *p;
279 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800280
Nick Pigginee2ffa02010-08-18 04:37:35 +1000281 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 list_for_each(p, &tty->tty_files) {
283 count++;
284 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000285 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
287 tty->driver->subtype == PTY_TYPE_SLAVE &&
288 tty->link && tty->link->count)
289 count++;
290 if (tty->count != count) {
291 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
292 "!= #fd's(%d) in %s\n",
293 tty->name, tty->count, count, routine);
294 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296#endif
297 return 0;
298}
299
Alan Coxaf9b8972006-08-27 01:24:01 -0700300/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700301 * get_tty_driver - find device of a tty
302 * @dev_t: device identifier
303 * @index: returns the index of the tty
304 *
305 * This routine returns a tty driver structure, given a device number
306 * and also passes back the index number.
307 *
308 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311static struct tty_driver *get_tty_driver(dev_t device, int *index)
312{
313 struct tty_driver *p;
314
315 list_for_each_entry(p, &tty_drivers, tty_drivers) {
316 dev_t base = MKDEV(p->major, p->minor_start);
317 if (device < base || device >= base + p->num)
318 continue;
319 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100320 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 }
322 return NULL;
323}
324
Jason Wesself2d937f2008-04-17 20:05:37 +0200325#ifdef CONFIG_CONSOLE_POLL
326
327/**
328 * tty_find_polling_driver - find device of a polled tty
329 * @name: name string to match
330 * @line: pointer to resulting tty line nr
331 *
332 * This routine returns a tty driver structure, given a name
333 * and the condition that the tty driver is capable of polled
334 * operation.
335 */
336struct tty_driver *tty_find_polling_driver(char *name, int *line)
337{
338 struct tty_driver *p, *res = NULL;
339 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500340 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100341 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200342
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500343 for (str = name; *str; str++)
344 if ((*str >= '0' && *str <= '9') || *str == ',')
345 break;
346 if (!*str)
347 return NULL;
348
349 len = str - name;
350 tty_line = simple_strtoul(str, &str, 10);
351
Jason Wesself2d937f2008-04-17 20:05:37 +0200352 mutex_lock(&tty_mutex);
353 /* Search through the tty devices to look for a match */
354 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500355 if (strncmp(name, p->name, len) != 0)
356 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100357 stp = str;
358 if (*stp == ',')
359 stp++;
360 if (*stp == '\0')
361 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200362
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200363 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100364 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100365 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200366 *line = tty_line;
367 break;
368 }
369 }
370 mutex_unlock(&tty_mutex);
371
372 return res;
373}
374EXPORT_SYMBOL_GPL(tty_find_polling_driver);
375#endif
376
Alan Coxaf9b8972006-08-27 01:24:01 -0700377/**
378 * tty_check_change - check for POSIX terminal changes
379 * @tty: tty to check
380 *
381 * If we try to write to, or set the state of, a terminal and we're
382 * not in the foreground, send a SIGTTOU. If the signal is blocked or
383 * ignored, go ahead and perform the operation. (POSIX 7.2)
384 *
Alan Cox978e5952008-04-30 00:53:59 -0700385 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700387
Alan Cox37bdfb02008-02-08 04:18:47 -0800388int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389{
Alan Cox47f86832008-04-30 00:53:30 -0700390 unsigned long flags;
Patrick Donnelly67196932015-07-12 18:51:52 -0400391 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -0700392 int ret = 0;
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 if (current->signal->tty != tty)
395 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700396
Patrick Donnelly67196932015-07-12 18:51:52 -0400397 rcu_read_lock();
398 pgrp = task_pgrp(current);
399
Alan Cox47f86832008-04-30 00:53:30 -0700400 spin_lock_irqsave(&tty->ctrl_lock, flags);
401
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800402 if (!tty->pgrp) {
403 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700404 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 }
Patrick Donnelly67196932015-07-12 18:51:52 -0400406 if (pgrp == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700407 goto out_unlock;
408 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Patrick Donnelly67196932015-07-12 18:51:52 -0400409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 if (is_ignored(SIGTTOU))
Patrick Donnelly67196932015-07-12 18:51:52 -0400411 goto out_rcuunlock;
Alan Cox47f86832008-04-30 00:53:30 -0700412 if (is_current_pgrp_orphaned()) {
413 ret = -EIO;
Patrick Donnelly67196932015-07-12 18:51:52 -0400414 goto out_rcuunlock;
Alan Cox47f86832008-04-30 00:53:30 -0700415 }
Patrick Donnelly67196932015-07-12 18:51:52 -0400416 kill_pgrp(pgrp, SIGTTOU, 1);
417 rcu_read_unlock();
Oleg Nesterov040b6362007-06-01 00:46:53 -0700418 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700419 ret = -ERESTARTSYS;
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700420 return ret;
421out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700422 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Patrick Donnelly67196932015-07-12 18:51:52 -0400423out_rcuunlock:
424 rcu_read_unlock();
Alan Cox47f86832008-04-30 00:53:30 -0700425 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426}
427
428EXPORT_SYMBOL(tty_check_change);
429
Alan Cox37bdfb02008-02-08 04:18:47 -0800430static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 size_t count, loff_t *ppos)
432{
433 return 0;
434}
435
Alan Cox37bdfb02008-02-08 04:18:47 -0800436static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 size_t count, loff_t *ppos)
438{
439 return -EIO;
440}
441
442/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800443static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
445 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
446}
447
Alan Cox04f378b2008-04-30 00:53:29 -0700448static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
449 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700450{
451 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
452}
453
Alan Cox37bdfb02008-02-08 04:18:47 -0800454static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700455 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
458}
459
Arjan van de Ven62322d22006-07-03 00:24:21 -0700460static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 .llseek = no_llseek,
462 .read = tty_read,
463 .write = tty_write,
464 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700465 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700466 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 .open = tty_open,
468 .release = tty_release,
469 .fasync = tty_fasync,
470};
471
Arjan van de Ven62322d22006-07-03 00:24:21 -0700472static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 .llseek = no_llseek,
474 .read = tty_read,
475 .write = redirected_tty_write,
476 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700477 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700478 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 .open = tty_open,
480 .release = tty_release,
481 .fasync = tty_fasync,
482};
483
Arjan van de Ven62322d22006-07-03 00:24:21 -0700484static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 .llseek = no_llseek,
486 .read = hung_up_tty_read,
487 .write = hung_up_tty_write,
488 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700489 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700490 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 .release = tty_release,
492};
493
494static DEFINE_SPINLOCK(redirect_lock);
495static struct file *redirect;
496
Peter Hurley11d9bef2014-10-16 14:59:42 -0400497
498void proc_clear_tty(struct task_struct *p)
499{
500 unsigned long flags;
501 struct tty_struct *tty;
502 spin_lock_irqsave(&p->sighand->siglock, flags);
503 tty = p->signal->tty;
504 p->signal->tty = NULL;
505 spin_unlock_irqrestore(&p->sighand->siglock, flags);
506 tty_kref_put(tty);
507}
508
Peter Hurley2c411c12014-10-16 14:59:47 -0400509/**
510 * proc_set_tty - set the controlling terminal
511 *
512 * Only callable by the session leader and only if it does not already have
513 * a controlling terminal.
514 *
Peter Hurleye218eb32014-10-16 14:59:49 -0400515 * Caller must hold: tty_lock()
516 * a readlock on tasklist_lock
Peter Hurley2c411c12014-10-16 14:59:47 -0400517 * sighand lock
518 */
Peter Hurleybce65f12014-10-16 14:59:43 -0400519static void __proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400520{
Peter Hurleyae28fa72014-10-16 14:59:46 -0400521 unsigned long flags;
522
Peter Hurleyae28fa72014-10-16 14:59:46 -0400523 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya3618582014-10-16 14:59:50 -0400524 /*
525 * The session and fg pgrp references will be non-NULL if
526 * tiocsctty() is stealing the controlling tty
527 */
Peter Hurleyae28fa72014-10-16 14:59:46 -0400528 put_pid(tty->session);
529 put_pid(tty->pgrp);
530 tty->pgrp = get_pid(task_pgrp(current));
531 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
532 tty->session = get_pid(task_session(current));
533 if (current->signal->tty) {
534 printk(KERN_DEBUG "tty not NULL!!\n");
535 tty_kref_put(current->signal->tty);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400536 }
Peter Hurleybce65f12014-10-16 14:59:43 -0400537 put_pid(current->signal->tty_old_pgrp);
538 current->signal->tty = tty_kref_get(tty);
539 current->signal->tty_old_pgrp = NULL;
Peter Hurley11d9bef2014-10-16 14:59:42 -0400540}
541
Peter Hurleybce65f12014-10-16 14:59:43 -0400542static void proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400543{
Peter Hurleybce65f12014-10-16 14:59:43 -0400544 spin_lock_irq(&current->sighand->siglock);
545 __proc_set_tty(tty);
546 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400547}
548
549struct tty_struct *get_current_tty(void)
550{
551 struct tty_struct *tty;
552 unsigned long flags;
553
554 spin_lock_irqsave(&current->sighand->siglock, flags);
555 tty = tty_kref_get(current->signal->tty);
556 spin_unlock_irqrestore(&current->sighand->siglock, flags);
557 return tty;
558}
559EXPORT_SYMBOL_GPL(get_current_tty);
560
561static void session_clear_tty(struct pid *session)
562{
563 struct task_struct *p;
564 do_each_pid_task(session, PIDTYPE_SID, p) {
565 proc_clear_tty(p);
566 } while_each_pid_task(session, PIDTYPE_SID, p);
567}
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/**
570 * tty_wakeup - request more data
571 * @tty: terminal
572 *
573 * Internal and external helper for wakeups of tty. This function
574 * informs the line discipline if present that the driver is ready
575 * to receive more output data.
576 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578void tty_wakeup(struct tty_struct *tty)
579{
580 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
583 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800584 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100585 if (ld->ops->write_wakeup)
586 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 tty_ldisc_deref(ld);
588 }
589 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700590 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
593EXPORT_SYMBOL_GPL(tty_wakeup);
594
595/**
Peter Hurleyea648a42013-03-06 07:20:53 -0500596 * tty_signal_session_leader - sends SIGHUP to session leader
Peter Hurleyf91e2592013-03-06 07:20:56 -0500597 * @tty controlling tty
598 * @exit_session if non-zero, signal all foreground group processes
Peter Hurleyea648a42013-03-06 07:20:53 -0500599 *
Peter Hurleyf91e2592013-03-06 07:20:56 -0500600 * Send SIGHUP and SIGCONT to the session leader and its process group.
601 * Optionally, signal all processes in the foreground process group.
Peter Hurleyea648a42013-03-06 07:20:53 -0500602 *
603 * Returns the number of processes in the session with this tty
604 * as their controlling terminal. This value is used to drop
605 * tty references for those processes.
606 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500607static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
Peter Hurleyea648a42013-03-06 07:20:53 -0500608{
609 struct task_struct *p;
Peter Hurleyea648a42013-03-06 07:20:53 -0500610 int refs = 0;
Peter Hurleyf91e2592013-03-06 07:20:56 -0500611 struct pid *tty_pgrp = NULL;
Peter Hurleyea648a42013-03-06 07:20:53 -0500612
613 read_lock(&tasklist_lock);
614 if (tty->session) {
615 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
616 spin_lock_irq(&p->sighand->siglock);
617 if (p->signal->tty == tty) {
618 p->signal->tty = NULL;
619 /* We defer the dereferences outside fo
620 the tasklist lock */
621 refs++;
622 }
623 if (!p->signal->leader) {
624 spin_unlock_irq(&p->sighand->siglock);
625 continue;
626 }
627 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
628 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
629 put_pid(p->signal->tty_old_pgrp); /* A noop */
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500630 spin_lock(&tty->ctrl_lock);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500631 tty_pgrp = get_pid(tty->pgrp);
Peter Hurleyea648a42013-03-06 07:20:53 -0500632 if (tty->pgrp)
633 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500634 spin_unlock(&tty->ctrl_lock);
Peter Hurleyea648a42013-03-06 07:20:53 -0500635 spin_unlock_irq(&p->sighand->siglock);
636 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
637 }
638 read_unlock(&tasklist_lock);
639
Peter Hurleyf91e2592013-03-06 07:20:56 -0500640 if (tty_pgrp) {
641 if (exit_session)
642 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
643 put_pid(tty_pgrp);
644 }
645
Peter Hurleyea648a42013-03-06 07:20:53 -0500646 return refs;
647}
648
649/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200650 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000651 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700652 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800653 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700654 * synchronous but doesn't hold any locks, so we need to make sure we
655 * have the appropriate locks for what we're doing.
656 *
657 * The hangup event clears any pending redirections onto the hung up
658 * device. It ensures future writes will error and it does the needed
659 * line discipline hangup and signal delivery. The tty object itself
660 * remains intact.
661 *
662 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200663 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800664 * redirect lock for undoing redirection
665 * file list lock for manipulating list of ttys
Peter Hurley137084b2013-06-15 07:04:46 -0400666 * tty_ldiscs_lock from called functions
Peter Hurley6a1c0682013-06-15 09:14:23 -0400667 * termios_rwsem resetting termios data
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800668 * tasklist_lock to walk task list for hangup event
669 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500671static void __tty_hangup(struct tty_struct *tty, int exit_session)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672{
Alan Cox37bdfb02008-02-08 04:18:47 -0800673 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 struct file *filp, *f = NULL;
Nick Piggind996b622010-08-18 04:37:36 +1000675 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 int closecount = 0, n;
Peter Hurleyea648a42013-03-06 07:20:53 -0500677 int refs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679 if (!tty)
680 return;
681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
683 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000684 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 f = redirect;
686 redirect = NULL;
687 }
688 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800689
Alan Cox89c8d912012-08-08 16:30:13 +0100690 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200691
Peter Hurleycb50e522013-07-31 14:05:45 -0400692 if (test_bit(TTY_HUPPED, &tty->flags)) {
693 tty_unlock(tty);
694 return;
695 }
696
Arnd Bergmannec79d602010-06-01 22:53:01 +0200697 /* inuse_filps is protected by the single tty lock,
698 this really needs to change if we want to flush the
699 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200700 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000701
Nick Pigginee2ffa02010-08-18 04:37:35 +1000702 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000704 list_for_each_entry(priv, &tty->tty_files, list) {
705 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 if (filp->f_op->write == redirected_tty_write)
707 cons_filp = filp;
708 if (filp->f_op->write != tty_write)
709 continue;
710 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200711 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 filp->f_op = &hung_up_tty_fops;
713 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000714 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800715
Peter Hurley25fdf242013-03-06 07:20:57 -0500716 refs = tty_signal_session_leader(tty, exit_session);
717 /* Account for the p->signal references we killed */
718 while (refs--)
719 tty_kref_put(tty);
720
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800722
Peter Hurley20cc2252013-03-06 07:20:54 -0500723 spin_lock_irq(&tty->ctrl_lock);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100724 clear_bit(TTY_THROTTLED, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100725 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600726 put_pid(tty->session);
727 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800728 tty->session = NULL;
729 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 tty->ctrl_status = 0;
Peter Hurley20cc2252013-03-06 07:20:54 -0500731 spin_unlock_irq(&tty->ctrl_lock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800734 * If one of the devices matches a console pointer, we
735 * cannot just call hangup() because that will cause
736 * tty->count and state->count to go out of sync.
737 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 */
739 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700740 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700742 tty->ops->close(tty, cons_filp);
743 } else if (tty->ops->hangup)
Peter Hurley7c6d3402014-06-16 09:17:08 -0400744 tty->ops->hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800745 /*
746 * We don't want to have driver/ldisc interactions beyond
747 * the ones we did here. The driver layer expects no
748 * calls after ->hangup() from the ldisc side. However we
749 * can't yet guarantee all that.
750 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 set_bit(TTY_HUPPED, &tty->flags);
Alan Cox89c8d912012-08-08 16:30:13 +0100752 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200753
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 if (f)
755 fput(f);
756}
757
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200758static void do_tty_hangup(struct work_struct *work)
759{
760 struct tty_struct *tty =
761 container_of(work, struct tty_struct, hangup_work);
762
Peter Hurleyf91e2592013-03-06 07:20:56 -0500763 __tty_hangup(tty, 0);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200764}
765
Alan Coxaf9b8972006-08-27 01:24:01 -0700766/**
767 * tty_hangup - trigger a hangup event
768 * @tty: tty to hangup
769 *
770 * A carrier loss (virtual or otherwise) has occurred on this like
771 * schedule a hangup sequence to run after this event.
772 */
773
Alan Cox37bdfb02008-02-08 04:18:47 -0800774void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775{
776#ifdef TTY_DEBUG_HANGUP
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200777 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778#endif
779 schedule_work(&tty->hangup_work);
780}
781
782EXPORT_SYMBOL(tty_hangup);
783
Alan Coxaf9b8972006-08-27 01:24:01 -0700784/**
785 * tty_vhangup - process vhangup
786 * @tty: tty to hangup
787 *
788 * The user has asked via system call for the terminal to be hung up.
789 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200790 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700791 */
792
Alan Cox37bdfb02008-02-08 04:18:47 -0800793void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
795#ifdef TTY_DEBUG_HANGUP
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200796 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797#endif
Peter Hurleyf91e2592013-03-06 07:20:56 -0500798 __tty_hangup(tty, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
Alan Cox37bdfb02008-02-08 04:18:47 -0800800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801EXPORT_SYMBOL(tty_vhangup);
802
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200803
Alan Coxaf9b8972006-08-27 01:24:01 -0700804/**
Alan Cox2cb59982008-10-13 10:40:30 +0100805 * tty_vhangup_self - process vhangup for own ctty
806 *
807 * Perform a vhangup on the current controlling tty
808 */
809
810void tty_vhangup_self(void)
811{
812 struct tty_struct *tty;
813
Alan Cox2cb59982008-10-13 10:40:30 +0100814 tty = get_current_tty();
815 if (tty) {
816 tty_vhangup(tty);
817 tty_kref_put(tty);
818 }
Alan Cox2cb59982008-10-13 10:40:30 +0100819}
820
821/**
Peter Hurleyf91e2592013-03-06 07:20:56 -0500822 * tty_vhangup_session - hangup session leader exit
823 * @tty: tty to hangup
824 *
825 * The session leader is exiting and hanging up its controlling terminal.
826 * Every process in the foreground process group is signalled SIGHUP.
827 *
828 * We do this synchronously so that when the syscall returns the process
829 * is complete. That guarantee is necessary for security reasons.
830 */
831
Changlong Xie44a459f2013-03-20 08:42:04 +0800832static void tty_vhangup_session(struct tty_struct *tty)
Peter Hurleyf91e2592013-03-06 07:20:56 -0500833{
834#ifdef TTY_DEBUG_HANGUP
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200835 printk(KERN_DEBUG "%s vhangup session...\n", tty_name(tty));
Peter Hurleyf91e2592013-03-06 07:20:56 -0500836#endif
837 __tty_hangup(tty, 1);
838}
839
840/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700841 * tty_hung_up_p - was tty hung up
842 * @filp: file pointer of tty
843 *
844 * Return true if the tty has been subject to a vhangup or a carrier
845 * loss
846 */
847
Alan Cox37bdfb02008-02-08 04:18:47 -0800848int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
850 return (filp->f_op == &hung_up_tty_fops);
851}
852
853EXPORT_SYMBOL(tty_hung_up_p);
854
Alan Coxaf9b8972006-08-27 01:24:01 -0700855/**
856 * disassociate_ctty - disconnect controlling tty
857 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700859 * This function is typically called only by the session leader, when
860 * it wants to disassociate itself from its controlling tty.
861 *
862 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
864 * (2) Clears the tty from being controlling the session
865 * (3) Clears the controlling tty for all processes in the
866 * session group.
867 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700868 * The argument on_exit is set to 1 if called when a process is
869 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
870 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800871 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200872 * BTM is taken for hysterical raisins, and held when
873 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800874 * tty_mutex is taken to protect tty
875 * ->siglock is taken to protect ->signal/->sighand
876 * tasklist_lock is taken to walk process list for sessions
877 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880void disassociate_ctty(int on_exit)
881{
882 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Alan Cox5ec93d12009-11-30 13:18:45 +0000884 if (!current->signal->leader)
885 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800887 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 if (tty) {
Peter Hurleyf91e2592013-03-06 07:20:56 -0500889 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
890 tty_vhangup_session(tty);
891 } else {
892 struct pid *tty_pgrp = tty_get_pgrp(tty);
893 if (tty_pgrp) {
894 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Oleg Nesterov03e12612013-09-15 17:50:26 +0200895 if (!on_exit)
896 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500897 put_pid(tty_pgrp);
898 }
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200899 }
Alan Cox452a00d2008-10-13 10:39:13 +0100900 tty_kref_put(tty);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500901
Eric W. Biederman680a9672007-02-12 00:52:52 -0800902 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800903 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800904 spin_lock_irq(&current->sighand->siglock);
905 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800906 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800907 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800908 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800909 kill_pgrp(old_pgrp, SIGHUP, on_exit);
910 kill_pgrp(old_pgrp, SIGCONT, on_exit);
911 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 return;
914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800916 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700917 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800918 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800919
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800920 tty = tty_kref_get(current->signal->tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800921 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700922 unsigned long flags;
923 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800924 put_pid(tty->session);
925 put_pid(tty->pgrp);
926 tty->session = NULL;
927 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700928 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100929 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800930 } else {
931#ifdef TTY_DEBUG_HANGUP
932 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
933 " = NULL", tty);
934#endif
935 }
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 Hurley04980702014-11-05 12:12:52 -05001205 if (tty->ops->write && tty->count > 0) {
Alan Cox89c8d912012-08-08 16:30:13 +01001206 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001207 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001208 } else
Alan Cox89c8d912012-08-08 16:30:13 +01001209 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001210 tty_write_unlock(tty);
1211 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001212 return;
1213}
1214
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
Alan Coxaf9b8972006-08-27 01:24:01 -07001216/**
1217 * tty_write - write method for tty device file
1218 * @file: tty file pointer
1219 * @buf: user data to write
1220 * @count: bytes to write
1221 * @ppos: unused
1222 *
1223 * Write data to a tty device via the line discipline.
1224 *
1225 * Locking:
1226 * Locks the line discipline as required
1227 * Writes to the tty driver are serialized by the atomic_write_lock
1228 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001229 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001230 */
1231
Alan Cox37bdfb02008-02-08 04:18:47 -08001232static ssize_t tty_write(struct file *file, const char __user *buf,
1233 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234{
Nick Piggind996b622010-08-18 04:37:36 +10001235 struct tty_struct *tty = file_tty(file);
1236 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001238
Al Viro6131ffa2013-02-27 16:59:05 -05001239 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001241 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001242 (test_bit(TTY_IO_ERROR, &tty->flags)))
1243 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001244 /* Short term debug to catch buggy drivers */
1245 if (tty->ops->write_room == NULL)
1246 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1247 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001248 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001249 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 ret = -EIO;
1251 else
Alan Coxa352def2008-07-16 21:53:12 +01001252 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 tty_ldisc_deref(ld);
1254 return ret;
1255}
1256
Alan Cox37bdfb02008-02-08 04:18:47 -08001257ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1258 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259{
1260 struct file *p = NULL;
1261
1262 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001263 if (redirect)
1264 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 spin_unlock(&redirect_lock);
1266
1267 if (p) {
1268 ssize_t res;
1269 res = vfs_write(p, buf, count, &p->f_pos);
1270 fput(p);
1271 return res;
1272 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 return tty_write(file, buf, count, ppos);
1274}
1275
Peter Hurley136d5252014-09-10 15:06:34 -04001276/**
1277 * tty_send_xchar - send priority character
1278 *
1279 * Send a high priority character to the tty even if stopped
1280 *
1281 * Locking: none for xchar method, write ordering for write method.
1282 */
1283
1284int tty_send_xchar(struct tty_struct *tty, char ch)
1285{
1286 int was_stopped = tty->stopped;
1287
1288 if (tty->ops->send_xchar) {
1289 tty->ops->send_xchar(tty, ch);
1290 return 0;
1291 }
1292
1293 if (tty_write_lock(tty, 0) < 0)
1294 return -ERESTARTSYS;
1295
1296 if (was_stopped)
1297 start_tty(tty);
1298 tty->ops->write(tty, &ch, 1);
1299 if (was_stopped)
1300 stop_tty(tty);
1301 tty_write_unlock(tty);
1302 return 0;
1303}
1304
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305static char ptychar[] = "pqrstuvwxyzabcde";
1306
Alan Coxaf9b8972006-08-27 01:24:01 -07001307/**
1308 * pty_line_name - generate name for a pty
1309 * @driver: the tty driver in use
1310 * @index: the minor number
1311 * @p: output buffer of at least 6 bytes
1312 *
1313 * Generate a name from a driver reference and write it to the output
1314 * buffer.
1315 *
1316 * Locking: None
1317 */
1318static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319{
1320 int i = index + driver->name_base;
1321 /* ->name is initialized to "ttyp", but "tty" is expected */
1322 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001323 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1324 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325}
1326
Alan Coxaf9b8972006-08-27 01:24:01 -07001327/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001328 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001329 * @driver: the tty driver in use
1330 * @index: the minor number
1331 * @p: output buffer of at least 7 bytes
1332 *
1333 * Generate a name from a driver reference and write it to the output
Greg Kroah-Hartman5c0a2452014-02-22 14:31:04 -08001334 * buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07001335 *
1336 * Locking: None
1337 */
Hannes Reinecke723abd82014-02-27 12:30:51 +01001338static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339{
Jiri Slaby0019b402012-08-08 22:26:43 +02001340 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
Hannes Reinecke723abd82014-02-27 12:30:51 +01001341 return sprintf(p, "%s", driver->name);
Jiri Slaby0019b402012-08-08 22:26:43 +02001342 else
Hannes Reinecke723abd82014-02-27 12:30:51 +01001343 return sprintf(p, "%s%d", driver->name,
1344 index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345}
1346
Alan Cox99f1fe12008-10-13 10:42:00 +01001347/**
1348 * tty_driver_lookup_tty() - find an existing tty, if any
1349 * @driver: the driver for the tty
1350 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001351 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001352 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the
1353 * driver lookup() method returns an error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001354 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001355 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001356 */
Jason Wessela47d5452009-01-02 13:43:04 +00001357static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001358 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001359{
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001360 struct tty_struct *tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001361
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001362 if (driver->ops->lookup)
1363 tty = driver->ops->lookup(driver, inode, idx);
1364 else
1365 tty = driver->ttys[idx];
1366
1367 if (!IS_ERR(tty))
1368 tty_kref_get(tty);
1369 return tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001370}
1371
Alan Cox99f1fe12008-10-13 10:42:00 +01001372/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001373 * tty_init_termios - helper for termios setup
1374 * @tty: the tty to set up
1375 *
1376 * Initialise the termios structures for this tty. Thus runs under
1377 * the tty_mutex currently so we can be relaxed about ordering.
1378 */
1379
1380int tty_init_termios(struct tty_struct *tty)
1381{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001382 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001383 int idx = tty->index;
1384
Alan Cox36b3c072012-07-17 17:06:57 +01001385 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1386 tty->termios = tty->driver->init_termios;
1387 else {
1388 /* Check for lazy saved data */
1389 tp = tty->driver->termios[idx];
1390 if (tp != NULL)
1391 tty->termios = *tp;
1392 else
1393 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001394 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001395 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001396 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1397 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001398 return 0;
1399}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001400EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001401
Jiri Slaby66d450e2012-01-30 21:14:28 +01001402int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1403{
1404 int ret = tty_init_termios(tty);
1405 if (ret)
1406 return ret;
1407
1408 tty_driver_kref_get(driver);
1409 tty->count++;
1410 driver->ttys[tty->index] = tty;
1411 return 0;
1412}
1413EXPORT_SYMBOL_GPL(tty_standard_install);
1414
Alan Coxbf970ee2008-10-13 10:42:39 +01001415/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001416 * tty_driver_install_tty() - install a tty entry in the driver
1417 * @driver: the driver for the tty
1418 * @tty: the tty
1419 *
1420 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001421 * will be set by the time this is called. This method is responsible
1422 * for ensuring any need additional structures are allocated and
1423 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001424 *
1425 * Locking: tty_mutex for now
1426 */
1427static int tty_driver_install_tty(struct tty_driver *driver,
1428 struct tty_struct *tty)
1429{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001430 return driver->ops->install ? driver->ops->install(driver, tty) :
1431 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001432}
1433
1434/**
1435 * tty_driver_remove_tty() - remove a tty from the driver tables
1436 * @driver: the driver for the tty
1437 * @idx: the minor number
1438 *
1439 * Remvoe a tty object from the driver tables. The tty->index field
1440 * will be set by the time this is called.
1441 *
1442 * Locking: tty_mutex for now
1443 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001444void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001445{
1446 if (driver->ops->remove)
1447 driver->ops->remove(driver, tty);
1448 else
1449 driver->ttys[tty->index] = NULL;
1450}
1451
1452/*
1453 * tty_reopen() - fast re-open of an open tty
1454 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001455 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001456 * Return 0 on success, -errno on error.
Peter Hurley5d93e742014-11-05 12:12:47 -05001457 * Re-opens on master ptys are not allowed and return -EIO.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001458 *
Peter Hurley5d93e742014-11-05 12:12:47 -05001459 * Locking: Caller must hold tty_lock
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001460 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001461static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001462{
1463 struct tty_driver *driver = tty->driver;
1464
Peter Hurley216030e2014-11-05 12:12:48 -05001465 if (!tty->count)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001466 return -EIO;
1467
1468 if (driver->type == TTY_DRIVER_TYPE_PTY &&
Peter Hurley5d93e742014-11-05 12:12:47 -05001469 driver->subtype == PTY_TYPE_MASTER)
1470 return -EIO;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001471
Peter Hurley86f2c002014-12-30 10:39:25 -05001472 if (test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
1473 return -EBUSY;
1474
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001475 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001476
Peter Hurley36697522013-06-15 07:04:48 -04001477 WARN_ON(!tty->ldisc);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001478
1479 return 0;
1480}
1481
Alan Coxaf9b8972006-08-27 01:24:01 -07001482/**
Alan Coxd81ed102008-10-13 10:41:42 +01001483 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001484 * @driver: tty driver we are opening a device on
1485 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001486 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001487 *
1488 * Prepare a tty device. This may not be a "new" clean device but
1489 * could also be an active device. The pty drivers require special
1490 * handling because of this.
1491 *
1492 * Locking:
1493 * The function is called under the tty_mutex, which
1494 * protects us from the tty struct or driver itself going away.
1495 *
1496 * On exit the tty device has the line discipline attached and
1497 * a reference count of 1. If a pair was created for pty/tty use
1498 * and the other was a pty master then it too has a reference count of 1.
1499 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001501 * failed open. The new code protects the open with a mutex, so it's
1502 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 * relaxed for the (most common) case of reopening a tty.
1504 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001505
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001506struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507{
Alan Coxbf970ee2008-10-13 10:42:39 +01001508 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001509 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 /*
1512 * First time open is complex, especially for PTY devices.
1513 * This code guarantees that either everything succeeds and the
1514 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001515 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 * and locked termios may be retained.)
1517 */
1518
Alan Cox73ec06f2008-10-13 10:42:29 +01001519 if (!try_module_get(driver->owner))
1520 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02001522 tty = alloc_tty_struct(driver, idx);
Jiri Slabyd5543502011-03-23 10:48:32 +01001523 if (!tty) {
1524 retval = -ENOMEM;
1525 goto err_module_put;
1526 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Alan Cox89c8d912012-08-08 16:30:13 +01001528 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001529 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001530 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001531 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001532
Jiri Slaby04831dc2012-06-04 13:35:36 +02001533 if (!tty->port)
1534 tty->port = driver->ports[idx];
1535
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001536 WARN_RATELIMIT(!tty->port,
1537 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1538 __func__, tty->driver->name);
1539
Jiri Slaby967fab62012-10-18 22:26:46 +02001540 tty->port->itty = tty;
1541
Alan Cox37bdfb02008-02-08 04:18:47 -08001542 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001544 * If we fail here just call release_tty to clean up. No need
1545 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001547 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001548 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001549 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001550 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001551 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001553err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001554 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001555 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001556 free_tty_struct(tty);
1557err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001559 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001561 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001562err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001563 tty_unlock(tty);
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +02001564 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001565 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001566 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001567 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568}
1569
Alan Coxfeebed62008-10-13 10:41:30 +01001570void tty_free_termios(struct tty_struct *tty)
1571{
1572 struct ktermios *tp;
1573 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001574
1575 /* If the port is going to reset then it has no termios to save */
1576 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1577 return;
1578
1579 /* Stash the termios data */
1580 tp = tty->driver->termios[idx];
1581 if (tp == NULL) {
1582 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1583 if (tp == NULL) {
1584 pr_warn("tty: no memory to save termios state.\n");
1585 return;
1586 }
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001587 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001588 }
Alan Cox36b3c072012-07-17 17:06:57 +01001589 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001590}
1591EXPORT_SYMBOL(tty_free_termios);
1592
Peter Hurleya2965b72013-03-11 16:44:35 -04001593/**
Peter Hurley949aa642014-11-05 12:12:57 -05001594 * tty_flush_works - flush all works of a tty/pty pair
1595 * @tty: tty device to flush works for (or either end of a pty pair)
Peter Hurleya2965b72013-03-11 16:44:35 -04001596 *
Peter Hurley949aa642014-11-05 12:12:57 -05001597 * Sync flush all works belonging to @tty (and the 'other' tty).
Peter Hurleya2965b72013-03-11 16:44:35 -04001598 */
1599static void tty_flush_works(struct tty_struct *tty)
1600{
1601 flush_work(&tty->SAK_work);
1602 flush_work(&tty->hangup_work);
Peter Hurley949aa642014-11-05 12:12:57 -05001603 if (tty->link) {
1604 flush_work(&tty->link->SAK_work);
1605 flush_work(&tty->link->hangup_work);
1606 }
Peter Hurleya2965b72013-03-11 16:44:35 -04001607}
Alan Coxfeebed62008-10-13 10:41:30 +01001608
Alan Coxaf9b8972006-08-27 01:24:01 -07001609/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001610 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001611 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001612 *
1613 * Releases memory associated with a tty structure, and clears out the
1614 * driver table slots. This function is called when a device is no longer
1615 * in use. It also gets called when setup of a device fails.
1616 *
1617 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001618 * takes the file list lock internally when working on the list
1619 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001620 *
1621 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001622 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 */
Alan Coxb50989d2009-09-19 13:13:22 -07001624static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625{
Alan Coxb50989d2009-09-19 13:13:22 -07001626 struct tty_struct *tty =
1627 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001628 struct tty_driver *driver = tty->driver;
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001629 struct module *owner = driver->owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Dave Youngf278a2f2009-09-27 16:00:42 +00001631 if (tty->ops->cleanup)
1632 tty->ops->cleanup(tty);
1633
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001635 tty_driver_kref_put(driver);
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001636 module_put(owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001637
Nick Pigginee2ffa02010-08-18 04:37:35 +10001638 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001640 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001641
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001642 put_pid(tty->pgrp);
1643 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 free_tty_struct(tty);
1645}
1646
Alan Coxb50989d2009-09-19 13:13:22 -07001647static void queue_release_one_tty(struct kref *kref)
1648{
1649 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001650
Alan Coxb50989d2009-09-19 13:13:22 -07001651 /* The hangup queue is now free so we can reuse it rather than
1652 waste a chunk of memory for each port */
1653 INIT_WORK(&tty->hangup_work, release_one_tty);
1654 schedule_work(&tty->hangup_work);
1655}
1656
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001657/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001658 * tty_kref_put - release a tty kref
1659 * @tty: tty device
1660 *
1661 * Release a reference to a tty device and if need be let the kref
1662 * layer destruct the object for us
1663 */
1664
1665void tty_kref_put(struct tty_struct *tty)
1666{
1667 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001668 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001669}
1670EXPORT_SYMBOL(tty_kref_put);
1671
1672/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001673 * release_tty - release tty structure memory
1674 *
1675 * Release both @tty and a possible linked partner (think pty pair),
1676 * and decrement the refcount of the backing module.
1677 *
1678 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001679 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001680 * takes the file list lock internally when working on the list
1681 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001682 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001683 */
1684static void release_tty(struct tty_struct *tty, int idx)
1685{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001686 /* This should always be true but check for the moment */
1687 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001688 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001689 if (tty->ops->shutdown)
1690 tty->ops->shutdown(tty);
1691 tty_free_termios(tty);
1692 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001693 tty->port->itty = NULL;
Peter Hurley64e377d2013-06-15 09:01:00 -04001694 if (tty->link)
1695 tty->link->port->itty = NULL;
Peter Hurley4f98d462013-03-11 16:44:34 -04001696 cancel_work_sync(&tty->port->buf.work);
Alan Cox36b3c072012-07-17 17:06:57 +01001697
Markus Elfringa211b1a2014-11-21 13:42:29 +01001698 tty_kref_put(tty->link);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001699 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001700}
1701
Alan Coxeeb89d92009-11-30 13:18:29 +00001702/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001703 * tty_release_checks - check a tty before real release
1704 * @tty: tty to check
1705 * @o_tty: link of @tty (if any)
1706 * @idx: index of the tty
1707 *
1708 * Performs some paranoid checking before true release of the @tty.
1709 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1710 */
Peter Hurley359b9fb2014-11-05 12:12:59 -05001711static int tty_release_checks(struct tty_struct *tty, int idx)
Jiri Slaby955787ca2011-11-11 10:47:23 +01001712{
1713#ifdef TTY_PARANOIA_CHECK
1714 if (idx < 0 || idx >= tty->driver->num) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001715 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1716 __func__, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001717 return -1;
1718 }
1719
1720 /* not much to check for devpts */
1721 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1722 return 0;
1723
1724 if (tty != tty->driver->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001725 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1726 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001727 return -1;
1728 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001729 if (tty->driver->other) {
Peter Hurley359b9fb2014-11-05 12:12:59 -05001730 struct tty_struct *o_tty = tty->link;
1731
Jiri Slaby955787ca2011-11-11 10:47:23 +01001732 if (o_tty != tty->driver->other->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001733 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1734 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001735 return -1;
1736 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001737 if (o_tty->link != tty) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001738 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001739 return -1;
1740 }
1741 }
1742#endif
1743 return 0;
1744}
1745
1746/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001747 * tty_release - vfs callback for close
1748 * @inode: inode of tty
1749 * @filp: file pointer for handle to tty
1750 *
1751 * Called the last time each file handle is closed that references
1752 * this tty. There may however be several such references.
1753 *
1754 * Locking:
1755 * Takes bkl. See tty_release_dev
1756 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 * Even releasing the tty structures is a tricky business.. We have
1758 * to be very careful that the structures are all released at the
1759 * same time, as interrupts might otherwise get the wrong pointers.
1760 *
1761 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1762 * lead to double frees or releasing memory still in use.
1763 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001764
1765int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766{
Nick Piggind996b622010-08-18 04:37:36 +10001767 struct tty_struct *tty = file_tty(filp);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001768 struct tty_struct *o_tty = NULL;
1769 int do_sleep, final;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 int idx;
Peter Hurley37b16452014-10-16 13:51:30 -04001771 long timeout = 0;
Peter Hurley494c1ea2014-10-16 13:54:36 -04001772 int once = 1;
Alan Cox37bdfb02008-02-08 04:18:47 -08001773
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001774 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001775 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Alan Cox89c8d912012-08-08 16:30:13 +01001777 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001778 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Arnd Bergmannec79d602010-06-01 22:53:01 +02001780 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
1782 idx = tty->index;
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001783 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1784 tty->driver->subtype == PTY_TYPE_MASTER)
1785 o_tty = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Peter Hurley359b9fb2014-11-05 12:12:59 -05001787 if (tty_release_checks(tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001788 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001789 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
1792#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001793 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001794 tty_name(tty), tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795#endif
1796
Alan Coxf34d7a52008-04-30 00:54:13 -07001797 if (tty->ops->close)
1798 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
Peter Hurley2aff5e22014-11-05 12:13:01 -05001800 /* If tty is pty master, lock the slave pty (stable lock order) */
1801 tty_lock_slave(o_tty);
1802
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 /*
1804 * Sanity check: if tty->count is going to zero, there shouldn't be
1805 * any waiters on tty->read_wait or tty->write_wait. We test the
1806 * wait queues and kick everyone out _before_ actually starting to
1807 * close. This ensures that we won't block while releasing the tty
1808 * structure.
1809 *
1810 * The test for the o_tty closing is necessary, since the master and
1811 * slave sides may close in any order. If the slave side closes out
1812 * first, its count will be one, since the master side holds an open.
Peter Hurley324c1652014-11-05 12:12:56 -05001813 * Thus this test wouldn't be triggered at the time the slave closed,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 * so we do it now.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 */
1816 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 do_sleep = 0;
1818
Peter Hurley324c1652014-11-05 12:12:56 -05001819 if (tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001821 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 do_sleep++;
1823 }
1824 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001825 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 do_sleep++;
1827 }
1828 }
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001829 if (o_tty && o_tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001831 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 do_sleep++;
1833 }
1834 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001835 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 do_sleep++;
1837 }
1838 }
1839 if (!do_sleep)
1840 break;
1841
Peter Hurley494c1ea2014-10-16 13:54:36 -04001842 if (once) {
1843 once = 0;
1844 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001845 __func__, tty_name(tty));
Peter Hurley494c1ea2014-10-16 13:54:36 -04001846 }
Peter Hurley37b16452014-10-16 13:51:30 -04001847 schedule_timeout_killable(timeout);
1848 if (timeout < 120 * HZ)
1849 timeout = 2 * timeout + 1;
1850 else
1851 timeout = MAX_SCHEDULE_TIMEOUT;
Alan Cox37bdfb02008-02-08 04:18:47 -08001852 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001854 if (o_tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001856 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001857 __func__, o_tty->count, tty_name(o_tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 o_tty->count = 0;
1859 }
1860 }
1861 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001862 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001863 __func__, tty->count, tty_name(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 tty->count = 0;
1865 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001866
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 /*
1868 * We've decremented tty->count, so we need to remove this file
1869 * descriptor off the tty->tty_files list; this serves two
1870 * purposes:
1871 * - check_tty_count sees the correct number of file descriptors
1872 * associated with this tty.
1873 * - do_tty_hangup no longer sees this file descriptor as
1874 * something that needs to be handled for hangups.
1875 */
Nick Piggind996b622010-08-18 04:37:36 +10001876 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877
1878 /*
1879 * Perform some housekeeping before deciding whether to return.
1880 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 * If _either_ side is closing, make sure there aren't any
1882 * processes that still think tty or o_tty is their controlling
1883 * tty.
1884 */
Peter Hurley324c1652014-11-05 12:12:56 -05001885 if (!tty->count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001887 session_clear_tty(tty->session);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001888 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001889 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 read_unlock(&tasklist_lock);
1891 }
1892
Peter Hurley324c1652014-11-05 12:12:56 -05001893 /* check whether both sides are closing ... */
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001894 final = !tty->count && !(o_tty && o_tty->count);
Peter Hurley324c1652014-11-05 12:12:56 -05001895
Peter Hurley2aff5e22014-11-05 12:13:01 -05001896 tty_unlock_slave(o_tty);
1897 tty_unlock(tty);
1898
Peter Hurley04980702014-11-05 12:12:52 -05001899 /* At this point, the tty->count == 0 should ensure a dead tty
Alan Coxd1552552012-07-27 18:02:54 +01001900 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001901
Peter Hurley324c1652014-11-05 12:12:56 -05001902 if (!final)
Alan Coxeeb89d92009-11-30 13:18:29 +00001903 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001904
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905#ifdef TTY_DEBUG_HANGUP
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001906 printk(KERN_DEBUG "%s: %s: final close\n", __func__, tty_name(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907#endif
1908 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001909 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 */
Peter Hurley62462ae2014-11-05 12:12:58 -05001911 tty_ldisc_release(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001912
1913 /* Wait for pending work before tty destruction commmences */
1914 tty_flush_works(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001915
Peter Hurley96433d12013-03-11 16:44:37 -04001916#ifdef TTY_DEBUG_HANGUP
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001917 printk(KERN_DEBUG "%s: %s: freeing structure...\n", __func__,
1918 tty_name(tty));
Peter Hurley96433d12013-03-11 16:44:37 -04001919#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001921 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001922 * the slots and preserving the termios structure. The tty_unlock_pair
1923 * should be safe as we keep a kref while the tty is locked (so the
1924 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 */
Alan Coxd1552552012-07-27 18:02:54 +01001926 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001927 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001928 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
Alan Coxeeb89d92009-11-30 13:18:29 +00001930 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931}
1932
Alan Coxaf9b8972006-08-27 01:24:01 -07001933/**
Peter Hurley52494ee2014-11-05 12:12:50 -05001934 * tty_open_current_tty - get locked tty of current task
Jiri Slabyb82154a2011-11-09 21:33:19 +01001935 * @device: device number
1936 * @filp: file pointer to tty
Peter Hurley52494ee2014-11-05 12:12:50 -05001937 * @return: locked tty of the current task iff @device is /dev/tty
1938 *
1939 * Performs a re-open of the current task's controlling tty.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001940 *
1941 * We cannot return driver and index like for the other nodes because
1942 * devpts will not work then. It expects inodes to be from devpts FS.
1943 */
1944static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1945{
1946 struct tty_struct *tty;
Peter Hurley52494ee2014-11-05 12:12:50 -05001947 int retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001948
1949 if (device != MKDEV(TTYAUX_MAJOR, 0))
1950 return NULL;
1951
1952 tty = get_current_tty();
1953 if (!tty)
1954 return ERR_PTR(-ENXIO);
1955
1956 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1957 /* noctty = 1; */
Peter Hurley52494ee2014-11-05 12:12:50 -05001958 tty_lock(tty);
1959 tty_kref_put(tty); /* safe to drop the kref now */
1960
1961 retval = tty_reopen(tty);
1962 if (retval < 0) {
1963 tty_unlock(tty);
1964 tty = ERR_PTR(retval);
1965 }
Jiri Slabyb82154a2011-11-09 21:33:19 +01001966 return tty;
1967}
1968
1969/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001970 * tty_lookup_driver - lookup a tty driver for a given device file
1971 * @device: device number
1972 * @filp: file pointer to tty
1973 * @noctty: set if the device should not become a controlling tty
1974 * @index: index for the device in the @return driver
1975 * @return: driver for this inode (with increased refcount)
1976 *
1977 * If @return is not erroneous, the caller is responsible to decrement the
1978 * refcount by tty_driver_kref_put.
1979 *
1980 * Locking: tty_mutex protects get_tty_driver
1981 */
1982static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1983 int *noctty, int *index)
1984{
1985 struct tty_driver *driver;
1986
Jiri Slaby2cd00502011-11-09 21:33:22 +01001987 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001988#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001989 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001990 extern struct tty_driver *console_driver;
1991 driver = tty_driver_kref_get(console_driver);
1992 *index = fg_console;
1993 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001994 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001995 }
1996#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001997 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001998 struct tty_driver *console_driver = console_device(index);
1999 if (console_driver) {
2000 driver = tty_driver_kref_get(console_driver);
2001 if (driver) {
2002 /* Don't let /dev/console block */
2003 filp->f_flags |= O_NONBLOCK;
2004 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01002005 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002006 }
2007 }
2008 return ERR_PTR(-ENODEV);
2009 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01002010 default:
2011 driver = get_tty_driver(device, index);
2012 if (!driver)
2013 return ERR_PTR(-ENODEV);
2014 break;
2015 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002016 return driver;
2017}
2018
2019/**
Alan Coxeeb89d92009-11-30 13:18:29 +00002020 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002021 * @inode: inode of device file
2022 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002024 * tty_open and tty_release keep up the tty count that contains the
2025 * number of opens done on a tty. We cannot use the inode-count, as
2026 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002028 * Open-counting is needed for pty masters, as well as for keeping
2029 * track of serial lines: DTR is dropped when the last close happens.
2030 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2031 *
2032 * The termios state of a pty is reset on first open so that
2033 * settings don't persist across reuse.
2034 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002035 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002036 * tty->count should protect the rest.
2037 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01002038 *
2039 * Note: the tty_unlock/lock cases without a ref are only safe due to
2040 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002042
Alan Coxeeb89d92009-11-30 13:18:29 +00002043static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044{
Jiri Slabyb82154a2011-11-09 21:33:19 +01002045 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01002047 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 int index;
2049 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07002050 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051
2052 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08002053
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002055 retval = tty_alloc_file(filp);
2056 if (retval)
2057 return -ENOMEM;
2058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 noctty = filp->f_flags & O_NOCTTY;
2060 index = -1;
2061 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002062
Jiri Slabyb82154a2011-11-09 21:33:19 +01002063 tty = tty_open_current_tty(device, filp);
Peter Hurley52494ee2014-11-05 12:12:50 -05002064 if (!tty) {
2065 mutex_lock(&tty_mutex);
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002066 driver = tty_lookup_driver(device, filp, &noctty, &index);
2067 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002068 retval = PTR_ERR(driver);
2069 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002072 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01002073 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00002074 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002075 retval = PTR_ERR(tty);
2076 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00002077 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002078
2079 if (tty) {
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002080 mutex_unlock(&tty_mutex);
Peter Hurley52494ee2014-11-05 12:12:50 -05002081 tty_lock(tty);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002082 /* safe to drop the kref from tty_driver_lookup_tty() */
2083 tty_kref_put(tty);
Peter Hurley52494ee2014-11-05 12:12:50 -05002084 retval = tty_reopen(tty);
2085 if (retval < 0) {
2086 tty_unlock(tty);
2087 tty = ERR_PTR(retval);
2088 }
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002089 } else { /* Returns with the tty_lock held for now */
Peter Hurley52494ee2014-11-05 12:12:50 -05002090 tty = tty_init_dev(driver, index);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002091 mutex_unlock(&tty_mutex);
2092 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002093
Peter Hurley52494ee2014-11-05 12:12:50 -05002094 tty_driver_kref_put(driver);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002095 }
2096
Alan Coxeeb89d92009-11-30 13:18:29 +00002097 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002098 retval = PTR_ERR(tty);
2099 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00002100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002102 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10002103
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002104 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2106 tty->driver->subtype == PTY_TYPE_MASTER)
2107 noctty = 1;
2108#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002109 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03002111 if (tty->ops->open)
2112 retval = tty->ops->open(tty, filp);
2113 else
2114 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 filp->f_flags = saved_flags;
2116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 if (retval) {
2118#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002119 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
2120 retval, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121#endif
Alan Cox89c8d912012-08-08 16:30:13 +01002122 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00002123 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002124 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002126
2127 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 schedule();
2131 /*
2132 * Need to reset f_op in case a hangup happened.
2133 */
Peter Hurley12569372014-11-05 12:26:24 -05002134 if (tty_hung_up_p(filp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 filp->f_op = &tty_fops;
2136 goto retry_open;
2137 }
Peter Hurleyd4855e12013-11-19 08:46:27 -05002138 clear_bit(TTY_HUPPED, &tty->flags);
Alan Coxeeb89d92009-11-30 13:18:29 +00002139
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002140
Peter Hurley2c411c12014-10-16 14:59:47 -04002141 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002142 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 if (!noctty &&
2144 current->signal->leader &&
2145 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002146 tty->session == NULL)
Peter Hurleybce65f12014-10-16 14:59:43 -04002147 __proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002148 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley2c411c12014-10-16 14:59:47 -04002149 read_unlock(&tasklist_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01002150 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002152err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002153 mutex_unlock(&tty_mutex);
2154 /* after locks to avoid deadlock */
2155 if (!IS_ERR_OR_NULL(driver))
2156 tty_driver_kref_put(driver);
2157err_file:
2158 tty_free_file(filp);
2159 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160}
2161
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002162
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163
Alan Coxaf9b8972006-08-27 01:24:01 -07002164/**
2165 * tty_poll - check tty status
2166 * @filp: file being polled
2167 * @wait: poll wait structures to update
2168 *
2169 * Call the line discipline polling method to obtain the poll
2170 * status of the device.
2171 *
2172 * Locking: locks called line discipline but ldisc poll method
2173 * may be re-entered freely by other callers.
2174 */
2175
Alan Cox37bdfb02008-02-08 04:18:47 -08002176static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177{
Nick Piggind996b622010-08-18 04:37:36 +10002178 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 struct tty_ldisc *ld;
2180 int ret = 0;
2181
Al Viro6131ffa2013-02-27 16:59:05 -05002182 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002184
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002186 if (ld->ops->poll)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002187 ret = ld->ops->poll(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 tty_ldisc_deref(ld);
2189 return ret;
2190}
2191
Arnd Bergmannec79d602010-06-01 22:53:01 +02002192static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193{
Nick Piggind996b622010-08-18 04:37:36 +10002194 struct tty_struct *tty = file_tty(filp);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002195 struct tty_ldisc *ldisc;
Alan Cox47f86832008-04-30 00:53:30 -07002196 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002197 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198
Al Viro6131ffa2013-02-27 16:59:05 -05002199 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002200 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002201
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 retval = fasync_helper(fd, filp, on, &tty->fasync);
2203 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002204 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002206 ldisc = tty_ldisc_ref(tty);
2207 if (ldisc) {
2208 if (ldisc->ops->fasync)
2209 ldisc->ops->fasync(tty, on);
2210 tty_ldisc_deref(ldisc);
2211 }
2212
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002214 enum pid_type type;
2215 struct pid *pid;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002216
Alan Cox47f86832008-04-30 00:53:30 -07002217 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002218 if (tty->pgrp) {
2219 pid = tty->pgrp;
2220 type = PIDTYPE_PGID;
2221 } else {
2222 pid = task_pid(current);
2223 type = PIDTYPE_PID;
2224 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002225 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002226 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002227 __f_setown(filp, pid, type, 0);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002228 put_pid(pid);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002229 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002231out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002232 return retval;
2233}
2234
2235static int tty_fasync(int fd, struct file *filp, int on)
2236{
Alan Cox89c8d912012-08-08 16:30:13 +01002237 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002238 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002239
2240 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002241 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002242 tty_unlock(tty);
2243
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002244 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245}
2246
Alan Coxaf9b8972006-08-27 01:24:01 -07002247/**
2248 * tiocsti - fake input character
2249 * @tty: tty to fake input into
2250 * @p: pointer to character
2251 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002252 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002253 * input management.
2254 *
2255 * FIXME: does not honour flow control ??
2256 *
2257 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -04002258 * Called functions take tty_ldiscs_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002259 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002260 *
2261 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002262 */
2263
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264static int tiocsti(struct tty_struct *tty, char __user *p)
2265{
2266 char ch, mbz = 0;
2267 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002268
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2270 return -EPERM;
2271 if (get_user(ch, p))
2272 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002273 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002275 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 tty_ldisc_deref(ld);
2277 return 0;
2278}
2279
Alan Coxaf9b8972006-08-27 01:24:01 -07002280/**
2281 * tiocgwinsz - implement window query ioctl
2282 * @tty; tty
2283 * @arg: user buffer for result
2284 *
Alan Cox808a0d32006-09-29 02:00:40 -07002285 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002286 *
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002287 * Locking: tty->winsize_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002288 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002289 */
2290
Alan Cox37bdfb02008-02-08 04:18:47 -08002291static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292{
Alan Cox808a0d32006-09-29 02:00:40 -07002293 int err;
2294
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002295 mutex_lock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002296 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002297 mutex_unlock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002298
2299 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300}
2301
Alan Coxaf9b8972006-08-27 01:24:01 -07002302/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002303 * tty_do_resize - resize event
2304 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002305 * @rows: rows (character)
2306 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002307 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002308 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002309 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002310 */
2311
Alan Coxfc6f6232009-01-02 13:43:17 +00002312int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313{
Alan Coxfc6f6232009-01-02 13:43:17 +00002314 struct pid *pgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315
Alan Coxfc6f6232009-01-02 13:43:17 +00002316 /* Lock the tty */
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002317 mutex_lock(&tty->winsize_mutex);
Alan Coxfc6f6232009-01-02 13:43:17 +00002318 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002319 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002320
Peter Hurley5b239542014-10-16 14:59:45 -04002321 /* Signal the foreground process group */
2322 pgrp = tty_get_pgrp(tty);
Alan Cox47f86832008-04-30 00:53:30 -07002323 if (pgrp)
2324 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002325 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002326
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002327 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002328done:
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002329 mutex_unlock(&tty->winsize_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 return 0;
2331}
Martin Schwidefsky4d334fd2013-01-04 14:55:13 +01002332EXPORT_SYMBOL(tty_do_resize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
Alan Coxaf9b8972006-08-27 01:24:01 -07002334/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002335 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002336 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002337 * @arg: user buffer for result
2338 *
2339 * Copies the user idea of the window size to the kernel. Traditionally
2340 * this is just advisory information but for the Linux console it
2341 * actually has driver level meaning and triggers a VC resize.
2342 *
2343 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002344 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002345 * tty termios mutex and ctrl_lock. The console takes its own lock
2346 * then calls into the default method.
2347 */
2348
Alan Coxfc6f6232009-01-02 13:43:17 +00002349static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002350{
2351 struct winsize tmp_ws;
2352 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2353 return -EFAULT;
2354
2355 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002356 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002357 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002358 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002359}
2360
2361/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002362 * tioccons - allow admin to move logical console
2363 * @file: the file to become console
2364 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002365 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002366 *
2367 * Locking: uses redirect_lock to guard the redirect information
2368 */
2369
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370static int tioccons(struct file *file)
2371{
2372 if (!capable(CAP_SYS_ADMIN))
2373 return -EPERM;
2374 if (file->f_op->write == redirected_tty_write) {
2375 struct file *f;
2376 spin_lock(&redirect_lock);
2377 f = redirect;
2378 redirect = NULL;
2379 spin_unlock(&redirect_lock);
2380 if (f)
2381 fput(f);
2382 return 0;
2383 }
2384 spin_lock(&redirect_lock);
2385 if (redirect) {
2386 spin_unlock(&redirect_lock);
2387 return -EBUSY;
2388 }
Al Virocb0942b2012-08-27 14:48:26 -04002389 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 spin_unlock(&redirect_lock);
2391 return 0;
2392}
2393
Alan Coxaf9b8972006-08-27 01:24:01 -07002394/**
2395 * fionbio - non blocking ioctl
2396 * @file: file to set blocking value
2397 * @p: user parameter
2398 *
2399 * Historical tty interfaces had a blocking control ioctl before
2400 * the generic functionality existed. This piece of history is preserved
2401 * in the expected tty API of posix OS's.
2402 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002403 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002404 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405
2406static int fionbio(struct file *file, int __user *p)
2407{
2408 int nonblock;
2409
2410 if (get_user(nonblock, p))
2411 return -EFAULT;
2412
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002413 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 if (nonblock)
2415 file->f_flags |= O_NONBLOCK;
2416 else
2417 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002418 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 return 0;
2420}
2421
Alan Coxaf9b8972006-08-27 01:24:01 -07002422/**
2423 * tiocsctty - set controlling tty
2424 * @tty: tty structure
2425 * @arg: user argument
2426 *
2427 * This ioctl is used to manage job control. It permits a session
2428 * leader to set this tty as the controlling tty for the session.
2429 *
2430 * Locking:
Peter Hurleye218eb32014-10-16 14:59:49 -04002431 * Takes tty_lock() to serialize proc_set_tty() for this tty
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002432 * Takes tasklist_lock internally to walk sessions
2433 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002434 */
2435
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436static int tiocsctty(struct tty_struct *tty, int arg)
2437{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002438 int ret = 0;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002439
Peter Hurleye218eb32014-10-16 14:59:49 -04002440 tty_lock(tty);
Peter Hurley2c411c12014-10-16 14:59:47 -04002441 read_lock(&tasklist_lock);
2442
2443 if (current->signal->leader && (task_session(current) == tty->session))
2444 goto unlock;
2445
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 /*
2447 * The process must be a session leader and
2448 * not have a controlling tty already.
2449 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002450 if (!current->signal->leader || current->signal->tty) {
2451 ret = -EPERM;
2452 goto unlock;
2453 }
2454
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002455 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 /*
2457 * This tty is already the controlling
2458 * tty for another session group!
2459 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002460 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 /*
2462 * Steal it away
2463 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002464 session_clear_tty(tty->session);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002465 } else {
2466 ret = -EPERM;
2467 goto unlock;
2468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 }
Peter Hurleybce65f12014-10-16 14:59:43 -04002470 proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002471unlock:
Peter Hurley2c411c12014-10-16 14:59:47 -04002472 read_unlock(&tasklist_lock);
Peter Hurleye218eb32014-10-16 14:59:49 -04002473 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002474 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475}
2476
Alan Coxaf9b8972006-08-27 01:24:01 -07002477/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002478 * tty_get_pgrp - return a ref counted pgrp pid
2479 * @tty: tty to read
2480 *
2481 * Returns a refcounted instance of the pid struct for the process
2482 * group controlling the tty.
2483 */
2484
2485struct pid *tty_get_pgrp(struct tty_struct *tty)
2486{
2487 unsigned long flags;
2488 struct pid *pgrp;
2489
2490 spin_lock_irqsave(&tty->ctrl_lock, flags);
2491 pgrp = get_pid(tty->pgrp);
2492 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2493
2494 return pgrp;
2495}
2496EXPORT_SYMBOL_GPL(tty_get_pgrp);
2497
Peter Hurleye1c22962014-10-16 14:59:48 -04002498/*
2499 * This checks not only the pgrp, but falls back on the pid if no
2500 * satisfactory pgrp is found. I dunno - gdb doesn't work correctly
2501 * without this...
2502 *
2503 * The caller must hold rcu lock or the tasklist lock.
2504 */
2505static struct pid *session_of_pgrp(struct pid *pgrp)
2506{
2507 struct task_struct *p;
2508 struct pid *sid = NULL;
2509
2510 p = pid_task(pgrp, PIDTYPE_PGID);
2511 if (p == NULL)
2512 p = pid_task(pgrp, PIDTYPE_PID);
2513 if (p != NULL)
2514 sid = task_session(p);
2515
2516 return sid;
2517}
2518
Alan Cox5d0fdf12008-04-30 00:53:31 -07002519/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002520 * tiocgpgrp - get process group
2521 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002522 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002523 * @p: returned pid
2524 *
2525 * Obtain the process group of the tty. If there is no process group
2526 * return an error.
2527 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002528 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002529 */
2530
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2532{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002533 struct pid *pid;
2534 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 /*
2536 * (tty == real_tty) is a cheap way of
2537 * testing if the tty is NOT a master pty.
2538 */
2539 if (tty == real_tty && current->signal->tty != real_tty)
2540 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002541 pid = tty_get_pgrp(real_tty);
2542 ret = put_user(pid_vnr(pid), p);
2543 put_pid(pid);
2544 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545}
2546
Alan Coxaf9b8972006-08-27 01:24:01 -07002547/**
2548 * tiocspgrp - attempt to set process group
2549 * @tty: tty passed by user
2550 * @real_tty: tty side device matching tty passed by user
2551 * @p: pid pointer
2552 *
2553 * Set the process group of the tty to the session passed. Only
2554 * permitted where the tty session is our session.
2555 *
Alan Cox47f86832008-04-30 00:53:30 -07002556 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002557 */
2558
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2560{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002561 struct pid *pgrp;
2562 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002564 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565
2566 if (retval == -EIO)
2567 return -ENOTTY;
2568 if (retval)
2569 return retval;
2570 if (!current->signal->tty ||
2571 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002572 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002574 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002576 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002578 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002579 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002580 retval = -ESRCH;
2581 if (!pgrp)
2582 goto out_unlock;
2583 retval = -EPERM;
2584 if (session_of_pgrp(pgrp) != task_session(current))
2585 goto out_unlock;
2586 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002587 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002588 put_pid(real_tty->pgrp);
2589 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002590 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002591out_unlock:
2592 rcu_read_unlock();
2593 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594}
2595
Alan Coxaf9b8972006-08-27 01:24:01 -07002596/**
2597 * tiocgsid - get session id
2598 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002599 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002600 * @p: pointer to returned session id
2601 *
2602 * Obtain the session id of the tty. If there is no session
2603 * return an error.
2604 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002605 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002606 */
2607
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2609{
2610 /*
2611 * (tty == real_tty) is a cheap way of
2612 * testing if the tty is NOT a master pty.
2613 */
2614 if (tty == real_tty && current->signal->tty != real_tty)
2615 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002616 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002618 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619}
2620
Alan Coxaf9b8972006-08-27 01:24:01 -07002621/**
2622 * tiocsetd - set line discipline
2623 * @tty: tty device
2624 * @p: pointer to user data
2625 *
2626 * Set the line discipline according to user request.
2627 *
2628 * Locking: see tty_set_ldisc, this function is just a helper
2629 */
2630
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631static int tiocsetd(struct tty_struct *tty, int __user *p)
2632{
2633 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002634 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
2636 if (get_user(ldisc, p))
2637 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002638
Alan Cox04f378b2008-04-30 00:53:29 -07002639 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002640
2641 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642}
2643
Alan Coxaf9b8972006-08-27 01:24:01 -07002644/**
2645 * send_break - performed time break
2646 * @tty: device to break on
2647 * @duration: timeout in mS
2648 *
2649 * Perform a timed break on hardware that lacks its own driver level
2650 * timed break functionality.
2651 *
2652 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002653 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002654 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002655 */
2656
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002657static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658{
Alan Cox9e989662008-07-22 11:18:03 +01002659 int retval;
2660
2661 if (tty->ops->break_ctl == NULL)
2662 return 0;
2663
2664 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2665 retval = tty->ops->break_ctl(tty, duration);
2666 else {
2667 /* Do the work ourselves */
2668 if (tty_write_lock(tty, 0) < 0)
2669 return -EINTR;
2670 retval = tty->ops->break_ctl(tty, -1);
2671 if (retval)
2672 goto out;
2673 if (!signal_pending(current))
2674 msleep_interruptible(duration);
2675 retval = tty->ops->break_ctl(tty, 0);
2676out:
2677 tty_write_unlock(tty);
2678 if (signal_pending(current))
2679 retval = -EINTR;
2680 }
2681 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682}
2683
Alan Coxaf9b8972006-08-27 01:24:01 -07002684/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002685 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002686 * @tty: tty device
2687 * @file: user file pointer
2688 * @p: pointer to result
2689 *
2690 * Obtain the modem status bits from the tty driver if the feature
2691 * is supported. Return -EINVAL if it is not available.
2692 *
2693 * Locking: none (up to the driver)
2694 */
2695
Alan Cox60b33c12011-02-14 16:26:14 +00002696static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697{
2698 int retval = -EINVAL;
2699
Alan Coxf34d7a52008-04-30 00:54:13 -07002700 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002701 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702
2703 if (retval >= 0)
2704 retval = put_user(retval, p);
2705 }
2706 return retval;
2707}
2708
Alan Coxaf9b8972006-08-27 01:24:01 -07002709/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002710 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002711 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002712 * @cmd: command - clear bits, set bits or set all
2713 * @p: pointer to desired bits
2714 *
2715 * Set the modem status bits from the tty driver if the feature
2716 * is supported. Return -EINVAL if it is not available.
2717 *
2718 * Locking: none (up to the driver)
2719 */
2720
Alan Cox20b9d172011-02-14 16:26:50 +00002721static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722 unsigned __user *p)
2723{
Alan Coxae677512008-07-16 21:56:54 +01002724 int retval;
2725 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726
Alan Coxae677512008-07-16 21:56:54 +01002727 if (tty->ops->tiocmset == NULL)
2728 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729
Alan Coxae677512008-07-16 21:56:54 +01002730 retval = get_user(val, p);
2731 if (retval)
2732 return retval;
2733 set = clear = 0;
2734 switch (cmd) {
2735 case TIOCMBIS:
2736 set = val;
2737 break;
2738 case TIOCMBIC:
2739 clear = val;
2740 break;
2741 case TIOCMSET:
2742 set = val;
2743 clear = ~val;
2744 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002745 }
Alan Coxae677512008-07-16 21:56:54 +01002746 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2747 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002748 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749}
2750
Alan Coxd281da72010-09-16 18:21:24 +01002751static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2752{
2753 int retval = -EINVAL;
2754 struct serial_icounter_struct icount;
2755 memset(&icount, 0, sizeof(icount));
2756 if (tty->ops->get_icount)
2757 retval = tty->ops->get_icount(tty, &icount);
2758 if (retval != 0)
2759 return retval;
2760 if (copy_to_user(arg, &icount, sizeof(icount)))
2761 return -EFAULT;
2762 return 0;
2763}
2764
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002765static void tty_warn_deprecated_flags(struct serial_struct __user *ss)
2766{
2767 static DEFINE_RATELIMIT_STATE(depr_flags,
2768 DEFAULT_RATELIMIT_INTERVAL,
2769 DEFAULT_RATELIMIT_BURST);
2770 char comm[TASK_COMM_LEN];
2771 int flags;
2772
2773 if (get_user(flags, &ss->flags))
2774 return;
2775
2776 flags &= ASYNC_DEPRECATED;
2777
2778 if (flags && __ratelimit(&depr_flags))
2779 pr_warning("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n",
2780 __func__, get_task_comm(comm, current), flags);
2781}
2782
Peter Hurley8f166e02014-10-16 14:59:41 -04002783/*
2784 * if pty, return the slave side (real_tty)
2785 * otherwise, return self
2786 */
2787static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +01002788{
2789 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2790 tty->driver->subtype == PTY_TYPE_MASTER)
2791 tty = tty->link;
2792 return tty;
2793}
Alan Coxe8b70e72009-06-11 12:48:02 +01002794
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795/*
2796 * Split this up, as gcc can choke on it otherwise..
2797 */
Alan Cox04f378b2008-04-30 00:53:29 -07002798long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799{
Nick Piggind996b622010-08-18 04:37:36 +10002800 struct tty_struct *tty = file_tty(file);
2801 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 void __user *p = (void __user *)arg;
2803 int retval;
2804 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002805
Al Viro6131ffa2013-02-27 16:59:05 -05002806 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807 return -EINVAL;
2808
Alan Coxe8b70e72009-06-11 12:48:02 +01002809 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810
2811 /*
2812 * Factor out some common prep work
2813 */
2814 switch (cmd) {
2815 case TIOCSETD:
2816 case TIOCSBRK:
2817 case TIOCCBRK:
2818 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002819 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 retval = tty_check_change(tty);
2821 if (retval)
2822 return retval;
2823 if (cmd != TIOCCBRK) {
2824 tty_wait_until_sent(tty, 0);
2825 if (signal_pending(current))
2826 return -EINTR;
2827 }
2828 break;
2829 }
2830
Alan Cox9e989662008-07-22 11:18:03 +01002831 /*
2832 * Now do the stuff.
2833 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002835 case TIOCSTI:
2836 return tiocsti(tty, p);
2837 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002838 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002839 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002840 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002841 case TIOCCONS:
2842 return real_tty != tty ? -EINVAL : tioccons(file);
2843 case FIONBIO:
2844 return fionbio(file, p);
2845 case TIOCEXCL:
2846 set_bit(TTY_EXCLUSIVE, &tty->flags);
2847 return 0;
2848 case TIOCNXCL:
2849 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2850 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002851 case TIOCGEXCL:
2852 {
2853 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2854 return put_user(excl, (int __user *)p);
2855 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002856 case TIOCNOTTY:
2857 if (current->signal->tty != tty)
2858 return -ENOTTY;
2859 no_tty();
2860 return 0;
2861 case TIOCSCTTY:
2862 return tiocsctty(tty, arg);
2863 case TIOCGPGRP:
2864 return tiocgpgrp(tty, real_tty, p);
2865 case TIOCSPGRP:
2866 return tiocspgrp(tty, real_tty, p);
2867 case TIOCGSID:
2868 return tiocgsid(tty, real_tty, p);
2869 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002870 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002871 case TIOCSETD:
2872 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002873 case TIOCVHANGUP:
2874 if (!capable(CAP_SYS_ADMIN))
2875 return -EPERM;
2876 tty_vhangup(tty);
2877 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002878 case TIOCGDEV:
2879 {
2880 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2881 return put_user(ret, (unsigned int __user *)p);
2882 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002883 /*
2884 * Break handling
2885 */
2886 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002887 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002888 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002889 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002890 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002891 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002892 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002893 return 0;
2894 case TCSBRK: /* SVID version: non-zero arg --> no break */
2895 /* non-zero arg means wait for all output data
2896 * to be sent (performed above) but don't send break.
2897 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002899 if (!arg)
2900 return send_break(tty, 250);
2901 return 0;
2902 case TCSBRKP: /* support for POSIX tcsendbreak() */
2903 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904
Alan Cox37bdfb02008-02-08 04:18:47 -08002905 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002906 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002907 case TIOCMSET:
2908 case TIOCMBIC:
2909 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002910 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002911 case TIOCGICOUNT:
2912 retval = tty_tiocgicount(tty, p);
2913 /* For the moment allow fall through to the old method */
2914 if (retval != -EINVAL)
2915 return retval;
2916 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002917 case TCFLSH:
2918 switch (arg) {
2919 case TCIFLUSH:
2920 case TCIOFLUSH:
2921 /* flush tty buffer and allow ldisc to process ioctl */
Peter Hurley86c80a82014-11-05 12:13:09 -05002922 tty_buffer_flush(tty, NULL);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002923 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002924 }
2925 break;
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002926 case TIOCSSERIAL:
2927 tty_warn_deprecated_flags(p);
2928 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002930 if (tty->ops->ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002931 retval = tty->ops->ioctl(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932 if (retval != -ENOIOCTLCMD)
2933 return retval;
2934 }
2935 ld = tty_ldisc_ref_wait(tty);
2936 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002937 if (ld->ops->ioctl) {
2938 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002940 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941 }
2942 tty_ldisc_deref(ld);
2943 return retval;
2944}
2945
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002946#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002947static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002948 unsigned long arg)
2949{
Nick Piggind996b622010-08-18 04:37:36 +10002950 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002951 struct tty_ldisc *ld;
2952 int retval = -ENOIOCTLCMD;
2953
Al Viro6131ffa2013-02-27 16:59:05 -05002954 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002955 return -EINVAL;
2956
Alan Coxf34d7a52008-04-30 00:54:13 -07002957 if (tty->ops->compat_ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002958 retval = tty->ops->compat_ioctl(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002959 if (retval != -ENOIOCTLCMD)
2960 return retval;
2961 }
2962
2963 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002964 if (ld->ops->compat_ioctl)
2965 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002966 else
2967 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002968 tty_ldisc_deref(ld);
2969
2970 return retval;
2971}
2972#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973
Al Viroc3c073f2012-08-21 22:32:06 -04002974static int this_tty(const void *t, struct file *file, unsigned fd)
2975{
2976 if (likely(file->f_op->read != tty_read))
2977 return 0;
2978 return file_tty(file) != t ? 0 : fd + 1;
2979}
2980
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981/*
2982 * This implements the "Secure Attention Key" --- the idea is to
2983 * prevent trojan horses by killing all processes associated with this
2984 * tty when the user hits the "Secure Attention Key". Required for
2985 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002986 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987 * This code could be nicer; ideally it should send a HUP, wait a few
2988 * seconds, then send a INT, and then a KILL signal. But you then
2989 * have to coordinate with the init process, since all processes associated
2990 * with the current tty must be dead before the new getty is allowed
2991 * to spawn.
2992 *
2993 * Now, if it would be correct ;-/ The current code has a nasty hole -
2994 * it doesn't catch files in flight. We may send the descriptor to ourselves
2995 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2996 *
2997 * Nasty bug: do_SAK is being called in interrupt context. This can
2998 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2999 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003000void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001{
3002#ifdef TTY_SOFT_SAK
3003 tty_hangup(tty);
3004#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08003005 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003006 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08003008
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009 if (!tty)
3010 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003011 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08003012
Dan Carpenterb3f13de2006-12-13 00:35:09 -08003013 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014
Alan Coxf34d7a52008-04-30 00:54:13 -07003015 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08003016
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003018 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003019 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08003020 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003021 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003022 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003023 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003024 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003025 /* Now kill any processes that happen to have the
3026 * tty open.
3027 */
3028 do_each_thread(g, p) {
3029 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003031 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003032 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033 send_sig(SIGKILL, p, 1);
3034 continue;
3035 }
3036 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04003037 i = iterate_fd(p->files, 0, this_tty, tty);
3038 if (i != 0) {
3039 printk(KERN_NOTICE "SAK: killed process %d"
3040 " (%s): fd#%d opened to the tty\n",
3041 task_pid_nr(p), p->comm, i - 1);
3042 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 }
3044 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003045 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003046 read_unlock(&tasklist_lock);
3047#endif
3048}
3049
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003050static void do_SAK_work(struct work_struct *work)
3051{
3052 struct tty_struct *tty =
3053 container_of(work, struct tty_struct, SAK_work);
3054 __do_SAK(tty);
3055}
3056
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057/*
3058 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3059 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3060 * the values which we write to it will be identical to the values which it
3061 * already has. --akpm
3062 */
3063void do_SAK(struct tty_struct *tty)
3064{
3065 if (!tty)
3066 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003067 schedule_work(&tty->SAK_work);
3068}
3069
3070EXPORT_SYMBOL(do_SAK);
3071
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003072static int dev_match_devt(struct device *dev, const void *data)
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003073{
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003074 const dev_t *devt = data;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003075 return dev->devt == *devt;
3076}
3077
3078/* Must put_device() after it's unused! */
3079static struct device *tty_get_device(struct tty_struct *tty)
3080{
3081 dev_t devt = tty_devnum(tty);
3082 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3083}
3084
3085
Alan Coxaf9b8972006-08-27 01:24:01 -07003086/**
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003087 * alloc_tty_struct
Alan Coxaf9b8972006-08-27 01:24:01 -07003088 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003089 * This subroutine allocates and initializes a tty structure.
Alan Coxaf9b8972006-08-27 01:24:01 -07003090 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003091 * Locking: none - tty in question is not exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003093
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003094struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003095{
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003096 struct tty_struct *tty;
3097
3098 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
3099 if (!tty)
3100 return NULL;
3101
Alan Cox9c9f4de2008-10-13 10:37:26 +01003102 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003103 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01003104 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003105 tty->session = NULL;
3106 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01003107 mutex_init(&tty->legacy_mutex);
Peter Hurleyd8c1f922013-06-15 09:14:31 -04003108 mutex_init(&tty->throttle_mutex);
Peter Hurley6a1c0682013-06-15 09:14:23 -04003109 init_rwsem(&tty->termios_rwsem);
Peter Hurleydee4a0b2013-07-24 16:43:51 -04003110 mutex_init(&tty->winsize_mutex);
Peter Hurley36697522013-06-15 07:04:48 -04003111 init_ldsem(&tty->ldisc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112 init_waitqueue_head(&tty->write_wait);
3113 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003114 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003115 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07003116 spin_lock_init(&tty->ctrl_lock);
Peter Hurleyf9e053d2014-09-10 15:06:31 -04003117 spin_lock_init(&tty->flow_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003119 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01003120
3121 tty->driver = driver;
3122 tty->ops = driver->ops;
3123 tty->index = idx;
3124 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003125 tty->dev = tty_get_device(tty);
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003126
3127 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003128}
3129
Alan Coxf34d7a52008-04-30 00:54:13 -07003130/**
Jiri Slaby67166712011-03-23 10:48:35 +01003131 * deinitialize_tty_struct
3132 * @tty: tty to deinitialize
3133 *
3134 * This subroutine deinitializes a tty structure that has been newly
3135 * allocated but tty_release cannot be called on that yet.
3136 *
3137 * Locking: none - tty in question must not be exposed at this point
3138 */
3139void deinitialize_tty_struct(struct tty_struct *tty)
3140{
3141 tty_ldisc_deinit(tty);
3142}
3143
3144/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003145 * tty_put_char - write one character to a tty
3146 * @tty: tty
3147 * @ch: character
3148 *
3149 * Write one byte to the tty using the provided put_char method
3150 * if present. Returns the number of characters successfully output.
3151 *
3152 * Note: the specific put_char operation in the driver layer may go
3153 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003155
Alan Coxf34d7a52008-04-30 00:54:13 -07003156int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003157{
Alan Coxf34d7a52008-04-30 00:54:13 -07003158 if (tty->ops->put_char)
3159 return tty->ops->put_char(tty, ch);
3160 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003161}
Alan Coxf34d7a52008-04-30 00:54:13 -07003162EXPORT_SYMBOL_GPL(tty_put_char);
3163
Alan Coxd81ed102008-10-13 10:41:42 +01003164struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003166static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3167 unsigned int index, unsigned int count)
3168{
3169 /* init here, since reused cdevs cause crashes */
3170 cdev_init(&driver->cdevs[index], &tty_fops);
3171 driver->cdevs[index].owner = driver->owner;
3172 return cdev_add(&driver->cdevs[index], dev, count);
3173}
3174
Linus Torvalds1da177e2005-04-16 15:20:36 -07003175/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003176 * tty_register_device - register a tty device
3177 * @driver: the tty driver that describes the tty device
3178 * @index: the index in the tty driver for this tty device
3179 * @device: a struct device that is associated with this tty device.
3180 * This field is optional, if there is no known struct device
3181 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003183 * Returns a pointer to the struct device for this tty device
3184 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003185 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003186 * This call is required to be made to register an individual tty device
3187 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3188 * that bit is not set, this function should not be called by a tty
3189 * driver.
3190 *
3191 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003193
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003194struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3195 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003196{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003197 return tty_register_device_attr(driver, index, device, NULL, NULL);
3198}
3199EXPORT_SYMBOL(tty_register_device);
3200
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003201static void tty_device_create_release(struct device *dev)
3202{
3203 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3204 kfree(dev);
3205}
3206
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003207/**
3208 * tty_register_device_attr - register a tty device
3209 * @driver: the tty driver that describes the tty device
3210 * @index: the index in the tty driver for this tty device
3211 * @device: a struct device that is associated with this tty device.
3212 * This field is optional, if there is no known struct device
3213 * for this tty device it can be set to NULL safely.
3214 * @drvdata: Driver data to be set to device.
3215 * @attr_grp: Attribute group to be set on device.
3216 *
3217 * Returns a pointer to the struct device for this tty device
3218 * (or ERR_PTR(-EFOO) on error).
3219 *
3220 * This call is required to be made to register an individual tty device
3221 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3222 * that bit is not set, this function should not be called by a tty
3223 * driver.
3224 *
3225 * Locking: ??
3226 */
3227struct device *tty_register_device_attr(struct tty_driver *driver,
3228 unsigned index, struct device *device,
3229 void *drvdata,
3230 const struct attribute_group **attr_grp)
3231{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003232 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003233 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3234 struct device *dev = NULL;
3235 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003236 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237
3238 if (index >= driver->num) {
3239 printk(KERN_ERR "Attempt to register invalid tty line number "
3240 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003241 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003242 }
3243
Linus Torvalds1da177e2005-04-16 15:20:36 -07003244 if (driver->type == TTY_DRIVER_TYPE_PTY)
3245 pty_line_name(driver, index, name);
3246 else
3247 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003248
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003249 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003250 retval = tty_cdev_add(driver, devt, index, 1);
3251 if (retval)
3252 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003253 cdev = true;
3254 }
3255
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003256 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3257 if (!dev) {
3258 retval = -ENOMEM;
3259 goto error;
3260 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003261
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003262 dev->devt = devt;
3263 dev->class = tty_class;
3264 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003265 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003266 dev_set_name(dev, "%s", name);
3267 dev->groups = attr_grp;
3268 dev_set_drvdata(dev, drvdata);
3269
3270 retval = device_register(dev);
3271 if (retval)
3272 goto error;
3273
3274 return dev;
3275
3276error:
3277 put_device(dev);
3278 if (cdev)
3279 cdev_del(&driver->cdevs[index]);
3280 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003282EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003283
3284/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003285 * tty_unregister_device - unregister a tty device
3286 * @driver: the tty driver that describes the tty device
3287 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003289 * If a tty device is registered with a call to tty_register_device() then
3290 * this function must be called when the tty device is gone.
3291 *
3292 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003293 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003294
Linus Torvalds1da177e2005-04-16 15:20:36 -07003295void tty_unregister_device(struct tty_driver *driver, unsigned index)
3296{
Alan Cox37bdfb02008-02-08 04:18:47 -08003297 device_destroy(tty_class,
3298 MKDEV(driver->major, driver->minor_start) + index);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003299 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3300 cdev_del(&driver->cdevs[index]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003301}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302EXPORT_SYMBOL(tty_unregister_device);
3303
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003304/**
3305 * __tty_alloc_driver -- allocate tty driver
3306 * @lines: count of lines this driver can handle at most
3307 * @owner: module which is repsonsible for this driver
3308 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3309 *
3310 * This should not be called directly, some of the provided macros should be
3311 * used instead. Use IS_ERR and friends on @retval.
3312 */
3313struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3314 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315{
3316 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003317 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003318 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003319
Jiri Slaby0019b402012-08-08 22:26:43 +02003320 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003321 return ERR_PTR(-EINVAL);
3322
Jean Delvare506eb992007-07-15 23:40:14 -07003323 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003324 if (!driver)
3325 return ERR_PTR(-ENOMEM);
3326
3327 kref_init(&driver->kref);
3328 driver->magic = TTY_DRIVER_MAGIC;
3329 driver->num = lines;
3330 driver->owner = owner;
3331 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003332
3333 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3334 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3335 GFP_KERNEL);
3336 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3337 GFP_KERNEL);
3338 if (!driver->ttys || !driver->termios) {
3339 err = -ENOMEM;
3340 goto err_free_all;
3341 }
3342 }
3343
3344 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3345 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3346 GFP_KERNEL);
3347 if (!driver->ports) {
3348 err = -ENOMEM;
3349 goto err_free_all;
3350 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003351 cdevs = lines;
3352 }
3353
3354 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3355 if (!driver->cdevs) {
3356 err = -ENOMEM;
3357 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003358 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003359
Linus Torvalds1da177e2005-04-16 15:20:36 -07003360 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003361err_free_all:
3362 kfree(driver->ports);
3363 kfree(driver->ttys);
3364 kfree(driver->termios);
3365 kfree(driver);
3366 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003368EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003369
Alan Cox7d7b93c2008-10-13 10:42:09 +01003370static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003372 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3373 int i;
3374 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003375
3376 if (driver->flags & TTY_DRIVER_INSTALLED) {
3377 /*
3378 * Free the termios and termios_locked structures because
3379 * we don't want to get memory leaks when modular tty
3380 * drivers are removed from the kernel.
3381 */
3382 for (i = 0; i < driver->num; i++) {
3383 tp = driver->termios[i];
3384 if (tp) {
3385 driver->termios[i] = NULL;
3386 kfree(tp);
3387 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003388 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3389 tty_unregister_device(driver, i);
3390 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003391 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003392 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3393 cdev_del(&driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003394 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003395 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003396 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003397 kfree(driver->termios);
3398 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399 kfree(driver);
3400}
3401
Alan Cox7d7b93c2008-10-13 10:42:09 +01003402void tty_driver_kref_put(struct tty_driver *driver)
3403{
3404 kref_put(&driver->kref, destruct_tty_driver);
3405}
3406EXPORT_SYMBOL(tty_driver_kref_put);
3407
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003408void tty_set_operations(struct tty_driver *driver,
3409 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003410{
Alan Coxf34d7a52008-04-30 00:54:13 -07003411 driver->ops = op;
3412};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003413EXPORT_SYMBOL(tty_set_operations);
3414
Alan Cox7d7b93c2008-10-13 10:42:09 +01003415void put_tty_driver(struct tty_driver *d)
3416{
3417 tty_driver_kref_put(d);
3418}
3419EXPORT_SYMBOL(put_tty_driver);
3420
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421/*
3422 * Called by a tty driver to register itself.
3423 */
3424int tty_register_driver(struct tty_driver *driver)
3425{
3426 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003427 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003429 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003430
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003432 error = alloc_chrdev_region(&dev, driver->minor_start,
3433 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003434 if (!error) {
3435 driver->major = MAJOR(dev);
3436 driver->minor_start = MINOR(dev);
3437 }
3438 } else {
3439 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003440 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003442 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003443 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003444
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003445 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3446 error = tty_cdev_add(driver, dev, 0, driver->num);
3447 if (error)
3448 goto err_unreg_char;
3449 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003451 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003453 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003454
3455 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003456 for (i = 0; i < driver->num; i++) {
3457 d = tty_register_device(driver, i, NULL);
3458 if (IS_ERR(d)) {
3459 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003460 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003461 }
3462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 }
3464 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003465 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003467
Jiri Slaby16a02082012-08-08 22:26:42 +02003468err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003469 for (i--; i >= 0; i--)
3470 tty_unregister_device(driver, i);
3471
3472 mutex_lock(&tty_mutex);
3473 list_del(&driver->tty_drivers);
3474 mutex_unlock(&tty_mutex);
3475
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003476err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003477 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003478err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003479 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003480}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003481EXPORT_SYMBOL(tty_register_driver);
3482
3483/*
3484 * Called by a tty driver to unregister itself.
3485 */
3486int tty_unregister_driver(struct tty_driver *driver)
3487{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003488#if 0
3489 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003490 if (driver->refcount)
3491 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003492#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003493 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3494 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003495 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003497 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498 return 0;
3499}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003500
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501EXPORT_SYMBOL(tty_unregister_driver);
3502
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003503dev_t tty_devnum(struct tty_struct *tty)
3504{
3505 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3506}
3507EXPORT_SYMBOL(tty_devnum);
3508
Alan Coxd81ed102008-10-13 10:41:42 +01003509void tty_default_fops(struct file_operations *fops)
3510{
3511 *fops = tty_fops;
3512}
3513
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514/*
3515 * Initialize the console device. This is called *early*, so
3516 * we can't necessarily depend on lots of kernel help here.
3517 * Just do some early initializations, and do the complex setup
3518 * later.
3519 */
3520void __init console_init(void)
3521{
3522 initcall_t *call;
3523
3524 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003525 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003526
3527 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003528 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003529 * inform about problems etc..
3530 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003531 call = __con_initcall_start;
3532 while (call < __con_initcall_end) {
3533 (*call)();
3534 call++;
3535 }
3536}
3537
Al Viro2c9ede52011-07-23 20:24:48 -04003538static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003539{
3540 if (!mode)
3541 return NULL;
3542 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3543 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3544 *mode = 0666;
3545 return NULL;
3546}
3547
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548static int __init tty_class_init(void)
3549{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003550 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 if (IS_ERR(tty_class))
3552 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003553 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554 return 0;
3555}
3556
3557postcore_initcall(tty_class_init);
3558
3559/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003560static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561
Kay Sieversfbc92a32010-12-01 18:51:05 +01003562static ssize_t show_cons_active(struct device *dev,
3563 struct device_attribute *attr, char *buf)
3564{
3565 struct console *cs[16];
3566 int i = 0;
3567 struct console *c;
3568 ssize_t count = 0;
3569
Torben Hohnac751ef2011-01-25 15:07:35 -08003570 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003571 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003572 if (!c->device)
3573 continue;
3574 if (!c->write)
3575 continue;
3576 if ((c->flags & CON_ENABLED) == 0)
3577 continue;
3578 cs[i++] = c;
3579 if (i >= ARRAY_SIZE(cs))
3580 break;
3581 }
Hannes Reinecke723abd82014-02-27 12:30:51 +01003582 while (i--) {
3583 int index = cs[i]->index;
3584 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3585
3586 /* don't resolve tty0 as some programs depend on it */
3587 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3588 count += tty_line_name(drv, index, buf + count);
3589 else
3590 count += sprintf(buf + count, "%s%d",
3591 cs[i]->name, cs[i]->index);
3592
3593 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3594 }
Torben Hohnac751ef2011-01-25 15:07:35 -08003595 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003596
3597 return count;
3598}
3599static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3600
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003601static struct attribute *cons_dev_attrs[] = {
3602 &dev_attr_active.attr,
3603 NULL
3604};
3605
3606ATTRIBUTE_GROUPS(cons_dev);
3607
Kay Sieversfbc92a32010-12-01 18:51:05 +01003608static struct device *consdev;
3609
3610void console_sysfs_notify(void)
3611{
3612 if (consdev)
3613 sysfs_notify(&consdev->kobj, NULL, "active");
3614}
3615
Linus Torvalds1da177e2005-04-16 15:20:36 -07003616/*
3617 * Ok, now we can initialize the rest of the tty devices and can count
3618 * on memory allocations, interrupts etc..
3619 */
David Howells31d1d482010-08-06 16:34:43 +01003620int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003621{
3622 cdev_init(&tty_cdev, &tty_fops);
3623 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3624 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3625 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003626 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003627
3628 cdev_init(&console_cdev, &console_fops);
3629 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3630 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3631 panic("Couldn't register /dev/console driver\n");
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003632 consdev = device_create_with_groups(tty_class, NULL,
3633 MKDEV(TTYAUX_MAJOR, 1), NULL,
3634 cons_dev_groups, "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003635 if (IS_ERR(consdev))
3636 consdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003637
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003639 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003640#endif
3641 return 0;
3642}
David Howells31d1d482010-08-06 16:34:43 +01003643