blob: e5695467598f9b68629738586c5ed9285d8384ae [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (C) 1991, 1992 Linus Torvalds
3 */
4
5/*
6 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
7 * or rs-channels. It also implements echoing, cooked mode etc.
8 *
9 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
10 *
11 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
12 * tty_struct and tty_queue structures. Previously there was an array
13 * of 256 tty_struct's which was statically allocated, and the
14 * tty_queue structures were allocated at boot time. Both are now
15 * dynamically allocated only when the tty is open.
16 *
17 * Also restructured routines so that there is more of a separation
18 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
19 * the low-level tty routines (serial.c, pty.c, console.c). This
Alan Cox37bdfb02008-02-08 04:18:47 -080020 * makes for cleaner and more compact code. -TYT, 9/17/92
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 *
22 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
23 * which can be dynamically activated and de-activated by the line
24 * discipline handling modules (like SLIP).
25 *
26 * NOTE: pay no attention to the line discipline code (yet); its
27 * interface is still subject to change in this version...
28 * -- TYT, 1/31/92
29 *
30 * Added functionality to the OPOST tty handling. No delays, but all
31 * other bits should be there.
32 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
33 *
34 * Rewrote canonical mode and added more termios flags.
35 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
36 *
37 * Reorganized FASYNC support so mouse code can share it.
38 * -- ctm@ardi.com, 9Sep95
39 *
40 * New TIOCLINUX variants added.
41 * -- mj@k332.feld.cvut.cz, 19-Nov-95
Alan Cox37bdfb02008-02-08 04:18:47 -080042 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * Restrict vt switching via ioctl()
44 * -- grif@cs.ucr.edu, 5-Dec-95
45 *
46 * Move console and virtual terminal code to more appropriate files,
47 * implement CONFIG_VT and generalize console device interface.
48 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
49 *
Alan Coxd81ed102008-10-13 10:41:42 +010050 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * -- Bill Hawes <whawes@star.net>, June 97
52 *
53 * Added devfs support.
54 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
55 *
56 * Added support for a Unix98-style ptmx device.
57 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
58 *
59 * Reduced memory usage for older ARM systems
60 * -- Russell King <rmk@arm.linux.org.uk>
61 *
62 * Move do_SAK() into process context. Less stack use in devfs functions.
Alan Cox37bdfb02008-02-08 04:18:47 -080063 * alloc_tty_struct() always uses kmalloc()
64 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 */
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067#include <linux/types.h>
68#include <linux/major.h>
69#include <linux/errno.h>
70#include <linux/signal.h>
71#include <linux/fcntl.h>
72#include <linux/sched.h>
73#include <linux/interrupt.h>
74#include <linux/tty.h>
75#include <linux/tty_driver.h>
76#include <linux/tty_flip.h>
77#include <linux/devpts_fs.h>
78#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040079#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#include <linux/console.h>
81#include <linux/timer.h>
82#include <linux/ctype.h>
83#include <linux/kd.h>
84#include <linux/mm.h>
85#include <linux/string.h>
86#include <linux/slab.h>
87#include <linux/poll.h>
88#include <linux/proc_fs.h>
89#include <linux/init.h>
90#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070092#include <linux/wait.h>
93#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070094#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010095#include <linux/seq_file.h>
Alan Coxd281da72010-09-16 18:21:24 +010096#include <linux/serial.h>
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +020097#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Alan Coxa352def2008-07-16 21:53:12 +010099#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101#include <linux/kbd_kern.h>
102#include <linux/vt_kern.h>
103#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700106#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108#undef TTY_DEBUG_HANGUP
109
110#define TTY_PARANOIA_CHECK 1
111#define CHECK_TTY_COUNT 1
112
Alan Coxedc6afc2006-12-08 02:38:44 -0800113struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 .c_iflag = ICRNL | IXON,
115 .c_oflag = OPOST | ONLCR,
116 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
117 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
118 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800119 .c_cc = INIT_C_CC,
120 .c_ispeed = 38400,
121 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122};
123
124EXPORT_SYMBOL(tty_std_termios);
125
126/* This list gets poked at by procfs and various bits of boot up code. This
127 could do with some rationalisation such as pulling the tty proc function
128 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130LIST_HEAD(tty_drivers); /* linked list of tty drivers */
131
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800132/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800134DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700135EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Nick Pigginee2ffa02010-08-18 04:37:35 +1000137/* Spinlock to protect the tty->tty_files list */
138DEFINE_SPINLOCK(tty_files_lock);
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
141static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800142ssize_t redirected_tty_write(struct file *, const char __user *,
143 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144static unsigned int tty_poll(struct file *, poll_table *);
145static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700146long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700147#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800148static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700149 unsigned long arg);
150#else
151#define tty_compat_ioctl NULL
152#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200153static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800154static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800155static void release_tty(struct tty_struct *tty, int idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Alan Coxaf9b8972006-08-27 01:24:01 -0700157/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700158 * free_tty_struct - free a disused tty
159 * @tty: tty struct to free
160 *
161 * Free the write buffers, tty queue and tty memory itself.
162 *
163 * Locking: none. Must be called after tty is definitely unused
164 */
165
Alan Coxbf970ee2008-10-13 10:42:39 +0100166void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Dan Carpenterdc6802a2012-07-24 12:52:04 +0100168 if (!tty)
169 return;
Markus Elfringa211b1a2014-11-21 13:42:29 +0100170 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 kfree(tty->write_buf);
Alan Cox89c8d912012-08-08 16:30:13 +0100172 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 kfree(tty);
174}
175
Nick Piggind996b622010-08-18 04:37:36 +1000176static inline struct tty_struct *file_tty(struct file *file)
177{
178 return ((struct tty_file_private *)file->private_data)->tty;
179}
180
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200181int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000182{
183 struct tty_file_private *priv;
184
Pekka Enbergf573bd12010-08-24 07:48:34 +0300185 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
186 if (!priv)
187 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000188
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200189 file->private_data = priv;
190
191 return 0;
192}
193
194/* Associate a new file with the tty structure */
195void tty_add_file(struct tty_struct *tty, struct file *file)
196{
197 struct tty_file_private *priv = file->private_data;
198
Nick Piggind996b622010-08-18 04:37:36 +1000199 priv->tty = tty;
200 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000201
202 spin_lock(&tty_files_lock);
203 list_add(&priv->list, &tty->tty_files);
204 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200205}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300206
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200207/**
208 * tty_free_file - free file->private_data
209 *
210 * This shall be used only for fail path handling when tty_add_file was not
211 * called yet.
212 */
213void tty_free_file(struct file *file)
214{
215 struct tty_file_private *priv = file->private_data;
216
217 file->private_data = NULL;
218 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000219}
220
221/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800222static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000223{
224 struct tty_file_private *priv = file->private_data;
225
226 spin_lock(&tty_files_lock);
227 list_del(&priv->list);
228 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200229 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000230}
231
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
234
Alan Coxaf9b8972006-08-27 01:24:01 -0700235/**
236 * tty_name - return tty naming
237 * @tty: tty structure
238 * @buf: buffer for output
239 *
240 * Convert a tty structure into a name. The name reflects the kernel
241 * naming policy and if udev is in use may not reflect user space
242 *
243 * Locking: none
244 */
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246char *tty_name(struct tty_struct *tty, char *buf)
247{
248 if (!tty) /* Hmm. NULL pointer. That's fun. */
249 strcpy(buf, "NULL tty");
250 else
251 strcpy(buf, tty->name);
252 return buf;
253}
254
255EXPORT_SYMBOL(tty_name);
256
Andrew Mortond769a662005-05-05 16:15:50 -0700257int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 const char *routine)
259{
260#ifdef TTY_PARANOIA_CHECK
261 if (!tty) {
262 printk(KERN_WARNING
263 "null TTY for (%d:%d) in %s\n",
264 imajor(inode), iminor(inode), routine);
265 return 1;
266 }
267 if (tty->magic != TTY_MAGIC) {
268 printk(KERN_WARNING
269 "bad magic number for tty struct (%d:%d) in %s\n",
270 imajor(inode), iminor(inode), routine);
271 return 1;
272 }
273#endif
274 return 0;
275}
276
Peter Hurleydeb287e2014-11-05 12:12:55 -0500277/* Caller must hold tty_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278static int check_tty_count(struct tty_struct *tty, const char *routine)
279{
280#ifdef CHECK_TTY_COUNT
281 struct list_head *p;
282 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800283
Nick Pigginee2ffa02010-08-18 04:37:35 +1000284 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 list_for_each(p, &tty->tty_files) {
286 count++;
287 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000288 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
290 tty->driver->subtype == PTY_TYPE_SLAVE &&
291 tty->link && tty->link->count)
292 count++;
293 if (tty->count != count) {
294 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
295 "!= #fd's(%d) in %s\n",
296 tty->name, tty->count, count, routine);
297 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800298 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299#endif
300 return 0;
301}
302
Alan Coxaf9b8972006-08-27 01:24:01 -0700303/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700304 * get_tty_driver - find device of a tty
305 * @dev_t: device identifier
306 * @index: returns the index of the tty
307 *
308 * This routine returns a tty driver structure, given a device number
309 * and also passes back the index number.
310 *
311 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314static struct tty_driver *get_tty_driver(dev_t device, int *index)
315{
316 struct tty_driver *p;
317
318 list_for_each_entry(p, &tty_drivers, tty_drivers) {
319 dev_t base = MKDEV(p->major, p->minor_start);
320 if (device < base || device >= base + p->num)
321 continue;
322 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100323 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 }
325 return NULL;
326}
327
Jason Wesself2d937f2008-04-17 20:05:37 +0200328#ifdef CONFIG_CONSOLE_POLL
329
330/**
331 * tty_find_polling_driver - find device of a polled tty
332 * @name: name string to match
333 * @line: pointer to resulting tty line nr
334 *
335 * This routine returns a tty driver structure, given a name
336 * and the condition that the tty driver is capable of polled
337 * operation.
338 */
339struct tty_driver *tty_find_polling_driver(char *name, int *line)
340{
341 struct tty_driver *p, *res = NULL;
342 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500343 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100344 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200345
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500346 for (str = name; *str; str++)
347 if ((*str >= '0' && *str <= '9') || *str == ',')
348 break;
349 if (!*str)
350 return NULL;
351
352 len = str - name;
353 tty_line = simple_strtoul(str, &str, 10);
354
Jason Wesself2d937f2008-04-17 20:05:37 +0200355 mutex_lock(&tty_mutex);
356 /* Search through the tty devices to look for a match */
357 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500358 if (strncmp(name, p->name, len) != 0)
359 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100360 stp = str;
361 if (*stp == ',')
362 stp++;
363 if (*stp == '\0')
364 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200365
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200366 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100367 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100368 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200369 *line = tty_line;
370 break;
371 }
372 }
373 mutex_unlock(&tty_mutex);
374
375 return res;
376}
377EXPORT_SYMBOL_GPL(tty_find_polling_driver);
378#endif
379
Alan Coxaf9b8972006-08-27 01:24:01 -0700380/**
381 * tty_check_change - check for POSIX terminal changes
382 * @tty: tty to check
383 *
384 * If we try to write to, or set the state of, a terminal and we're
385 * not in the foreground, send a SIGTTOU. If the signal is blocked or
386 * ignored, go ahead and perform the operation. (POSIX 7.2)
387 *
Alan Cox978e5952008-04-30 00:53:59 -0700388 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700390
Alan Cox37bdfb02008-02-08 04:18:47 -0800391int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392{
Alan Cox47f86832008-04-30 00:53:30 -0700393 unsigned long flags;
394 int ret = 0;
395
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 if (current->signal->tty != tty)
397 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700398
399 spin_lock_irqsave(&tty->ctrl_lock, flags);
400
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800401 if (!tty->pgrp) {
402 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700403 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800405 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700406 goto out_unlock;
407 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700409 goto out;
410 if (is_current_pgrp_orphaned()) {
411 ret = -EIO;
412 goto out;
413 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700414 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
415 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700416 ret = -ERESTARTSYS;
417out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700418 return ret;
419out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700420 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
421 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422}
423
424EXPORT_SYMBOL(tty_check_change);
425
Alan Cox37bdfb02008-02-08 04:18:47 -0800426static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 size_t count, loff_t *ppos)
428{
429 return 0;
430}
431
Alan Cox37bdfb02008-02-08 04:18:47 -0800432static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 size_t count, loff_t *ppos)
434{
435 return -EIO;
436}
437
438/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800439static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
441 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
442}
443
Alan Cox04f378b2008-04-30 00:53:29 -0700444static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
445 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700446{
447 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
448}
449
Alan Cox37bdfb02008-02-08 04:18:47 -0800450static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700451 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
453 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
454}
455
Arjan van de Ven62322d22006-07-03 00:24:21 -0700456static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 .llseek = no_llseek,
458 .read = tty_read,
459 .write = tty_write,
460 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700461 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700462 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 .open = tty_open,
464 .release = tty_release,
465 .fasync = tty_fasync,
466};
467
Arjan van de Ven62322d22006-07-03 00:24:21 -0700468static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 .llseek = no_llseek,
470 .read = tty_read,
471 .write = redirected_tty_write,
472 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700473 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700474 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 .open = tty_open,
476 .release = tty_release,
477 .fasync = tty_fasync,
478};
479
Arjan van de Ven62322d22006-07-03 00:24:21 -0700480static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 .llseek = no_llseek,
482 .read = hung_up_tty_read,
483 .write = hung_up_tty_write,
484 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700485 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700486 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 .release = tty_release,
488};
489
490static DEFINE_SPINLOCK(redirect_lock);
491static struct file *redirect;
492
Peter Hurley11d9bef2014-10-16 14:59:42 -0400493
494void proc_clear_tty(struct task_struct *p)
495{
496 unsigned long flags;
497 struct tty_struct *tty;
498 spin_lock_irqsave(&p->sighand->siglock, flags);
499 tty = p->signal->tty;
500 p->signal->tty = NULL;
501 spin_unlock_irqrestore(&p->sighand->siglock, flags);
502 tty_kref_put(tty);
503}
504
Peter Hurley2c411c12014-10-16 14:59:47 -0400505/**
506 * proc_set_tty - set the controlling terminal
507 *
508 * Only callable by the session leader and only if it does not already have
509 * a controlling terminal.
510 *
Peter Hurleye218eb32014-10-16 14:59:49 -0400511 * Caller must hold: tty_lock()
512 * a readlock on tasklist_lock
Peter Hurley2c411c12014-10-16 14:59:47 -0400513 * sighand lock
514 */
Peter Hurleybce65f12014-10-16 14:59:43 -0400515static void __proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400516{
Peter Hurleyae28fa72014-10-16 14:59:46 -0400517 unsigned long flags;
518
Peter Hurleyae28fa72014-10-16 14:59:46 -0400519 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya3618582014-10-16 14:59:50 -0400520 /*
521 * The session and fg pgrp references will be non-NULL if
522 * tiocsctty() is stealing the controlling tty
523 */
Peter Hurleyae28fa72014-10-16 14:59:46 -0400524 put_pid(tty->session);
525 put_pid(tty->pgrp);
526 tty->pgrp = get_pid(task_pgrp(current));
527 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
528 tty->session = get_pid(task_session(current));
529 if (current->signal->tty) {
530 printk(KERN_DEBUG "tty not NULL!!\n");
531 tty_kref_put(current->signal->tty);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400532 }
Peter Hurleybce65f12014-10-16 14:59:43 -0400533 put_pid(current->signal->tty_old_pgrp);
534 current->signal->tty = tty_kref_get(tty);
535 current->signal->tty_old_pgrp = NULL;
Peter Hurley11d9bef2014-10-16 14:59:42 -0400536}
537
Peter Hurleybce65f12014-10-16 14:59:43 -0400538static void proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400539{
Peter Hurleybce65f12014-10-16 14:59:43 -0400540 spin_lock_irq(&current->sighand->siglock);
541 __proc_set_tty(tty);
542 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400543}
544
545struct tty_struct *get_current_tty(void)
546{
547 struct tty_struct *tty;
548 unsigned long flags;
549
550 spin_lock_irqsave(&current->sighand->siglock, flags);
551 tty = tty_kref_get(current->signal->tty);
552 spin_unlock_irqrestore(&current->sighand->siglock, flags);
553 return tty;
554}
555EXPORT_SYMBOL_GPL(get_current_tty);
556
557static void session_clear_tty(struct pid *session)
558{
559 struct task_struct *p;
560 do_each_pid_task(session, PIDTYPE_SID, p) {
561 proc_clear_tty(p);
562 } while_each_pid_task(session, PIDTYPE_SID, p);
563}
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565/**
566 * tty_wakeup - request more data
567 * @tty: terminal
568 *
569 * Internal and external helper for wakeups of tty. This function
570 * informs the line discipline if present that the driver is ready
571 * to receive more output data.
572 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574void tty_wakeup(struct tty_struct *tty)
575{
576 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
579 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800580 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100581 if (ld->ops->write_wakeup)
582 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 tty_ldisc_deref(ld);
584 }
585 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700586 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
589EXPORT_SYMBOL_GPL(tty_wakeup);
590
591/**
Peter Hurleyea648a42013-03-06 07:20:53 -0500592 * tty_signal_session_leader - sends SIGHUP to session leader
Peter Hurleyf91e2592013-03-06 07:20:56 -0500593 * @tty controlling tty
594 * @exit_session if non-zero, signal all foreground group processes
Peter Hurleyea648a42013-03-06 07:20:53 -0500595 *
Peter Hurleyf91e2592013-03-06 07:20:56 -0500596 * Send SIGHUP and SIGCONT to the session leader and its process group.
597 * Optionally, signal all processes in the foreground process group.
Peter Hurleyea648a42013-03-06 07:20:53 -0500598 *
599 * Returns the number of processes in the session with this tty
600 * as their controlling terminal. This value is used to drop
601 * tty references for those processes.
602 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500603static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
Peter Hurleyea648a42013-03-06 07:20:53 -0500604{
605 struct task_struct *p;
Peter Hurleyea648a42013-03-06 07:20:53 -0500606 int refs = 0;
Peter Hurleyf91e2592013-03-06 07:20:56 -0500607 struct pid *tty_pgrp = NULL;
Peter Hurleyea648a42013-03-06 07:20:53 -0500608
609 read_lock(&tasklist_lock);
610 if (tty->session) {
611 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
612 spin_lock_irq(&p->sighand->siglock);
613 if (p->signal->tty == tty) {
614 p->signal->tty = NULL;
615 /* We defer the dereferences outside fo
616 the tasklist lock */
617 refs++;
618 }
619 if (!p->signal->leader) {
620 spin_unlock_irq(&p->sighand->siglock);
621 continue;
622 }
623 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
624 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
625 put_pid(p->signal->tty_old_pgrp); /* A noop */
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500626 spin_lock(&tty->ctrl_lock);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500627 tty_pgrp = get_pid(tty->pgrp);
Peter Hurleyea648a42013-03-06 07:20:53 -0500628 if (tty->pgrp)
629 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500630 spin_unlock(&tty->ctrl_lock);
Peter Hurleyea648a42013-03-06 07:20:53 -0500631 spin_unlock_irq(&p->sighand->siglock);
632 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
633 }
634 read_unlock(&tasklist_lock);
635
Peter Hurleyf91e2592013-03-06 07:20:56 -0500636 if (tty_pgrp) {
637 if (exit_session)
638 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
639 put_pid(tty_pgrp);
640 }
641
Peter Hurleyea648a42013-03-06 07:20:53 -0500642 return refs;
643}
644
645/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200646 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000647 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700648 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800649 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700650 * synchronous but doesn't hold any locks, so we need to make sure we
651 * have the appropriate locks for what we're doing.
652 *
653 * The hangup event clears any pending redirections onto the hung up
654 * device. It ensures future writes will error and it does the needed
655 * line discipline hangup and signal delivery. The tty object itself
656 * remains intact.
657 *
658 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200659 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800660 * redirect lock for undoing redirection
661 * file list lock for manipulating list of ttys
Peter Hurley137084b2013-06-15 07:04:46 -0400662 * tty_ldiscs_lock from called functions
Peter Hurley6a1c0682013-06-15 09:14:23 -0400663 * termios_rwsem resetting termios data
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800664 * tasklist_lock to walk task list for hangup event
665 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500667static void __tty_hangup(struct tty_struct *tty, int exit_session)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
Alan Cox37bdfb02008-02-08 04:18:47 -0800669 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 struct file *filp, *f = NULL;
Nick Piggind996b622010-08-18 04:37:36 +1000671 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 int closecount = 0, n;
Peter Hurleyea648a42013-03-06 07:20:53 -0500673 int refs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 if (!tty)
676 return;
677
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000680 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 f = redirect;
682 redirect = NULL;
683 }
684 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800685
Alan Cox89c8d912012-08-08 16:30:13 +0100686 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200687
Peter Hurleycb50e522013-07-31 14:05:45 -0400688 if (test_bit(TTY_HUPPED, &tty->flags)) {
689 tty_unlock(tty);
690 return;
691 }
692
Arnd Bergmannec79d602010-06-01 22:53:01 +0200693 /* inuse_filps is protected by the single tty lock,
694 this really needs to change if we want to flush the
695 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200696 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000697
Nick Pigginee2ffa02010-08-18 04:37:35 +1000698 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000700 list_for_each_entry(priv, &tty->tty_files, list) {
701 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 if (filp->f_op->write == redirected_tty_write)
703 cons_filp = filp;
704 if (filp->f_op->write != tty_write)
705 continue;
706 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200707 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 filp->f_op = &hung_up_tty_fops;
709 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000710 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800711
Peter Hurley25fdf242013-03-06 07:20:57 -0500712 refs = tty_signal_session_leader(tty, exit_session);
713 /* Account for the p->signal references we killed */
714 while (refs--)
715 tty_kref_put(tty);
716
Alan Coxc65c9bc2009-06-11 12:50:12 +0100717 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800718
Peter Hurley20cc2252013-03-06 07:20:54 -0500719 spin_lock_irq(&tty->ctrl_lock);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100720 clear_bit(TTY_THROTTLED, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600722 put_pid(tty->session);
723 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800724 tty->session = NULL;
725 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 tty->ctrl_status = 0;
Peter Hurley20cc2252013-03-06 07:20:54 -0500727 spin_unlock_irq(&tty->ctrl_lock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800730 * If one of the devices matches a console pointer, we
731 * cannot just call hangup() because that will cause
732 * tty->count and state->count to go out of sync.
733 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 */
735 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700736 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700738 tty->ops->close(tty, cons_filp);
739 } else if (tty->ops->hangup)
Peter Hurley7c6d3402014-06-16 09:17:08 -0400740 tty->ops->hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800741 /*
742 * We don't want to have driver/ldisc interactions beyond
743 * the ones we did here. The driver layer expects no
744 * calls after ->hangup() from the ldisc side. However we
745 * can't yet guarantee all that.
746 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 set_bit(TTY_HUPPED, &tty->flags);
Alan Cox89c8d912012-08-08 16:30:13 +0100748 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200749
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 if (f)
751 fput(f);
752}
753
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200754static void do_tty_hangup(struct work_struct *work)
755{
756 struct tty_struct *tty =
757 container_of(work, struct tty_struct, hangup_work);
758
Peter Hurleyf91e2592013-03-06 07:20:56 -0500759 __tty_hangup(tty, 0);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200760}
761
Alan Coxaf9b8972006-08-27 01:24:01 -0700762/**
763 * tty_hangup - trigger a hangup event
764 * @tty: tty to hangup
765 *
766 * A carrier loss (virtual or otherwise) has occurred on this like
767 * schedule a hangup sequence to run after this event.
768 */
769
Alan Cox37bdfb02008-02-08 04:18:47 -0800770void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
772#ifdef TTY_DEBUG_HANGUP
773 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
775#endif
776 schedule_work(&tty->hangup_work);
777}
778
779EXPORT_SYMBOL(tty_hangup);
780
Alan Coxaf9b8972006-08-27 01:24:01 -0700781/**
782 * tty_vhangup - process vhangup
783 * @tty: tty to hangup
784 *
785 * The user has asked via system call for the terminal to be hung up.
786 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200787 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700788 */
789
Alan Cox37bdfb02008-02-08 04:18:47 -0800790void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
792#ifdef TTY_DEBUG_HANGUP
793 char buf[64];
794
795 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
796#endif
Peter Hurleyf91e2592013-03-06 07:20:56 -0500797 __tty_hangup(tty, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798}
Alan Cox37bdfb02008-02-08 04:18:47 -0800799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800EXPORT_SYMBOL(tty_vhangup);
801
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200802
Alan Coxaf9b8972006-08-27 01:24:01 -0700803/**
Alan Cox2cb59982008-10-13 10:40:30 +0100804 * tty_vhangup_self - process vhangup for own ctty
805 *
806 * Perform a vhangup on the current controlling tty
807 */
808
809void tty_vhangup_self(void)
810{
811 struct tty_struct *tty;
812
Alan Cox2cb59982008-10-13 10:40:30 +0100813 tty = get_current_tty();
814 if (tty) {
815 tty_vhangup(tty);
816 tty_kref_put(tty);
817 }
Alan Cox2cb59982008-10-13 10:40:30 +0100818}
819
820/**
Peter Hurleyf91e2592013-03-06 07:20:56 -0500821 * tty_vhangup_session - hangup session leader exit
822 * @tty: tty to hangup
823 *
824 * The session leader is exiting and hanging up its controlling terminal.
825 * Every process in the foreground process group is signalled SIGHUP.
826 *
827 * We do this synchronously so that when the syscall returns the process
828 * is complete. That guarantee is necessary for security reasons.
829 */
830
Changlong Xie44a459f2013-03-20 08:42:04 +0800831static void tty_vhangup_session(struct tty_struct *tty)
Peter Hurleyf91e2592013-03-06 07:20:56 -0500832{
833#ifdef TTY_DEBUG_HANGUP
834 char buf[64];
835
836 printk(KERN_DEBUG "%s vhangup session...\n", tty_name(tty, buf));
837#endif
838 __tty_hangup(tty, 1);
839}
840
841/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700842 * tty_hung_up_p - was tty hung up
843 * @filp: file pointer of tty
844 *
845 * Return true if the tty has been subject to a vhangup or a carrier
846 * loss
847 */
848
Alan Cox37bdfb02008-02-08 04:18:47 -0800849int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850{
851 return (filp->f_op == &hung_up_tty_fops);
852}
853
854EXPORT_SYMBOL(tty_hung_up_p);
855
Alan Coxaf9b8972006-08-27 01:24:01 -0700856/**
857 * disassociate_ctty - disconnect controlling tty
858 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700860 * This function is typically called only by the session leader, when
861 * it wants to disassociate itself from its controlling tty.
862 *
863 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
865 * (2) Clears the tty from being controlling the session
866 * (3) Clears the controlling tty for all processes in the
867 * session group.
868 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700869 * The argument on_exit is set to 1 if called when a process is
870 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
871 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800872 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200873 * BTM is taken for hysterical raisins, and held when
874 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800875 * tty_mutex is taken to protect tty
876 * ->siglock is taken to protect ->signal/->sighand
877 * tasklist_lock is taken to walk process list for sessions
878 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881void disassociate_ctty(int on_exit)
882{
883 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
Alan Cox5ec93d12009-11-30 13:18:45 +0000885 if (!current->signal->leader)
886 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800888 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 if (tty) {
Peter Hurleyf91e2592013-03-06 07:20:56 -0500890 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
891 tty_vhangup_session(tty);
892 } else {
893 struct pid *tty_pgrp = tty_get_pgrp(tty);
894 if (tty_pgrp) {
895 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Oleg Nesterov03e12612013-09-15 17:50:26 +0200896 if (!on_exit)
897 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500898 put_pid(tty_pgrp);
899 }
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200900 }
Alan Cox452a00d2008-10-13 10:39:13 +0100901 tty_kref_put(tty);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500902
Eric W. Biederman680a9672007-02-12 00:52:52 -0800903 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800904 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800905 spin_lock_irq(&current->sighand->siglock);
906 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800907 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800908 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800909 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800910 kill_pgrp(old_pgrp, SIGHUP, on_exit);
911 kill_pgrp(old_pgrp, SIGCONT, on_exit);
912 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 return;
915 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800917 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700918 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800919 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800920
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800921 tty = tty_kref_get(current->signal->tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800922 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700923 unsigned long flags;
924 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800925 put_pid(tty->session);
926 put_pid(tty->pgrp);
927 tty->session = NULL;
928 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700929 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100930 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800931 } else {
932#ifdef TTY_DEBUG_HANGUP
933 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
934 " = NULL", tty);
935#endif
936 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800938 spin_unlock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 /* Now clear signal->tty under the lock */
940 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800941 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943}
944
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700945/**
946 *
947 * no_tty - Ensure the current process does not have a controlling tty
948 */
949void no_tty(void)
950{
Alan Cox3af502b2012-05-03 22:21:53 +0100951 /* FIXME: Review locking here. The tty_lock never covered any race
952 between a new association and proc_clear_tty but possible we need
953 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700954 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000955 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700956 proc_clear_tty(tsk);
957}
958
Alan Coxaf9b8972006-08-27 01:24:01 -0700959
960/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200961 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700962 * @tty: tty to stop
963 *
Peter Hurley01adc802014-09-10 15:06:32 -0400964 * Perform flow control to the driver. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700965 * on an already stopped device and will not re-call the driver
966 * method.
967 *
968 * This functionality is used by both the line disciplines for
969 * halting incoming flow and by the driver. It may therefore be
970 * called from any context, may be under the tty atomic_write_lock
971 * but not always.
972 *
973 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400974 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700975 */
976
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400977void __stop_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400979 if (tty->stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 return;
981 tty->stopped = 1;
Alan Coxf34d7a52008-04-30 00:54:13 -0700982 if (tty->ops->stop)
Peter Hurleyc961bfb2014-11-05 12:26:25 -0500983 tty->ops->stop(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984}
985
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400986void stop_tty(struct tty_struct *tty)
987{
988 unsigned long flags;
989
990 spin_lock_irqsave(&tty->flow_lock, flags);
991 __stop_tty(tty);
992 spin_unlock_irqrestore(&tty->flow_lock, flags);
993}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994EXPORT_SYMBOL(stop_tty);
995
Alan Coxaf9b8972006-08-27 01:24:01 -0700996/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200997 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700998 * @tty: tty to start
999 *
Peter Hurley01adc802014-09-10 15:06:32 -04001000 * Start a tty that has been stopped if at all possible. If this
1001 * tty was previous stopped and is now being started, the driver
1002 * start method is invoked and the line discipline woken.
Alan Coxaf9b8972006-08-27 01:24:01 -07001003 *
1004 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001005 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07001006 */
1007
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001008void __start_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009{
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001010 if (!tty->stopped || tty->flow_stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 return;
1012 tty->stopped = 0;
Alan Coxf34d7a52008-04-30 00:54:13 -07001013 if (tty->ops->start)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05001014 tty->ops->start(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016}
1017
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001018void start_tty(struct tty_struct *tty)
1019{
1020 unsigned long flags;
1021
1022 spin_lock_irqsave(&tty->flow_lock, flags);
1023 __start_tty(tty);
1024 spin_unlock_irqrestore(&tty->flow_lock, flags);
1025}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026EXPORT_SYMBOL(start_tty);
1027
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001028static void tty_update_time(struct timespec *time)
1029{
Jiri Slabyf0bf0bd2015-02-27 18:40:31 +01001030 unsigned long sec = get_seconds();
Greg Kroah-Hartmanfbf47632015-03-26 23:10:27 +01001031
1032 /*
1033 * We only care if the two values differ in anything other than the
1034 * lower three bits (i.e every 8 seconds). If so, then we can update
1035 * the time of the tty device, otherwise it could be construded as a
1036 * security leak to let userspace know the exact timing of the tty.
1037 */
1038 if ((sec ^ time->tv_sec) & ~7)
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001039 time->tv_sec = sec;
1040}
1041
Alan Coxaf9b8972006-08-27 01:24:01 -07001042/**
1043 * tty_read - read method for tty device files
1044 * @file: pointer to tty file
1045 * @buf: user buffer
1046 * @count: size of user buffer
1047 * @ppos: unused
1048 *
1049 * Perform the read system call function on this terminal device. Checks
1050 * for hung up devices before calling the line discipline method.
1051 *
1052 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -07001053 * Locks the line discipline internally while needed. Multiple
1054 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -07001055 */
1056
Alan Cox37bdfb02008-02-08 04:18:47 -08001057static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 loff_t *ppos)
1059{
1060 int i;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001061 struct inode *inode = file_inode(file);
Nick Piggind996b622010-08-18 04:37:36 +10001062 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 struct tty_ldisc *ld;
1064
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001065 if (tty_paranoia_check(tty, inode, "tty_read"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 return -EIO;
1067 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1068 return -EIO;
1069
1070 /* We want to wait for the line discipline to sort out in this
1071 situation */
1072 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001073 if (ld->ops->read)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05001074 i = ld->ops->read(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 else
1076 i = -EIO;
1077 tty_ldisc_deref(ld);
Jiri Slabyb0de59b2013-02-15 15:25:05 +01001078
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001079 if (i > 0)
1080 tty_update_time(&inode->i_atime);
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 return i;
1083}
1084
Peter Hurley136d5252014-09-10 15:06:34 -04001085static void tty_write_unlock(struct tty_struct *tty)
Alan Cox9c1729d2007-07-15 23:39:43 -07001086{
1087 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -07001088 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -07001089}
1090
Peter Hurley136d5252014-09-10 15:06:34 -04001091static int tty_write_lock(struct tty_struct *tty, int ndelay)
Alan Cox9c1729d2007-07-15 23:39:43 -07001092{
1093 if (!mutex_trylock(&tty->atomic_write_lock)) {
1094 if (ndelay)
1095 return -EAGAIN;
1096 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1097 return -ERESTARTSYS;
1098 }
1099 return 0;
1100}
1101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102/*
1103 * Split writes up in sane blocksizes to avoid
1104 * denial-of-service type attacks
1105 */
1106static inline ssize_t do_tty_write(
1107 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1108 struct tty_struct *tty,
1109 struct file *file,
1110 const char __user *buf,
1111 size_t count)
1112{
Alan Cox9c1729d2007-07-15 23:39:43 -07001113 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001115
Alan Cox9c1729d2007-07-15 23:39:43 -07001116 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1117 if (ret < 0)
1118 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
1120 /*
1121 * We chunk up writes into a temporary buffer. This
1122 * simplifies low-level drivers immensely, since they
1123 * don't have locking issues and user mode accesses.
1124 *
1125 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1126 * big chunk-size..
1127 *
1128 * The default chunk-size is 2kB, because the NTTY
1129 * layer has problems with bigger chunks. It will
1130 * claim to be able to handle more characters than
1131 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001132 *
1133 * FIXME: This can probably go away now except that 64K chunks
1134 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 */
1136 chunk = 2048;
1137 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1138 chunk = 65536;
1139 if (count < chunk)
1140 chunk = count;
1141
Ingo Molnar70522e12006-03-23 03:00:31 -08001142 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001144 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
1146 if (chunk < 1024)
1147 chunk = 1024;
1148
Jason Wessel402fda92008-10-13 10:45:36 +01001149 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1150 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001151 ret = -ENOMEM;
1152 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 }
1154 kfree(tty->write_buf);
1155 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001156 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 }
1158
1159 /* Do the write .. */
1160 for (;;) {
1161 size_t size = count;
1162 if (size > chunk)
1163 size = chunk;
1164 ret = -EFAULT;
1165 if (copy_from_user(tty->write_buf, buf, size))
1166 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 if (ret <= 0)
1169 break;
1170 written += ret;
1171 buf += ret;
1172 count -= ret;
1173 if (!count)
1174 break;
1175 ret = -ERESTARTSYS;
1176 if (signal_pending(current))
1177 break;
1178 cond_resched();
1179 }
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001180 if (written) {
1181 tty_update_time(&file_inode(file)->i_mtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 ret = written;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001183 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001184out:
1185 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 return ret;
1187}
1188
Alan Cox95f9bfc2008-10-13 10:39:23 +01001189/**
1190 * tty_write_message - write a message to a certain tty, not just the console.
1191 * @tty: the destination tty_struct
1192 * @msg: the message to write
1193 *
1194 * This is used for messages that need to be redirected to a specific tty.
1195 * We don't put it into the syslog queue right now maybe in the future if
1196 * really needed.
1197 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001198 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001199 */
1200
1201void tty_write_message(struct tty_struct *tty, char *msg)
1202{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001203 if (tty) {
1204 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001205 tty_lock(tty);
Peter Hurley04980702014-11-05 12:12:52 -05001206 if (tty->ops->write && tty->count > 0) {
Alan Cox89c8d912012-08-08 16:30:13 +01001207 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001208 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001209 } else
Alan Cox89c8d912012-08-08 16:30:13 +01001210 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001211 tty_write_unlock(tty);
1212 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001213 return;
1214}
1215
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
Alan Coxaf9b8972006-08-27 01:24:01 -07001217/**
1218 * tty_write - write method for tty device file
1219 * @file: tty file pointer
1220 * @buf: user data to write
1221 * @count: bytes to write
1222 * @ppos: unused
1223 *
1224 * Write data to a tty device via the line discipline.
1225 *
1226 * Locking:
1227 * Locks the line discipline as required
1228 * Writes to the tty driver are serialized by the atomic_write_lock
1229 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001230 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001231 */
1232
Alan Cox37bdfb02008-02-08 04:18:47 -08001233static ssize_t tty_write(struct file *file, const char __user *buf,
1234 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235{
Nick Piggind996b622010-08-18 04:37:36 +10001236 struct tty_struct *tty = file_tty(file);
1237 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001239
Al Viro6131ffa2013-02-27 16:59:05 -05001240 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001242 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001243 (test_bit(TTY_IO_ERROR, &tty->flags)))
1244 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001245 /* Short term debug to catch buggy drivers */
1246 if (tty->ops->write_room == NULL)
1247 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1248 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001249 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001250 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 ret = -EIO;
1252 else
Alan Coxa352def2008-07-16 21:53:12 +01001253 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 tty_ldisc_deref(ld);
1255 return ret;
1256}
1257
Alan Cox37bdfb02008-02-08 04:18:47 -08001258ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1259 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260{
1261 struct file *p = NULL;
1262
1263 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001264 if (redirect)
1265 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 spin_unlock(&redirect_lock);
1267
1268 if (p) {
1269 ssize_t res;
1270 res = vfs_write(p, buf, count, &p->f_pos);
1271 fput(p);
1272 return res;
1273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 return tty_write(file, buf, count, ppos);
1275}
1276
Peter Hurley136d5252014-09-10 15:06:34 -04001277/**
1278 * tty_send_xchar - send priority character
1279 *
1280 * Send a high priority character to the tty even if stopped
1281 *
1282 * Locking: none for xchar method, write ordering for write method.
1283 */
1284
1285int tty_send_xchar(struct tty_struct *tty, char ch)
1286{
1287 int was_stopped = tty->stopped;
1288
1289 if (tty->ops->send_xchar) {
1290 tty->ops->send_xchar(tty, ch);
1291 return 0;
1292 }
1293
1294 if (tty_write_lock(tty, 0) < 0)
1295 return -ERESTARTSYS;
1296
1297 if (was_stopped)
1298 start_tty(tty);
1299 tty->ops->write(tty, &ch, 1);
1300 if (was_stopped)
1301 stop_tty(tty);
1302 tty_write_unlock(tty);
1303 return 0;
1304}
1305
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306static char ptychar[] = "pqrstuvwxyzabcde";
1307
Alan Coxaf9b8972006-08-27 01:24:01 -07001308/**
1309 * pty_line_name - generate name for a pty
1310 * @driver: the tty driver in use
1311 * @index: the minor number
1312 * @p: output buffer of at least 6 bytes
1313 *
1314 * Generate a name from a driver reference and write it to the output
1315 * buffer.
1316 *
1317 * Locking: None
1318 */
1319static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320{
1321 int i = index + driver->name_base;
1322 /* ->name is initialized to "ttyp", but "tty" is expected */
1323 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001324 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1325 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326}
1327
Alan Coxaf9b8972006-08-27 01:24:01 -07001328/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001329 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001330 * @driver: the tty driver in use
1331 * @index: the minor number
1332 * @p: output buffer of at least 7 bytes
1333 *
1334 * Generate a name from a driver reference and write it to the output
Greg Kroah-Hartman5c0a2452014-02-22 14:31:04 -08001335 * buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07001336 *
1337 * Locking: None
1338 */
Hannes Reinecke723abd82014-02-27 12:30:51 +01001339static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
Jiri Slaby0019b402012-08-08 22:26:43 +02001341 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
Hannes Reinecke723abd82014-02-27 12:30:51 +01001342 return sprintf(p, "%s", driver->name);
Jiri Slaby0019b402012-08-08 22:26:43 +02001343 else
Hannes Reinecke723abd82014-02-27 12:30:51 +01001344 return sprintf(p, "%s%d", driver->name,
1345 index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346}
1347
Alan Cox99f1fe12008-10-13 10:42:00 +01001348/**
1349 * tty_driver_lookup_tty() - find an existing tty, if any
1350 * @driver: the driver for the tty
1351 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001352 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001353 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the
1354 * driver lookup() method returns an error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001355 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001356 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001357 */
Jason Wessela47d5452009-01-02 13:43:04 +00001358static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001359 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001360{
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001361 struct tty_struct *tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001362
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001363 if (driver->ops->lookup)
1364 tty = driver->ops->lookup(driver, inode, idx);
1365 else
1366 tty = driver->ttys[idx];
1367
1368 if (!IS_ERR(tty))
1369 tty_kref_get(tty);
1370 return tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001371}
1372
Alan Cox99f1fe12008-10-13 10:42:00 +01001373/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001374 * tty_init_termios - helper for termios setup
1375 * @tty: the tty to set up
1376 *
1377 * Initialise the termios structures for this tty. Thus runs under
1378 * the tty_mutex currently so we can be relaxed about ordering.
1379 */
1380
1381int tty_init_termios(struct tty_struct *tty)
1382{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001383 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001384 int idx = tty->index;
1385
Alan Cox36b3c072012-07-17 17:06:57 +01001386 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1387 tty->termios = tty->driver->init_termios;
1388 else {
1389 /* Check for lazy saved data */
1390 tp = tty->driver->termios[idx];
1391 if (tp != NULL)
1392 tty->termios = *tp;
1393 else
1394 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001395 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001396 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001397 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1398 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001399 return 0;
1400}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001401EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001402
Jiri Slaby66d450e2012-01-30 21:14:28 +01001403int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1404{
1405 int ret = tty_init_termios(tty);
1406 if (ret)
1407 return ret;
1408
1409 tty_driver_kref_get(driver);
1410 tty->count++;
1411 driver->ttys[tty->index] = tty;
1412 return 0;
1413}
1414EXPORT_SYMBOL_GPL(tty_standard_install);
1415
Alan Coxbf970ee2008-10-13 10:42:39 +01001416/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001417 * tty_driver_install_tty() - install a tty entry in the driver
1418 * @driver: the driver for the tty
1419 * @tty: the tty
1420 *
1421 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001422 * will be set by the time this is called. This method is responsible
1423 * for ensuring any need additional structures are allocated and
1424 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001425 *
1426 * Locking: tty_mutex for now
1427 */
1428static int tty_driver_install_tty(struct tty_driver *driver,
1429 struct tty_struct *tty)
1430{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001431 return driver->ops->install ? driver->ops->install(driver, tty) :
1432 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001433}
1434
1435/**
1436 * tty_driver_remove_tty() - remove a tty from the driver tables
1437 * @driver: the driver for the tty
1438 * @idx: the minor number
1439 *
1440 * Remvoe a tty object from the driver tables. The tty->index field
1441 * will be set by the time this is called.
1442 *
1443 * Locking: tty_mutex for now
1444 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001445void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001446{
1447 if (driver->ops->remove)
1448 driver->ops->remove(driver, tty);
1449 else
1450 driver->ttys[tty->index] = NULL;
1451}
1452
1453/*
1454 * tty_reopen() - fast re-open of an open tty
1455 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001456 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001457 * Return 0 on success, -errno on error.
Peter Hurley5d93e742014-11-05 12:12:47 -05001458 * Re-opens on master ptys are not allowed and return -EIO.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001459 *
Peter Hurley5d93e742014-11-05 12:12:47 -05001460 * Locking: Caller must hold tty_lock
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001461 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001462static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001463{
1464 struct tty_driver *driver = tty->driver;
1465
Peter Hurley216030e2014-11-05 12:12:48 -05001466 if (!tty->count)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001467 return -EIO;
1468
1469 if (driver->type == TTY_DRIVER_TYPE_PTY &&
Peter Hurley5d93e742014-11-05 12:12:47 -05001470 driver->subtype == PTY_TYPE_MASTER)
1471 return -EIO;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001472
Peter Hurley86f2c002014-12-30 10:39:25 -05001473 if (test_bit(TTY_EXCLUSIVE, &tty->flags) && !capable(CAP_SYS_ADMIN))
1474 return -EBUSY;
1475
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001476 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001477
Peter Hurley36697522013-06-15 07:04:48 -04001478 WARN_ON(!tty->ldisc);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001479
1480 return 0;
1481}
1482
Alan Coxaf9b8972006-08-27 01:24:01 -07001483/**
Alan Coxd81ed102008-10-13 10:41:42 +01001484 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001485 * @driver: tty driver we are opening a device on
1486 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001487 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001488 *
1489 * Prepare a tty device. This may not be a "new" clean device but
1490 * could also be an active device. The pty drivers require special
1491 * handling because of this.
1492 *
1493 * Locking:
1494 * The function is called under the tty_mutex, which
1495 * protects us from the tty struct or driver itself going away.
1496 *
1497 * On exit the tty device has the line discipline attached and
1498 * a reference count of 1. If a pair was created for pty/tty use
1499 * and the other was a pty master then it too has a reference count of 1.
1500 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001502 * failed open. The new code protects the open with a mutex, so it's
1503 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 * relaxed for the (most common) case of reopening a tty.
1505 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001506
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001507struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
Alan Coxbf970ee2008-10-13 10:42:39 +01001509 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001510 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 /*
1513 * First time open is complex, especially for PTY devices.
1514 * This code guarantees that either everything succeeds and the
1515 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001516 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 * and locked termios may be retained.)
1518 */
1519
Alan Cox73ec06f2008-10-13 10:42:29 +01001520 if (!try_module_get(driver->owner))
1521 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02001523 tty = alloc_tty_struct(driver, idx);
Jiri Slabyd5543502011-03-23 10:48:32 +01001524 if (!tty) {
1525 retval = -ENOMEM;
1526 goto err_module_put;
1527 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
Alan Cox89c8d912012-08-08 16:30:13 +01001529 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001530 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001531 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001532 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001533
Jiri Slaby04831dc2012-06-04 13:35:36 +02001534 if (!tty->port)
1535 tty->port = driver->ports[idx];
1536
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001537 WARN_RATELIMIT(!tty->port,
1538 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1539 __func__, tty->driver->name);
1540
Jiri Slaby967fab62012-10-18 22:26:46 +02001541 tty->port->itty = tty;
1542
Alan Cox37bdfb02008-02-08 04:18:47 -08001543 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001545 * If we fail here just call release_tty to clean up. No need
1546 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001548 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001549 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001550 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001551 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001552 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001554err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001555 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001556 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001557 free_tty_struct(tty);
1558err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001560 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001562 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001563err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001564 tty_unlock(tty);
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +02001565 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001566 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001567 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001568 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569}
1570
Alan Coxfeebed62008-10-13 10:41:30 +01001571void tty_free_termios(struct tty_struct *tty)
1572{
1573 struct ktermios *tp;
1574 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001575
1576 /* If the port is going to reset then it has no termios to save */
1577 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1578 return;
1579
1580 /* Stash the termios data */
1581 tp = tty->driver->termios[idx];
1582 if (tp == NULL) {
1583 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1584 if (tp == NULL) {
1585 pr_warn("tty: no memory to save termios state.\n");
1586 return;
1587 }
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001588 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001589 }
Alan Cox36b3c072012-07-17 17:06:57 +01001590 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001591}
1592EXPORT_SYMBOL(tty_free_termios);
1593
Peter Hurleya2965b72013-03-11 16:44:35 -04001594/**
Peter Hurley949aa642014-11-05 12:12:57 -05001595 * tty_flush_works - flush all works of a tty/pty pair
1596 * @tty: tty device to flush works for (or either end of a pty pair)
Peter Hurleya2965b72013-03-11 16:44:35 -04001597 *
Peter Hurley949aa642014-11-05 12:12:57 -05001598 * Sync flush all works belonging to @tty (and the 'other' tty).
Peter Hurleya2965b72013-03-11 16:44:35 -04001599 */
1600static void tty_flush_works(struct tty_struct *tty)
1601{
1602 flush_work(&tty->SAK_work);
1603 flush_work(&tty->hangup_work);
Peter Hurley949aa642014-11-05 12:12:57 -05001604 if (tty->link) {
1605 flush_work(&tty->link->SAK_work);
1606 flush_work(&tty->link->hangup_work);
1607 }
Peter Hurleya2965b72013-03-11 16:44:35 -04001608}
Alan Coxfeebed62008-10-13 10:41:30 +01001609
Alan Coxaf9b8972006-08-27 01:24:01 -07001610/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001611 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001612 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001613 *
1614 * Releases memory associated with a tty structure, and clears out the
1615 * driver table slots. This function is called when a device is no longer
1616 * in use. It also gets called when setup of a device fails.
1617 *
1618 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001619 * takes the file list lock internally when working on the list
1620 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001621 *
1622 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001623 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 */
Alan Coxb50989d2009-09-19 13:13:22 -07001625static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626{
Alan Coxb50989d2009-09-19 13:13:22 -07001627 struct tty_struct *tty =
1628 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001629 struct tty_driver *driver = tty->driver;
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001630 struct module *owner = driver->owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Dave Youngf278a2f2009-09-27 16:00:42 +00001632 if (tty->ops->cleanup)
1633 tty->ops->cleanup(tty);
1634
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001636 tty_driver_kref_put(driver);
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001637 module_put(owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001638
Nick Pigginee2ffa02010-08-18 04:37:35 +10001639 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001641 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001642
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001643 put_pid(tty->pgrp);
1644 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 free_tty_struct(tty);
1646}
1647
Alan Coxb50989d2009-09-19 13:13:22 -07001648static void queue_release_one_tty(struct kref *kref)
1649{
1650 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001651
Alan Coxb50989d2009-09-19 13:13:22 -07001652 /* The hangup queue is now free so we can reuse it rather than
1653 waste a chunk of memory for each port */
1654 INIT_WORK(&tty->hangup_work, release_one_tty);
1655 schedule_work(&tty->hangup_work);
1656}
1657
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001658/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001659 * tty_kref_put - release a tty kref
1660 * @tty: tty device
1661 *
1662 * Release a reference to a tty device and if need be let the kref
1663 * layer destruct the object for us
1664 */
1665
1666void tty_kref_put(struct tty_struct *tty)
1667{
1668 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001669 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001670}
1671EXPORT_SYMBOL(tty_kref_put);
1672
1673/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001674 * release_tty - release tty structure memory
1675 *
1676 * Release both @tty and a possible linked partner (think pty pair),
1677 * and decrement the refcount of the backing module.
1678 *
1679 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001680 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001681 * takes the file list lock internally when working on the list
1682 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001683 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001684 */
1685static void release_tty(struct tty_struct *tty, int idx)
1686{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001687 /* This should always be true but check for the moment */
1688 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001689 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001690 if (tty->ops->shutdown)
1691 tty->ops->shutdown(tty);
1692 tty_free_termios(tty);
1693 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001694 tty->port->itty = NULL;
Peter Hurley64e377d2013-06-15 09:01:00 -04001695 if (tty->link)
1696 tty->link->port->itty = NULL;
Peter Hurley4f98d462013-03-11 16:44:34 -04001697 cancel_work_sync(&tty->port->buf.work);
Alan Cox36b3c072012-07-17 17:06:57 +01001698
Markus Elfringa211b1a2014-11-21 13:42:29 +01001699 tty_kref_put(tty->link);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001700 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001701}
1702
Alan Coxeeb89d92009-11-30 13:18:29 +00001703/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001704 * tty_release_checks - check a tty before real release
1705 * @tty: tty to check
1706 * @o_tty: link of @tty (if any)
1707 * @idx: index of the tty
1708 *
1709 * Performs some paranoid checking before true release of the @tty.
1710 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1711 */
Peter Hurley359b9fb2014-11-05 12:12:59 -05001712static int tty_release_checks(struct tty_struct *tty, int idx)
Jiri Slaby955787ca2011-11-11 10:47:23 +01001713{
1714#ifdef TTY_PARANOIA_CHECK
1715 if (idx < 0 || idx >= tty->driver->num) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001716 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1717 __func__, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001718 return -1;
1719 }
1720
1721 /* not much to check for devpts */
1722 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1723 return 0;
1724
1725 if (tty != tty->driver->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001726 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1727 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001728 return -1;
1729 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001730 if (tty->driver->other) {
Peter Hurley359b9fb2014-11-05 12:12:59 -05001731 struct tty_struct *o_tty = tty->link;
1732
Jiri Slaby955787ca2011-11-11 10:47:23 +01001733 if (o_tty != tty->driver->other->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001734 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1735 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001736 return -1;
1737 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001738 if (o_tty->link != tty) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001739 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001740 return -1;
1741 }
1742 }
1743#endif
1744 return 0;
1745}
1746
1747/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001748 * tty_release - vfs callback for close
1749 * @inode: inode of tty
1750 * @filp: file pointer for handle to tty
1751 *
1752 * Called the last time each file handle is closed that references
1753 * this tty. There may however be several such references.
1754 *
1755 * Locking:
1756 * Takes bkl. See tty_release_dev
1757 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 * Even releasing the tty structures is a tricky business.. We have
1759 * to be very careful that the structures are all released at the
1760 * same time, as interrupts might otherwise get the wrong pointers.
1761 *
1762 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1763 * lead to double frees or releasing memory still in use.
1764 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001765
1766int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767{
Nick Piggind996b622010-08-18 04:37:36 +10001768 struct tty_struct *tty = file_tty(filp);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001769 struct tty_struct *o_tty = NULL;
1770 int do_sleep, final;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 int idx;
1772 char buf[64];
Peter Hurley37b16452014-10-16 13:51:30 -04001773 long timeout = 0;
Peter Hurley494c1ea2014-10-16 13:54:36 -04001774 int once = 1;
Alan Cox37bdfb02008-02-08 04:18:47 -08001775
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001776 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001777 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
Alan Cox89c8d912012-08-08 16:30:13 +01001779 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001780 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
Arnd Bergmannec79d602010-06-01 22:53:01 +02001782 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
1784 idx = tty->index;
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001785 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1786 tty->driver->subtype == PTY_TYPE_MASTER)
1787 o_tty = tty->link;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Peter Hurley359b9fb2014-11-05 12:12:59 -05001789 if (tty_release_checks(tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001790 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001791 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
1794#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001795 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1796 tty_name(tty, buf), tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797#endif
1798
Alan Coxf34d7a52008-04-30 00:54:13 -07001799 if (tty->ops->close)
1800 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801
Peter Hurley2aff5e22014-11-05 12:13:01 -05001802 /* If tty is pty master, lock the slave pty (stable lock order) */
1803 tty_lock_slave(o_tty);
1804
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 /*
1806 * Sanity check: if tty->count is going to zero, there shouldn't be
1807 * any waiters on tty->read_wait or tty->write_wait. We test the
1808 * wait queues and kick everyone out _before_ actually starting to
1809 * close. This ensures that we won't block while releasing the tty
1810 * structure.
1811 *
1812 * The test for the o_tty closing is necessary, since the master and
1813 * slave sides may close in any order. If the slave side closes out
1814 * first, its count will be one, since the master side holds an open.
Peter Hurley324c1652014-11-05 12:12:56 -05001815 * Thus this test wouldn't be triggered at the time the slave closed,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 * so we do it now.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 */
1818 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 do_sleep = 0;
1820
Peter Hurley324c1652014-11-05 12:12:56 -05001821 if (tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001823 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 do_sleep++;
1825 }
1826 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001827 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 do_sleep++;
1829 }
1830 }
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001831 if (o_tty && o_tty->count <= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001833 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 do_sleep++;
1835 }
1836 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001837 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 do_sleep++;
1839 }
1840 }
1841 if (!do_sleep)
1842 break;
1843
Peter Hurley494c1ea2014-10-16 13:54:36 -04001844 if (once) {
1845 once = 0;
1846 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1847 __func__, tty_name(tty, buf));
1848 }
Peter Hurley37b16452014-10-16 13:51:30 -04001849 schedule_timeout_killable(timeout);
1850 if (timeout < 120 * HZ)
1851 timeout = 2 * timeout + 1;
1852 else
1853 timeout = MAX_SCHEDULE_TIMEOUT;
Alan Cox37bdfb02008-02-08 04:18:47 -08001854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001856 if (o_tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001858 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1859 __func__, o_tty->count, tty_name(o_tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 o_tty->count = 0;
1861 }
1862 }
1863 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001864 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1865 __func__, tty->count, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 tty->count = 0;
1867 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001868
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 /*
1870 * We've decremented tty->count, so we need to remove this file
1871 * descriptor off the tty->tty_files list; this serves two
1872 * purposes:
1873 * - check_tty_count sees the correct number of file descriptors
1874 * associated with this tty.
1875 * - do_tty_hangup no longer sees this file descriptor as
1876 * something that needs to be handled for hangups.
1877 */
Nick Piggind996b622010-08-18 04:37:36 +10001878 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
1880 /*
1881 * Perform some housekeeping before deciding whether to return.
1882 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 * If _either_ side is closing, make sure there aren't any
1884 * processes that still think tty or o_tty is their controlling
1885 * tty.
1886 */
Peter Hurley324c1652014-11-05 12:12:56 -05001887 if (!tty->count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001889 session_clear_tty(tty->session);
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001890 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001891 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 read_unlock(&tasklist_lock);
1893 }
1894
Peter Hurley324c1652014-11-05 12:12:56 -05001895 /* check whether both sides are closing ... */
Peter Hurley7ffb6da2014-11-05 12:13:00 -05001896 final = !tty->count && !(o_tty && o_tty->count);
Peter Hurley324c1652014-11-05 12:12:56 -05001897
Peter Hurley2aff5e22014-11-05 12:13:01 -05001898 tty_unlock_slave(o_tty);
1899 tty_unlock(tty);
1900
Peter Hurley04980702014-11-05 12:12:52 -05001901 /* At this point, the tty->count == 0 should ensure a dead tty
Alan Coxd1552552012-07-27 18:02:54 +01001902 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001903
Peter Hurley324c1652014-11-05 12:12:56 -05001904 if (!final)
Alan Coxeeb89d92009-11-30 13:18:29 +00001905 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001906
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907#ifdef TTY_DEBUG_HANGUP
Peter Hurley96433d12013-03-11 16:44:37 -04001908 printk(KERN_DEBUG "%s: %s: final close\n", __func__, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909#endif
1910 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001911 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 */
Peter Hurley62462ae2014-11-05 12:12:58 -05001913 tty_ldisc_release(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001914
1915 /* Wait for pending work before tty destruction commmences */
1916 tty_flush_works(tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001917
Peter Hurley96433d12013-03-11 16:44:37 -04001918#ifdef TTY_DEBUG_HANGUP
1919 printk(KERN_DEBUG "%s: %s: freeing structure...\n", __func__, tty_name(tty, buf));
1920#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001922 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001923 * the slots and preserving the termios structure. The tty_unlock_pair
1924 * should be safe as we keep a kref while the tty is locked (so the
1925 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 */
Alan Coxd1552552012-07-27 18:02:54 +01001927 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001928 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001929 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
Alan Coxeeb89d92009-11-30 13:18:29 +00001931 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932}
1933
Alan Coxaf9b8972006-08-27 01:24:01 -07001934/**
Peter Hurley52494ee2014-11-05 12:12:50 -05001935 * tty_open_current_tty - get locked tty of current task
Jiri Slabyb82154a2011-11-09 21:33:19 +01001936 * @device: device number
1937 * @filp: file pointer to tty
Peter Hurley52494ee2014-11-05 12:12:50 -05001938 * @return: locked tty of the current task iff @device is /dev/tty
1939 *
1940 * Performs a re-open of the current task's controlling tty.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001941 *
1942 * We cannot return driver and index like for the other nodes because
1943 * devpts will not work then. It expects inodes to be from devpts FS.
1944 */
1945static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1946{
1947 struct tty_struct *tty;
Peter Hurley52494ee2014-11-05 12:12:50 -05001948 int retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001949
1950 if (device != MKDEV(TTYAUX_MAJOR, 0))
1951 return NULL;
1952
1953 tty = get_current_tty();
1954 if (!tty)
1955 return ERR_PTR(-ENXIO);
1956
1957 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1958 /* noctty = 1; */
Peter Hurley52494ee2014-11-05 12:12:50 -05001959 tty_lock(tty);
1960 tty_kref_put(tty); /* safe to drop the kref now */
1961
1962 retval = tty_reopen(tty);
1963 if (retval < 0) {
1964 tty_unlock(tty);
1965 tty = ERR_PTR(retval);
1966 }
Jiri Slabyb82154a2011-11-09 21:33:19 +01001967 return tty;
1968}
1969
1970/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001971 * tty_lookup_driver - lookup a tty driver for a given device file
1972 * @device: device number
1973 * @filp: file pointer to tty
1974 * @noctty: set if the device should not become a controlling tty
1975 * @index: index for the device in the @return driver
1976 * @return: driver for this inode (with increased refcount)
1977 *
1978 * If @return is not erroneous, the caller is responsible to decrement the
1979 * refcount by tty_driver_kref_put.
1980 *
1981 * Locking: tty_mutex protects get_tty_driver
1982 */
1983static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1984 int *noctty, int *index)
1985{
1986 struct tty_driver *driver;
1987
Jiri Slaby2cd00502011-11-09 21:33:22 +01001988 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001989#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001990 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001991 extern struct tty_driver *console_driver;
1992 driver = tty_driver_kref_get(console_driver);
1993 *index = fg_console;
1994 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001995 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001996 }
1997#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001998 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001999 struct tty_driver *console_driver = console_device(index);
2000 if (console_driver) {
2001 driver = tty_driver_kref_get(console_driver);
2002 if (driver) {
2003 /* Don't let /dev/console block */
2004 filp->f_flags |= O_NONBLOCK;
2005 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01002006 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002007 }
2008 }
2009 return ERR_PTR(-ENODEV);
2010 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01002011 default:
2012 driver = get_tty_driver(device, index);
2013 if (!driver)
2014 return ERR_PTR(-ENODEV);
2015 break;
2016 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002017 return driver;
2018}
2019
2020/**
Alan Coxeeb89d92009-11-30 13:18:29 +00002021 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002022 * @inode: inode of device file
2023 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002025 * tty_open and tty_release keep up the tty count that contains the
2026 * number of opens done on a tty. We cannot use the inode-count, as
2027 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002029 * Open-counting is needed for pty masters, as well as for keeping
2030 * track of serial lines: DTR is dropped when the last close happens.
2031 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2032 *
2033 * The termios state of a pty is reset on first open so that
2034 * settings don't persist across reuse.
2035 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002036 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002037 * tty->count should protect the rest.
2038 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01002039 *
2040 * Note: the tty_unlock/lock cases without a ref are only safe due to
2041 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002043
Alan Coxeeb89d92009-11-30 13:18:29 +00002044static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045{
Jiri Slabyb82154a2011-11-09 21:33:19 +01002046 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01002048 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 int index;
2050 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07002051 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052
2053 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08002054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002056 retval = tty_alloc_file(filp);
2057 if (retval)
2058 return -ENOMEM;
2059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 noctty = filp->f_flags & O_NOCTTY;
2061 index = -1;
2062 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002063
Jiri Slabyb82154a2011-11-09 21:33:19 +01002064 tty = tty_open_current_tty(device, filp);
Peter Hurley52494ee2014-11-05 12:12:50 -05002065 if (!tty) {
2066 mutex_lock(&tty_mutex);
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002067 driver = tty_lookup_driver(device, filp, &noctty, &index);
2068 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002069 retval = PTR_ERR(driver);
2070 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002073 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01002074 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00002075 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002076 retval = PTR_ERR(tty);
2077 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00002078 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002079
2080 if (tty) {
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002081 mutex_unlock(&tty_mutex);
Peter Hurley52494ee2014-11-05 12:12:50 -05002082 tty_lock(tty);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002083 /* safe to drop the kref from tty_driver_lookup_tty() */
2084 tty_kref_put(tty);
Peter Hurley52494ee2014-11-05 12:12:50 -05002085 retval = tty_reopen(tty);
2086 if (retval < 0) {
2087 tty_unlock(tty);
2088 tty = ERR_PTR(retval);
2089 }
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002090 } else { /* Returns with the tty_lock held for now */
Peter Hurley52494ee2014-11-05 12:12:50 -05002091 tty = tty_init_dev(driver, index);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002092 mutex_unlock(&tty_mutex);
2093 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002094
Peter Hurley52494ee2014-11-05 12:12:50 -05002095 tty_driver_kref_put(driver);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002096 }
2097
Alan Coxeeb89d92009-11-30 13:18:29 +00002098 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002099 retval = PTR_ERR(tty);
2100 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00002101 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002103 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10002104
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002105 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2107 tty->driver->subtype == PTY_TYPE_MASTER)
2108 noctty = 1;
2109#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002110 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03002112 if (tty->ops->open)
2113 retval = tty->ops->open(tty, filp);
2114 else
2115 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 filp->f_flags = saved_flags;
2117
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 if (retval) {
2119#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002120 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
2121 retval, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122#endif
Alan Cox89c8d912012-08-08 16:30:13 +01002123 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00002124 tty_release(inode, filp);
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02002125 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 return retval;
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02002127
2128 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 return retval;
Arnd Bergmann64ba3dc32010-06-01 22:53:02 +02002130
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 schedule();
2132 /*
2133 * Need to reset f_op in case a hangup happened.
2134 */
Peter Hurley12569372014-11-05 12:26:24 -05002135 if (tty_hung_up_p(filp))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 filp->f_op = &tty_fops;
2137 goto retry_open;
2138 }
Peter Hurleyd4855e12013-11-19 08:46:27 -05002139 clear_bit(TTY_HUPPED, &tty->flags);
Alan Coxeeb89d92009-11-30 13:18:29 +00002140
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002141
Peter Hurley2c411c12014-10-16 14:59:47 -04002142 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002143 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 if (!noctty &&
2145 current->signal->leader &&
2146 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002147 tty->session == NULL)
Peter Hurleybce65f12014-10-16 14:59:43 -04002148 __proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002149 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley2c411c12014-10-16 14:59:47 -04002150 read_unlock(&tasklist_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01002151 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002153err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002154 mutex_unlock(&tty_mutex);
2155 /* after locks to avoid deadlock */
2156 if (!IS_ERR_OR_NULL(driver))
2157 tty_driver_kref_put(driver);
2158err_file:
2159 tty_free_file(filp);
2160 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161}
2162
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002163
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164
Alan Coxaf9b8972006-08-27 01:24:01 -07002165/**
2166 * tty_poll - check tty status
2167 * @filp: file being polled
2168 * @wait: poll wait structures to update
2169 *
2170 * Call the line discipline polling method to obtain the poll
2171 * status of the device.
2172 *
2173 * Locking: locks called line discipline but ldisc poll method
2174 * may be re-entered freely by other callers.
2175 */
2176
Alan Cox37bdfb02008-02-08 04:18:47 -08002177static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178{
Nick Piggind996b622010-08-18 04:37:36 +10002179 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 struct tty_ldisc *ld;
2181 int ret = 0;
2182
Al Viro6131ffa2013-02-27 16:59:05 -05002183 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002185
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002187 if (ld->ops->poll)
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002188 ret = ld->ops->poll(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 tty_ldisc_deref(ld);
2190 return ret;
2191}
2192
Arnd Bergmannec79d602010-06-01 22:53:01 +02002193static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194{
Nick Piggind996b622010-08-18 04:37:36 +10002195 struct tty_struct *tty = file_tty(filp);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002196 struct tty_ldisc *ldisc;
Alan Cox47f86832008-04-30 00:53:30 -07002197 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002198 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199
Al Viro6131ffa2013-02-27 16:59:05 -05002200 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002201 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002202
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 retval = fasync_helper(fd, filp, on, &tty->fasync);
2204 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002205 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002207 ldisc = tty_ldisc_ref(tty);
2208 if (ldisc) {
2209 if (ldisc->ops->fasync)
2210 ldisc->ops->fasync(tty, on);
2211 tty_ldisc_deref(ldisc);
2212 }
2213
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002215 enum pid_type type;
2216 struct pid *pid;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002217
Alan Cox47f86832008-04-30 00:53:30 -07002218 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002219 if (tty->pgrp) {
2220 pid = tty->pgrp;
2221 type = PIDTYPE_PGID;
2222 } else {
2223 pid = task_pid(current);
2224 type = PIDTYPE_PID;
2225 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002226 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002227 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002228 __f_setown(filp, pid, type, 0);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002229 put_pid(pid);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002230 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002232out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002233 return retval;
2234}
2235
2236static int tty_fasync(int fd, struct file *filp, int on)
2237{
Alan Cox89c8d912012-08-08 16:30:13 +01002238 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002239 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002240
2241 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002242 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002243 tty_unlock(tty);
2244
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002245 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246}
2247
Alan Coxaf9b8972006-08-27 01:24:01 -07002248/**
2249 * tiocsti - fake input character
2250 * @tty: tty to fake input into
2251 * @p: pointer to character
2252 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002253 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002254 * input management.
2255 *
2256 * FIXME: does not honour flow control ??
2257 *
2258 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -04002259 * Called functions take tty_ldiscs_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002260 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002261 *
2262 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002263 */
2264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265static int tiocsti(struct tty_struct *tty, char __user *p)
2266{
2267 char ch, mbz = 0;
2268 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002269
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2271 return -EPERM;
2272 if (get_user(ch, p))
2273 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002274 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002276 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 tty_ldisc_deref(ld);
2278 return 0;
2279}
2280
Alan Coxaf9b8972006-08-27 01:24:01 -07002281/**
2282 * tiocgwinsz - implement window query ioctl
2283 * @tty; tty
2284 * @arg: user buffer for result
2285 *
Alan Cox808a0d32006-09-29 02:00:40 -07002286 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002287 *
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002288 * Locking: tty->winsize_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002289 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002290 */
2291
Alan Cox37bdfb02008-02-08 04:18:47 -08002292static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293{
Alan Cox808a0d32006-09-29 02:00:40 -07002294 int err;
2295
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002296 mutex_lock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002297 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002298 mutex_unlock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002299
2300 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301}
2302
Alan Coxaf9b8972006-08-27 01:24:01 -07002303/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002304 * tty_do_resize - resize event
2305 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002306 * @rows: rows (character)
2307 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002308 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002309 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002310 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002311 */
2312
Alan Coxfc6f6232009-01-02 13:43:17 +00002313int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314{
Alan Coxfc6f6232009-01-02 13:43:17 +00002315 struct pid *pgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316
Alan Coxfc6f6232009-01-02 13:43:17 +00002317 /* Lock the tty */
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002318 mutex_lock(&tty->winsize_mutex);
Alan Coxfc6f6232009-01-02 13:43:17 +00002319 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002320 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002321
Peter Hurley5b239542014-10-16 14:59:45 -04002322 /* Signal the foreground process group */
2323 pgrp = tty_get_pgrp(tty);
Alan Cox47f86832008-04-30 00:53:30 -07002324 if (pgrp)
2325 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002326 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002327
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002328 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002329done:
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002330 mutex_unlock(&tty->winsize_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 return 0;
2332}
Martin Schwidefsky4d334fd2013-01-04 14:55:13 +01002333EXPORT_SYMBOL(tty_do_resize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334
Alan Coxaf9b8972006-08-27 01:24:01 -07002335/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002336 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002337 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002338 * @arg: user buffer for result
2339 *
2340 * Copies the user idea of the window size to the kernel. Traditionally
2341 * this is just advisory information but for the Linux console it
2342 * actually has driver level meaning and triggers a VC resize.
2343 *
2344 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002345 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002346 * tty termios mutex and ctrl_lock. The console takes its own lock
2347 * then calls into the default method.
2348 */
2349
Alan Coxfc6f6232009-01-02 13:43:17 +00002350static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002351{
2352 struct winsize tmp_ws;
2353 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2354 return -EFAULT;
2355
2356 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002357 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002358 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002359 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002360}
2361
2362/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002363 * tioccons - allow admin to move logical console
2364 * @file: the file to become console
2365 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002366 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002367 *
2368 * Locking: uses redirect_lock to guard the redirect information
2369 */
2370
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371static int tioccons(struct file *file)
2372{
2373 if (!capable(CAP_SYS_ADMIN))
2374 return -EPERM;
2375 if (file->f_op->write == redirected_tty_write) {
2376 struct file *f;
2377 spin_lock(&redirect_lock);
2378 f = redirect;
2379 redirect = NULL;
2380 spin_unlock(&redirect_lock);
2381 if (f)
2382 fput(f);
2383 return 0;
2384 }
2385 spin_lock(&redirect_lock);
2386 if (redirect) {
2387 spin_unlock(&redirect_lock);
2388 return -EBUSY;
2389 }
Al Virocb0942b2012-08-27 14:48:26 -04002390 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 spin_unlock(&redirect_lock);
2392 return 0;
2393}
2394
Alan Coxaf9b8972006-08-27 01:24:01 -07002395/**
2396 * fionbio - non blocking ioctl
2397 * @file: file to set blocking value
2398 * @p: user parameter
2399 *
2400 * Historical tty interfaces had a blocking control ioctl before
2401 * the generic functionality existed. This piece of history is preserved
2402 * in the expected tty API of posix OS's.
2403 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002404 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002405 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406
2407static int fionbio(struct file *file, int __user *p)
2408{
2409 int nonblock;
2410
2411 if (get_user(nonblock, p))
2412 return -EFAULT;
2413
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002414 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 if (nonblock)
2416 file->f_flags |= O_NONBLOCK;
2417 else
2418 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002419 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420 return 0;
2421}
2422
Alan Coxaf9b8972006-08-27 01:24:01 -07002423/**
2424 * tiocsctty - set controlling tty
2425 * @tty: tty structure
2426 * @arg: user argument
2427 *
2428 * This ioctl is used to manage job control. It permits a session
2429 * leader to set this tty as the controlling tty for the session.
2430 *
2431 * Locking:
Peter Hurleye218eb32014-10-16 14:59:49 -04002432 * Takes tty_lock() to serialize proc_set_tty() for this tty
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002433 * Takes tasklist_lock internally to walk sessions
2434 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002435 */
2436
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437static int tiocsctty(struct tty_struct *tty, int arg)
2438{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002439 int ret = 0;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002440
Peter Hurleye218eb32014-10-16 14:59:49 -04002441 tty_lock(tty);
Peter Hurley2c411c12014-10-16 14:59:47 -04002442 read_lock(&tasklist_lock);
2443
2444 if (current->signal->leader && (task_session(current) == tty->session))
2445 goto unlock;
2446
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 /*
2448 * The process must be a session leader and
2449 * not have a controlling tty already.
2450 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002451 if (!current->signal->leader || current->signal->tty) {
2452 ret = -EPERM;
2453 goto unlock;
2454 }
2455
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002456 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 /*
2458 * This tty is already the controlling
2459 * tty for another session group!
2460 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002461 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 /*
2463 * Steal it away
2464 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002465 session_clear_tty(tty->session);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002466 } else {
2467 ret = -EPERM;
2468 goto unlock;
2469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 }
Peter Hurleybce65f12014-10-16 14:59:43 -04002471 proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002472unlock:
Peter Hurley2c411c12014-10-16 14:59:47 -04002473 read_unlock(&tasklist_lock);
Peter Hurleye218eb32014-10-16 14:59:49 -04002474 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002475 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476}
2477
Alan Coxaf9b8972006-08-27 01:24:01 -07002478/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002479 * tty_get_pgrp - return a ref counted pgrp pid
2480 * @tty: tty to read
2481 *
2482 * Returns a refcounted instance of the pid struct for the process
2483 * group controlling the tty.
2484 */
2485
2486struct pid *tty_get_pgrp(struct tty_struct *tty)
2487{
2488 unsigned long flags;
2489 struct pid *pgrp;
2490
2491 spin_lock_irqsave(&tty->ctrl_lock, flags);
2492 pgrp = get_pid(tty->pgrp);
2493 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2494
2495 return pgrp;
2496}
2497EXPORT_SYMBOL_GPL(tty_get_pgrp);
2498
Peter Hurleye1c22962014-10-16 14:59:48 -04002499/*
2500 * This checks not only the pgrp, but falls back on the pid if no
2501 * satisfactory pgrp is found. I dunno - gdb doesn't work correctly
2502 * without this...
2503 *
2504 * The caller must hold rcu lock or the tasklist lock.
2505 */
2506static struct pid *session_of_pgrp(struct pid *pgrp)
2507{
2508 struct task_struct *p;
2509 struct pid *sid = NULL;
2510
2511 p = pid_task(pgrp, PIDTYPE_PGID);
2512 if (p == NULL)
2513 p = pid_task(pgrp, PIDTYPE_PID);
2514 if (p != NULL)
2515 sid = task_session(p);
2516
2517 return sid;
2518}
2519
Alan Cox5d0fdf12008-04-30 00:53:31 -07002520/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002521 * tiocgpgrp - get process group
2522 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002523 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002524 * @p: returned pid
2525 *
2526 * Obtain the process group of the tty. If there is no process group
2527 * return an error.
2528 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002529 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002530 */
2531
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2533{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002534 struct pid *pid;
2535 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 /*
2537 * (tty == real_tty) is a cheap way of
2538 * testing if the tty is NOT a master pty.
2539 */
2540 if (tty == real_tty && current->signal->tty != real_tty)
2541 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002542 pid = tty_get_pgrp(real_tty);
2543 ret = put_user(pid_vnr(pid), p);
2544 put_pid(pid);
2545 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002546}
2547
Alan Coxaf9b8972006-08-27 01:24:01 -07002548/**
2549 * tiocspgrp - attempt to set process group
2550 * @tty: tty passed by user
2551 * @real_tty: tty side device matching tty passed by user
2552 * @p: pid pointer
2553 *
2554 * Set the process group of the tty to the session passed. Only
2555 * permitted where the tty session is our session.
2556 *
Alan Cox47f86832008-04-30 00:53:30 -07002557 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002558 */
2559
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2561{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002562 struct pid *pgrp;
2563 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002565 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
2567 if (retval == -EIO)
2568 return -ENOTTY;
2569 if (retval)
2570 return retval;
2571 if (!current->signal->tty ||
2572 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002573 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002575 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002577 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002579 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002580 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002581 retval = -ESRCH;
2582 if (!pgrp)
2583 goto out_unlock;
2584 retval = -EPERM;
2585 if (session_of_pgrp(pgrp) != task_session(current))
2586 goto out_unlock;
2587 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002588 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002589 put_pid(real_tty->pgrp);
2590 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002591 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002592out_unlock:
2593 rcu_read_unlock();
2594 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595}
2596
Alan Coxaf9b8972006-08-27 01:24:01 -07002597/**
2598 * tiocgsid - get session id
2599 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002600 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002601 * @p: pointer to returned session id
2602 *
2603 * Obtain the session id of the tty. If there is no session
2604 * return an error.
2605 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002606 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002607 */
2608
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2610{
2611 /*
2612 * (tty == real_tty) is a cheap way of
2613 * testing if the tty is NOT a master pty.
2614 */
2615 if (tty == real_tty && current->signal->tty != real_tty)
2616 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002617 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002619 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620}
2621
Alan Coxaf9b8972006-08-27 01:24:01 -07002622/**
2623 * tiocsetd - set line discipline
2624 * @tty: tty device
2625 * @p: pointer to user data
2626 *
2627 * Set the line discipline according to user request.
2628 *
2629 * Locking: see tty_set_ldisc, this function is just a helper
2630 */
2631
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632static int tiocsetd(struct tty_struct *tty, int __user *p)
2633{
2634 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002635 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636
2637 if (get_user(ldisc, p))
2638 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002639
Alan Cox04f378b2008-04-30 00:53:29 -07002640 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002641
2642 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643}
2644
Alan Coxaf9b8972006-08-27 01:24:01 -07002645/**
2646 * send_break - performed time break
2647 * @tty: device to break on
2648 * @duration: timeout in mS
2649 *
2650 * Perform a timed break on hardware that lacks its own driver level
2651 * timed break functionality.
2652 *
2653 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002654 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002655 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002656 */
2657
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002658static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659{
Alan Cox9e989662008-07-22 11:18:03 +01002660 int retval;
2661
2662 if (tty->ops->break_ctl == NULL)
2663 return 0;
2664
2665 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2666 retval = tty->ops->break_ctl(tty, duration);
2667 else {
2668 /* Do the work ourselves */
2669 if (tty_write_lock(tty, 0) < 0)
2670 return -EINTR;
2671 retval = tty->ops->break_ctl(tty, -1);
2672 if (retval)
2673 goto out;
2674 if (!signal_pending(current))
2675 msleep_interruptible(duration);
2676 retval = tty->ops->break_ctl(tty, 0);
2677out:
2678 tty_write_unlock(tty);
2679 if (signal_pending(current))
2680 retval = -EINTR;
2681 }
2682 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683}
2684
Alan Coxaf9b8972006-08-27 01:24:01 -07002685/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002686 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002687 * @tty: tty device
2688 * @file: user file pointer
2689 * @p: pointer to result
2690 *
2691 * Obtain the modem status bits from the tty driver if the feature
2692 * is supported. Return -EINVAL if it is not available.
2693 *
2694 * Locking: none (up to the driver)
2695 */
2696
Alan Cox60b33c12011-02-14 16:26:14 +00002697static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698{
2699 int retval = -EINVAL;
2700
Alan Coxf34d7a52008-04-30 00:54:13 -07002701 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002702 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703
2704 if (retval >= 0)
2705 retval = put_user(retval, p);
2706 }
2707 return retval;
2708}
2709
Alan Coxaf9b8972006-08-27 01:24:01 -07002710/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002711 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002712 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002713 * @cmd: command - clear bits, set bits or set all
2714 * @p: pointer to desired bits
2715 *
2716 * Set the modem status bits from the tty driver if the feature
2717 * is supported. Return -EINVAL if it is not available.
2718 *
2719 * Locking: none (up to the driver)
2720 */
2721
Alan Cox20b9d172011-02-14 16:26:50 +00002722static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723 unsigned __user *p)
2724{
Alan Coxae677512008-07-16 21:56:54 +01002725 int retval;
2726 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727
Alan Coxae677512008-07-16 21:56:54 +01002728 if (tty->ops->tiocmset == NULL)
2729 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730
Alan Coxae677512008-07-16 21:56:54 +01002731 retval = get_user(val, p);
2732 if (retval)
2733 return retval;
2734 set = clear = 0;
2735 switch (cmd) {
2736 case TIOCMBIS:
2737 set = val;
2738 break;
2739 case TIOCMBIC:
2740 clear = val;
2741 break;
2742 case TIOCMSET:
2743 set = val;
2744 clear = ~val;
2745 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746 }
Alan Coxae677512008-07-16 21:56:54 +01002747 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2748 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002749 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750}
2751
Alan Coxd281da72010-09-16 18:21:24 +01002752static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2753{
2754 int retval = -EINVAL;
2755 struct serial_icounter_struct icount;
2756 memset(&icount, 0, sizeof(icount));
2757 if (tty->ops->get_icount)
2758 retval = tty->ops->get_icount(tty, &icount);
2759 if (retval != 0)
2760 return retval;
2761 if (copy_to_user(arg, &icount, sizeof(icount)))
2762 return -EFAULT;
2763 return 0;
2764}
2765
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002766static void tty_warn_deprecated_flags(struct serial_struct __user *ss)
2767{
2768 static DEFINE_RATELIMIT_STATE(depr_flags,
2769 DEFAULT_RATELIMIT_INTERVAL,
2770 DEFAULT_RATELIMIT_BURST);
2771 char comm[TASK_COMM_LEN];
2772 int flags;
2773
2774 if (get_user(flags, &ss->flags))
2775 return;
2776
2777 flags &= ASYNC_DEPRECATED;
2778
2779 if (flags && __ratelimit(&depr_flags))
2780 pr_warning("%s: '%s' is using deprecated serial flags (with no effect): %.8x\n",
2781 __func__, get_task_comm(comm, current), flags);
2782}
2783
Peter Hurley8f166e02014-10-16 14:59:41 -04002784/*
2785 * if pty, return the slave side (real_tty)
2786 * otherwise, return self
2787 */
2788static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +01002789{
2790 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2791 tty->driver->subtype == PTY_TYPE_MASTER)
2792 tty = tty->link;
2793 return tty;
2794}
Alan Coxe8b70e72009-06-11 12:48:02 +01002795
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796/*
2797 * Split this up, as gcc can choke on it otherwise..
2798 */
Alan Cox04f378b2008-04-30 00:53:29 -07002799long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800{
Nick Piggind996b622010-08-18 04:37:36 +10002801 struct tty_struct *tty = file_tty(file);
2802 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002803 void __user *p = (void __user *)arg;
2804 int retval;
2805 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002806
Al Viro6131ffa2013-02-27 16:59:05 -05002807 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 return -EINVAL;
2809
Alan Coxe8b70e72009-06-11 12:48:02 +01002810 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002811
2812 /*
2813 * Factor out some common prep work
2814 */
2815 switch (cmd) {
2816 case TIOCSETD:
2817 case TIOCSBRK:
2818 case TIOCCBRK:
2819 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002820 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821 retval = tty_check_change(tty);
2822 if (retval)
2823 return retval;
2824 if (cmd != TIOCCBRK) {
2825 tty_wait_until_sent(tty, 0);
2826 if (signal_pending(current))
2827 return -EINTR;
2828 }
2829 break;
2830 }
2831
Alan Cox9e989662008-07-22 11:18:03 +01002832 /*
2833 * Now do the stuff.
2834 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002836 case TIOCSTI:
2837 return tiocsti(tty, p);
2838 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002839 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002840 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002841 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002842 case TIOCCONS:
2843 return real_tty != tty ? -EINVAL : tioccons(file);
2844 case FIONBIO:
2845 return fionbio(file, p);
2846 case TIOCEXCL:
2847 set_bit(TTY_EXCLUSIVE, &tty->flags);
2848 return 0;
2849 case TIOCNXCL:
2850 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2851 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002852 case TIOCGEXCL:
2853 {
2854 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2855 return put_user(excl, (int __user *)p);
2856 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002857 case TIOCNOTTY:
2858 if (current->signal->tty != tty)
2859 return -ENOTTY;
2860 no_tty();
2861 return 0;
2862 case TIOCSCTTY:
2863 return tiocsctty(tty, arg);
2864 case TIOCGPGRP:
2865 return tiocgpgrp(tty, real_tty, p);
2866 case TIOCSPGRP:
2867 return tiocspgrp(tty, real_tty, p);
2868 case TIOCGSID:
2869 return tiocgsid(tty, real_tty, p);
2870 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002871 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002872 case TIOCSETD:
2873 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002874 case TIOCVHANGUP:
2875 if (!capable(CAP_SYS_ADMIN))
2876 return -EPERM;
2877 tty_vhangup(tty);
2878 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002879 case TIOCGDEV:
2880 {
2881 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2882 return put_user(ret, (unsigned int __user *)p);
2883 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002884 /*
2885 * Break handling
2886 */
2887 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002888 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002889 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002890 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002891 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002892 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002893 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002894 return 0;
2895 case TCSBRK: /* SVID version: non-zero arg --> no break */
2896 /* non-zero arg means wait for all output data
2897 * to be sent (performed above) but don't send break.
2898 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002900 if (!arg)
2901 return send_break(tty, 250);
2902 return 0;
2903 case TCSBRKP: /* support for POSIX tcsendbreak() */
2904 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905
Alan Cox37bdfb02008-02-08 04:18:47 -08002906 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002907 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002908 case TIOCMSET:
2909 case TIOCMBIC:
2910 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002911 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002912 case TIOCGICOUNT:
2913 retval = tty_tiocgicount(tty, p);
2914 /* For the moment allow fall through to the old method */
2915 if (retval != -EINVAL)
2916 return retval;
2917 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002918 case TCFLSH:
2919 switch (arg) {
2920 case TCIFLUSH:
2921 case TCIOFLUSH:
2922 /* flush tty buffer and allow ldisc to process ioctl */
Peter Hurley86c80a82014-11-05 12:13:09 -05002923 tty_buffer_flush(tty, NULL);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002924 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002925 }
2926 break;
Jiri Slaby8a8ae622014-11-06 16:56:33 +01002927 case TIOCSSERIAL:
2928 tty_warn_deprecated_flags(p);
2929 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002931 if (tty->ops->ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002932 retval = tty->ops->ioctl(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933 if (retval != -ENOIOCTLCMD)
2934 return retval;
2935 }
2936 ld = tty_ldisc_ref_wait(tty);
2937 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002938 if (ld->ops->ioctl) {
2939 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002941 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 }
2943 tty_ldisc_deref(ld);
2944 return retval;
2945}
2946
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002947#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002948static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002949 unsigned long arg)
2950{
Nick Piggind996b622010-08-18 04:37:36 +10002951 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002952 struct tty_ldisc *ld;
2953 int retval = -ENOIOCTLCMD;
2954
Al Viro6131ffa2013-02-27 16:59:05 -05002955 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002956 return -EINVAL;
2957
Alan Coxf34d7a52008-04-30 00:54:13 -07002958 if (tty->ops->compat_ioctl) {
Peter Hurleyc961bfb2014-11-05 12:26:25 -05002959 retval = tty->ops->compat_ioctl(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002960 if (retval != -ENOIOCTLCMD)
2961 return retval;
2962 }
2963
2964 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002965 if (ld->ops->compat_ioctl)
2966 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002967 else
2968 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002969 tty_ldisc_deref(ld);
2970
2971 return retval;
2972}
2973#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974
Al Viroc3c073f2012-08-21 22:32:06 -04002975static int this_tty(const void *t, struct file *file, unsigned fd)
2976{
2977 if (likely(file->f_op->read != tty_read))
2978 return 0;
2979 return file_tty(file) != t ? 0 : fd + 1;
2980}
2981
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982/*
2983 * This implements the "Secure Attention Key" --- the idea is to
2984 * prevent trojan horses by killing all processes associated with this
2985 * tty when the user hits the "Secure Attention Key". Required for
2986 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002987 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988 * This code could be nicer; ideally it should send a HUP, wait a few
2989 * seconds, then send a INT, and then a KILL signal. But you then
2990 * have to coordinate with the init process, since all processes associated
2991 * with the current tty must be dead before the new getty is allowed
2992 * to spawn.
2993 *
2994 * Now, if it would be correct ;-/ The current code has a nasty hole -
2995 * it doesn't catch files in flight. We may send the descriptor to ourselves
2996 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2997 *
2998 * Nasty bug: do_SAK is being called in interrupt context. This can
2999 * deadlock. We punt it up to process context. AKPM - 16Mar2001
3000 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003001void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002{
3003#ifdef TTY_SOFT_SAK
3004 tty_hangup(tty);
3005#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08003006 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003007 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08003009
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 if (!tty)
3011 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003012 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08003013
Dan Carpenterb3f13de2006-12-13 00:35:09 -08003014 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015
Alan Coxf34d7a52008-04-30 00:54:13 -07003016 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08003017
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003019 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003020 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08003021 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003022 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003023 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003024 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003025 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003026 /* Now kill any processes that happen to have the
3027 * tty open.
3028 */
3029 do_each_thread(g, p) {
3030 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003032 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003033 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003034 send_sig(SIGKILL, p, 1);
3035 continue;
3036 }
3037 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04003038 i = iterate_fd(p->files, 0, this_tty, tty);
3039 if (i != 0) {
3040 printk(KERN_NOTICE "SAK: killed process %d"
3041 " (%s): fd#%d opened to the tty\n",
3042 task_pid_nr(p), p->comm, i - 1);
3043 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044 }
3045 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003046 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047 read_unlock(&tasklist_lock);
3048#endif
3049}
3050
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003051static void do_SAK_work(struct work_struct *work)
3052{
3053 struct tty_struct *tty =
3054 container_of(work, struct tty_struct, SAK_work);
3055 __do_SAK(tty);
3056}
3057
Linus Torvalds1da177e2005-04-16 15:20:36 -07003058/*
3059 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3060 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3061 * the values which we write to it will be identical to the values which it
3062 * already has. --akpm
3063 */
3064void do_SAK(struct tty_struct *tty)
3065{
3066 if (!tty)
3067 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068 schedule_work(&tty->SAK_work);
3069}
3070
3071EXPORT_SYMBOL(do_SAK);
3072
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003073static int dev_match_devt(struct device *dev, const void *data)
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003074{
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003075 const dev_t *devt = data;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003076 return dev->devt == *devt;
3077}
3078
3079/* Must put_device() after it's unused! */
3080static struct device *tty_get_device(struct tty_struct *tty)
3081{
3082 dev_t devt = tty_devnum(tty);
3083 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3084}
3085
3086
Alan Coxaf9b8972006-08-27 01:24:01 -07003087/**
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003088 * alloc_tty_struct
Alan Coxaf9b8972006-08-27 01:24:01 -07003089 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003090 * This subroutine allocates and initializes a tty structure.
Alan Coxaf9b8972006-08-27 01:24:01 -07003091 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003092 * Locking: none - tty in question is not exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003093 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003094
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003095struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003096{
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003097 struct tty_struct *tty;
3098
3099 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
3100 if (!tty)
3101 return NULL;
3102
Alan Cox9c9f4de2008-10-13 10:37:26 +01003103 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01003105 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003106 tty->session = NULL;
3107 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01003108 mutex_init(&tty->legacy_mutex);
Peter Hurleyd8c1f922013-06-15 09:14:31 -04003109 mutex_init(&tty->throttle_mutex);
Peter Hurley6a1c0682013-06-15 09:14:23 -04003110 init_rwsem(&tty->termios_rwsem);
Peter Hurleydee4a0b2013-07-24 16:43:51 -04003111 mutex_init(&tty->winsize_mutex);
Peter Hurley36697522013-06-15 07:04:48 -04003112 init_ldsem(&tty->ldisc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003113 init_waitqueue_head(&tty->write_wait);
3114 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003115 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003116 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07003117 spin_lock_init(&tty->ctrl_lock);
Peter Hurleyf9e053d2014-09-10 15:06:31 -04003118 spin_lock_init(&tty->flow_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003120 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01003121
3122 tty->driver = driver;
3123 tty->ops = driver->ops;
3124 tty->index = idx;
3125 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003126 tty->dev = tty_get_device(tty);
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003127
3128 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003129}
3130
Alan Coxf34d7a52008-04-30 00:54:13 -07003131/**
Jiri Slaby67166712011-03-23 10:48:35 +01003132 * deinitialize_tty_struct
3133 * @tty: tty to deinitialize
3134 *
3135 * This subroutine deinitializes a tty structure that has been newly
3136 * allocated but tty_release cannot be called on that yet.
3137 *
3138 * Locking: none - tty in question must not be exposed at this point
3139 */
3140void deinitialize_tty_struct(struct tty_struct *tty)
3141{
3142 tty_ldisc_deinit(tty);
3143}
3144
3145/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003146 * tty_put_char - write one character to a tty
3147 * @tty: tty
3148 * @ch: character
3149 *
3150 * Write one byte to the tty using the provided put_char method
3151 * if present. Returns the number of characters successfully output.
3152 *
3153 * Note: the specific put_char operation in the driver layer may go
3154 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003156
Alan Coxf34d7a52008-04-30 00:54:13 -07003157int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158{
Alan Coxf34d7a52008-04-30 00:54:13 -07003159 if (tty->ops->put_char)
3160 return tty->ops->put_char(tty, ch);
3161 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162}
Alan Coxf34d7a52008-04-30 00:54:13 -07003163EXPORT_SYMBOL_GPL(tty_put_char);
3164
Alan Coxd81ed102008-10-13 10:41:42 +01003165struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003167static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3168 unsigned int index, unsigned int count)
3169{
3170 /* init here, since reused cdevs cause crashes */
3171 cdev_init(&driver->cdevs[index], &tty_fops);
3172 driver->cdevs[index].owner = driver->owner;
3173 return cdev_add(&driver->cdevs[index], dev, count);
3174}
3175
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003177 * tty_register_device - register a tty device
3178 * @driver: the tty driver that describes the tty device
3179 * @index: the index in the tty driver for this tty device
3180 * @device: a struct device that is associated with this tty device.
3181 * This field is optional, if there is no known struct device
3182 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003184 * Returns a pointer to the struct device for this tty device
3185 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003186 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003187 * This call is required to be made to register an individual tty device
3188 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3189 * that bit is not set, this function should not be called by a tty
3190 * driver.
3191 *
3192 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003194
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003195struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3196 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003198 return tty_register_device_attr(driver, index, device, NULL, NULL);
3199}
3200EXPORT_SYMBOL(tty_register_device);
3201
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003202static void tty_device_create_release(struct device *dev)
3203{
3204 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3205 kfree(dev);
3206}
3207
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003208/**
3209 * tty_register_device_attr - register a tty device
3210 * @driver: the tty driver that describes the tty device
3211 * @index: the index in the tty driver for this tty device
3212 * @device: a struct device that is associated with this tty device.
3213 * This field is optional, if there is no known struct device
3214 * for this tty device it can be set to NULL safely.
3215 * @drvdata: Driver data to be set to device.
3216 * @attr_grp: Attribute group to be set on device.
3217 *
3218 * Returns a pointer to the struct device for this tty device
3219 * (or ERR_PTR(-EFOO) on error).
3220 *
3221 * This call is required to be made to register an individual tty device
3222 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3223 * that bit is not set, this function should not be called by a tty
3224 * driver.
3225 *
3226 * Locking: ??
3227 */
3228struct device *tty_register_device_attr(struct tty_driver *driver,
3229 unsigned index, struct device *device,
3230 void *drvdata,
3231 const struct attribute_group **attr_grp)
3232{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003233 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003234 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3235 struct device *dev = NULL;
3236 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003237 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238
3239 if (index >= driver->num) {
3240 printk(KERN_ERR "Attempt to register invalid tty line number "
3241 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003242 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003243 }
3244
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245 if (driver->type == TTY_DRIVER_TYPE_PTY)
3246 pty_line_name(driver, index, name);
3247 else
3248 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003249
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003250 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003251 retval = tty_cdev_add(driver, devt, index, 1);
3252 if (retval)
3253 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003254 cdev = true;
3255 }
3256
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003257 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3258 if (!dev) {
3259 retval = -ENOMEM;
3260 goto error;
3261 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003262
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003263 dev->devt = devt;
3264 dev->class = tty_class;
3265 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003266 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003267 dev_set_name(dev, "%s", name);
3268 dev->groups = attr_grp;
3269 dev_set_drvdata(dev, drvdata);
3270
3271 retval = device_register(dev);
3272 if (retval)
3273 goto error;
3274
3275 return dev;
3276
3277error:
3278 put_device(dev);
3279 if (cdev)
3280 cdev_del(&driver->cdevs[index]);
3281 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003282}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003283EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284
3285/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003286 * tty_unregister_device - unregister a tty device
3287 * @driver: the tty driver that describes the tty device
3288 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003290 * If a tty device is registered with a call to tty_register_device() then
3291 * this function must be called when the tty device is gone.
3292 *
3293 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003295
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296void tty_unregister_device(struct tty_driver *driver, unsigned index)
3297{
Alan Cox37bdfb02008-02-08 04:18:47 -08003298 device_destroy(tty_class,
3299 MKDEV(driver->major, driver->minor_start) + index);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003300 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3301 cdev_del(&driver->cdevs[index]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003302}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303EXPORT_SYMBOL(tty_unregister_device);
3304
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003305/**
3306 * __tty_alloc_driver -- allocate tty driver
3307 * @lines: count of lines this driver can handle at most
3308 * @owner: module which is repsonsible for this driver
3309 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3310 *
3311 * This should not be called directly, some of the provided macros should be
3312 * used instead. Use IS_ERR and friends on @retval.
3313 */
3314struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3315 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003316{
3317 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003318 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003319 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003320
Jiri Slaby0019b402012-08-08 22:26:43 +02003321 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003322 return ERR_PTR(-EINVAL);
3323
Jean Delvare506eb992007-07-15 23:40:14 -07003324 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003325 if (!driver)
3326 return ERR_PTR(-ENOMEM);
3327
3328 kref_init(&driver->kref);
3329 driver->magic = TTY_DRIVER_MAGIC;
3330 driver->num = lines;
3331 driver->owner = owner;
3332 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003333
3334 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3335 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3336 GFP_KERNEL);
3337 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3338 GFP_KERNEL);
3339 if (!driver->ttys || !driver->termios) {
3340 err = -ENOMEM;
3341 goto err_free_all;
3342 }
3343 }
3344
3345 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3346 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3347 GFP_KERNEL);
3348 if (!driver->ports) {
3349 err = -ENOMEM;
3350 goto err_free_all;
3351 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003352 cdevs = lines;
3353 }
3354
3355 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3356 if (!driver->cdevs) {
3357 err = -ENOMEM;
3358 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003359 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003360
Linus Torvalds1da177e2005-04-16 15:20:36 -07003361 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003362err_free_all:
3363 kfree(driver->ports);
3364 kfree(driver->ttys);
3365 kfree(driver->termios);
3366 kfree(driver);
3367 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003369EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003370
Alan Cox7d7b93c2008-10-13 10:42:09 +01003371static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003373 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3374 int i;
3375 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003376
3377 if (driver->flags & TTY_DRIVER_INSTALLED) {
3378 /*
3379 * Free the termios and termios_locked structures because
3380 * we don't want to get memory leaks when modular tty
3381 * drivers are removed from the kernel.
3382 */
3383 for (i = 0; i < driver->num; i++) {
3384 tp = driver->termios[i];
3385 if (tp) {
3386 driver->termios[i] = NULL;
3387 kfree(tp);
3388 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003389 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3390 tty_unregister_device(driver, i);
3391 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003392 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003393 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3394 cdev_del(&driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003395 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003396 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003397 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003398 kfree(driver->termios);
3399 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003400 kfree(driver);
3401}
3402
Alan Cox7d7b93c2008-10-13 10:42:09 +01003403void tty_driver_kref_put(struct tty_driver *driver)
3404{
3405 kref_put(&driver->kref, destruct_tty_driver);
3406}
3407EXPORT_SYMBOL(tty_driver_kref_put);
3408
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003409void tty_set_operations(struct tty_driver *driver,
3410 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003411{
Alan Coxf34d7a52008-04-30 00:54:13 -07003412 driver->ops = op;
3413};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003414EXPORT_SYMBOL(tty_set_operations);
3415
Alan Cox7d7b93c2008-10-13 10:42:09 +01003416void put_tty_driver(struct tty_driver *d)
3417{
3418 tty_driver_kref_put(d);
3419}
3420EXPORT_SYMBOL(put_tty_driver);
3421
Linus Torvalds1da177e2005-04-16 15:20:36 -07003422/*
3423 * Called by a tty driver to register itself.
3424 */
3425int tty_register_driver(struct tty_driver *driver)
3426{
3427 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003428 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003430 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431
Linus Torvalds1da177e2005-04-16 15:20:36 -07003432 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003433 error = alloc_chrdev_region(&dev, driver->minor_start,
3434 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435 if (!error) {
3436 driver->major = MAJOR(dev);
3437 driver->minor_start = MINOR(dev);
3438 }
3439 } else {
3440 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003441 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003442 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003443 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003444 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003445
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003446 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3447 error = tty_cdev_add(driver, dev, 0, driver->num);
3448 if (error)
3449 goto err_unreg_char;
3450 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003452 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003454 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003455
3456 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003457 for (i = 0; i < driver->num; i++) {
3458 d = tty_register_device(driver, i, NULL);
3459 if (IS_ERR(d)) {
3460 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003461 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003462 }
3463 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003464 }
3465 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003466 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003468
Jiri Slaby16a02082012-08-08 22:26:42 +02003469err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003470 for (i--; i >= 0; i--)
3471 tty_unregister_device(driver, i);
3472
3473 mutex_lock(&tty_mutex);
3474 list_del(&driver->tty_drivers);
3475 mutex_unlock(&tty_mutex);
3476
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003477err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003478 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003479err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003480 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003481}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003482EXPORT_SYMBOL(tty_register_driver);
3483
3484/*
3485 * Called by a tty driver to unregister itself.
3486 */
3487int tty_unregister_driver(struct tty_driver *driver)
3488{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003489#if 0
3490 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003491 if (driver->refcount)
3492 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003493#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3495 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003496 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003498 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003499 return 0;
3500}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003501
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502EXPORT_SYMBOL(tty_unregister_driver);
3503
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003504dev_t tty_devnum(struct tty_struct *tty)
3505{
3506 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3507}
3508EXPORT_SYMBOL(tty_devnum);
3509
Alan Coxd81ed102008-10-13 10:41:42 +01003510void tty_default_fops(struct file_operations *fops)
3511{
3512 *fops = tty_fops;
3513}
3514
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515/*
3516 * Initialize the console device. This is called *early*, so
3517 * we can't necessarily depend on lots of kernel help here.
3518 * Just do some early initializations, and do the complex setup
3519 * later.
3520 */
3521void __init console_init(void)
3522{
3523 initcall_t *call;
3524
3525 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003526 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003527
3528 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003529 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530 * inform about problems etc..
3531 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532 call = __con_initcall_start;
3533 while (call < __con_initcall_end) {
3534 (*call)();
3535 call++;
3536 }
3537}
3538
Al Viro2c9ede52011-07-23 20:24:48 -04003539static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003540{
3541 if (!mode)
3542 return NULL;
3543 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3544 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3545 *mode = 0666;
3546 return NULL;
3547}
3548
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549static int __init tty_class_init(void)
3550{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003551 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552 if (IS_ERR(tty_class))
3553 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003554 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003555 return 0;
3556}
3557
3558postcore_initcall(tty_class_init);
3559
3560/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003561static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562
Kay Sieversfbc92a32010-12-01 18:51:05 +01003563static ssize_t show_cons_active(struct device *dev,
3564 struct device_attribute *attr, char *buf)
3565{
3566 struct console *cs[16];
3567 int i = 0;
3568 struct console *c;
3569 ssize_t count = 0;
3570
Torben Hohnac751ef2011-01-25 15:07:35 -08003571 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003572 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003573 if (!c->device)
3574 continue;
3575 if (!c->write)
3576 continue;
3577 if ((c->flags & CON_ENABLED) == 0)
3578 continue;
3579 cs[i++] = c;
3580 if (i >= ARRAY_SIZE(cs))
3581 break;
3582 }
Hannes Reinecke723abd82014-02-27 12:30:51 +01003583 while (i--) {
3584 int index = cs[i]->index;
3585 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3586
3587 /* don't resolve tty0 as some programs depend on it */
3588 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3589 count += tty_line_name(drv, index, buf + count);
3590 else
3591 count += sprintf(buf + count, "%s%d",
3592 cs[i]->name, cs[i]->index);
3593
3594 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3595 }
Torben Hohnac751ef2011-01-25 15:07:35 -08003596 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003597
3598 return count;
3599}
3600static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3601
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003602static struct attribute *cons_dev_attrs[] = {
3603 &dev_attr_active.attr,
3604 NULL
3605};
3606
3607ATTRIBUTE_GROUPS(cons_dev);
3608
Kay Sieversfbc92a32010-12-01 18:51:05 +01003609static struct device *consdev;
3610
3611void console_sysfs_notify(void)
3612{
3613 if (consdev)
3614 sysfs_notify(&consdev->kobj, NULL, "active");
3615}
3616
Linus Torvalds1da177e2005-04-16 15:20:36 -07003617/*
3618 * Ok, now we can initialize the rest of the tty devices and can count
3619 * on memory allocations, interrupts etc..
3620 */
David Howells31d1d482010-08-06 16:34:43 +01003621int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622{
3623 cdev_init(&tty_cdev, &tty_fops);
3624 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3625 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3626 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003627 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003628
3629 cdev_init(&console_cdev, &console_fops);
3630 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3631 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3632 panic("Couldn't register /dev/console driver\n");
Takashi Iwai1083a7b2015-02-05 11:07:42 +01003633 consdev = device_create_with_groups(tty_class, NULL,
3634 MKDEV(TTYAUX_MAJOR, 1), NULL,
3635 cons_dev_groups, "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003636 if (IS_ERR(consdev))
3637 consdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003640 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003641#endif
3642 return 0;
3643}
David Howells31d1d482010-08-06 16:34:43 +01003644