blob: 336714cf370af239a7ec0a847c1e8026643e0431 [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
Peter Hurleyaccff792015-07-12 22:49:09 -0400109#ifdef TTY_DEBUG_HANGUP
110# define tty_debug_hangup(tty, f, args...) tty_debug(tty, f, ##args)
111#else
112# define tty_debug_hangup(tty, f, args...) do { } while (0)
113#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115#define TTY_PARANOIA_CHECK 1
116#define CHECK_TTY_COUNT 1
117
Alan Coxedc6afc2006-12-08 02:38:44 -0800118struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 .c_iflag = ICRNL | IXON,
120 .c_oflag = OPOST | ONLCR,
121 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
122 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
123 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800124 .c_cc = INIT_C_CC,
125 .c_ispeed = 38400,
126 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127};
128
129EXPORT_SYMBOL(tty_std_termios);
130
131/* This list gets poked at by procfs and various bits of boot up code. This
132 could do with some rationalisation such as pulling the tty proc function
133 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135LIST_HEAD(tty_drivers); /* linked list of tty drivers */
136
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800137/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800139DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700140EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Nick Pigginee2ffa02010-08-18 04:37:35 +1000142/* Spinlock to protect the tty->tty_files list */
143DEFINE_SPINLOCK(tty_files_lock);
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
146static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800147ssize_t redirected_tty_write(struct file *, const char __user *,
148 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149static unsigned int tty_poll(struct file *, poll_table *);
150static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700151long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700152#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800153static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700154 unsigned long arg);
155#else
156#define tty_compat_ioctl NULL
157#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200158static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800159static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800160static void release_tty(struct tty_struct *tty, int idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Alan Coxaf9b8972006-08-27 01:24:01 -0700162/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700163 * free_tty_struct - free a disused tty
164 * @tty: tty struct to free
165 *
166 * Free the write buffers, tty queue and tty memory itself.
167 *
168 * Locking: none. Must be called after tty is definitely unused
169 */
170
Alan Coxbf970ee2008-10-13 10:42:39 +0100171void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Dan Carpenterdc6802a2012-07-24 12:52:04 +0100173 if (!tty)
174 return;
Markus Elfringa211b1a2014-11-21 13:42:29 +0100175 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 kfree(tty->write_buf);
Alan Cox89c8d912012-08-08 16:30:13 +0100177 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 kfree(tty);
179}
180
Nick Piggind996b622010-08-18 04:37:36 +1000181static inline struct tty_struct *file_tty(struct file *file)
182{
183 return ((struct tty_file_private *)file->private_data)->tty;
184}
185
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200186int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000187{
188 struct tty_file_private *priv;
189
Pekka Enbergf573bd12010-08-24 07:48:34 +0300190 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
191 if (!priv)
192 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000193
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200194 file->private_data = priv;
195
196 return 0;
197}
198
199/* Associate a new file with the tty structure */
200void tty_add_file(struct tty_struct *tty, struct file *file)
201{
202 struct tty_file_private *priv = file->private_data;
203
Nick Piggind996b622010-08-18 04:37:36 +1000204 priv->tty = tty;
205 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000206
207 spin_lock(&tty_files_lock);
208 list_add(&priv->list, &tty->tty_files);
209 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200210}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300211
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200212/**
213 * tty_free_file - free file->private_data
214 *
215 * This shall be used only for fail path handling when tty_add_file was not
216 * called yet.
217 */
218void tty_free_file(struct file *file)
219{
220 struct tty_file_private *priv = file->private_data;
221
222 file->private_data = NULL;
223 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000224}
225
226/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800227static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000228{
229 struct tty_file_private *priv = file->private_data;
230
231 spin_lock(&tty_files_lock);
232 list_del(&priv->list);
233 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200234 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000235}
236
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
239
Alan Coxaf9b8972006-08-27 01:24:01 -0700240/**
241 * tty_name - return tty naming
242 * @tty: tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -0700243 *
244 * Convert a tty structure into a name. The name reflects the kernel
245 * naming policy and if udev is in use may not reflect user space
246 *
247 * Locking: none
248 */
249
Rasmus Villemoes429b4742015-03-31 15:55:59 +0200250const char *tty_name(const struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 if (!tty) /* Hmm. NULL pointer. That's fun. */
Rasmus Villemoes917162c2015-03-31 15:55:58 +0200253 return "NULL tty";
254 return tty->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
257EXPORT_SYMBOL(tty_name);
258
Peter Hurley82b8f882015-11-08 13:01:09 -0500259static int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 const char *routine)
261{
262#ifdef TTY_PARANOIA_CHECK
263 if (!tty) {
264 printk(KERN_WARNING
265 "null TTY for (%d:%d) in %s\n",
266 imajor(inode), iminor(inode), routine);
267 return 1;
268 }
269 if (tty->magic != TTY_MAGIC) {
270 printk(KERN_WARNING
271 "bad magic number for tty struct (%d:%d) in %s\n",
272 imajor(inode), iminor(inode), routine);
273 return 1;
274 }
275#endif
276 return 0;
277}
278
Peter Hurleydeb287e2014-11-05 12:12:55 -0500279/* Caller must hold tty_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280static int check_tty_count(struct tty_struct *tty, const char *routine)
281{
282#ifdef CHECK_TTY_COUNT
283 struct list_head *p;
284 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800285
Nick Pigginee2ffa02010-08-18 04:37:35 +1000286 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 list_for_each(p, &tty->tty_files) {
288 count++;
289 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000290 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
292 tty->driver->subtype == PTY_TYPE_SLAVE &&
293 tty->link && tty->link->count)
294 count++;
295 if (tty->count != count) {
296 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
297 "!= #fd's(%d) in %s\n",
298 tty->name, tty->count, count, routine);
299 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800300 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301#endif
302 return 0;
303}
304
Alan Coxaf9b8972006-08-27 01:24:01 -0700305/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700306 * get_tty_driver - find device of a tty
307 * @dev_t: device identifier
308 * @index: returns the index of the tty
309 *
310 * This routine returns a tty driver structure, given a device number
311 * and also passes back the index number.
312 *
313 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700315
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316static struct tty_driver *get_tty_driver(dev_t device, int *index)
317{
318 struct tty_driver *p;
319
320 list_for_each_entry(p, &tty_drivers, tty_drivers) {
321 dev_t base = MKDEV(p->major, p->minor_start);
322 if (device < base || device >= base + p->num)
323 continue;
324 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100325 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 }
327 return NULL;
328}
329
Jason Wesself2d937f2008-04-17 20:05:37 +0200330#ifdef CONFIG_CONSOLE_POLL
331
332/**
333 * tty_find_polling_driver - find device of a polled tty
334 * @name: name string to match
335 * @line: pointer to resulting tty line nr
336 *
337 * This routine returns a tty driver structure, given a name
338 * and the condition that the tty driver is capable of polled
339 * operation.
340 */
341struct tty_driver *tty_find_polling_driver(char *name, int *line)
342{
343 struct tty_driver *p, *res = NULL;
344 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500345 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100346 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200347
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500348 for (str = name; *str; str++)
349 if ((*str >= '0' && *str <= '9') || *str == ',')
350 break;
351 if (!*str)
352 return NULL;
353
354 len = str - name;
355 tty_line = simple_strtoul(str, &str, 10);
356
Jason Wesself2d937f2008-04-17 20:05:37 +0200357 mutex_lock(&tty_mutex);
358 /* Search through the tty devices to look for a match */
359 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500360 if (strncmp(name, p->name, len) != 0)
361 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100362 stp = str;
363 if (*stp == ',')
364 stp++;
365 if (*stp == '\0')
366 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200367
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200368 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100369 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100370 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200371 *line = tty_line;
372 break;
373 }
374 }
375 mutex_unlock(&tty_mutex);
376
377 return res;
378}
379EXPORT_SYMBOL_GPL(tty_find_polling_driver);
380#endif
381
Alan Coxaf9b8972006-08-27 01:24:01 -0700382/**
383 * tty_check_change - check for POSIX terminal changes
384 * @tty: tty to check
385 *
386 * If we try to write to, or set the state of, a terminal and we're
387 * not in the foreground, send a SIGTTOU. If the signal is blocked or
388 * ignored, go ahead and perform the operation. (POSIX 7.2)
389 *
Alan Cox978e5952008-04-30 00:53:59 -0700390 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700392
Peter Hurley2812d9e2015-10-10 20:28:42 -0400393int __tty_check_change(struct tty_struct *tty, int sig)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394{
Alan Cox47f86832008-04-30 00:53:30 -0700395 unsigned long flags;
Peter Hurley2812d9e2015-10-10 20:28:42 -0400396 struct pid *pgrp, *tty_pgrp;
Alan Cox47f86832008-04-30 00:53:30 -0700397 int ret = 0;
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 if (current->signal->tty != tty)
400 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700401
Patrick Donnelly67196932015-07-12 18:51:52 -0400402 rcu_read_lock();
403 pgrp = task_pgrp(current);
404
Alan Cox47f86832008-04-30 00:53:30 -0700405 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurley2812d9e2015-10-10 20:28:42 -0400406 tty_pgrp = tty->pgrp;
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700407 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Patrick Donnelly67196932015-07-12 18:51:52 -0400408
Peter Hurley2812d9e2015-10-10 20:28:42 -0400409 if (tty_pgrp && pgrp != tty->pgrp) {
410 if (is_ignored(sig)) {
411 if (sig == SIGTTIN)
412 ret = -EIO;
413 } else if (is_current_pgrp_orphaned())
414 ret = -EIO;
415 else {
416 kill_pgrp(pgrp, sig, 1);
417 set_thread_flag(TIF_SIGPENDING);
418 ret = -ERESTARTSYS;
419 }
Alan Cox47f86832008-04-30 00:53:30 -0700420 }
Patrick Donnelly67196932015-07-12 18:51:52 -0400421 rcu_read_unlock();
Peter Hurley2812d9e2015-10-10 20:28:42 -0400422
423 if (!tty_pgrp) {
424 pr_warn("%s: tty_check_change: sig=%d, tty->pgrp == NULL!\n",
425 tty_name(tty), sig);
426 }
427
Alan Cox47f86832008-04-30 00:53:30 -0700428 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429}
430
Peter Hurley2812d9e2015-10-10 20:28:42 -0400431int tty_check_change(struct tty_struct *tty)
432{
433 return __tty_check_change(tty, SIGTTOU);
434}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435EXPORT_SYMBOL(tty_check_change);
436
Alan Cox37bdfb02008-02-08 04:18:47 -0800437static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 size_t count, loff_t *ppos)
439{
440 return 0;
441}
442
Alan Cox37bdfb02008-02-08 04:18:47 -0800443static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 size_t count, loff_t *ppos)
445{
446 return -EIO;
447}
448
449/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800450static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451{
452 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
453}
454
Alan Cox04f378b2008-04-30 00:53:29 -0700455static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
456 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700457{
458 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
459}
460
Alan Cox37bdfb02008-02-08 04:18:47 -0800461static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700462 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
464 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
465}
466
Arjan van de Ven62322d22006-07-03 00:24:21 -0700467static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 .llseek = no_llseek,
469 .read = tty_read,
470 .write = tty_write,
471 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700472 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700473 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 .open = tty_open,
475 .release = tty_release,
476 .fasync = tty_fasync,
477};
478
Arjan van de Ven62322d22006-07-03 00:24:21 -0700479static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 .llseek = no_llseek,
481 .read = tty_read,
482 .write = redirected_tty_write,
483 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700484 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700485 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 .open = tty_open,
487 .release = tty_release,
488 .fasync = tty_fasync,
489};
490
Arjan van de Ven62322d22006-07-03 00:24:21 -0700491static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 .llseek = no_llseek,
493 .read = hung_up_tty_read,
494 .write = hung_up_tty_write,
495 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700496 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700497 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 .release = tty_release,
499};
500
501static DEFINE_SPINLOCK(redirect_lock);
502static struct file *redirect;
503
Peter Hurley11d9bef2014-10-16 14:59:42 -0400504
505void proc_clear_tty(struct task_struct *p)
506{
507 unsigned long flags;
508 struct tty_struct *tty;
509 spin_lock_irqsave(&p->sighand->siglock, flags);
510 tty = p->signal->tty;
511 p->signal->tty = NULL;
512 spin_unlock_irqrestore(&p->sighand->siglock, flags);
513 tty_kref_put(tty);
514}
515
Peter Hurley2c411c12014-10-16 14:59:47 -0400516/**
517 * proc_set_tty - set the controlling terminal
518 *
519 * Only callable by the session leader and only if it does not already have
520 * a controlling terminal.
521 *
Peter Hurleye218eb32014-10-16 14:59:49 -0400522 * Caller must hold: tty_lock()
523 * a readlock on tasklist_lock
Peter Hurley2c411c12014-10-16 14:59:47 -0400524 * sighand lock
525 */
Peter Hurleybce65f12014-10-16 14:59:43 -0400526static void __proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400527{
Peter Hurleyae28fa72014-10-16 14:59:46 -0400528 unsigned long flags;
529
Peter Hurleyae28fa72014-10-16 14:59:46 -0400530 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya3618582014-10-16 14:59:50 -0400531 /*
532 * The session and fg pgrp references will be non-NULL if
533 * tiocsctty() is stealing the controlling tty
534 */
Peter Hurleyae28fa72014-10-16 14:59:46 -0400535 put_pid(tty->session);
536 put_pid(tty->pgrp);
537 tty->pgrp = get_pid(task_pgrp(current));
538 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
539 tty->session = get_pid(task_session(current));
540 if (current->signal->tty) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -0400541 tty_debug(tty, "current tty %s not NULL!!\n",
542 current->signal->tty->name);
Peter Hurleyae28fa72014-10-16 14:59:46 -0400543 tty_kref_put(current->signal->tty);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400544 }
Peter Hurleybce65f12014-10-16 14:59:43 -0400545 put_pid(current->signal->tty_old_pgrp);
546 current->signal->tty = tty_kref_get(tty);
547 current->signal->tty_old_pgrp = NULL;
Peter Hurley11d9bef2014-10-16 14:59:42 -0400548}
549
Peter Hurleybce65f12014-10-16 14:59:43 -0400550static void proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400551{
Peter Hurleybce65f12014-10-16 14:59:43 -0400552 spin_lock_irq(&current->sighand->siglock);
553 __proc_set_tty(tty);
554 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400555}
556
557struct tty_struct *get_current_tty(void)
558{
559 struct tty_struct *tty;
560 unsigned long flags;
561
562 spin_lock_irqsave(&current->sighand->siglock, flags);
563 tty = tty_kref_get(current->signal->tty);
564 spin_unlock_irqrestore(&current->sighand->siglock, flags);
565 return tty;
566}
567EXPORT_SYMBOL_GPL(get_current_tty);
568
569static void session_clear_tty(struct pid *session)
570{
571 struct task_struct *p;
572 do_each_pid_task(session, PIDTYPE_SID, p) {
573 proc_clear_tty(p);
574 } while_each_pid_task(session, PIDTYPE_SID, p);
575}
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/**
578 * tty_wakeup - request more data
579 * @tty: terminal
580 *
581 * Internal and external helper for wakeups of tty. This function
582 * informs the line discipline if present that the driver is ready
583 * to receive more output data.
584 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586void tty_wakeup(struct tty_struct *tty)
587{
588 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
591 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800592 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100593 if (ld->ops->write_wakeup)
594 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 tty_ldisc_deref(ld);
596 }
597 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700598 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599}
600
601EXPORT_SYMBOL_GPL(tty_wakeup);
602
603/**
Peter Hurleyea648a42013-03-06 07:20:53 -0500604 * tty_signal_session_leader - sends SIGHUP to session leader
Peter Hurleyf91e2592013-03-06 07:20:56 -0500605 * @tty controlling tty
606 * @exit_session if non-zero, signal all foreground group processes
Peter Hurleyea648a42013-03-06 07:20:53 -0500607 *
Peter Hurleyf91e2592013-03-06 07:20:56 -0500608 * Send SIGHUP and SIGCONT to the session leader and its process group.
609 * Optionally, signal all processes in the foreground process group.
Peter Hurleyea648a42013-03-06 07:20:53 -0500610 *
611 * Returns the number of processes in the session with this tty
612 * as their controlling terminal. This value is used to drop
613 * tty references for those processes.
614 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500615static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
Peter Hurleyea648a42013-03-06 07:20:53 -0500616{
617 struct task_struct *p;
Peter Hurleyea648a42013-03-06 07:20:53 -0500618 int refs = 0;
Peter Hurleyf91e2592013-03-06 07:20:56 -0500619 struct pid *tty_pgrp = NULL;
Peter Hurleyea648a42013-03-06 07:20:53 -0500620
621 read_lock(&tasklist_lock);
622 if (tty->session) {
623 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
624 spin_lock_irq(&p->sighand->siglock);
625 if (p->signal->tty == tty) {
626 p->signal->tty = NULL;
627 /* We defer the dereferences outside fo
628 the tasklist lock */
629 refs++;
630 }
631 if (!p->signal->leader) {
632 spin_unlock_irq(&p->sighand->siglock);
633 continue;
634 }
635 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
636 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
637 put_pid(p->signal->tty_old_pgrp); /* A noop */
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500638 spin_lock(&tty->ctrl_lock);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500639 tty_pgrp = get_pid(tty->pgrp);
Peter Hurleyea648a42013-03-06 07:20:53 -0500640 if (tty->pgrp)
641 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500642 spin_unlock(&tty->ctrl_lock);
Peter Hurleyea648a42013-03-06 07:20:53 -0500643 spin_unlock_irq(&p->sighand->siglock);
644 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
645 }
646 read_unlock(&tasklist_lock);
647
Peter Hurleyf91e2592013-03-06 07:20:56 -0500648 if (tty_pgrp) {
649 if (exit_session)
650 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
651 put_pid(tty_pgrp);
652 }
653
Peter Hurleyea648a42013-03-06 07:20:53 -0500654 return refs;
655}
656
657/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200658 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000659 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700660 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800661 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700662 * synchronous but doesn't hold any locks, so we need to make sure we
663 * have the appropriate locks for what we're doing.
664 *
665 * The hangup event clears any pending redirections onto the hung up
666 * device. It ensures future writes will error and it does the needed
667 * line discipline hangup and signal delivery. The tty object itself
668 * remains intact.
669 *
670 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200671 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800672 * redirect lock for undoing redirection
673 * file list lock for manipulating list of ttys
Peter Hurley137084b2013-06-15 07:04:46 -0400674 * tty_ldiscs_lock from called functions
Peter Hurley6a1c0682013-06-15 09:14:23 -0400675 * termios_rwsem resetting termios data
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800676 * tasklist_lock to walk task list for hangup event
677 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500679static void __tty_hangup(struct tty_struct *tty, int exit_session)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680{
Alan Cox37bdfb02008-02-08 04:18:47 -0800681 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 struct file *filp, *f = NULL;
Nick Piggind996b622010-08-18 04:37:36 +1000683 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 int closecount = 0, n;
Peter Hurleyea648a42013-03-06 07:20:53 -0500685 int refs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
687 if (!tty)
688 return;
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000692 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 f = redirect;
694 redirect = NULL;
695 }
696 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800697
Alan Cox89c8d912012-08-08 16:30:13 +0100698 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200699
Peter Hurleycb50e522013-07-31 14:05:45 -0400700 if (test_bit(TTY_HUPPED, &tty->flags)) {
701 tty_unlock(tty);
702 return;
703 }
704
Arnd Bergmannec79d602010-06-01 22:53:01 +0200705 /* inuse_filps is protected by the single tty lock,
706 this really needs to change if we want to flush the
707 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200708 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000709
Nick Pigginee2ffa02010-08-18 04:37:35 +1000710 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000712 list_for_each_entry(priv, &tty->tty_files, list) {
713 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 if (filp->f_op->write == redirected_tty_write)
715 cons_filp = filp;
716 if (filp->f_op->write != tty_write)
717 continue;
718 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200719 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 filp->f_op = &hung_up_tty_fops;
721 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000722 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800723
Peter Hurley25fdf242013-03-06 07:20:57 -0500724 refs = tty_signal_session_leader(tty, exit_session);
725 /* Account for the p->signal references we killed */
726 while (refs--)
727 tty_kref_put(tty);
728
Alan Coxc65c9bc2009-06-11 12:50:12 +0100729 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800730
Peter Hurley20cc2252013-03-06 07:20:54 -0500731 spin_lock_irq(&tty->ctrl_lock);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100732 clear_bit(TTY_THROTTLED, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100733 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600734 put_pid(tty->session);
735 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800736 tty->session = NULL;
737 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 tty->ctrl_status = 0;
Peter Hurley20cc2252013-03-06 07:20:54 -0500739 spin_unlock_irq(&tty->ctrl_lock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800742 * If one of the devices matches a console pointer, we
743 * cannot just call hangup() because that will cause
744 * tty->count and state->count to go out of sync.
745 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 */
747 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700748 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700750 tty->ops->close(tty, cons_filp);
751 } else if (tty->ops->hangup)
Peter Hurley7c6d3402014-06-16 09:17:08 -0400752 tty->ops->hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800753 /*
754 * We don't want to have driver/ldisc interactions beyond
755 * the ones we did here. The driver layer expects no
756 * calls after ->hangup() from the ldisc side. However we
757 * can't yet guarantee all that.
758 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 set_bit(TTY_HUPPED, &tty->flags);
Alan Cox89c8d912012-08-08 16:30:13 +0100760 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 if (f)
763 fput(f);
764}
765
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200766static void do_tty_hangup(struct work_struct *work)
767{
768 struct tty_struct *tty =
769 container_of(work, struct tty_struct, hangup_work);
770
Peter Hurleyf91e2592013-03-06 07:20:56 -0500771 __tty_hangup(tty, 0);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200772}
773
Alan Coxaf9b8972006-08-27 01:24:01 -0700774/**
775 * tty_hangup - trigger a hangup event
776 * @tty: tty to hangup
777 *
778 * A carrier loss (virtual or otherwise) has occurred on this like
779 * schedule a hangup sequence to run after this event.
780 */
781
Alan Cox37bdfb02008-02-08 04:18:47 -0800782void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783{
Peter Hurleyaccff792015-07-12 22:49:09 -0400784 tty_debug_hangup(tty, "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 schedule_work(&tty->hangup_work);
786}
787
788EXPORT_SYMBOL(tty_hangup);
789
Alan Coxaf9b8972006-08-27 01:24:01 -0700790/**
791 * tty_vhangup - process vhangup
792 * @tty: tty to hangup
793 *
794 * The user has asked via system call for the terminal to be hung up.
795 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200796 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700797 */
798
Alan Cox37bdfb02008-02-08 04:18:47 -0800799void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800{
Peter Hurleyaccff792015-07-12 22:49:09 -0400801 tty_debug_hangup(tty, "\n");
Peter Hurleyf91e2592013-03-06 07:20:56 -0500802 __tty_hangup(tty, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
Alan Cox37bdfb02008-02-08 04:18:47 -0800804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805EXPORT_SYMBOL(tty_vhangup);
806
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200807
Alan Coxaf9b8972006-08-27 01:24:01 -0700808/**
Alan Cox2cb59982008-10-13 10:40:30 +0100809 * tty_vhangup_self - process vhangup for own ctty
810 *
811 * Perform a vhangup on the current controlling tty
812 */
813
814void tty_vhangup_self(void)
815{
816 struct tty_struct *tty;
817
Alan Cox2cb59982008-10-13 10:40:30 +0100818 tty = get_current_tty();
819 if (tty) {
820 tty_vhangup(tty);
821 tty_kref_put(tty);
822 }
Alan Cox2cb59982008-10-13 10:40:30 +0100823}
824
825/**
Peter Hurleyf91e2592013-03-06 07:20:56 -0500826 * tty_vhangup_session - hangup session leader exit
827 * @tty: tty to hangup
828 *
829 * The session leader is exiting and hanging up its controlling terminal.
830 * Every process in the foreground process group is signalled SIGHUP.
831 *
832 * We do this synchronously so that when the syscall returns the process
833 * is complete. That guarantee is necessary for security reasons.
834 */
835
Changlong Xie44a459f2013-03-20 08:42:04 +0800836static void tty_vhangup_session(struct tty_struct *tty)
Peter Hurleyf91e2592013-03-06 07:20:56 -0500837{
Peter Hurleyaccff792015-07-12 22:49:09 -0400838 tty_debug_hangup(tty, "\n");
Peter Hurleyf91e2592013-03-06 07:20:56 -0500839 __tty_hangup(tty, 1);
840}
841
842/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700843 * tty_hung_up_p - was tty hung up
844 * @filp: file pointer of tty
845 *
846 * Return true if the tty has been subject to a vhangup or a carrier
847 * loss
848 */
849
Alan Cox37bdfb02008-02-08 04:18:47 -0800850int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
852 return (filp->f_op == &hung_up_tty_fops);
853}
854
855EXPORT_SYMBOL(tty_hung_up_p);
856
Alan Coxaf9b8972006-08-27 01:24:01 -0700857/**
858 * disassociate_ctty - disconnect controlling tty
859 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700861 * This function is typically called only by the session leader, when
862 * it wants to disassociate itself from its controlling tty.
863 *
864 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
866 * (2) Clears the tty from being controlling the session
867 * (3) Clears the controlling tty for all processes in the
868 * session group.
869 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700870 * The argument on_exit is set to 1 if called when a process is
871 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
872 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800873 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200874 * BTM is taken for hysterical raisins, and held when
875 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800876 * tty_mutex is taken to protect tty
877 * ->siglock is taken to protect ->signal/->sighand
878 * tasklist_lock is taken to walk process list for sessions
879 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882void disassociate_ctty(int on_exit)
883{
884 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Alan Cox5ec93d12009-11-30 13:18:45 +0000886 if (!current->signal->leader)
887 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800889 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 if (tty) {
Peter Hurleyf91e2592013-03-06 07:20:56 -0500891 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
892 tty_vhangup_session(tty);
893 } else {
894 struct pid *tty_pgrp = tty_get_pgrp(tty);
895 if (tty_pgrp) {
896 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Oleg Nesterov03e12612013-09-15 17:50:26 +0200897 if (!on_exit)
898 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500899 put_pid(tty_pgrp);
900 }
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200901 }
Alan Cox452a00d2008-10-13 10:39:13 +0100902 tty_kref_put(tty);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500903
Eric W. Biederman680a9672007-02-12 00:52:52 -0800904 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800905 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800906 spin_lock_irq(&current->sighand->siglock);
907 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800908 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800909 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800910 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800911 kill_pgrp(old_pgrp, SIGHUP, on_exit);
912 kill_pgrp(old_pgrp, SIGCONT, on_exit);
913 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 return;
916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800918 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700919 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800920 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800921
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800922 tty = tty_kref_get(current->signal->tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800923 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700924 unsigned long flags;
925 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800926 put_pid(tty->session);
927 put_pid(tty->pgrp);
928 tty->session = NULL;
929 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700930 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100931 tty_kref_put(tty);
Peter Hurleyaccff792015-07-12 22:49:09 -0400932 } else
933 tty_debug_hangup(tty, "no current tty\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800935 spin_unlock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 /* Now clear signal->tty under the lock */
937 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800938 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940}
941
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700942/**
943 *
944 * no_tty - Ensure the current process does not have a controlling tty
945 */
946void no_tty(void)
947{
Alan Cox3af502b2012-05-03 22:21:53 +0100948 /* FIXME: Review locking here. The tty_lock never covered any race
949 between a new association and proc_clear_tty but possible we need
950 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700951 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000952 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700953 proc_clear_tty(tsk);
954}
955
Alan Coxaf9b8972006-08-27 01:24:01 -0700956
957/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200958 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700959 * @tty: tty to stop
960 *
Peter Hurley01adc802014-09-10 15:06:32 -0400961 * Perform flow control to the driver. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700962 * on an already stopped device and will not re-call the driver
963 * method.
964 *
965 * This functionality is used by both the line disciplines for
966 * halting incoming flow and by the driver. It may therefore be
967 * called from any context, may be under the tty atomic_write_lock
968 * but not always.
969 *
970 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400971 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700972 */
973
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400974void __stop_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975{
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400976 if (tty->stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 return;
978 tty->stopped = 1;
Alan Coxf34d7a52008-04-30 00:54:13 -0700979 if (tty->ops->stop)
Peter Hurleyc961bfb2014-11-05 12:26:25 -0500980 tty->ops->stop(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981}
982
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400983void stop_tty(struct tty_struct *tty)
984{
985 unsigned long flags;
986
987 spin_lock_irqsave(&tty->flow_lock, flags);
988 __stop_tty(tty);
989 spin_unlock_irqrestore(&tty->flow_lock, flags);
990}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991EXPORT_SYMBOL(stop_tty);
992
Alan Coxaf9b8972006-08-27 01:24:01 -0700993/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200994 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700995 * @tty: tty to start
996 *
Peter Hurley01adc802014-09-10 15:06:32 -0400997 * Start a tty that has been stopped if at all possible. If this
998 * tty was previous stopped and is now being started, the driver
999 * start method is invoked and the line discipline woken.
Alan Coxaf9b8972006-08-27 01:24:01 -07001000 *
1001 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001002 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07001003 */
1004
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001005void __start_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006{
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001007 if (!tty->stopped || tty->flow_stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 return;
1009 tty->stopped = 0;
Alan Coxf34d7a52008-04-30 00:54:13 -07001010 if (tty->ops->start)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05001011 tty->ops->start(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013}
1014
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001015void start_tty(struct tty_struct *tty)
1016{
1017 unsigned long flags;
1018
1019 spin_lock_irqsave(&tty->flow_lock, flags);
1020 __start_tty(tty);
1021 spin_unlock_irqrestore(&tty->flow_lock, flags);
1022}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023EXPORT_SYMBOL(start_tty);
1024
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001025static void tty_update_time(struct timespec *time)
1026{
Jiri Slabyf0bf0bd2015-02-27 18:40:31 +01001027 unsigned long sec = get_seconds();
Greg Kroah-Hartmanfbf47632015-03-26 23:10:27 +01001028
1029 /*
1030 * We only care if the two values differ in anything other than the
1031 * lower three bits (i.e every 8 seconds). If so, then we can update
1032 * the time of the tty device, otherwise it could be construded as a
1033 * security leak to let userspace know the exact timing of the tty.
1034 */
1035 if ((sec ^ time->tv_sec) & ~7)
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001036 time->tv_sec = sec;
1037}
1038
Alan Coxaf9b8972006-08-27 01:24:01 -07001039/**
1040 * tty_read - read method for tty device files
1041 * @file: pointer to tty file
1042 * @buf: user buffer
1043 * @count: size of user buffer
1044 * @ppos: unused
1045 *
1046 * Perform the read system call function on this terminal device. Checks
1047 * for hung up devices before calling the line discipline method.
1048 *
1049 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -07001050 * Locks the line discipline internally while needed. Multiple
1051 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -07001052 */
1053
Alan Cox37bdfb02008-02-08 04:18:47 -08001054static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 loff_t *ppos)
1056{
1057 int i;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001058 struct inode *inode = file_inode(file);
Nick Piggind996b622010-08-18 04:37:36 +10001059 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 struct tty_ldisc *ld;
1061
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001062 if (tty_paranoia_check(tty, inode, "tty_read"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 return -EIO;
1064 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1065 return -EIO;
1066
1067 /* We want to wait for the line discipline to sort out in this
1068 situation */
1069 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001070 if (ld->ops->read)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05001071 i = ld->ops->read(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 else
1073 i = -EIO;
1074 tty_ldisc_deref(ld);
Jiri Slabyb0de59b2013-02-15 15:25:05 +01001075
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001076 if (i > 0)
1077 tty_update_time(&inode->i_atime);
1078
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 return i;
1080}
1081
Peter Hurley136d5252014-09-10 15:06:34 -04001082static void tty_write_unlock(struct tty_struct *tty)
Alan Cox9c1729d2007-07-15 23:39:43 -07001083{
1084 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -07001085 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -07001086}
1087
Peter Hurley136d5252014-09-10 15:06:34 -04001088static int tty_write_lock(struct tty_struct *tty, int ndelay)
Alan Cox9c1729d2007-07-15 23:39:43 -07001089{
1090 if (!mutex_trylock(&tty->atomic_write_lock)) {
1091 if (ndelay)
1092 return -EAGAIN;
1093 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1094 return -ERESTARTSYS;
1095 }
1096 return 0;
1097}
1098
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099/*
1100 * Split writes up in sane blocksizes to avoid
1101 * denial-of-service type attacks
1102 */
1103static inline ssize_t do_tty_write(
1104 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1105 struct tty_struct *tty,
1106 struct file *file,
1107 const char __user *buf,
1108 size_t count)
1109{
Alan Cox9c1729d2007-07-15 23:39:43 -07001110 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001112
Alan Cox9c1729d2007-07-15 23:39:43 -07001113 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1114 if (ret < 0)
1115 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
1117 /*
1118 * We chunk up writes into a temporary buffer. This
1119 * simplifies low-level drivers immensely, since they
1120 * don't have locking issues and user mode accesses.
1121 *
1122 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1123 * big chunk-size..
1124 *
1125 * The default chunk-size is 2kB, because the NTTY
1126 * layer has problems with bigger chunks. It will
1127 * claim to be able to handle more characters than
1128 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001129 *
1130 * FIXME: This can probably go away now except that 64K chunks
1131 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 */
1133 chunk = 2048;
1134 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1135 chunk = 65536;
1136 if (count < chunk)
1137 chunk = count;
1138
Ingo Molnar70522e12006-03-23 03:00:31 -08001139 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001141 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
1143 if (chunk < 1024)
1144 chunk = 1024;
1145
Jason Wessel402fda92008-10-13 10:45:36 +01001146 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1147 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001148 ret = -ENOMEM;
1149 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 }
1151 kfree(tty->write_buf);
1152 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001153 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 }
1155
1156 /* Do the write .. */
1157 for (;;) {
1158 size_t size = count;
1159 if (size > chunk)
1160 size = chunk;
1161 ret = -EFAULT;
1162 if (copy_from_user(tty->write_buf, buf, size))
1163 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 if (ret <= 0)
1166 break;
1167 written += ret;
1168 buf += ret;
1169 count -= ret;
1170 if (!count)
1171 break;
1172 ret = -ERESTARTSYS;
1173 if (signal_pending(current))
1174 break;
1175 cond_resched();
1176 }
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001177 if (written) {
1178 tty_update_time(&file_inode(file)->i_mtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 ret = written;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001180 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001181out:
1182 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 return ret;
1184}
1185
Alan Cox95f9bfc2008-10-13 10:39:23 +01001186/**
1187 * tty_write_message - write a message to a certain tty, not just the console.
1188 * @tty: the destination tty_struct
1189 * @msg: the message to write
1190 *
1191 * This is used for messages that need to be redirected to a specific tty.
1192 * We don't put it into the syslog queue right now maybe in the future if
1193 * really needed.
1194 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001195 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001196 */
1197
1198void tty_write_message(struct tty_struct *tty, char *msg)
1199{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001200 if (tty) {
1201 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001202 tty_lock(tty);
Peter Hurley4b41b952015-10-10 20:28:44 -04001203 if (tty->ops->write && tty->count > 0)
Alan Cox95f9bfc2008-10-13 10:39:23 +01001204 tty->ops->write(tty, msg, strlen(msg));
Peter Hurley4b41b952015-10-10 20:28:44 -04001205 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001206 tty_write_unlock(tty);
1207 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001208 return;
1209}
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Alan Coxaf9b8972006-08-27 01:24:01 -07001212/**
1213 * tty_write - write method for tty device file
1214 * @file: tty file pointer
1215 * @buf: user data to write
1216 * @count: bytes to write
1217 * @ppos: unused
1218 *
1219 * Write data to a tty device via the line discipline.
1220 *
1221 * Locking:
1222 * Locks the line discipline as required
1223 * Writes to the tty driver are serialized by the atomic_write_lock
1224 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001225 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001226 */
1227
Alan Cox37bdfb02008-02-08 04:18:47 -08001228static ssize_t tty_write(struct file *file, const char __user *buf,
1229 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230{
Nick Piggind996b622010-08-18 04:37:36 +10001231 struct tty_struct *tty = file_tty(file);
1232 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001234
Al Viro6131ffa2013-02-27 16:59:05 -05001235 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001237 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001238 (test_bit(TTY_IO_ERROR, &tty->flags)))
1239 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001240 /* Short term debug to catch buggy drivers */
1241 if (tty->ops->write_room == NULL)
1242 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1243 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001244 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001245 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 ret = -EIO;
1247 else
Alan Coxa352def2008-07-16 21:53:12 +01001248 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 tty_ldisc_deref(ld);
1250 return ret;
1251}
1252
Alan Cox37bdfb02008-02-08 04:18:47 -08001253ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1254 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
1256 struct file *p = NULL;
1257
1258 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001259 if (redirect)
1260 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 spin_unlock(&redirect_lock);
1262
1263 if (p) {
1264 ssize_t res;
1265 res = vfs_write(p, buf, count, &p->f_pos);
1266 fput(p);
1267 return res;
1268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 return tty_write(file, buf, count, ppos);
1270}
1271
Peter Hurley136d5252014-09-10 15:06:34 -04001272/**
1273 * tty_send_xchar - send priority character
1274 *
1275 * Send a high priority character to the tty even if stopped
1276 *
1277 * Locking: none for xchar method, write ordering for write method.
1278 */
1279
1280int tty_send_xchar(struct tty_struct *tty, char ch)
1281{
1282 int was_stopped = tty->stopped;
1283
1284 if (tty->ops->send_xchar) {
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001285 down_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001286 tty->ops->send_xchar(tty, ch);
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001287 up_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001288 return 0;
1289 }
1290
1291 if (tty_write_lock(tty, 0) < 0)
1292 return -ERESTARTSYS;
1293
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001294 down_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001295 if (was_stopped)
1296 start_tty(tty);
1297 tty->ops->write(tty, &ch, 1);
1298 if (was_stopped)
1299 stop_tty(tty);
Peter Hurleyee0c1a62015-11-11 08:03:54 -05001300 up_read(&tty->termios_rwsem);
Peter Hurley136d5252014-09-10 15:06:34 -04001301 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);
Peter Hurley25080652015-11-08 13:01:11 -05001583 if (tp == NULL)
Alan Cox36b3c072012-07-17 17:06:57 +01001584 return;
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001585 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001586 }
Alan Cox36b3c072012-07-17 17:06:57 +01001587 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001588}
1589EXPORT_SYMBOL(tty_free_termios);
1590
Peter Hurleya2965b72013-03-11 16:44:35 -04001591/**
Peter Hurley949aa642014-11-05 12:12:57 -05001592 * tty_flush_works - flush all works of a tty/pty pair
1593 * @tty: tty device to flush works for (or either end of a pty pair)
Peter Hurleya2965b72013-03-11 16:44:35 -04001594 *
Peter Hurley949aa642014-11-05 12:12:57 -05001595 * Sync flush all works belonging to @tty (and the 'other' tty).
Peter Hurleya2965b72013-03-11 16:44:35 -04001596 */
1597static void tty_flush_works(struct tty_struct *tty)
1598{
1599 flush_work(&tty->SAK_work);
1600 flush_work(&tty->hangup_work);
Peter Hurley949aa642014-11-05 12:12:57 -05001601 if (tty->link) {
1602 flush_work(&tty->link->SAK_work);
1603 flush_work(&tty->link->hangup_work);
1604 }
Peter Hurleya2965b72013-03-11 16:44:35 -04001605}
Alan Coxfeebed62008-10-13 10:41:30 +01001606
Alan Coxaf9b8972006-08-27 01:24:01 -07001607/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001608 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001609 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001610 *
1611 * Releases memory associated with a tty structure, and clears out the
1612 * driver table slots. This function is called when a device is no longer
1613 * in use. It also gets called when setup of a device fails.
1614 *
1615 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001616 * takes the file list lock internally when working on the list
1617 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001618 *
1619 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001620 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 */
Alan Coxb50989d2009-09-19 13:13:22 -07001622static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623{
Alan Coxb50989d2009-09-19 13:13:22 -07001624 struct tty_struct *tty =
1625 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001626 struct tty_driver *driver = tty->driver;
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001627 struct module *owner = driver->owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Dave Youngf278a2f2009-09-27 16:00:42 +00001629 if (tty->ops->cleanup)
1630 tty->ops->cleanup(tty);
1631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001633 tty_driver_kref_put(driver);
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001634 module_put(owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001635
Nick Pigginee2ffa02010-08-18 04:37:35 +10001636 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001638 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001639
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001640 put_pid(tty->pgrp);
1641 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 free_tty_struct(tty);
1643}
1644
Alan Coxb50989d2009-09-19 13:13:22 -07001645static void queue_release_one_tty(struct kref *kref)
1646{
1647 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001648
Alan Coxb50989d2009-09-19 13:13:22 -07001649 /* The hangup queue is now free so we can reuse it rather than
1650 waste a chunk of memory for each port */
1651 INIT_WORK(&tty->hangup_work, release_one_tty);
1652 schedule_work(&tty->hangup_work);
1653}
1654
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001655/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001656 * tty_kref_put - release a tty kref
1657 * @tty: tty device
1658 *
1659 * Release a reference to a tty device and if need be let the kref
1660 * layer destruct the object for us
1661 */
1662
1663void tty_kref_put(struct tty_struct *tty)
1664{
1665 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001666 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001667}
1668EXPORT_SYMBOL(tty_kref_put);
1669
1670/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001671 * release_tty - release tty structure memory
1672 *
1673 * Release both @tty and a possible linked partner (think pty pair),
1674 * and decrement the refcount of the backing module.
1675 *
1676 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001677 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001678 * takes the file list lock internally when working on the list
1679 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001680 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001681 */
1682static void release_tty(struct tty_struct *tty, int idx)
1683{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001684 /* This should always be true but check for the moment */
1685 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001686 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001687 if (tty->ops->shutdown)
1688 tty->ops->shutdown(tty);
1689 tty_free_termios(tty);
1690 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001691 tty->port->itty = NULL;
Peter Hurley64e377d2013-06-15 09:01:00 -04001692 if (tty->link)
1693 tty->link->port->itty = NULL;
Peter Hurleye1760582015-10-17 16:36:23 -04001694 tty_buffer_cancel_work(tty->port);
Alan Cox36b3c072012-07-17 17:06:57 +01001695
Markus Elfringa211b1a2014-11-21 13:42:29 +01001696 tty_kref_put(tty->link);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001697 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001698}
1699
Alan Coxeeb89d92009-11-30 13:18:29 +00001700/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001701 * tty_release_checks - check a tty before real release
1702 * @tty: tty to check
1703 * @o_tty: link of @tty (if any)
1704 * @idx: index of the tty
1705 *
1706 * Performs some paranoid checking before true release of the @tty.
1707 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1708 */
Peter Hurley359b9fb2014-11-05 12:12:59 -05001709static int tty_release_checks(struct tty_struct *tty, int idx)
Jiri Slaby955787ca2011-11-11 10:47:23 +01001710{
1711#ifdef TTY_PARANOIA_CHECK
1712 if (idx < 0 || idx >= tty->driver->num) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001713 tty_debug(tty, "bad idx %d\n", idx);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001714 return -1;
1715 }
1716
1717 /* not much to check for devpts */
1718 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1719 return 0;
1720
1721 if (tty != tty->driver->ttys[idx]) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001722 tty_debug(tty, "bad driver table[%d] = %p\n",
1723 idx, tty->driver->ttys[idx]);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001724 return -1;
1725 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001726 if (tty->driver->other) {
Peter Hurley359b9fb2014-11-05 12:12:59 -05001727 struct tty_struct *o_tty = tty->link;
1728
Jiri Slaby955787ca2011-11-11 10:47:23 +01001729 if (o_tty != tty->driver->other->ttys[idx]) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001730 tty_debug(tty, "bad other table[%d] = %p\n",
1731 idx, tty->driver->other->ttys[idx]);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001732 return -1;
1733 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001734 if (o_tty->link != tty) {
Peter Hurleye2dfa3d2015-07-12 22:49:08 -04001735 tty_debug(tty, "bad link = %p\n", o_tty->link);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001736 return -1;
1737 }
1738 }
1739#endif
1740 return 0;
1741}
1742
1743/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001744 * tty_release - vfs callback for close
1745 * @inode: inode of tty
1746 * @filp: file pointer for handle to tty
1747 *
1748 * Called the last time each file handle is closed that references
1749 * this tty. There may however be several such references.
1750 *
1751 * Locking:
1752 * Takes bkl. See tty_release_dev
1753 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 * Even releasing the tty structures is a tricky business.. We have
1755 * to be very careful that the structures are all released at the
1756 * same time, as interrupts might otherwise get the wrong pointers.
1757 *
1758 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1759 * lead to double frees or releasing memory still in use.
1760 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001761
1762int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763{
Nick Piggind996b622010-08-18 04:37:36 +10001764 struct tty_struct *tty = file_tty(filp);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001765 struct tty_struct *o_tty = NULL;
1766 int do_sleep, final;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 int idx;
Peter Hurley37b16452014-10-16 13:51:30 -04001768 long timeout = 0;
Peter Hurley494c1ea2014-10-16 13:54:36 -04001769 int once = 1;
Alan Cox37bdfb02008-02-08 04:18:47 -08001770
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001771 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001772 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Alan Cox89c8d912012-08-08 16:30:13 +01001774 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001775 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Arnd Bergmannec79d602010-06-01 22:53:01 +02001777 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
1779 idx = tty->index;
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001780 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1781 tty->driver->subtype == PTY_TYPE_MASTER)
1782 o_tty = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Peter Hurley359b9fb2014-11-05 12:12:59 -05001784 if (tty_release_checks(tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001785 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001786 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Peter Hurleyaccff792015-07-12 22:49:09 -04001789 tty_debug_hangup(tty, "(tty count=%d)...\n", tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790
Alan Coxf34d7a52008-04-30 00:54:13 -07001791 if (tty->ops->close)
1792 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
Peter Hurley2aff5e22014-11-05 12:13:01 -05001794 /* If tty is pty master, lock the slave pty (stable lock order) */
1795 tty_lock_slave(o_tty);
1796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 /*
1798 * Sanity check: if tty->count is going to zero, there shouldn't be
1799 * any waiters on tty->read_wait or tty->write_wait. We test the
1800 * wait queues and kick everyone out _before_ actually starting to
1801 * close. This ensures that we won't block while releasing the tty
1802 * structure.
1803 *
1804 * The test for the o_tty closing is necessary, since the master and
1805 * slave sides may close in any order. If the slave side closes out
1806 * first, its count will be one, since the master side holds an open.
Peter Hurley324c1652014-11-05 12:12:56 -05001807 * Thus this test wouldn't be triggered at the time the slave closed,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 * so we do it now.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 */
1810 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 do_sleep = 0;
1812
Peter Hurley324c1652014-11-05 12:12:56 -05001813 if (tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001815 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 do_sleep++;
1817 }
1818 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001819 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 do_sleep++;
1821 }
1822 }
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001823 if (o_tty && o_tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001825 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 do_sleep++;
1827 }
1828 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001829 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 do_sleep++;
1831 }
1832 }
1833 if (!do_sleep)
1834 break;
1835
Peter Hurley494c1ea2014-10-16 13:54:36 -04001836 if (once) {
1837 once = 0;
1838 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001839 __func__, tty_name(tty));
Peter Hurley494c1ea2014-10-16 13:54:36 -04001840 }
Peter Hurley37b16452014-10-16 13:51:30 -04001841 schedule_timeout_killable(timeout);
1842 if (timeout < 120 * HZ)
1843 timeout = 2 * timeout + 1;
1844 else
1845 timeout = MAX_SCHEDULE_TIMEOUT;
Alan Cox37bdfb02008-02-08 04:18:47 -08001846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001848 if (o_tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001850 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001851 __func__, o_tty->count, tty_name(o_tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 o_tty->count = 0;
1853 }
1854 }
1855 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001856 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
Rasmus Villemoes429b4742015-03-31 15:55:59 +02001857 __func__, tty->count, tty_name(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 tty->count = 0;
1859 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001860
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 /*
1862 * We've decremented tty->count, so we need to remove this file
1863 * descriptor off the tty->tty_files list; this serves two
1864 * purposes:
1865 * - check_tty_count sees the correct number of file descriptors
1866 * associated with this tty.
1867 * - do_tty_hangup no longer sees this file descriptor as
1868 * something that needs to be handled for hangups.
1869 */
Nick Piggind996b622010-08-18 04:37:36 +10001870 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871
1872 /*
1873 * Perform some housekeeping before deciding whether to return.
1874 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 * If _either_ side is closing, make sure there aren't any
1876 * processes that still think tty or o_tty is their controlling
1877 * tty.
1878 */
Peter Hurley324c1652014-11-05 12:12:56 -05001879 if (!tty->count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001881 session_clear_tty(tty->session);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001882 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001883 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 read_unlock(&tasklist_lock);
1885 }
1886
Peter Hurley324c1652014-11-05 12:12:56 -05001887 /* check whether both sides are closing ... */
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001888 final = !tty->count && !(o_tty && o_tty->count);
Peter Hurley324c1652014-11-05 12:12:56 -05001889
Peter Hurley2aff5e22014-11-05 12:13:01 -05001890 tty_unlock_slave(o_tty);
1891 tty_unlock(tty);
1892
Peter Hurley04980702014-11-05 12:12:52 -05001893 /* At this point, the tty->count == 0 should ensure a dead tty
Alan Coxd1552552012-07-27 18:02:54 +01001894 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001895
Peter Hurley324c1652014-11-05 12:12:56 -05001896 if (!final)
Alan Coxeeb89d92009-11-30 13:18:29 +00001897 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001898
Peter Hurleyaccff792015-07-12 22:49:09 -04001899 tty_debug_hangup(tty, "final close\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001901 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 */
Peter Hurley62462ae2014-11-05 12:12:58 -05001903 tty_ldisc_release(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001904
1905 /* Wait for pending work before tty destruction commmences */
1906 tty_flush_works(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001907
Peter Hurleyaccff792015-07-12 22:49:09 -04001908 tty_debug_hangup(tty, "freeing structure...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001910 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001911 * the slots and preserving the termios structure. The tty_unlock_pair
1912 * should be safe as we keep a kref while the tty is locked (so the
1913 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 */
Alan Coxd1552552012-07-27 18:02:54 +01001915 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001916 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001917 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
Alan Coxeeb89d92009-11-30 13:18:29 +00001919 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920}
1921
Alan Coxaf9b8972006-08-27 01:24:01 -07001922/**
Peter Hurley52494ee2014-11-05 12:12:50 -05001923 * tty_open_current_tty - get locked tty of current task
Jiri Slabyb82154a2011-11-09 21:33:19 +01001924 * @device: device number
1925 * @filp: file pointer to tty
Peter Hurley52494ee2014-11-05 12:12:50 -05001926 * @return: locked tty of the current task iff @device is /dev/tty
1927 *
1928 * Performs a re-open of the current task's controlling tty.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001929 *
1930 * We cannot return driver and index like for the other nodes because
1931 * devpts will not work then. It expects inodes to be from devpts FS.
1932 */
1933static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1934{
1935 struct tty_struct *tty;
Peter Hurley52494ee2014-11-05 12:12:50 -05001936 int retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001937
1938 if (device != MKDEV(TTYAUX_MAJOR, 0))
1939 return NULL;
1940
1941 tty = get_current_tty();
1942 if (!tty)
1943 return ERR_PTR(-ENXIO);
1944
1945 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1946 /* noctty = 1; */
Peter Hurley52494ee2014-11-05 12:12:50 -05001947 tty_lock(tty);
1948 tty_kref_put(tty); /* safe to drop the kref now */
1949
1950 retval = tty_reopen(tty);
1951 if (retval < 0) {
1952 tty_unlock(tty);
1953 tty = ERR_PTR(retval);
1954 }
Jiri Slabyb82154a2011-11-09 21:33:19 +01001955 return tty;
1956}
1957
1958/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001959 * tty_lookup_driver - lookup a tty driver for a given device file
1960 * @device: device number
1961 * @filp: file pointer to tty
1962 * @noctty: set if the device should not become a controlling tty
1963 * @index: index for the device in the @return driver
1964 * @return: driver for this inode (with increased refcount)
1965 *
1966 * If @return is not erroneous, the caller is responsible to decrement the
1967 * refcount by tty_driver_kref_put.
1968 *
1969 * Locking: tty_mutex protects get_tty_driver
1970 */
1971static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1972 int *noctty, int *index)
1973{
1974 struct tty_driver *driver;
1975
Jiri Slaby2cd00502011-11-09 21:33:22 +01001976 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001977#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001978 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001979 extern struct tty_driver *console_driver;
1980 driver = tty_driver_kref_get(console_driver);
1981 *index = fg_console;
1982 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001983 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001984 }
1985#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001986 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001987 struct tty_driver *console_driver = console_device(index);
1988 if (console_driver) {
1989 driver = tty_driver_kref_get(console_driver);
1990 if (driver) {
1991 /* Don't let /dev/console block */
1992 filp->f_flags |= O_NONBLOCK;
1993 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001994 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001995 }
1996 }
1997 return ERR_PTR(-ENODEV);
1998 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01001999 default:
2000 driver = get_tty_driver(device, index);
2001 if (!driver)
2002 return ERR_PTR(-ENODEV);
2003 break;
2004 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002005 return driver;
2006}
2007
2008/**
Alan Coxeeb89d92009-11-30 13:18:29 +00002009 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002010 * @inode: inode of device file
2011 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002013 * tty_open and tty_release keep up the tty count that contains the
2014 * number of opens done on a tty. We cannot use the inode-count, as
2015 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002017 * Open-counting is needed for pty masters, as well as for keeping
2018 * track of serial lines: DTR is dropped when the last close happens.
2019 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2020 *
2021 * The termios state of a pty is reset on first open so that
2022 * settings don't persist across reuse.
2023 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002024 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002025 * tty->count should protect the rest.
2026 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01002027 *
2028 * Note: the tty_unlock/lock cases without a ref are only safe due to
2029 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002031
Alan Coxeeb89d92009-11-30 13:18:29 +00002032static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033{
Jiri Slabyb82154a2011-11-09 21:33:19 +01002034 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01002036 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 int index;
2038 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07002039 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040
2041 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08002042
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002044 retval = tty_alloc_file(filp);
2045 if (retval)
2046 return -ENOMEM;
2047
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 noctty = filp->f_flags & O_NOCTTY;
2049 index = -1;
2050 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002051
Jiri Slabyb82154a2011-11-09 21:33:19 +01002052 tty = tty_open_current_tty(device, filp);
Peter Hurley52494ee2014-11-05 12:12:50 -05002053 if (!tty) {
2054 mutex_lock(&tty_mutex);
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002055 driver = tty_lookup_driver(device, filp, &noctty, &index);
2056 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002057 retval = PTR_ERR(driver);
2058 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002061 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01002062 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00002063 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002064 retval = PTR_ERR(tty);
2065 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00002066 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002067
2068 if (tty) {
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002069 mutex_unlock(&tty_mutex);
Peter Hurley52494ee2014-11-05 12:12:50 -05002070 tty_lock(tty);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002071 /* safe to drop the kref from tty_driver_lookup_tty() */
2072 tty_kref_put(tty);
Peter Hurley52494ee2014-11-05 12:12:50 -05002073 retval = tty_reopen(tty);
2074 if (retval < 0) {
2075 tty_unlock(tty);
2076 tty = ERR_PTR(retval);
2077 }
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002078 } else { /* Returns with the tty_lock held for now */
Peter Hurley52494ee2014-11-05 12:12:50 -05002079 tty = tty_init_dev(driver, index);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002080 mutex_unlock(&tty_mutex);
2081 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002082
Peter Hurley52494ee2014-11-05 12:12:50 -05002083 tty_driver_kref_put(driver);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002084 }
2085
Alan Coxeeb89d92009-11-30 13:18:29 +00002086 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002087 retval = PTR_ERR(tty);
2088 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00002089 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002091 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10002092
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002093 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2095 tty->driver->subtype == PTY_TYPE_MASTER)
2096 noctty = 1;
Peter Hurleyaccff792015-07-12 22:49:09 -04002097
2098 tty_debug_hangup(tty, "(tty count=%d)\n", tty->count);
2099
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03002100 if (tty->ops->open)
2101 retval = tty->ops->open(tty, filp);
2102 else
2103 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 filp->f_flags = saved_flags;
2105
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 if (retval) {
Peter Hurleyaccff792015-07-12 22:49:09 -04002107 tty_debug_hangup(tty, "error %d, releasing...\n", retval);
2108
Alan Cox89c8d912012-08-08 16:30:13 +01002109 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00002110 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002111 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002113
2114 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 schedule();
2118 /*
2119 * Need to reset f_op in case a hangup happened.
2120 */
Peter Hurley12569372014-11-05 12:26:24 -05002121 if (tty_hung_up_p(filp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 filp->f_op = &tty_fops;
2123 goto retry_open;
2124 }
Peter Hurleyd4855e12013-11-19 08:46:27 -05002125 clear_bit(TTY_HUPPED, &tty->flags);
Alan Coxeeb89d92009-11-30 13:18:29 +00002126
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002127
Peter Hurley2c411c12014-10-16 14:59:47 -04002128 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002129 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 if (!noctty &&
2131 current->signal->leader &&
2132 !current->signal->tty &&
Jann Horn0c5562712015-10-04 19:29:12 +02002133 tty->session == NULL) {
2134 /*
2135 * Don't let a process that only has write access to the tty
2136 * obtain the privileges associated with having a tty as
2137 * controlling terminal (being able to reopen it with full
2138 * access through /dev/tty, being able to perform pushback).
2139 * Many distributions set the group of all ttys to "tty" and
2140 * grant write-only access to all terminals for setgid tty
2141 * binaries, which should not imply full privileges on all ttys.
2142 *
2143 * This could theoretically break old code that performs open()
2144 * on a write-only file descriptor. In that case, it might be
2145 * necessary to also permit this if
2146 * inode_permission(inode, MAY_READ) == 0.
2147 */
2148 if (filp->f_mode & FMODE_READ)
2149 __proc_set_tty(tty);
2150 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002151 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley2c411c12014-10-16 14:59:47 -04002152 read_unlock(&tasklist_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01002153 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002155err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002156 mutex_unlock(&tty_mutex);
2157 /* after locks to avoid deadlock */
2158 if (!IS_ERR_OR_NULL(driver))
2159 tty_driver_kref_put(driver);
2160err_file:
2161 tty_free_file(filp);
2162 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163}
2164
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002165
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166
Alan Coxaf9b8972006-08-27 01:24:01 -07002167/**
2168 * tty_poll - check tty status
2169 * @filp: file being polled
2170 * @wait: poll wait structures to update
2171 *
2172 * Call the line discipline polling method to obtain the poll
2173 * status of the device.
2174 *
2175 * Locking: locks called line discipline but ldisc poll method
2176 * may be re-entered freely by other callers.
2177 */
2178
Alan Cox37bdfb02008-02-08 04:18:47 -08002179static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180{
Nick Piggind996b622010-08-18 04:37:36 +10002181 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 struct tty_ldisc *ld;
2183 int ret = 0;
2184
Al Viro6131ffa2013-02-27 16:59:05 -05002185 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002187
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002189 if (ld->ops->poll)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002190 ret = ld->ops->poll(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 tty_ldisc_deref(ld);
2192 return ret;
2193}
2194
Arnd Bergmannec79d602010-06-01 22:53:01 +02002195static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196{
Nick Piggind996b622010-08-18 04:37:36 +10002197 struct tty_struct *tty = file_tty(filp);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002198 struct tty_ldisc *ldisc;
Alan Cox47f86832008-04-30 00:53:30 -07002199 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002200 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201
Al Viro6131ffa2013-02-27 16:59:05 -05002202 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002203 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002204
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 retval = fasync_helper(fd, filp, on, &tty->fasync);
2206 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002207 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002209 ldisc = tty_ldisc_ref(tty);
2210 if (ldisc) {
2211 if (ldisc->ops->fasync)
2212 ldisc->ops->fasync(tty, on);
2213 tty_ldisc_deref(ldisc);
2214 }
2215
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002217 enum pid_type type;
2218 struct pid *pid;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002219
Alan Cox47f86832008-04-30 00:53:30 -07002220 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002221 if (tty->pgrp) {
2222 pid = tty->pgrp;
2223 type = PIDTYPE_PGID;
2224 } else {
2225 pid = task_pid(current);
2226 type = PIDTYPE_PID;
2227 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002228 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002229 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002230 __f_setown(filp, pid, type, 0);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002231 put_pid(pid);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002232 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002234out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002235 return retval;
2236}
2237
2238static int tty_fasync(int fd, struct file *filp, int on)
2239{
Alan Cox89c8d912012-08-08 16:30:13 +01002240 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002241 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002242
2243 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002244 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002245 tty_unlock(tty);
2246
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002247 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248}
2249
Alan Coxaf9b8972006-08-27 01:24:01 -07002250/**
2251 * tiocsti - fake input character
2252 * @tty: tty to fake input into
2253 * @p: pointer to character
2254 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002255 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002256 * input management.
2257 *
2258 * FIXME: does not honour flow control ??
2259 *
2260 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -04002261 * Called functions take tty_ldiscs_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002262 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002263 *
2264 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002265 */
2266
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267static int tiocsti(struct tty_struct *tty, char __user *p)
2268{
2269 char ch, mbz = 0;
2270 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002271
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2273 return -EPERM;
2274 if (get_user(ch, p))
2275 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002276 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002278 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 tty_ldisc_deref(ld);
2280 return 0;
2281}
2282
Alan Coxaf9b8972006-08-27 01:24:01 -07002283/**
2284 * tiocgwinsz - implement window query ioctl
2285 * @tty; tty
2286 * @arg: user buffer for result
2287 *
Alan Cox808a0d32006-09-29 02:00:40 -07002288 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002289 *
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002290 * Locking: tty->winsize_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002291 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002292 */
2293
Alan Cox37bdfb02008-02-08 04:18:47 -08002294static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295{
Alan Cox808a0d32006-09-29 02:00:40 -07002296 int err;
2297
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002298 mutex_lock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002299 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002300 mutex_unlock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002301
2302 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303}
2304
Alan Coxaf9b8972006-08-27 01:24:01 -07002305/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002306 * tty_do_resize - resize event
2307 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002308 * @rows: rows (character)
2309 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002310 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002311 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002312 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002313 */
2314
Alan Coxfc6f6232009-01-02 13:43:17 +00002315int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316{
Alan Coxfc6f6232009-01-02 13:43:17 +00002317 struct pid *pgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318
Alan Coxfc6f6232009-01-02 13:43:17 +00002319 /* Lock the tty */
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002320 mutex_lock(&tty->winsize_mutex);
Alan Coxfc6f6232009-01-02 13:43:17 +00002321 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002322 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002323
Peter Hurley5b239542014-10-16 14:59:45 -04002324 /* Signal the foreground process group */
2325 pgrp = tty_get_pgrp(tty);
Alan Cox47f86832008-04-30 00:53:30 -07002326 if (pgrp)
2327 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002328 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002329
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002330 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002331done:
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002332 mutex_unlock(&tty->winsize_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 return 0;
2334}
Martin Schwidefsky4d334fd2013-01-04 14:55:13 +01002335EXPORT_SYMBOL(tty_do_resize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336
Alan Coxaf9b8972006-08-27 01:24:01 -07002337/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002338 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002339 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002340 * @arg: user buffer for result
2341 *
2342 * Copies the user idea of the window size to the kernel. Traditionally
2343 * this is just advisory information but for the Linux console it
2344 * actually has driver level meaning and triggers a VC resize.
2345 *
2346 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002347 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002348 * tty termios mutex and ctrl_lock. The console takes its own lock
2349 * then calls into the default method.
2350 */
2351
Alan Coxfc6f6232009-01-02 13:43:17 +00002352static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002353{
2354 struct winsize tmp_ws;
2355 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2356 return -EFAULT;
2357
2358 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002359 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002360 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002361 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002362}
2363
2364/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002365 * tioccons - allow admin to move logical console
2366 * @file: the file to become console
2367 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002368 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002369 *
2370 * Locking: uses redirect_lock to guard the redirect information
2371 */
2372
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373static int tioccons(struct file *file)
2374{
2375 if (!capable(CAP_SYS_ADMIN))
2376 return -EPERM;
2377 if (file->f_op->write == redirected_tty_write) {
2378 struct file *f;
2379 spin_lock(&redirect_lock);
2380 f = redirect;
2381 redirect = NULL;
2382 spin_unlock(&redirect_lock);
2383 if (f)
2384 fput(f);
2385 return 0;
2386 }
2387 spin_lock(&redirect_lock);
2388 if (redirect) {
2389 spin_unlock(&redirect_lock);
2390 return -EBUSY;
2391 }
Al Virocb0942b2012-08-27 14:48:26 -04002392 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 spin_unlock(&redirect_lock);
2394 return 0;
2395}
2396
Alan Coxaf9b8972006-08-27 01:24:01 -07002397/**
2398 * fionbio - non blocking ioctl
2399 * @file: file to set blocking value
2400 * @p: user parameter
2401 *
2402 * Historical tty interfaces had a blocking control ioctl before
2403 * the generic functionality existed. This piece of history is preserved
2404 * in the expected tty API of posix OS's.
2405 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002406 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002407 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408
2409static int fionbio(struct file *file, int __user *p)
2410{
2411 int nonblock;
2412
2413 if (get_user(nonblock, p))
2414 return -EFAULT;
2415
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002416 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 if (nonblock)
2418 file->f_flags |= O_NONBLOCK;
2419 else
2420 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002421 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422 return 0;
2423}
2424
Alan Coxaf9b8972006-08-27 01:24:01 -07002425/**
2426 * tiocsctty - set controlling tty
2427 * @tty: tty structure
2428 * @arg: user argument
2429 *
2430 * This ioctl is used to manage job control. It permits a session
2431 * leader to set this tty as the controlling tty for the session.
2432 *
2433 * Locking:
Peter Hurleye218eb32014-10-16 14:59:49 -04002434 * Takes tty_lock() to serialize proc_set_tty() for this tty
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002435 * Takes tasklist_lock internally to walk sessions
2436 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002437 */
2438
Jann Horn0c5562712015-10-04 19:29:12 +02002439static int tiocsctty(struct tty_struct *tty, struct file *file, int arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002441 int ret = 0;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002442
Peter Hurleye218eb32014-10-16 14:59:49 -04002443 tty_lock(tty);
Peter Hurley2c411c12014-10-16 14:59:47 -04002444 read_lock(&tasklist_lock);
2445
2446 if (current->signal->leader && (task_session(current) == tty->session))
2447 goto unlock;
2448
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 /*
2450 * The process must be a session leader and
2451 * not have a controlling tty already.
2452 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002453 if (!current->signal->leader || current->signal->tty) {
2454 ret = -EPERM;
2455 goto unlock;
2456 }
2457
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002458 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 /*
2460 * This tty is already the controlling
2461 * tty for another session group!
2462 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002463 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 /*
2465 * Steal it away
2466 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002467 session_clear_tty(tty->session);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002468 } else {
2469 ret = -EPERM;
2470 goto unlock;
2471 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 }
Jann Horn0c5562712015-10-04 19:29:12 +02002473
2474 /* See the comment in tty_open(). */
2475 if ((file->f_mode & FMODE_READ) == 0 && !capable(CAP_SYS_ADMIN)) {
2476 ret = -EPERM;
2477 goto unlock;
2478 }
2479
Peter Hurleybce65f12014-10-16 14:59:43 -04002480 proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002481unlock:
Peter Hurley2c411c12014-10-16 14:59:47 -04002482 read_unlock(&tasklist_lock);
Peter Hurleye218eb32014-10-16 14:59:49 -04002483 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002484 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485}
2486
Alan Coxaf9b8972006-08-27 01:24:01 -07002487/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002488 * tty_get_pgrp - return a ref counted pgrp pid
2489 * @tty: tty to read
2490 *
2491 * Returns a refcounted instance of the pid struct for the process
2492 * group controlling the tty.
2493 */
2494
2495struct pid *tty_get_pgrp(struct tty_struct *tty)
2496{
2497 unsigned long flags;
2498 struct pid *pgrp;
2499
2500 spin_lock_irqsave(&tty->ctrl_lock, flags);
2501 pgrp = get_pid(tty->pgrp);
2502 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2503
2504 return pgrp;
2505}
2506EXPORT_SYMBOL_GPL(tty_get_pgrp);
2507
Peter Hurleye1c22962014-10-16 14:59:48 -04002508/*
2509 * This checks not only the pgrp, but falls back on the pid if no
2510 * satisfactory pgrp is found. I dunno - gdb doesn't work correctly
2511 * without this...
2512 *
2513 * The caller must hold rcu lock or the tasklist lock.
2514 */
2515static struct pid *session_of_pgrp(struct pid *pgrp)
2516{
2517 struct task_struct *p;
2518 struct pid *sid = NULL;
2519
2520 p = pid_task(pgrp, PIDTYPE_PGID);
2521 if (p == NULL)
2522 p = pid_task(pgrp, PIDTYPE_PID);
2523 if (p != NULL)
2524 sid = task_session(p);
2525
2526 return sid;
2527}
2528
Alan Cox5d0fdf12008-04-30 00:53:31 -07002529/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002530 * tiocgpgrp - get process group
2531 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002532 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002533 * @p: returned pid
2534 *
2535 * Obtain the process group of the tty. If there is no process group
2536 * return an error.
2537 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002538 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002539 */
2540
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2542{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002543 struct pid *pid;
2544 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 /*
2546 * (tty == real_tty) is a cheap way of
2547 * testing if the tty is NOT a master pty.
2548 */
2549 if (tty == real_tty && current->signal->tty != real_tty)
2550 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002551 pid = tty_get_pgrp(real_tty);
2552 ret = put_user(pid_vnr(pid), p);
2553 put_pid(pid);
2554 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555}
2556
Alan Coxaf9b8972006-08-27 01:24:01 -07002557/**
2558 * tiocspgrp - attempt to set process group
2559 * @tty: tty passed by user
2560 * @real_tty: tty side device matching tty passed by user
2561 * @p: pid pointer
2562 *
2563 * Set the process group of the tty to the session passed. Only
2564 * permitted where the tty session is our session.
2565 *
Alan Cox47f86832008-04-30 00:53:30 -07002566 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002567 */
2568
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2570{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002571 struct pid *pgrp;
2572 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 int retval = tty_check_change(real_tty);
2574
2575 if (retval == -EIO)
2576 return -ENOTTY;
2577 if (retval)
2578 return retval;
2579 if (!current->signal->tty ||
2580 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002581 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002583 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002585 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002587 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002588 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002589 retval = -ESRCH;
2590 if (!pgrp)
2591 goto out_unlock;
2592 retval = -EPERM;
2593 if (session_of_pgrp(pgrp) != task_session(current))
2594 goto out_unlock;
2595 retval = 0;
Peter Hurley1e86b5b2015-10-10 20:28:43 -04002596 spin_lock_irq(&tty->ctrl_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002597 put_pid(real_tty->pgrp);
2598 real_tty->pgrp = get_pid(pgrp);
Peter Hurley1e86b5b2015-10-10 20:28:43 -04002599 spin_unlock_irq(&tty->ctrl_lock);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002600out_unlock:
2601 rcu_read_unlock();
2602 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603}
2604
Alan Coxaf9b8972006-08-27 01:24:01 -07002605/**
2606 * tiocgsid - get session id
2607 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002608 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002609 * @p: pointer to returned session id
2610 *
2611 * Obtain the session id of the tty. If there is no session
2612 * return an error.
2613 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002614 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002615 */
2616
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2618{
2619 /*
2620 * (tty == real_tty) is a cheap way of
2621 * testing if the tty is NOT a master pty.
2622 */
2623 if (tty == real_tty && current->signal->tty != real_tty)
2624 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002625 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002627 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628}
2629
Alan Coxaf9b8972006-08-27 01:24:01 -07002630/**
2631 * tiocsetd - set line discipline
2632 * @tty: tty device
2633 * @p: pointer to user data
2634 *
2635 * Set the line discipline according to user request.
2636 *
2637 * Locking: see tty_set_ldisc, this function is just a helper
2638 */
2639
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640static int tiocsetd(struct tty_struct *tty, int __user *p)
2641{
2642 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002643 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644
2645 if (get_user(ldisc, p))
2646 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002647
Alan Cox04f378b2008-04-30 00:53:29 -07002648 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002649
2650 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651}
2652
Alan Coxaf9b8972006-08-27 01:24:01 -07002653/**
2654 * send_break - performed time break
2655 * @tty: device to break on
2656 * @duration: timeout in mS
2657 *
2658 * Perform a timed break on hardware that lacks its own driver level
2659 * timed break functionality.
2660 *
2661 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002662 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002663 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002664 */
2665
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002666static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667{
Alan Cox9e989662008-07-22 11:18:03 +01002668 int retval;
2669
2670 if (tty->ops->break_ctl == NULL)
2671 return 0;
2672
2673 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2674 retval = tty->ops->break_ctl(tty, duration);
2675 else {
2676 /* Do the work ourselves */
2677 if (tty_write_lock(tty, 0) < 0)
2678 return -EINTR;
2679 retval = tty->ops->break_ctl(tty, -1);
2680 if (retval)
2681 goto out;
2682 if (!signal_pending(current))
2683 msleep_interruptible(duration);
2684 retval = tty->ops->break_ctl(tty, 0);
2685out:
2686 tty_write_unlock(tty);
2687 if (signal_pending(current))
2688 retval = -EINTR;
2689 }
2690 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691}
2692
Alan Coxaf9b8972006-08-27 01:24:01 -07002693/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002694 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002695 * @tty: tty device
2696 * @file: user file pointer
2697 * @p: pointer to result
2698 *
2699 * Obtain the modem status bits from the tty driver if the feature
2700 * is supported. Return -EINVAL if it is not available.
2701 *
2702 * Locking: none (up to the driver)
2703 */
2704
Alan Cox60b33c12011-02-14 16:26:14 +00002705static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706{
2707 int retval = -EINVAL;
2708
Alan Coxf34d7a52008-04-30 00:54:13 -07002709 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002710 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711
2712 if (retval >= 0)
2713 retval = put_user(retval, p);
2714 }
2715 return retval;
2716}
2717
Alan Coxaf9b8972006-08-27 01:24:01 -07002718/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002719 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002720 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002721 * @cmd: command - clear bits, set bits or set all
2722 * @p: pointer to desired bits
2723 *
2724 * Set the modem status bits from the tty driver if the feature
2725 * is supported. Return -EINVAL if it is not available.
2726 *
2727 * Locking: none (up to the driver)
2728 */
2729
Alan Cox20b9d172011-02-14 16:26:50 +00002730static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 unsigned __user *p)
2732{
Alan Coxae677512008-07-16 21:56:54 +01002733 int retval;
2734 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735
Alan Coxae677512008-07-16 21:56:54 +01002736 if (tty->ops->tiocmset == NULL)
2737 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738
Alan Coxae677512008-07-16 21:56:54 +01002739 retval = get_user(val, p);
2740 if (retval)
2741 return retval;
2742 set = clear = 0;
2743 switch (cmd) {
2744 case TIOCMBIS:
2745 set = val;
2746 break;
2747 case TIOCMBIC:
2748 clear = val;
2749 break;
2750 case TIOCMSET:
2751 set = val;
2752 clear = ~val;
2753 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754 }
Alan Coxae677512008-07-16 21:56:54 +01002755 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2756 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002757 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758}
2759
Alan Coxd281da72010-09-16 18:21:24 +01002760static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2761{
2762 int retval = -EINVAL;
2763 struct serial_icounter_struct icount;
2764 memset(&icount, 0, sizeof(icount));
2765 if (tty->ops->get_icount)
2766 retval = tty->ops->get_icount(tty, &icount);
2767 if (retval != 0)
2768 return retval;
2769 if (copy_to_user(arg, &icount, sizeof(icount)))
2770 return -EFAULT;
2771 return 0;
2772}
2773
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002774static void tty_warn_deprecated_flags(struct serial_struct __user *ss)
2775{
2776 static DEFINE_RATELIMIT_STATE(depr_flags,
2777 DEFAULT_RATELIMIT_INTERVAL,
2778 DEFAULT_RATELIMIT_BURST);
2779 char comm[TASK_COMM_LEN];
2780 int flags;
2781
2782 if (get_user(flags, &ss->flags))
2783 return;
2784
2785 flags &= ASYNC_DEPRECATED;
2786
2787 if (flags && __ratelimit(&depr_flags))
2788 pr_warning("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n",
2789 __func__, get_task_comm(comm, current), flags);
2790}
2791
Peter Hurley8f166e02014-10-16 14:59:41 -04002792/*
2793 * if pty, return the slave side (real_tty)
2794 * otherwise, return self
2795 */
2796static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +01002797{
2798 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2799 tty->driver->subtype == PTY_TYPE_MASTER)
2800 tty = tty->link;
2801 return tty;
2802}
Alan Coxe8b70e72009-06-11 12:48:02 +01002803
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804/*
2805 * Split this up, as gcc can choke on it otherwise..
2806 */
Alan Cox04f378b2008-04-30 00:53:29 -07002807long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808{
Nick Piggind996b622010-08-18 04:37:36 +10002809 struct tty_struct *tty = file_tty(file);
2810 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811 void __user *p = (void __user *)arg;
2812 int retval;
2813 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002814
Al Viro6131ffa2013-02-27 16:59:05 -05002815 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002816 return -EINVAL;
2817
Alan Coxe8b70e72009-06-11 12:48:02 +01002818 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819
2820 /*
2821 * Factor out some common prep work
2822 */
2823 switch (cmd) {
2824 case TIOCSETD:
2825 case TIOCSBRK:
2826 case TIOCCBRK:
2827 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002828 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 retval = tty_check_change(tty);
2830 if (retval)
2831 return retval;
2832 if (cmd != TIOCCBRK) {
2833 tty_wait_until_sent(tty, 0);
2834 if (signal_pending(current))
2835 return -EINTR;
2836 }
2837 break;
2838 }
2839
Alan Cox9e989662008-07-22 11:18:03 +01002840 /*
2841 * Now do the stuff.
2842 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002843 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002844 case TIOCSTI:
2845 return tiocsti(tty, p);
2846 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002847 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002848 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002849 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002850 case TIOCCONS:
2851 return real_tty != tty ? -EINVAL : tioccons(file);
2852 case FIONBIO:
2853 return fionbio(file, p);
2854 case TIOCEXCL:
2855 set_bit(TTY_EXCLUSIVE, &tty->flags);
2856 return 0;
2857 case TIOCNXCL:
2858 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2859 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002860 case TIOCGEXCL:
2861 {
2862 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2863 return put_user(excl, (int __user *)p);
2864 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002865 case TIOCNOTTY:
2866 if (current->signal->tty != tty)
2867 return -ENOTTY;
2868 no_tty();
2869 return 0;
2870 case TIOCSCTTY:
Jann Horn0c5562712015-10-04 19:29:12 +02002871 return tiocsctty(tty, file, arg);
Alan Cox37bdfb02008-02-08 04:18:47 -08002872 case TIOCGPGRP:
2873 return tiocgpgrp(tty, real_tty, p);
2874 case TIOCSPGRP:
2875 return tiocspgrp(tty, real_tty, p);
2876 case TIOCGSID:
2877 return tiocgsid(tty, real_tty, p);
2878 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002879 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002880 case TIOCSETD:
2881 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002882 case TIOCVHANGUP:
2883 if (!capable(CAP_SYS_ADMIN))
2884 return -EPERM;
2885 tty_vhangup(tty);
2886 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002887 case TIOCGDEV:
2888 {
2889 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2890 return put_user(ret, (unsigned int __user *)p);
2891 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002892 /*
2893 * Break handling
2894 */
2895 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002896 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002897 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002898 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002899 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002900 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002901 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002902 return 0;
2903 case TCSBRK: /* SVID version: non-zero arg --> no break */
2904 /* non-zero arg means wait for all output data
2905 * to be sent (performed above) but don't send break.
2906 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002908 if (!arg)
2909 return send_break(tty, 250);
2910 return 0;
2911 case TCSBRKP: /* support for POSIX tcsendbreak() */
2912 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913
Alan Cox37bdfb02008-02-08 04:18:47 -08002914 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002915 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002916 case TIOCMSET:
2917 case TIOCMBIC:
2918 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002919 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002920 case TIOCGICOUNT:
2921 retval = tty_tiocgicount(tty, p);
2922 /* For the moment allow fall through to the old method */
2923 if (retval != -EINVAL)
2924 return retval;
2925 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002926 case TCFLSH:
2927 switch (arg) {
2928 case TCIFLUSH:
2929 case TCIOFLUSH:
2930 /* flush tty buffer and allow ldisc to process ioctl */
Peter Hurley86c80a82014-11-05 12:13:09 -05002931 tty_buffer_flush(tty, NULL);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002932 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002933 }
2934 break;
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002935 case TIOCSSERIAL:
2936 tty_warn_deprecated_flags(p);
2937 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002939 if (tty->ops->ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002940 retval = tty->ops->ioctl(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941 if (retval != -ENOIOCTLCMD)
2942 return retval;
2943 }
2944 ld = tty_ldisc_ref_wait(tty);
2945 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002946 if (ld->ops->ioctl) {
2947 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002949 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950 }
2951 tty_ldisc_deref(ld);
2952 return retval;
2953}
2954
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002955#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002956static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002957 unsigned long arg)
2958{
Nick Piggind996b622010-08-18 04:37:36 +10002959 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002960 struct tty_ldisc *ld;
2961 int retval = -ENOIOCTLCMD;
2962
Al Viro6131ffa2013-02-27 16:59:05 -05002963 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002964 return -EINVAL;
2965
Alan Coxf34d7a52008-04-30 00:54:13 -07002966 if (tty->ops->compat_ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002967 retval = tty->ops->compat_ioctl(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002968 if (retval != -ENOIOCTLCMD)
2969 return retval;
2970 }
2971
2972 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002973 if (ld->ops->compat_ioctl)
2974 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002975 else
2976 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002977 tty_ldisc_deref(ld);
2978
2979 return retval;
2980}
2981#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982
Al Viroc3c073f2012-08-21 22:32:06 -04002983static int this_tty(const void *t, struct file *file, unsigned fd)
2984{
2985 if (likely(file->f_op->read != tty_read))
2986 return 0;
2987 return file_tty(file) != t ? 0 : fd + 1;
2988}
2989
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990/*
2991 * This implements the "Secure Attention Key" --- the idea is to
2992 * prevent trojan horses by killing all processes associated with this
2993 * tty when the user hits the "Secure Attention Key". Required for
2994 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002995 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996 * This code could be nicer; ideally it should send a HUP, wait a few
2997 * seconds, then send a INT, and then a KILL signal. But you then
2998 * have to coordinate with the init process, since all processes associated
2999 * with the current tty must be dead before the new getty is allowed
3000 * to spawn.
3001 *
3002 * Now, if it would be correct ;-/ The current code has a nasty hole -
3003 * it doesn't catch files in flight. We may send the descriptor to ourselves
3004 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
3005 *
3006 * Nasty bug: do_SAK is being called in interrupt context. This can
3007 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3008 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003009void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010{
3011#ifdef TTY_SOFT_SAK
3012 tty_hangup(tty);
3013#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08003014 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003015 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003016 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08003017
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 if (!tty)
3019 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003020 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08003021
Dan Carpenterb3f13de2006-12-13 00:35:09 -08003022 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023
Alan Coxf34d7a52008-04-30 00:54:13 -07003024 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08003025
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003027 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003028 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08003029 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003030 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003031 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003032 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003033 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003034 /* Now kill any processes that happen to have the
3035 * tty open.
3036 */
3037 do_each_thread(g, p) {
3038 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003039 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003040 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003041 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042 send_sig(SIGKILL, p, 1);
3043 continue;
3044 }
3045 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04003046 i = iterate_fd(p->files, 0, this_tty, tty);
3047 if (i != 0) {
3048 printk(KERN_NOTICE "SAK: killed process %d"
3049 " (%s): fd#%d opened to the tty\n",
3050 task_pid_nr(p), p->comm, i - 1);
3051 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052 }
3053 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003054 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003055 read_unlock(&tasklist_lock);
3056#endif
3057}
3058
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003059static void do_SAK_work(struct work_struct *work)
3060{
3061 struct tty_struct *tty =
3062 container_of(work, struct tty_struct, SAK_work);
3063 __do_SAK(tty);
3064}
3065
Linus Torvalds1da177e2005-04-16 15:20:36 -07003066/*
3067 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3068 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3069 * the values which we write to it will be identical to the values which it
3070 * already has. --akpm
3071 */
3072void do_SAK(struct tty_struct *tty)
3073{
3074 if (!tty)
3075 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076 schedule_work(&tty->SAK_work);
3077}
3078
3079EXPORT_SYMBOL(do_SAK);
3080
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003081static int dev_match_devt(struct device *dev, const void *data)
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003082{
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003083 const dev_t *devt = data;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003084 return dev->devt == *devt;
3085}
3086
3087/* Must put_device() after it's unused! */
3088static struct device *tty_get_device(struct tty_struct *tty)
3089{
3090 dev_t devt = tty_devnum(tty);
3091 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3092}
3093
3094
Alan Coxaf9b8972006-08-27 01:24:01 -07003095/**
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003096 * alloc_tty_struct
Alan Coxaf9b8972006-08-27 01:24:01 -07003097 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003098 * This subroutine allocates and initializes a tty structure.
Alan Coxaf9b8972006-08-27 01:24:01 -07003099 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003100 * Locking: none - tty in question is not exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003102
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003103struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104{
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003105 struct tty_struct *tty;
3106
3107 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
3108 if (!tty)
3109 return NULL;
3110
Alan Cox9c9f4de2008-10-13 10:37:26 +01003111 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003112 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01003113 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003114 tty->session = NULL;
3115 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01003116 mutex_init(&tty->legacy_mutex);
Peter Hurleyd8c1f922013-06-15 09:14:31 -04003117 mutex_init(&tty->throttle_mutex);
Peter Hurley6a1c0682013-06-15 09:14:23 -04003118 init_rwsem(&tty->termios_rwsem);
Peter Hurleydee4a0b2013-07-24 16:43:51 -04003119 mutex_init(&tty->winsize_mutex);
Peter Hurley36697522013-06-15 07:04:48 -04003120 init_ldsem(&tty->ldisc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121 init_waitqueue_head(&tty->write_wait);
3122 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003123 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003124 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07003125 spin_lock_init(&tty->ctrl_lock);
Peter Hurleyf9e053d2014-09-10 15:06:31 -04003126 spin_lock_init(&tty->flow_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003128 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01003129
3130 tty->driver = driver;
3131 tty->ops = driver->ops;
3132 tty->index = idx;
3133 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003134 tty->dev = tty_get_device(tty);
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003135
3136 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003137}
3138
Alan Coxf34d7a52008-04-30 00:54:13 -07003139/**
Jiri Slaby67166712011-03-23 10:48:35 +01003140 * deinitialize_tty_struct
3141 * @tty: tty to deinitialize
3142 *
3143 * This subroutine deinitializes a tty structure that has been newly
3144 * allocated but tty_release cannot be called on that yet.
3145 *
3146 * Locking: none - tty in question must not be exposed at this point
3147 */
3148void deinitialize_tty_struct(struct tty_struct *tty)
3149{
3150 tty_ldisc_deinit(tty);
3151}
3152
3153/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003154 * tty_put_char - write one character to a tty
3155 * @tty: tty
3156 * @ch: character
3157 *
3158 * Write one byte to the tty using the provided put_char method
3159 * if present. Returns the number of characters successfully output.
3160 *
3161 * Note: the specific put_char operation in the driver layer may go
3162 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003164
Alan Coxf34d7a52008-04-30 00:54:13 -07003165int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166{
Alan Coxf34d7a52008-04-30 00:54:13 -07003167 if (tty->ops->put_char)
3168 return tty->ops->put_char(tty, ch);
3169 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170}
Alan Coxf34d7a52008-04-30 00:54:13 -07003171EXPORT_SYMBOL_GPL(tty_put_char);
3172
Alan Coxd81ed102008-10-13 10:41:42 +01003173struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003174
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003175static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3176 unsigned int index, unsigned int count)
3177{
Leon Yuc1a752b2015-09-07 13:08:37 +00003178 int err;
3179
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003180 /* init here, since reused cdevs cause crashes */
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003181 driver->cdevs[index] = cdev_alloc();
3182 if (!driver->cdevs[index])
3183 return -ENOMEM;
Leon Yuc1a752b2015-09-07 13:08:37 +00003184 driver->cdevs[index]->ops = &tty_fops;
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003185 driver->cdevs[index]->owner = driver->owner;
Leon Yuc1a752b2015-09-07 13:08:37 +00003186 err = cdev_add(driver->cdevs[index], dev, count);
3187 if (err)
3188 kobject_put(&driver->cdevs[index]->kobj);
3189 return err;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003190}
3191
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003193 * tty_register_device - register a tty device
3194 * @driver: the tty driver that describes the tty device
3195 * @index: the index in the tty driver for this tty device
3196 * @device: a struct device that is associated with this tty device.
3197 * This field is optional, if there is no known struct device
3198 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003200 * Returns a pointer to the struct device for this tty device
3201 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003202 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003203 * This call is required to be made to register an individual tty device
3204 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3205 * that bit is not set, this function should not be called by a tty
3206 * driver.
3207 *
3208 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003209 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003210
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003211struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3212 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003214 return tty_register_device_attr(driver, index, device, NULL, NULL);
3215}
3216EXPORT_SYMBOL(tty_register_device);
3217
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003218static void tty_device_create_release(struct device *dev)
3219{
3220 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3221 kfree(dev);
3222}
3223
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003224/**
3225 * tty_register_device_attr - register a tty device
3226 * @driver: the tty driver that describes the tty device
3227 * @index: the index in the tty driver for this tty device
3228 * @device: a struct device that is associated with this tty device.
3229 * This field is optional, if there is no known struct device
3230 * for this tty device it can be set to NULL safely.
3231 * @drvdata: Driver data to be set to device.
3232 * @attr_grp: Attribute group to be set on device.
3233 *
3234 * Returns a pointer to the struct device for this tty device
3235 * (or ERR_PTR(-EFOO) on error).
3236 *
3237 * This call is required to be made to register an individual tty device
3238 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3239 * that bit is not set, this function should not be called by a tty
3240 * driver.
3241 *
3242 * Locking: ??
3243 */
3244struct device *tty_register_device_attr(struct tty_driver *driver,
3245 unsigned index, struct device *device,
3246 void *drvdata,
3247 const struct attribute_group **attr_grp)
3248{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003250 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3251 struct device *dev = NULL;
3252 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003253 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
3255 if (index >= driver->num) {
3256 printk(KERN_ERR "Attempt to register invalid tty line number "
3257 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003258 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 }
3260
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 if (driver->type == TTY_DRIVER_TYPE_PTY)
3262 pty_line_name(driver, index, name);
3263 else
3264 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003265
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003266 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003267 retval = tty_cdev_add(driver, devt, index, 1);
3268 if (retval)
3269 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003270 cdev = true;
3271 }
3272
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003273 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3274 if (!dev) {
3275 retval = -ENOMEM;
3276 goto error;
3277 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003278
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003279 dev->devt = devt;
3280 dev->class = tty_class;
3281 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003282 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003283 dev_set_name(dev, "%s", name);
3284 dev->groups = attr_grp;
3285 dev_set_drvdata(dev, drvdata);
3286
3287 retval = device_register(dev);
3288 if (retval)
3289 goto error;
3290
3291 return dev;
3292
3293error:
3294 put_device(dev);
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003295 if (cdev) {
3296 cdev_del(driver->cdevs[index]);
3297 driver->cdevs[index] = NULL;
3298 }
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003299 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003301EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302
3303/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003304 * tty_unregister_device - unregister a tty device
3305 * @driver: the tty driver that describes the tty device
3306 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003308 * If a tty device is registered with a call to tty_register_device() then
3309 * this function must be called when the tty device is gone.
3310 *
3311 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003312 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003313
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314void tty_unregister_device(struct tty_driver *driver, unsigned index)
3315{
Alan Cox37bdfb02008-02-08 04:18:47 -08003316 device_destroy(tty_class,
3317 MKDEV(driver->major, driver->minor_start) + index);
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003318 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3319 cdev_del(driver->cdevs[index]);
3320 driver->cdevs[index] = NULL;
3321 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003322}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323EXPORT_SYMBOL(tty_unregister_device);
3324
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003325/**
3326 * __tty_alloc_driver -- allocate tty driver
3327 * @lines: count of lines this driver can handle at most
3328 * @owner: module which is repsonsible for this driver
3329 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3330 *
3331 * This should not be called directly, some of the provided macros should be
3332 * used instead. Use IS_ERR and friends on @retval.
3333 */
3334struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3335 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003336{
3337 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003338 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003339 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003340
Jiri Slaby0019b402012-08-08 22:26:43 +02003341 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003342 return ERR_PTR(-EINVAL);
3343
Jean Delvare506eb992007-07-15 23:40:14 -07003344 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003345 if (!driver)
3346 return ERR_PTR(-ENOMEM);
3347
3348 kref_init(&driver->kref);
3349 driver->magic = TTY_DRIVER_MAGIC;
3350 driver->num = lines;
3351 driver->owner = owner;
3352 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003353
3354 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3355 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3356 GFP_KERNEL);
3357 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3358 GFP_KERNEL);
3359 if (!driver->ttys || !driver->termios) {
3360 err = -ENOMEM;
3361 goto err_free_all;
3362 }
3363 }
3364
3365 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3366 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3367 GFP_KERNEL);
3368 if (!driver->ports) {
3369 err = -ENOMEM;
3370 goto err_free_all;
3371 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003372 cdevs = lines;
3373 }
3374
3375 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3376 if (!driver->cdevs) {
3377 err = -ENOMEM;
3378 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003379 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003380
Linus Torvalds1da177e2005-04-16 15:20:36 -07003381 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003382err_free_all:
3383 kfree(driver->ports);
3384 kfree(driver->ttys);
3385 kfree(driver->termios);
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003386 kfree(driver->cdevs);
Jiri Slaby16a02082012-08-08 22:26:42 +02003387 kfree(driver);
3388 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003389}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003390EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003391
Alan Cox7d7b93c2008-10-13 10:42:09 +01003392static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003394 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3395 int i;
3396 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003397
3398 if (driver->flags & TTY_DRIVER_INSTALLED) {
3399 /*
3400 * Free the termios and termios_locked structures because
3401 * we don't want to get memory leaks when modular tty
3402 * drivers are removed from the kernel.
3403 */
3404 for (i = 0; i < driver->num; i++) {
3405 tp = driver->termios[i];
3406 if (tp) {
3407 driver->termios[i] = NULL;
3408 kfree(tp);
3409 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003410 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3411 tty_unregister_device(driver, i);
3412 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003413 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003414 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
Richard Wattsa3a10ce2015-05-19 16:06:53 +01003415 cdev_del(driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003416 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003417 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003418 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003419 kfree(driver->termios);
3420 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421 kfree(driver);
3422}
3423
Alan Cox7d7b93c2008-10-13 10:42:09 +01003424void tty_driver_kref_put(struct tty_driver *driver)
3425{
3426 kref_put(&driver->kref, destruct_tty_driver);
3427}
3428EXPORT_SYMBOL(tty_driver_kref_put);
3429
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003430void tty_set_operations(struct tty_driver *driver,
3431 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003432{
Alan Coxf34d7a52008-04-30 00:54:13 -07003433 driver->ops = op;
3434};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435EXPORT_SYMBOL(tty_set_operations);
3436
Alan Cox7d7b93c2008-10-13 10:42:09 +01003437void put_tty_driver(struct tty_driver *d)
3438{
3439 tty_driver_kref_put(d);
3440}
3441EXPORT_SYMBOL(put_tty_driver);
3442
Linus Torvalds1da177e2005-04-16 15:20:36 -07003443/*
3444 * Called by a tty driver to register itself.
3445 */
3446int tty_register_driver(struct tty_driver *driver)
3447{
3448 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003449 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003451 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003454 error = alloc_chrdev_region(&dev, driver->minor_start,
3455 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456 if (!error) {
3457 driver->major = MAJOR(dev);
3458 driver->minor_start = MINOR(dev);
3459 }
3460 } else {
3461 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003462 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003464 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003465 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003467 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3468 error = tty_cdev_add(driver, dev, 0, driver->num);
3469 if (error)
3470 goto err_unreg_char;
3471 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003472
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003473 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003475 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003476
3477 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003478 for (i = 0; i < driver->num; i++) {
3479 d = tty_register_device(driver, i, NULL);
3480 if (IS_ERR(d)) {
3481 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003482 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003483 }
3484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 }
3486 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003487 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003488 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003489
Jiri Slaby16a02082012-08-08 22:26:42 +02003490err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003491 for (i--; i >= 0; i--)
3492 tty_unregister_device(driver, i);
3493
3494 mutex_lock(&tty_mutex);
3495 list_del(&driver->tty_drivers);
3496 mutex_unlock(&tty_mutex);
3497
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003498err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003499 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003500err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003501 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503EXPORT_SYMBOL(tty_register_driver);
3504
3505/*
3506 * Called by a tty driver to unregister itself.
3507 */
3508int tty_unregister_driver(struct tty_driver *driver)
3509{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003510#if 0
3511 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 if (driver->refcount)
3513 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003514#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3516 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003517 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003519 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520 return 0;
3521}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003522
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523EXPORT_SYMBOL(tty_unregister_driver);
3524
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003525dev_t tty_devnum(struct tty_struct *tty)
3526{
3527 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3528}
3529EXPORT_SYMBOL(tty_devnum);
3530
Alan Coxd81ed102008-10-13 10:41:42 +01003531void tty_default_fops(struct file_operations *fops)
3532{
3533 *fops = tty_fops;
3534}
3535
Linus Torvalds1da177e2005-04-16 15:20:36 -07003536/*
3537 * Initialize the console device. This is called *early*, so
3538 * we can't necessarily depend on lots of kernel help here.
3539 * Just do some early initializations, and do the complex setup
3540 * later.
3541 */
3542void __init console_init(void)
3543{
3544 initcall_t *call;
3545
3546 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003547 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548
3549 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003550 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551 * inform about problems etc..
3552 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003553 call = __con_initcall_start;
3554 while (call < __con_initcall_end) {
3555 (*call)();
3556 call++;
3557 }
3558}
3559
Al Viro2c9ede52011-07-23 20:24:48 -04003560static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003561{
3562 if (!mode)
3563 return NULL;
3564 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3565 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3566 *mode = 0666;
3567 return NULL;
3568}
3569
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570static int __init tty_class_init(void)
3571{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003572 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003573 if (IS_ERR(tty_class))
3574 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003575 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003576 return 0;
3577}
3578
3579postcore_initcall(tty_class_init);
3580
3581/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583
Kay Sieversfbc92a32010-12-01 18:51:05 +01003584static ssize_t show_cons_active(struct device *dev,
3585 struct device_attribute *attr, char *buf)
3586{
3587 struct console *cs[16];
3588 int i = 0;
3589 struct console *c;
3590 ssize_t count = 0;
3591
Torben Hohnac751ef2011-01-25 15:07:35 -08003592 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003593 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003594 if (!c->device)
3595 continue;
3596 if (!c->write)
3597 continue;
3598 if ((c->flags & CON_ENABLED) == 0)
3599 continue;
3600 cs[i++] = c;
3601 if (i >= ARRAY_SIZE(cs))
3602 break;
3603 }
Hannes Reinecke723abd82014-02-27 12:30:51 +01003604 while (i--) {
3605 int index = cs[i]->index;
3606 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3607
3608 /* don't resolve tty0 as some programs depend on it */
3609 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3610 count += tty_line_name(drv, index, buf + count);
3611 else
3612 count += sprintf(buf + count, "%s%d",
3613 cs[i]->name, cs[i]->index);
3614
3615 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3616 }
Torben Hohnac751ef2011-01-25 15:07:35 -08003617 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003618
3619 return count;
3620}
3621static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3622
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003623static struct attribute *cons_dev_attrs[] = {
3624 &dev_attr_active.attr,
3625 NULL
3626};
3627
3628ATTRIBUTE_GROUPS(cons_dev);
3629
Kay Sieversfbc92a32010-12-01 18:51:05 +01003630static struct device *consdev;
3631
3632void console_sysfs_notify(void)
3633{
3634 if (consdev)
3635 sysfs_notify(&consdev->kobj, NULL, "active");
3636}
3637
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638/*
3639 * Ok, now we can initialize the rest of the tty devices and can count
3640 * on memory allocations, interrupts etc..
3641 */
David Howells31d1d482010-08-06 16:34:43 +01003642int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003643{
3644 cdev_init(&tty_cdev, &tty_fops);
3645 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3646 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3647 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003648 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003649
3650 cdev_init(&console_cdev, &console_fops);
3651 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3652 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3653 panic("Couldn't register /dev/console driver\n");
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003654 consdev = device_create_with_groups(tty_class, NULL,
3655 MKDEV(TTYAUX_MAJOR, 1), NULL,
3656 cons_dev_groups, "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003657 if (IS_ERR(consdev))
3658 consdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003659
Linus Torvalds1da177e2005-04-16 15:20:36 -07003660#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003661 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003662#endif
3663 return 0;
3664}
David Howells31d1d482010-08-06 16:34:43 +01003665