blob: adbd9acf817f1594b04357274355714b99c6ea7d [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;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400170 if (tty->dev)
171 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 kfree(tty->write_buf);
Alan Cox89c8d912012-08-08 16:30:13 +0100173 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 kfree(tty);
175}
176
Nick Piggind996b622010-08-18 04:37:36 +1000177static inline struct tty_struct *file_tty(struct file *file)
178{
179 return ((struct tty_file_private *)file->private_data)->tty;
180}
181
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200182int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000183{
184 struct tty_file_private *priv;
185
Pekka Enbergf573bd12010-08-24 07:48:34 +0300186 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
187 if (!priv)
188 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000189
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200190 file->private_data = priv;
191
192 return 0;
193}
194
195/* Associate a new file with the tty structure */
196void tty_add_file(struct tty_struct *tty, struct file *file)
197{
198 struct tty_file_private *priv = file->private_data;
199
Nick Piggind996b622010-08-18 04:37:36 +1000200 priv->tty = tty;
201 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000202
203 spin_lock(&tty_files_lock);
204 list_add(&priv->list, &tty->tty_files);
205 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200206}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300207
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200208/**
209 * tty_free_file - free file->private_data
210 *
211 * This shall be used only for fail path handling when tty_add_file was not
212 * called yet.
213 */
214void tty_free_file(struct file *file)
215{
216 struct tty_file_private *priv = file->private_data;
217
218 file->private_data = NULL;
219 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000220}
221
222/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800223static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000224{
225 struct tty_file_private *priv = file->private_data;
226
227 spin_lock(&tty_files_lock);
228 list_del(&priv->list);
229 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200230 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000231}
232
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
235
Alan Coxaf9b8972006-08-27 01:24:01 -0700236/**
237 * tty_name - return tty naming
238 * @tty: tty structure
239 * @buf: buffer for output
240 *
241 * Convert a tty structure into a name. The name reflects the kernel
242 * naming policy and if udev is in use may not reflect user space
243 *
244 * Locking: none
245 */
246
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247char *tty_name(struct tty_struct *tty, char *buf)
248{
249 if (!tty) /* Hmm. NULL pointer. That's fun. */
250 strcpy(buf, "NULL tty");
251 else
252 strcpy(buf, tty->name);
253 return buf;
254}
255
256EXPORT_SYMBOL(tty_name);
257
Andrew Mortond769a662005-05-05 16:15:50 -0700258int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 const char *routine)
260{
261#ifdef TTY_PARANOIA_CHECK
262 if (!tty) {
263 printk(KERN_WARNING
264 "null TTY for (%d:%d) in %s\n",
265 imajor(inode), iminor(inode), routine);
266 return 1;
267 }
268 if (tty->magic != TTY_MAGIC) {
269 printk(KERN_WARNING
270 "bad magic number for tty struct (%d:%d) in %s\n",
271 imajor(inode), iminor(inode), routine);
272 return 1;
273 }
274#endif
275 return 0;
276}
277
Peter Hurleydeb287e2014-11-05 12:12:55 -0500278/* Caller must hold tty_lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279static int check_tty_count(struct tty_struct *tty, const char *routine)
280{
281#ifdef CHECK_TTY_COUNT
282 struct list_head *p;
283 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800284
Nick Pigginee2ffa02010-08-18 04:37:35 +1000285 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 list_for_each(p, &tty->tty_files) {
287 count++;
288 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000289 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
291 tty->driver->subtype == PTY_TYPE_SLAVE &&
292 tty->link && tty->link->count)
293 count++;
294 if (tty->count != count) {
295 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
296 "!= #fd's(%d) in %s\n",
297 tty->name, tty->count, count, routine);
298 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800299 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300#endif
301 return 0;
302}
303
Alan Coxaf9b8972006-08-27 01:24:01 -0700304/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700305 * get_tty_driver - find device of a tty
306 * @dev_t: device identifier
307 * @index: returns the index of the tty
308 *
309 * This routine returns a tty driver structure, given a device number
310 * and also passes back the index number.
311 *
312 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315static struct tty_driver *get_tty_driver(dev_t device, int *index)
316{
317 struct tty_driver *p;
318
319 list_for_each_entry(p, &tty_drivers, tty_drivers) {
320 dev_t base = MKDEV(p->major, p->minor_start);
321 if (device < base || device >= base + p->num)
322 continue;
323 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100324 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 }
326 return NULL;
327}
328
Jason Wesself2d937f2008-04-17 20:05:37 +0200329#ifdef CONFIG_CONSOLE_POLL
330
331/**
332 * tty_find_polling_driver - find device of a polled tty
333 * @name: name string to match
334 * @line: pointer to resulting tty line nr
335 *
336 * This routine returns a tty driver structure, given a name
337 * and the condition that the tty driver is capable of polled
338 * operation.
339 */
340struct tty_driver *tty_find_polling_driver(char *name, int *line)
341{
342 struct tty_driver *p, *res = NULL;
343 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500344 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100345 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200346
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500347 for (str = name; *str; str++)
348 if ((*str >= '0' && *str <= '9') || *str == ',')
349 break;
350 if (!*str)
351 return NULL;
352
353 len = str - name;
354 tty_line = simple_strtoul(str, &str, 10);
355
Jason Wesself2d937f2008-04-17 20:05:37 +0200356 mutex_lock(&tty_mutex);
357 /* Search through the tty devices to look for a match */
358 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500359 if (strncmp(name, p->name, len) != 0)
360 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100361 stp = str;
362 if (*stp == ',')
363 stp++;
364 if (*stp == '\0')
365 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200366
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200367 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100368 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100369 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200370 *line = tty_line;
371 break;
372 }
373 }
374 mutex_unlock(&tty_mutex);
375
376 return res;
377}
378EXPORT_SYMBOL_GPL(tty_find_polling_driver);
379#endif
380
Alan Coxaf9b8972006-08-27 01:24:01 -0700381/**
382 * tty_check_change - check for POSIX terminal changes
383 * @tty: tty to check
384 *
385 * If we try to write to, or set the state of, a terminal and we're
386 * not in the foreground, send a SIGTTOU. If the signal is blocked or
387 * ignored, go ahead and perform the operation. (POSIX 7.2)
388 *
Alan Cox978e5952008-04-30 00:53:59 -0700389 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700391
Alan Cox37bdfb02008-02-08 04:18:47 -0800392int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393{
Alan Cox47f86832008-04-30 00:53:30 -0700394 unsigned long flags;
395 int ret = 0;
396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 if (current->signal->tty != tty)
398 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700399
400 spin_lock_irqsave(&tty->ctrl_lock, flags);
401
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800402 if (!tty->pgrp) {
403 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700404 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800406 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700407 goto out_unlock;
408 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700410 goto out;
411 if (is_current_pgrp_orphaned()) {
412 ret = -EIO;
413 goto out;
414 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700415 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
416 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700417 ret = -ERESTARTSYS;
418out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700419 return ret;
420out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700421 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
422 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423}
424
425EXPORT_SYMBOL(tty_check_change);
426
Alan Cox37bdfb02008-02-08 04:18:47 -0800427static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 size_t count, loff_t *ppos)
429{
430 return 0;
431}
432
Alan Cox37bdfb02008-02-08 04:18:47 -0800433static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 size_t count, loff_t *ppos)
435{
436 return -EIO;
437}
438
439/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800440static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
443}
444
Alan Cox04f378b2008-04-30 00:53:29 -0700445static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
446 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700447{
448 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
449}
450
Alan Cox37bdfb02008-02-08 04:18:47 -0800451static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700452 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
454 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
455}
456
Arjan van de Ven62322d22006-07-03 00:24:21 -0700457static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 .llseek = no_llseek,
459 .read = tty_read,
460 .write = tty_write,
461 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700462 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700463 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 .open = tty_open,
465 .release = tty_release,
466 .fasync = tty_fasync,
467};
468
Arjan van de Ven62322d22006-07-03 00:24:21 -0700469static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 .llseek = no_llseek,
471 .read = tty_read,
472 .write = redirected_tty_write,
473 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700474 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700475 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 .open = tty_open,
477 .release = tty_release,
478 .fasync = tty_fasync,
479};
480
Arjan van de Ven62322d22006-07-03 00:24:21 -0700481static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 .llseek = no_llseek,
483 .read = hung_up_tty_read,
484 .write = hung_up_tty_write,
485 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700486 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700487 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 .release = tty_release,
489};
490
491static DEFINE_SPINLOCK(redirect_lock);
492static struct file *redirect;
493
Peter Hurley11d9bef2014-10-16 14:59:42 -0400494
495void proc_clear_tty(struct task_struct *p)
496{
497 unsigned long flags;
498 struct tty_struct *tty;
499 spin_lock_irqsave(&p->sighand->siglock, flags);
500 tty = p->signal->tty;
501 p->signal->tty = NULL;
502 spin_unlock_irqrestore(&p->sighand->siglock, flags);
503 tty_kref_put(tty);
504}
505
Peter Hurley2c411c12014-10-16 14:59:47 -0400506/**
507 * proc_set_tty - set the controlling terminal
508 *
509 * Only callable by the session leader and only if it does not already have
510 * a controlling terminal.
511 *
Peter Hurleye218eb32014-10-16 14:59:49 -0400512 * Caller must hold: tty_lock()
513 * a readlock on tasklist_lock
Peter Hurley2c411c12014-10-16 14:59:47 -0400514 * sighand lock
515 */
Peter Hurleybce65f12014-10-16 14:59:43 -0400516static void __proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400517{
Peter Hurleyae28fa72014-10-16 14:59:46 -0400518 unsigned long flags;
519
Peter Hurleyae28fa72014-10-16 14:59:46 -0400520 spin_lock_irqsave(&tty->ctrl_lock, flags);
Peter Hurleya3618582014-10-16 14:59:50 -0400521 /*
522 * The session and fg pgrp references will be non-NULL if
523 * tiocsctty() is stealing the controlling tty
524 */
Peter Hurleyae28fa72014-10-16 14:59:46 -0400525 put_pid(tty->session);
526 put_pid(tty->pgrp);
527 tty->pgrp = get_pid(task_pgrp(current));
528 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
529 tty->session = get_pid(task_session(current));
530 if (current->signal->tty) {
531 printk(KERN_DEBUG "tty not NULL!!\n");
532 tty_kref_put(current->signal->tty);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400533 }
Peter Hurleybce65f12014-10-16 14:59:43 -0400534 put_pid(current->signal->tty_old_pgrp);
535 current->signal->tty = tty_kref_get(tty);
536 current->signal->tty_old_pgrp = NULL;
Peter Hurley11d9bef2014-10-16 14:59:42 -0400537}
538
Peter Hurleybce65f12014-10-16 14:59:43 -0400539static void proc_set_tty(struct tty_struct *tty)
Peter Hurley11d9bef2014-10-16 14:59:42 -0400540{
Peter Hurleybce65f12014-10-16 14:59:43 -0400541 spin_lock_irq(&current->sighand->siglock);
542 __proc_set_tty(tty);
543 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley11d9bef2014-10-16 14:59:42 -0400544}
545
546struct tty_struct *get_current_tty(void)
547{
548 struct tty_struct *tty;
549 unsigned long flags;
550
551 spin_lock_irqsave(&current->sighand->siglock, flags);
552 tty = tty_kref_get(current->signal->tty);
553 spin_unlock_irqrestore(&current->sighand->siglock, flags);
554 return tty;
555}
556EXPORT_SYMBOL_GPL(get_current_tty);
557
558static void session_clear_tty(struct pid *session)
559{
560 struct task_struct *p;
561 do_each_pid_task(session, PIDTYPE_SID, p) {
562 proc_clear_tty(p);
563 } while_each_pid_task(session, PIDTYPE_SID, p);
564}
565
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566/**
567 * tty_wakeup - request more data
568 * @tty: terminal
569 *
570 * Internal and external helper for wakeups of tty. This function
571 * informs the line discipline if present that the driver is ready
572 * to receive more output data.
573 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800574
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575void tty_wakeup(struct tty_struct *tty)
576{
577 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
580 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800581 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100582 if (ld->ops->write_wakeup)
583 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 tty_ldisc_deref(ld);
585 }
586 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700587 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588}
589
590EXPORT_SYMBOL_GPL(tty_wakeup);
591
592/**
Peter Hurleyea648a42013-03-06 07:20:53 -0500593 * tty_signal_session_leader - sends SIGHUP to session leader
Peter Hurleyf91e2592013-03-06 07:20:56 -0500594 * @tty controlling tty
595 * @exit_session if non-zero, signal all foreground group processes
Peter Hurleyea648a42013-03-06 07:20:53 -0500596 *
Peter Hurleyf91e2592013-03-06 07:20:56 -0500597 * Send SIGHUP and SIGCONT to the session leader and its process group.
598 * Optionally, signal all processes in the foreground process group.
Peter Hurleyea648a42013-03-06 07:20:53 -0500599 *
600 * Returns the number of processes in the session with this tty
601 * as their controlling terminal. This value is used to drop
602 * tty references for those processes.
603 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500604static int tty_signal_session_leader(struct tty_struct *tty, int exit_session)
Peter Hurleyea648a42013-03-06 07:20:53 -0500605{
606 struct task_struct *p;
Peter Hurleyea648a42013-03-06 07:20:53 -0500607 int refs = 0;
Peter Hurleyf91e2592013-03-06 07:20:56 -0500608 struct pid *tty_pgrp = NULL;
Peter Hurleyea648a42013-03-06 07:20:53 -0500609
610 read_lock(&tasklist_lock);
611 if (tty->session) {
612 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
613 spin_lock_irq(&p->sighand->siglock);
614 if (p->signal->tty == tty) {
615 p->signal->tty = NULL;
616 /* We defer the dereferences outside fo
617 the tasklist lock */
618 refs++;
619 }
620 if (!p->signal->leader) {
621 spin_unlock_irq(&p->sighand->siglock);
622 continue;
623 }
624 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
625 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
626 put_pid(p->signal->tty_old_pgrp); /* A noop */
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500627 spin_lock(&tty->ctrl_lock);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500628 tty_pgrp = get_pid(tty->pgrp);
Peter Hurleyea648a42013-03-06 07:20:53 -0500629 if (tty->pgrp)
630 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Peter Hurleybc30c3b2013-03-06 07:20:55 -0500631 spin_unlock(&tty->ctrl_lock);
Peter Hurleyea648a42013-03-06 07:20:53 -0500632 spin_unlock_irq(&p->sighand->siglock);
633 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
634 }
635 read_unlock(&tasklist_lock);
636
Peter Hurleyf91e2592013-03-06 07:20:56 -0500637 if (tty_pgrp) {
638 if (exit_session)
639 kill_pgrp(tty_pgrp, SIGHUP, exit_session);
640 put_pid(tty_pgrp);
641 }
642
Peter Hurleyea648a42013-03-06 07:20:53 -0500643 return refs;
644}
645
646/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200647 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000648 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700649 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800650 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700651 * synchronous but doesn't hold any locks, so we need to make sure we
652 * have the appropriate locks for what we're doing.
653 *
654 * The hangup event clears any pending redirections onto the hung up
655 * device. It ensures future writes will error and it does the needed
656 * line discipline hangup and signal delivery. The tty object itself
657 * remains intact.
658 *
659 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200660 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800661 * redirect lock for undoing redirection
662 * file list lock for manipulating list of ttys
Peter Hurley137084b2013-06-15 07:04:46 -0400663 * tty_ldiscs_lock from called functions
Peter Hurley6a1c0682013-06-15 09:14:23 -0400664 * termios_rwsem resetting termios data
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800665 * tasklist_lock to walk task list for hangup event
666 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 */
Peter Hurleyf91e2592013-03-06 07:20:56 -0500668static void __tty_hangup(struct tty_struct *tty, int exit_session)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
Alan Cox37bdfb02008-02-08 04:18:47 -0800670 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 struct file *filp, *f = NULL;
Nick Piggind996b622010-08-18 04:37:36 +1000672 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 int closecount = 0, n;
Peter Hurleyea648a42013-03-06 07:20:53 -0500674 int refs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676 if (!tty)
677 return;
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000681 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 f = redirect;
683 redirect = NULL;
684 }
685 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800686
Alan Cox89c8d912012-08-08 16:30:13 +0100687 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200688
Peter Hurleycb50e522013-07-31 14:05:45 -0400689 if (test_bit(TTY_HUPPED, &tty->flags)) {
690 tty_unlock(tty);
691 return;
692 }
693
Arnd Bergmannec79d602010-06-01 22:53:01 +0200694 /* inuse_filps is protected by the single tty lock,
695 this really needs to change if we want to flush the
696 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200697 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000698
Nick Pigginee2ffa02010-08-18 04:37:35 +1000699 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000701 list_for_each_entry(priv, &tty->tty_files, list) {
702 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 if (filp->f_op->write == redirected_tty_write)
704 cons_filp = filp;
705 if (filp->f_op->write != tty_write)
706 continue;
707 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200708 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 filp->f_op = &hung_up_tty_fops;
710 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000711 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800712
Peter Hurley25fdf242013-03-06 07:20:57 -0500713 refs = tty_signal_session_leader(tty, exit_session);
714 /* Account for the p->signal references we killed */
715 while (refs--)
716 tty_kref_put(tty);
717
Alan Coxc65c9bc2009-06-11 12:50:12 +0100718 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800719
Peter Hurley20cc2252013-03-06 07:20:54 -0500720 spin_lock_irq(&tty->ctrl_lock);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100721 clear_bit(TTY_THROTTLED, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100722 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600723 put_pid(tty->session);
724 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800725 tty->session = NULL;
726 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 tty->ctrl_status = 0;
Peter Hurley20cc2252013-03-06 07:20:54 -0500728 spin_unlock_irq(&tty->ctrl_lock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800731 * If one of the devices matches a console pointer, we
732 * cannot just call hangup() because that will cause
733 * tty->count and state->count to go out of sync.
734 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 */
736 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700737 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700739 tty->ops->close(tty, cons_filp);
740 } else if (tty->ops->hangup)
Peter Hurley7c6d3402014-06-16 09:17:08 -0400741 tty->ops->hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800742 /*
743 * We don't want to have driver/ldisc interactions beyond
744 * the ones we did here. The driver layer expects no
745 * calls after ->hangup() from the ldisc side. However we
746 * can't yet guarantee all that.
747 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 set_bit(TTY_HUPPED, &tty->flags);
Alan Cox89c8d912012-08-08 16:30:13 +0100749 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 if (f)
752 fput(f);
753}
754
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200755static void do_tty_hangup(struct work_struct *work)
756{
757 struct tty_struct *tty =
758 container_of(work, struct tty_struct, hangup_work);
759
Peter Hurleyf91e2592013-03-06 07:20:56 -0500760 __tty_hangup(tty, 0);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200761}
762
Alan Coxaf9b8972006-08-27 01:24:01 -0700763/**
764 * tty_hangup - trigger a hangup event
765 * @tty: tty to hangup
766 *
767 * A carrier loss (virtual or otherwise) has occurred on this like
768 * schedule a hangup sequence to run after this event.
769 */
770
Alan Cox37bdfb02008-02-08 04:18:47 -0800771void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772{
773#ifdef TTY_DEBUG_HANGUP
774 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
776#endif
777 schedule_work(&tty->hangup_work);
778}
779
780EXPORT_SYMBOL(tty_hangup);
781
Alan Coxaf9b8972006-08-27 01:24:01 -0700782/**
783 * tty_vhangup - process vhangup
784 * @tty: tty to hangup
785 *
786 * The user has asked via system call for the terminal to be hung up.
787 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200788 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700789 */
790
Alan Cox37bdfb02008-02-08 04:18:47 -0800791void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792{
793#ifdef TTY_DEBUG_HANGUP
794 char buf[64];
795
796 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
797#endif
Peter Hurleyf91e2592013-03-06 07:20:56 -0500798 __tty_hangup(tty, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
Alan Cox37bdfb02008-02-08 04:18:47 -0800800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801EXPORT_SYMBOL(tty_vhangup);
802
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200803
Alan Coxaf9b8972006-08-27 01:24:01 -0700804/**
Alan Cox2cb59982008-10-13 10:40:30 +0100805 * tty_vhangup_self - process vhangup for own ctty
806 *
807 * Perform a vhangup on the current controlling tty
808 */
809
810void tty_vhangup_self(void)
811{
812 struct tty_struct *tty;
813
Alan Cox2cb59982008-10-13 10:40:30 +0100814 tty = get_current_tty();
815 if (tty) {
816 tty_vhangup(tty);
817 tty_kref_put(tty);
818 }
Alan Cox2cb59982008-10-13 10:40:30 +0100819}
820
821/**
Peter Hurleyf91e2592013-03-06 07:20:56 -0500822 * tty_vhangup_session - hangup session leader exit
823 * @tty: tty to hangup
824 *
825 * The session leader is exiting and hanging up its controlling terminal.
826 * Every process in the foreground process group is signalled SIGHUP.
827 *
828 * We do this synchronously so that when the syscall returns the process
829 * is complete. That guarantee is necessary for security reasons.
830 */
831
Changlong Xie44a459f2013-03-20 08:42:04 +0800832static void tty_vhangup_session(struct tty_struct *tty)
Peter Hurleyf91e2592013-03-06 07:20:56 -0500833{
834#ifdef TTY_DEBUG_HANGUP
835 char buf[64];
836
837 printk(KERN_DEBUG "%s vhangup session...\n", tty_name(tty, buf));
838#endif
839 __tty_hangup(tty, 1);
840}
841
842/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700843 * tty_hung_up_p - was tty hung up
844 * @filp: file pointer of tty
845 *
846 * Return true if the tty has been subject to a vhangup or a carrier
847 * loss
848 */
849
Alan Cox37bdfb02008-02-08 04:18:47 -0800850int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851{
852 return (filp->f_op == &hung_up_tty_fops);
853}
854
855EXPORT_SYMBOL(tty_hung_up_p);
856
Alan Coxaf9b8972006-08-27 01:24:01 -0700857/**
858 * disassociate_ctty - disconnect controlling tty
859 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700861 * This function is typically called only by the session leader, when
862 * it wants to disassociate itself from its controlling tty.
863 *
864 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
866 * (2) Clears the tty from being controlling the session
867 * (3) Clears the controlling tty for all processes in the
868 * session group.
869 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700870 * The argument on_exit is set to 1 if called when a process is
871 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
872 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800873 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200874 * BTM is taken for hysterical raisins, and held when
875 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800876 * tty_mutex is taken to protect tty
877 * ->siglock is taken to protect ->signal/->sighand
878 * tasklist_lock is taken to walk process list for sessions
879 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882void disassociate_ctty(int on_exit)
883{
884 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Alan Cox5ec93d12009-11-30 13:18:45 +0000886 if (!current->signal->leader)
887 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800889 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 if (tty) {
Peter Hurleyf91e2592013-03-06 07:20:56 -0500891 if (on_exit && tty->driver->type != TTY_DRIVER_TYPE_PTY) {
892 tty_vhangup_session(tty);
893 } else {
894 struct pid *tty_pgrp = tty_get_pgrp(tty);
895 if (tty_pgrp) {
896 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Oleg Nesterov03e12612013-09-15 17:50:26 +0200897 if (!on_exit)
898 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500899 put_pid(tty_pgrp);
900 }
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200901 }
Alan Cox452a00d2008-10-13 10:39:13 +0100902 tty_kref_put(tty);
Peter Hurleyf91e2592013-03-06 07:20:56 -0500903
Eric W. Biederman680a9672007-02-12 00:52:52 -0800904 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800905 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800906 spin_lock_irq(&current->sighand->siglock);
907 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800908 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800909 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800910 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800911 kill_pgrp(old_pgrp, SIGHUP, on_exit);
912 kill_pgrp(old_pgrp, SIGCONT, on_exit);
913 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 return;
916 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800918 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700919 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800920 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800921
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800922 tty = tty_kref_get(current->signal->tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800923 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700924 unsigned long flags;
925 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800926 put_pid(tty->session);
927 put_pid(tty->pgrp);
928 tty->session = NULL;
929 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700930 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100931 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800932 } else {
933#ifdef TTY_DEBUG_HANGUP
934 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
935 " = NULL", tty);
936#endif
937 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Chen Tingjiec70dbb12014-04-15 11:52:51 +0800939 spin_unlock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 /* Now clear signal->tty under the lock */
941 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800942 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944}
945
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700946/**
947 *
948 * no_tty - Ensure the current process does not have a controlling tty
949 */
950void no_tty(void)
951{
Alan Cox3af502b2012-05-03 22:21:53 +0100952 /* FIXME: Review locking here. The tty_lock never covered any race
953 between a new association and proc_clear_tty but possible we need
954 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700955 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000956 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700957 proc_clear_tty(tsk);
958}
959
Alan Coxaf9b8972006-08-27 01:24:01 -0700960
961/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200962 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700963 * @tty: tty to stop
964 *
Peter Hurley01adc802014-09-10 15:06:32 -0400965 * Perform flow control to the driver. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700966 * on an already stopped device and will not re-call the driver
967 * method.
968 *
969 * This functionality is used by both the line disciplines for
970 * halting incoming flow and by the driver. It may therefore be
971 * called from any context, may be under the tty atomic_write_lock
972 * but not always.
973 *
974 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400975 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700976 */
977
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400978void __stop_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400980 if (tty->stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 return;
982 tty->stopped = 1;
Alan Coxf34d7a52008-04-30 00:54:13 -0700983 if (tty->ops->stop)
984 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985}
986
Peter Hurleyf9e053d2014-09-10 15:06:31 -0400987void stop_tty(struct tty_struct *tty)
988{
989 unsigned long flags;
990
991 spin_lock_irqsave(&tty->flow_lock, flags);
992 __stop_tty(tty);
993 spin_unlock_irqrestore(&tty->flow_lock, flags);
994}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995EXPORT_SYMBOL(stop_tty);
996
Alan Coxaf9b8972006-08-27 01:24:01 -0700997/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200998 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700999 * @tty: tty to start
1000 *
Peter Hurley01adc802014-09-10 15:06:32 -04001001 * Start a tty that has been stopped if at all possible. If this
1002 * tty was previous stopped and is now being started, the driver
1003 * start method is invoked and the line discipline woken.
Alan Coxaf9b8972006-08-27 01:24:01 -07001004 *
1005 * Locking:
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001006 * flow_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07001007 */
1008
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001009void __start_tty(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010{
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001011 if (!tty->stopped || tty->flow_stopped)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 return;
1013 tty->stopped = 0;
Alan Coxf34d7a52008-04-30 00:54:13 -07001014 if (tty->ops->start)
1015 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017}
1018
Peter Hurleyf9e053d2014-09-10 15:06:31 -04001019void start_tty(struct tty_struct *tty)
1020{
1021 unsigned long flags;
1022
1023 spin_lock_irqsave(&tty->flow_lock, flags);
1024 __start_tty(tty);
1025 spin_unlock_irqrestore(&tty->flow_lock, flags);
1026}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027EXPORT_SYMBOL(start_tty);
1028
Linus Torvaldsb0b88562013-05-01 07:32:21 -07001029/* We limit tty time update visibility to every 8 seconds or so. */
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001030static void tty_update_time(struct timespec *time)
1031{
Linus Torvaldsb0b88562013-05-01 07:32:21 -07001032 unsigned long sec = get_seconds() & ~7;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001033 if ((long)(sec - time->tv_sec) > 0)
1034 time->tv_sec = sec;
1035}
1036
Alan Coxaf9b8972006-08-27 01:24:01 -07001037/**
1038 * tty_read - read method for tty device files
1039 * @file: pointer to tty file
1040 * @buf: user buffer
1041 * @count: size of user buffer
1042 * @ppos: unused
1043 *
1044 * Perform the read system call function on this terminal device. Checks
1045 * for hung up devices before calling the line discipline method.
1046 *
1047 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -07001048 * Locks the line discipline internally while needed. Multiple
1049 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -07001050 */
1051
Alan Cox37bdfb02008-02-08 04:18:47 -08001052static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 loff_t *ppos)
1054{
1055 int i;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001056 struct inode *inode = file_inode(file);
Nick Piggind996b622010-08-18 04:37:36 +10001057 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 struct tty_ldisc *ld;
1059
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001060 if (tty_paranoia_check(tty, inode, "tty_read"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 return -EIO;
1062 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
1063 return -EIO;
1064
1065 /* We want to wait for the line discipline to sort out in this
1066 situation */
1067 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001068 if (ld->ops->read)
1069 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 else
1071 i = -EIO;
1072 tty_ldisc_deref(ld);
Jiri Slabyb0de59b2013-02-15 15:25:05 +01001073
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001074 if (i > 0)
1075 tty_update_time(&inode->i_atime);
1076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 return i;
1078}
1079
Peter Hurley136d5252014-09-10 15:06:34 -04001080static void tty_write_unlock(struct tty_struct *tty)
Alan Cox9c1729d2007-07-15 23:39:43 -07001081{
1082 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -07001083 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -07001084}
1085
Peter Hurley136d5252014-09-10 15:06:34 -04001086static int tty_write_lock(struct tty_struct *tty, int ndelay)
Alan Cox9c1729d2007-07-15 23:39:43 -07001087{
1088 if (!mutex_trylock(&tty->atomic_write_lock)) {
1089 if (ndelay)
1090 return -EAGAIN;
1091 if (mutex_lock_interruptible(&tty->atomic_write_lock))
1092 return -ERESTARTSYS;
1093 }
1094 return 0;
1095}
1096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097/*
1098 * Split writes up in sane blocksizes to avoid
1099 * denial-of-service type attacks
1100 */
1101static inline ssize_t do_tty_write(
1102 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1103 struct tty_struct *tty,
1104 struct file *file,
1105 const char __user *buf,
1106 size_t count)
1107{
Alan Cox9c1729d2007-07-15 23:39:43 -07001108 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001110
Alan Cox9c1729d2007-07-15 23:39:43 -07001111 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1112 if (ret < 0)
1113 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
1115 /*
1116 * We chunk up writes into a temporary buffer. This
1117 * simplifies low-level drivers immensely, since they
1118 * don't have locking issues and user mode accesses.
1119 *
1120 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1121 * big chunk-size..
1122 *
1123 * The default chunk-size is 2kB, because the NTTY
1124 * layer has problems with bigger chunks. It will
1125 * claim to be able to handle more characters than
1126 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001127 *
1128 * FIXME: This can probably go away now except that 64K chunks
1129 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 */
1131 chunk = 2048;
1132 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1133 chunk = 65536;
1134 if (count < chunk)
1135 chunk = count;
1136
Ingo Molnar70522e12006-03-23 03:00:31 -08001137 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001139 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
1141 if (chunk < 1024)
1142 chunk = 1024;
1143
Jason Wessel402fda92008-10-13 10:45:36 +01001144 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1145 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001146 ret = -ENOMEM;
1147 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 }
1149 kfree(tty->write_buf);
1150 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001151 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 }
1153
1154 /* Do the write .. */
1155 for (;;) {
1156 size_t size = count;
1157 if (size > chunk)
1158 size = chunk;
1159 ret = -EFAULT;
1160 if (copy_from_user(tty->write_buf, buf, size))
1161 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 if (ret <= 0)
1164 break;
1165 written += ret;
1166 buf += ret;
1167 count -= ret;
1168 if (!count)
1169 break;
1170 ret = -ERESTARTSYS;
1171 if (signal_pending(current))
1172 break;
1173 cond_resched();
1174 }
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001175 if (written) {
1176 tty_update_time(&file_inode(file)->i_mtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 ret = written;
Jiri Slaby37b7f3c2013-04-26 13:48:53 +02001178 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001179out:
1180 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 return ret;
1182}
1183
Alan Cox95f9bfc2008-10-13 10:39:23 +01001184/**
1185 * tty_write_message - write a message to a certain tty, not just the console.
1186 * @tty: the destination tty_struct
1187 * @msg: the message to write
1188 *
1189 * This is used for messages that need to be redirected to a specific tty.
1190 * We don't put it into the syslog queue right now maybe in the future if
1191 * really needed.
1192 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001193 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001194 */
1195
1196void tty_write_message(struct tty_struct *tty, char *msg)
1197{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001198 if (tty) {
1199 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001200 tty_lock(tty);
Peter Hurley04980702014-11-05 12:12:52 -05001201 if (tty->ops->write && tty->count > 0) {
Alan Cox89c8d912012-08-08 16:30:13 +01001202 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001203 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001204 } else
Alan Cox89c8d912012-08-08 16:30:13 +01001205 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001206 tty_write_unlock(tty);
1207 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001208 return;
1209}
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Alan Coxaf9b8972006-08-27 01:24:01 -07001212/**
1213 * tty_write - write method for tty device file
1214 * @file: tty file pointer
1215 * @buf: user data to write
1216 * @count: bytes to write
1217 * @ppos: unused
1218 *
1219 * Write data to a tty device via the line discipline.
1220 *
1221 * Locking:
1222 * Locks the line discipline as required
1223 * Writes to the tty driver are serialized by the atomic_write_lock
1224 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001225 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001226 */
1227
Alan Cox37bdfb02008-02-08 04:18:47 -08001228static ssize_t tty_write(struct file *file, const char __user *buf,
1229 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230{
Nick Piggind996b622010-08-18 04:37:36 +10001231 struct tty_struct *tty = file_tty(file);
1232 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001234
Al Viro6131ffa2013-02-27 16:59:05 -05001235 if (tty_paranoia_check(tty, file_inode(file), "tty_write"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001237 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001238 (test_bit(TTY_IO_ERROR, &tty->flags)))
1239 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001240 /* Short term debug to catch buggy drivers */
1241 if (tty->ops->write_room == NULL)
1242 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1243 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001244 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001245 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 ret = -EIO;
1247 else
Alan Coxa352def2008-07-16 21:53:12 +01001248 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 tty_ldisc_deref(ld);
1250 return ret;
1251}
1252
Alan Cox37bdfb02008-02-08 04:18:47 -08001253ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1254 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255{
1256 struct file *p = NULL;
1257
1258 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001259 if (redirect)
1260 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 spin_unlock(&redirect_lock);
1262
1263 if (p) {
1264 ssize_t res;
1265 res = vfs_write(p, buf, count, &p->f_pos);
1266 fput(p);
1267 return res;
1268 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 return tty_write(file, buf, count, ppos);
1270}
1271
Peter Hurley136d5252014-09-10 15:06:34 -04001272/**
1273 * tty_send_xchar - send priority character
1274 *
1275 * Send a high priority character to the tty even if stopped
1276 *
1277 * Locking: none for xchar method, write ordering for write method.
1278 */
1279
1280int tty_send_xchar(struct tty_struct *tty, char ch)
1281{
1282 int was_stopped = tty->stopped;
1283
1284 if (tty->ops->send_xchar) {
1285 tty->ops->send_xchar(tty, ch);
1286 return 0;
1287 }
1288
1289 if (tty_write_lock(tty, 0) < 0)
1290 return -ERESTARTSYS;
1291
1292 if (was_stopped)
1293 start_tty(tty);
1294 tty->ops->write(tty, &ch, 1);
1295 if (was_stopped)
1296 stop_tty(tty);
1297 tty_write_unlock(tty);
1298 return 0;
1299}
1300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301static char ptychar[] = "pqrstuvwxyzabcde";
1302
Alan Coxaf9b8972006-08-27 01:24:01 -07001303/**
1304 * pty_line_name - generate name for a pty
1305 * @driver: the tty driver in use
1306 * @index: the minor number
1307 * @p: output buffer of at least 6 bytes
1308 *
1309 * Generate a name from a driver reference and write it to the output
1310 * buffer.
1311 *
1312 * Locking: None
1313 */
1314static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315{
1316 int i = index + driver->name_base;
1317 /* ->name is initialized to "ttyp", but "tty" is expected */
1318 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001319 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1320 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321}
1322
Alan Coxaf9b8972006-08-27 01:24:01 -07001323/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001324 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001325 * @driver: the tty driver in use
1326 * @index: the minor number
1327 * @p: output buffer of at least 7 bytes
1328 *
1329 * Generate a name from a driver reference and write it to the output
Greg Kroah-Hartman5c0a2452014-02-22 14:31:04 -08001330 * buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07001331 *
1332 * Locking: None
1333 */
Hannes Reinecke723abd82014-02-27 12:30:51 +01001334static ssize_t tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335{
Jiri Slaby0019b402012-08-08 22:26:43 +02001336 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
Hannes Reinecke723abd82014-02-27 12:30:51 +01001337 return sprintf(p, "%s", driver->name);
Jiri Slaby0019b402012-08-08 22:26:43 +02001338 else
Hannes Reinecke723abd82014-02-27 12:30:51 +01001339 return sprintf(p, "%s%d", driver->name,
1340 index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341}
1342
Alan Cox99f1fe12008-10-13 10:42:00 +01001343/**
1344 * tty_driver_lookup_tty() - find an existing tty, if any
1345 * @driver: the driver for the tty
1346 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001347 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001348 * Return the tty, if found. If not found, return NULL or ERR_PTR() if the
1349 * driver lookup() method returns an error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001350 *
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001351 * Locking: tty_mutex must be held. If the tty is found, bump the tty kref.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001352 */
Jason Wessela47d5452009-01-02 13:43:04 +00001353static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001354 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001355{
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001356 struct tty_struct *tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001357
Peter Hurleyaa3cb812014-11-05 12:12:51 -05001358 if (driver->ops->lookup)
1359 tty = driver->ops->lookup(driver, inode, idx);
1360 else
1361 tty = driver->ttys[idx];
1362
1363 if (!IS_ERR(tty))
1364 tty_kref_get(tty);
1365 return tty;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001366}
1367
Alan Cox99f1fe12008-10-13 10:42:00 +01001368/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001369 * tty_init_termios - helper for termios setup
1370 * @tty: the tty to set up
1371 *
1372 * Initialise the termios structures for this tty. Thus runs under
1373 * the tty_mutex currently so we can be relaxed about ordering.
1374 */
1375
1376int tty_init_termios(struct tty_struct *tty)
1377{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001378 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001379 int idx = tty->index;
1380
Alan Cox36b3c072012-07-17 17:06:57 +01001381 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1382 tty->termios = tty->driver->init_termios;
1383 else {
1384 /* Check for lazy saved data */
1385 tp = tty->driver->termios[idx];
1386 if (tp != NULL)
1387 tty->termios = *tp;
1388 else
1389 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001390 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001391 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001392 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1393 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001394 return 0;
1395}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001396EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001397
Jiri Slaby66d450e2012-01-30 21:14:28 +01001398int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1399{
1400 int ret = tty_init_termios(tty);
1401 if (ret)
1402 return ret;
1403
1404 tty_driver_kref_get(driver);
1405 tty->count++;
1406 driver->ttys[tty->index] = tty;
1407 return 0;
1408}
1409EXPORT_SYMBOL_GPL(tty_standard_install);
1410
Alan Coxbf970ee2008-10-13 10:42:39 +01001411/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001412 * tty_driver_install_tty() - install a tty entry in the driver
1413 * @driver: the driver for the tty
1414 * @tty: the tty
1415 *
1416 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001417 * will be set by the time this is called. This method is responsible
1418 * for ensuring any need additional structures are allocated and
1419 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001420 *
1421 * Locking: tty_mutex for now
1422 */
1423static int tty_driver_install_tty(struct tty_driver *driver,
1424 struct tty_struct *tty)
1425{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001426 return driver->ops->install ? driver->ops->install(driver, tty) :
1427 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001428}
1429
1430/**
1431 * tty_driver_remove_tty() - remove a tty from the driver tables
1432 * @driver: the driver for the tty
1433 * @idx: the minor number
1434 *
1435 * Remvoe a tty object from the driver tables. The tty->index field
1436 * will be set by the time this is called.
1437 *
1438 * Locking: tty_mutex for now
1439 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001440void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001441{
1442 if (driver->ops->remove)
1443 driver->ops->remove(driver, tty);
1444 else
1445 driver->ttys[tty->index] = NULL;
1446}
1447
1448/*
1449 * tty_reopen() - fast re-open of an open tty
1450 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001451 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001452 * Return 0 on success, -errno on error.
Peter Hurley5d93e742014-11-05 12:12:47 -05001453 * Re-opens on master ptys are not allowed and return -EIO.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001454 *
Peter Hurley5d93e742014-11-05 12:12:47 -05001455 * Locking: Caller must hold tty_lock
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001456 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001457static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001458{
1459 struct tty_driver *driver = tty->driver;
1460
Peter Hurley216030e2014-11-05 12:12:48 -05001461 if (!tty->count)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001462 return -EIO;
1463
1464 if (driver->type == TTY_DRIVER_TYPE_PTY &&
Peter Hurley5d93e742014-11-05 12:12:47 -05001465 driver->subtype == PTY_TYPE_MASTER)
1466 return -EIO;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001467
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001468 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001469
Peter Hurley36697522013-06-15 07:04:48 -04001470 WARN_ON(!tty->ldisc);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001471
1472 return 0;
1473}
1474
Alan Coxaf9b8972006-08-27 01:24:01 -07001475/**
Alan Coxd81ed102008-10-13 10:41:42 +01001476 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001477 * @driver: tty driver we are opening a device on
1478 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001479 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001480 *
1481 * Prepare a tty device. This may not be a "new" clean device but
1482 * could also be an active device. The pty drivers require special
1483 * handling because of this.
1484 *
1485 * Locking:
1486 * The function is called under the tty_mutex, which
1487 * protects us from the tty struct or driver itself going away.
1488 *
1489 * On exit the tty device has the line discipline attached and
1490 * a reference count of 1. If a pair was created for pty/tty use
1491 * and the other was a pty master then it too has a reference count of 1.
1492 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001494 * failed open. The new code protects the open with a mutex, so it's
1495 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 * relaxed for the (most common) case of reopening a tty.
1497 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001498
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001499struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500{
Alan Coxbf970ee2008-10-13 10:42:39 +01001501 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001502 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 /*
1505 * First time open is complex, especially for PTY devices.
1506 * This code guarantees that either everything succeeds and the
1507 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001508 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 * and locked termios may be retained.)
1510 */
1511
Alan Cox73ec06f2008-10-13 10:42:29 +01001512 if (!try_module_get(driver->owner))
1513 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02001515 tty = alloc_tty_struct(driver, idx);
Jiri Slabyd5543502011-03-23 10:48:32 +01001516 if (!tty) {
1517 retval = -ENOMEM;
1518 goto err_module_put;
1519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Alan Cox89c8d912012-08-08 16:30:13 +01001521 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001522 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001523 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001524 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001525
Jiri Slaby04831dc2012-06-04 13:35:36 +02001526 if (!tty->port)
1527 tty->port = driver->ports[idx];
1528
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001529 WARN_RATELIMIT(!tty->port,
1530 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1531 __func__, tty->driver->name);
1532
Jiri Slaby967fab62012-10-18 22:26:46 +02001533 tty->port->itty = tty;
1534
Alan Cox37bdfb02008-02-08 04:18:47 -08001535 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001537 * If we fail here just call release_tty to clean up. No need
1538 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001540 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001541 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001542 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001543 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001544 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001546err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001547 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001548 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001549 free_tty_struct(tty);
1550err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001552 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001554 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001555err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001556 tty_unlock(tty);
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +02001557 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001558 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001559 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001560 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561}
1562
Alan Coxfeebed62008-10-13 10:41:30 +01001563void tty_free_termios(struct tty_struct *tty)
1564{
1565 struct ktermios *tp;
1566 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001567
1568 /* If the port is going to reset then it has no termios to save */
1569 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1570 return;
1571
1572 /* Stash the termios data */
1573 tp = tty->driver->termios[idx];
1574 if (tp == NULL) {
1575 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1576 if (tp == NULL) {
1577 pr_warn("tty: no memory to save termios state.\n");
1578 return;
1579 }
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001580 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001581 }
Alan Cox36b3c072012-07-17 17:06:57 +01001582 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001583}
1584EXPORT_SYMBOL(tty_free_termios);
1585
Peter Hurleya2965b72013-03-11 16:44:35 -04001586/**
1587 * tty_flush_works - flush all works of a tty
1588 * @tty: tty device to flush works for
1589 *
1590 * Sync flush all works belonging to @tty.
1591 */
1592static void tty_flush_works(struct tty_struct *tty)
1593{
1594 flush_work(&tty->SAK_work);
1595 flush_work(&tty->hangup_work);
1596}
Alan Coxfeebed62008-10-13 10:41:30 +01001597
Alan Coxaf9b8972006-08-27 01:24:01 -07001598/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001599 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001600 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001601 *
1602 * Releases memory associated with a tty structure, and clears out the
1603 * driver table slots. This function is called when a device is no longer
1604 * in use. It also gets called when setup of a device fails.
1605 *
1606 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001607 * takes the file list lock internally when working on the list
1608 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001609 *
1610 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001611 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 */
Alan Coxb50989d2009-09-19 13:13:22 -07001613static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614{
Alan Coxb50989d2009-09-19 13:13:22 -07001615 struct tty_struct *tty =
1616 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001617 struct tty_driver *driver = tty->driver;
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001618 struct module *owner = driver->owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619
Dave Youngf278a2f2009-09-27 16:00:42 +00001620 if (tty->ops->cleanup)
1621 tty->ops->cleanup(tty);
1622
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001624 tty_driver_kref_put(driver);
Cyrill Gorcunovb216df52014-08-08 00:26:15 +04001625 module_put(owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001626
Nick Pigginee2ffa02010-08-18 04:37:35 +10001627 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001629 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001630
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001631 put_pid(tty->pgrp);
1632 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 free_tty_struct(tty);
1634}
1635
Alan Coxb50989d2009-09-19 13:13:22 -07001636static void queue_release_one_tty(struct kref *kref)
1637{
1638 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001639
Alan Coxb50989d2009-09-19 13:13:22 -07001640 /* The hangup queue is now free so we can reuse it rather than
1641 waste a chunk of memory for each port */
1642 INIT_WORK(&tty->hangup_work, release_one_tty);
1643 schedule_work(&tty->hangup_work);
1644}
1645
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001646/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001647 * tty_kref_put - release a tty kref
1648 * @tty: tty device
1649 *
1650 * Release a reference to a tty device and if need be let the kref
1651 * layer destruct the object for us
1652 */
1653
1654void tty_kref_put(struct tty_struct *tty)
1655{
1656 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001657 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001658}
1659EXPORT_SYMBOL(tty_kref_put);
1660
1661/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001662 * release_tty - release tty structure memory
1663 *
1664 * Release both @tty and a possible linked partner (think pty pair),
1665 * and decrement the refcount of the backing module.
1666 *
1667 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001668 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001669 * takes the file list lock internally when working on the list
1670 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001671 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001672 */
1673static void release_tty(struct tty_struct *tty, int idx)
1674{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001675 /* This should always be true but check for the moment */
1676 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001677 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001678 if (tty->ops->shutdown)
1679 tty->ops->shutdown(tty);
1680 tty_free_termios(tty);
1681 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001682 tty->port->itty = NULL;
Peter Hurley64e377d2013-06-15 09:01:00 -04001683 if (tty->link)
1684 tty->link->port->itty = NULL;
Peter Hurley4f98d462013-03-11 16:44:34 -04001685 cancel_work_sync(&tty->port->buf.work);
Alan Cox36b3c072012-07-17 17:06:57 +01001686
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001687 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001688 tty_kref_put(tty->link);
1689 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001690}
1691
Alan Coxeeb89d92009-11-30 13:18:29 +00001692/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001693 * tty_release_checks - check a tty before real release
1694 * @tty: tty to check
1695 * @o_tty: link of @tty (if any)
1696 * @idx: index of the tty
1697 *
1698 * Performs some paranoid checking before true release of the @tty.
1699 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1700 */
1701static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1702 int idx)
1703{
1704#ifdef TTY_PARANOIA_CHECK
1705 if (idx < 0 || idx >= tty->driver->num) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001706 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1707 __func__, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001708 return -1;
1709 }
1710
1711 /* not much to check for devpts */
1712 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1713 return 0;
1714
1715 if (tty != tty->driver->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001716 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1717 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001718 return -1;
1719 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001720 if (tty->driver->other) {
1721 if (o_tty != tty->driver->other->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001722 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1723 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001724 return -1;
1725 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001726 if (o_tty->link != tty) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001727 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001728 return -1;
1729 }
1730 }
1731#endif
1732 return 0;
1733}
1734
1735/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001736 * tty_release - vfs callback for close
1737 * @inode: inode of tty
1738 * @filp: file pointer for handle to tty
1739 *
1740 * Called the last time each file handle is closed that references
1741 * this tty. There may however be several such references.
1742 *
1743 * Locking:
1744 * Takes bkl. See tty_release_dev
1745 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 * Even releasing the tty structures is a tricky business.. We have
1747 * to be very careful that the structures are all released at the
1748 * same time, as interrupts might otherwise get the wrong pointers.
1749 *
1750 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1751 * lead to double frees or releasing memory still in use.
1752 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001753
1754int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755{
Nick Piggind996b622010-08-18 04:37:36 +10001756 struct tty_struct *tty = file_tty(filp);
1757 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 int pty_master, tty_closing, o_tty_closing, do_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 int idx;
1760 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001761
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001762 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001763 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Alan Cox89c8d912012-08-08 16:30:13 +01001765 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001766 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
Arnd Bergmannec79d602010-06-01 22:53:01 +02001768 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
1770 idx = tty->index;
1771 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1772 tty->driver->subtype == PTY_TYPE_MASTER);
Alan Cox89c8d912012-08-08 16:30:13 +01001773 /* Review: parallel close */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 o_tty = tty->link;
1775
Jiri Slaby955787ca2011-11-11 10:47:23 +01001776 if (tty_release_checks(tty, o_tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001777 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001778 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
1781#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001782 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1783 tty_name(tty, buf), tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784#endif
1785
Alan Coxf34d7a52008-04-30 00:54:13 -07001786 if (tty->ops->close)
1787 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Alan Cox89c8d912012-08-08 16:30:13 +01001789 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 /*
1791 * Sanity check: if tty->count is going to zero, there shouldn't be
1792 * any waiters on tty->read_wait or tty->write_wait. We test the
1793 * wait queues and kick everyone out _before_ actually starting to
1794 * close. This ensures that we won't block while releasing the tty
1795 * structure.
1796 *
1797 * The test for the o_tty closing is necessary, since the master and
1798 * slave sides may close in any order. If the slave side closes out
1799 * first, its count will be one, since the master side holds an open.
1800 * Thus this test wouldn't be triggered at the time the slave closes,
1801 * so we do it now.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 */
Peter Hurleyd5e370a2014-11-05 12:12:54 -05001803 tty_lock_pair(tty, o_tty);
1804
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 while (1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 tty_closing = tty->count <= 1;
1807 o_tty_closing = o_tty &&
1808 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 do_sleep = 0;
1810
1811 if (tty_closing) {
1812 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001813 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 do_sleep++;
1815 }
1816 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001817 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 do_sleep++;
1819 }
1820 }
1821 if (o_tty_closing) {
1822 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001823 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 do_sleep++;
1825 }
1826 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001827 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 do_sleep++;
1829 }
1830 }
1831 if (!do_sleep)
1832 break;
1833
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001834 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1835 __func__, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001837 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
1839 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001840 * The closing flags are now consistent with the open counts on
1841 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 * block, so it's safe to proceed with closing.
Alan Coxd1552552012-07-27 18:02:54 +01001843 *
1844 * We must *not* drop the tty_mutex until we ensure that a further
1845 * entry into tty_open can not pick up this tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 if (pty_master) {
1848 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001849 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1850 __func__, o_tty->count, tty_name(o_tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 o_tty->count = 0;
1852 }
1853 }
1854 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001855 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1856 __func__, tty->count, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 tty->count = 0;
1858 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001859
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 /*
1861 * We've decremented tty->count, so we need to remove this file
1862 * descriptor off the tty->tty_files list; this serves two
1863 * purposes:
1864 * - check_tty_count sees the correct number of file descriptors
1865 * associated with this tty.
1866 * - do_tty_hangup no longer sees this file descriptor as
1867 * something that needs to be handled for hangups.
1868 */
Nick Piggind996b622010-08-18 04:37:36 +10001869 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
1871 /*
1872 * Perform some housekeeping before deciding whether to return.
1873 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 * If _either_ side is closing, make sure there aren't any
1875 * processes that still think tty or o_tty is their controlling
1876 * tty.
1877 */
1878 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001880 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001882 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 read_unlock(&tasklist_lock);
1884 }
1885
Alan Cox89c8d912012-08-08 16:30:13 +01001886 tty_unlock_pair(tty, o_tty);
Peter Hurley04980702014-11-05 12:12:52 -05001887 /* At this point, the tty->count == 0 should ensure a dead tty
Alan Coxd1552552012-07-27 18:02:54 +01001888 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001889
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 /* check whether both sides are closing ... */
Alan Coxd1552552012-07-27 18:02:54 +01001891 if (!tty_closing || (o_tty && !o_tty_closing))
Alan Coxeeb89d92009-11-30 13:18:29 +00001892 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001893
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894#ifdef TTY_DEBUG_HANGUP
Peter Hurley96433d12013-03-11 16:44:37 -04001895 printk(KERN_DEBUG "%s: %s: final close\n", __func__, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896#endif
1897 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001898 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001900 tty_ldisc_release(tty, o_tty);
Peter Hurleya2965b72013-03-11 16:44:35 -04001901
1902 /* Wait for pending work before tty destruction commmences */
1903 tty_flush_works(tty);
1904 if (o_tty)
1905 tty_flush_works(o_tty);
1906
Peter Hurley96433d12013-03-11 16:44:37 -04001907#ifdef TTY_DEBUG_HANGUP
1908 printk(KERN_DEBUG "%s: %s: freeing structure...\n", __func__, tty_name(tty, buf));
1909#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001911 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001912 * the slots and preserving the termios structure. The tty_unlock_pair
1913 * should be safe as we keep a kref while the tty is locked (so the
1914 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 */
Alan Coxd1552552012-07-27 18:02:54 +01001916 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001917 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001918 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919
Alan Coxeeb89d92009-11-30 13:18:29 +00001920 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921}
1922
Alan Coxaf9b8972006-08-27 01:24:01 -07001923/**
Peter Hurley52494ee2014-11-05 12:12:50 -05001924 * tty_open_current_tty - get locked tty of current task
Jiri Slabyb82154a2011-11-09 21:33:19 +01001925 * @device: device number
1926 * @filp: file pointer to tty
Peter Hurley52494ee2014-11-05 12:12:50 -05001927 * @return: locked tty of the current task iff @device is /dev/tty
1928 *
1929 * Performs a re-open of the current task's controlling tty.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001930 *
1931 * We cannot return driver and index like for the other nodes because
1932 * devpts will not work then. It expects inodes to be from devpts FS.
1933 */
1934static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1935{
1936 struct tty_struct *tty;
Peter Hurley52494ee2014-11-05 12:12:50 -05001937 int retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001938
1939 if (device != MKDEV(TTYAUX_MAJOR, 0))
1940 return NULL;
1941
1942 tty = get_current_tty();
1943 if (!tty)
1944 return ERR_PTR(-ENXIO);
1945
1946 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1947 /* noctty = 1; */
Peter Hurley52494ee2014-11-05 12:12:50 -05001948 tty_lock(tty);
1949 tty_kref_put(tty); /* safe to drop the kref now */
1950
1951 retval = tty_reopen(tty);
1952 if (retval < 0) {
1953 tty_unlock(tty);
1954 tty = ERR_PTR(retval);
1955 }
Jiri Slabyb82154a2011-11-09 21:33:19 +01001956 return tty;
1957}
1958
1959/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001960 * tty_lookup_driver - lookup a tty driver for a given device file
1961 * @device: device number
1962 * @filp: file pointer to tty
1963 * @noctty: set if the device should not become a controlling tty
1964 * @index: index for the device in the @return driver
1965 * @return: driver for this inode (with increased refcount)
1966 *
1967 * If @return is not erroneous, the caller is responsible to decrement the
1968 * refcount by tty_driver_kref_put.
1969 *
1970 * Locking: tty_mutex protects get_tty_driver
1971 */
1972static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1973 int *noctty, int *index)
1974{
1975 struct tty_driver *driver;
1976
Jiri Slaby2cd00502011-11-09 21:33:22 +01001977 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001978#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001979 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001980 extern struct tty_driver *console_driver;
1981 driver = tty_driver_kref_get(console_driver);
1982 *index = fg_console;
1983 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001984 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001985 }
1986#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001987 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001988 struct tty_driver *console_driver = console_device(index);
1989 if (console_driver) {
1990 driver = tty_driver_kref_get(console_driver);
1991 if (driver) {
1992 /* Don't let /dev/console block */
1993 filp->f_flags |= O_NONBLOCK;
1994 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001995 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001996 }
1997 }
1998 return ERR_PTR(-ENODEV);
1999 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01002000 default:
2001 driver = get_tty_driver(device, index);
2002 if (!driver)
2003 return ERR_PTR(-ENODEV);
2004 break;
2005 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002006 return driver;
2007}
2008
2009/**
Alan Coxeeb89d92009-11-30 13:18:29 +00002010 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002011 * @inode: inode of device file
2012 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002014 * tty_open and tty_release keep up the tty count that contains the
2015 * number of opens done on a tty. We cannot use the inode-count, as
2016 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002018 * Open-counting is needed for pty masters, as well as for keeping
2019 * track of serial lines: DTR is dropped when the last close happens.
2020 * (This is not done solely through tty->count, now. - Ted 1/27/92)
2021 *
2022 * The termios state of a pty is reset on first open so that
2023 * settings don't persist across reuse.
2024 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002025 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002026 * tty->count should protect the rest.
2027 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01002028 *
2029 * Note: the tty_unlock/lock cases without a ref are only safe due to
2030 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002032
Alan Coxeeb89d92009-11-30 13:18:29 +00002033static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034{
Jiri Slabyb82154a2011-11-09 21:33:19 +01002035 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01002037 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 int index;
2039 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07002040 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
2042 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08002043
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002045 retval = tty_alloc_file(filp);
2046 if (retval)
2047 return -ENOMEM;
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 noctty = filp->f_flags & O_NOCTTY;
2050 index = -1;
2051 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002052
Jiri Slabyb82154a2011-11-09 21:33:19 +01002053 tty = tty_open_current_tty(device, filp);
Peter Hurley52494ee2014-11-05 12:12:50 -05002054 if (!tty) {
2055 mutex_lock(&tty_mutex);
Jiri Slaby5b5e7042011-11-09 21:33:20 +01002056 driver = tty_lookup_driver(device, filp, &noctty, &index);
2057 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002058 retval = PTR_ERR(driver);
2059 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002062 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01002063 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00002064 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002065 retval = PTR_ERR(tty);
2066 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00002067 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002068
2069 if (tty) {
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002070 mutex_unlock(&tty_mutex);
Peter Hurley52494ee2014-11-05 12:12:50 -05002071 tty_lock(tty);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002072 /* safe to drop the kref from tty_driver_lookup_tty() */
2073 tty_kref_put(tty);
Peter Hurley52494ee2014-11-05 12:12:50 -05002074 retval = tty_reopen(tty);
2075 if (retval < 0) {
2076 tty_unlock(tty);
2077 tty = ERR_PTR(retval);
2078 }
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002079 } else { /* Returns with the tty_lock held for now */
Peter Hurley52494ee2014-11-05 12:12:50 -05002080 tty = tty_init_dev(driver, index);
Peter Hurleyaa3cb812014-11-05 12:12:51 -05002081 mutex_unlock(&tty_mutex);
2082 }
Peter Hurley52494ee2014-11-05 12:12:50 -05002083
Peter Hurley52494ee2014-11-05 12:12:50 -05002084 tty_driver_kref_put(driver);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01002085 }
2086
Alan Coxeeb89d92009-11-30 13:18:29 +00002087 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01002088 retval = PTR_ERR(tty);
2089 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00002090 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02002092 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10002093
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002094 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2096 tty->driver->subtype == PTY_TYPE_MASTER)
2097 noctty = 1;
2098#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002099 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03002101 if (tty->ops->open)
2102 retval = tty->ops->open(tty, filp);
2103 else
2104 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 filp->f_flags = saved_flags;
2106
Alan Cox37bdfb02008-02-08 04:18:47 -08002107 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
2108 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 retval = -EBUSY;
2110
2111 if (retval) {
2112#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01002113 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
2114 retval, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115#endif
Alan Cox89c8d912012-08-08 16:30:13 +01002116 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00002117 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002118 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002120
2121 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02002123
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 schedule();
2125 /*
2126 * Need to reset f_op in case a hangup happened.
2127 */
2128 if (filp->f_op == &hung_up_tty_fops)
2129 filp->f_op = &tty_fops;
2130 goto retry_open;
2131 }
Peter Hurleyd4855e12013-11-19 08:46:27 -05002132 clear_bit(TTY_HUPPED, &tty->flags);
Alan Coxeeb89d92009-11-30 13:18:29 +00002133
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002134
Peter Hurley2c411c12014-10-16 14:59:47 -04002135 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002136 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 if (!noctty &&
2138 current->signal->leader &&
2139 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002140 tty->session == NULL)
Peter Hurleybce65f12014-10-16 14:59:43 -04002141 __proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002142 spin_unlock_irq(&current->sighand->siglock);
Peter Hurley2c411c12014-10-16 14:59:47 -04002143 read_unlock(&tasklist_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01002144 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002146err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002147 mutex_unlock(&tty_mutex);
2148 /* after locks to avoid deadlock */
2149 if (!IS_ERR_OR_NULL(driver))
2150 tty_driver_kref_put(driver);
2151err_file:
2152 tty_free_file(filp);
2153 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154}
2155
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002156
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157
Alan Coxaf9b8972006-08-27 01:24:01 -07002158/**
2159 * tty_poll - check tty status
2160 * @filp: file being polled
2161 * @wait: poll wait structures to update
2162 *
2163 * Call the line discipline polling method to obtain the poll
2164 * status of the device.
2165 *
2166 * Locking: locks called line discipline but ldisc poll method
2167 * may be re-entered freely by other callers.
2168 */
2169
Alan Cox37bdfb02008-02-08 04:18:47 -08002170static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171{
Nick Piggind996b622010-08-18 04:37:36 +10002172 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 struct tty_ldisc *ld;
2174 int ret = 0;
2175
Al Viro6131ffa2013-02-27 16:59:05 -05002176 if (tty_paranoia_check(tty, file_inode(filp), "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002178
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002180 if (ld->ops->poll)
2181 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 tty_ldisc_deref(ld);
2183 return ret;
2184}
2185
Arnd Bergmannec79d602010-06-01 22:53:01 +02002186static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187{
Nick Piggind996b622010-08-18 04:37:36 +10002188 struct tty_struct *tty = file_tty(filp);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002189 struct tty_ldisc *ldisc;
Alan Cox47f86832008-04-30 00:53:30 -07002190 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002191 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192
Al Viro6131ffa2013-02-27 16:59:05 -05002193 if (tty_paranoia_check(tty, file_inode(filp), "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002194 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002195
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 retval = fasync_helper(fd, filp, on, &tty->fasync);
2197 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002198 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002200 ldisc = tty_ldisc_ref(tty);
2201 if (ldisc) {
2202 if (ldisc->ops->fasync)
2203 ldisc->ops->fasync(tty, on);
2204 tty_ldisc_deref(ldisc);
2205 }
2206
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002208 enum pid_type type;
2209 struct pid *pid;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002210
Alan Cox47f86832008-04-30 00:53:30 -07002211 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002212 if (tty->pgrp) {
2213 pid = tty->pgrp;
2214 type = PIDTYPE_PGID;
2215 } else {
2216 pid = task_pid(current);
2217 type = PIDTYPE_PID;
2218 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002219 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002220 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002221 __f_setown(filp, pid, type, 0);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002222 put_pid(pid);
Jeff Laytone0b93ed2014-08-22 11:27:32 -04002223 retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002225out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002226 return retval;
2227}
2228
2229static int tty_fasync(int fd, struct file *filp, int on)
2230{
Alan Cox89c8d912012-08-08 16:30:13 +01002231 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002232 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002233
2234 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002235 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002236 tty_unlock(tty);
2237
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002238 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239}
2240
Alan Coxaf9b8972006-08-27 01:24:01 -07002241/**
2242 * tiocsti - fake input character
2243 * @tty: tty to fake input into
2244 * @p: pointer to character
2245 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002246 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002247 * input management.
2248 *
2249 * FIXME: does not honour flow control ??
2250 *
2251 * Locking:
Peter Hurley137084b2013-06-15 07:04:46 -04002252 * Called functions take tty_ldiscs_lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002253 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002254 *
2255 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002256 */
2257
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258static int tiocsti(struct tty_struct *tty, char __user *p)
2259{
2260 char ch, mbz = 0;
2261 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002262
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2264 return -EPERM;
2265 if (get_user(ch, p))
2266 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002267 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002269 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 tty_ldisc_deref(ld);
2271 return 0;
2272}
2273
Alan Coxaf9b8972006-08-27 01:24:01 -07002274/**
2275 * tiocgwinsz - implement window query ioctl
2276 * @tty; tty
2277 * @arg: user buffer for result
2278 *
Alan Cox808a0d32006-09-29 02:00:40 -07002279 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002280 *
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002281 * Locking: tty->winsize_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002282 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002283 */
2284
Alan Cox37bdfb02008-02-08 04:18:47 -08002285static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286{
Alan Cox808a0d32006-09-29 02:00:40 -07002287 int err;
2288
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002289 mutex_lock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002290 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002291 mutex_unlock(&tty->winsize_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002292
2293 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294}
2295
Alan Coxaf9b8972006-08-27 01:24:01 -07002296/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002297 * tty_do_resize - resize event
2298 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002299 * @rows: rows (character)
2300 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002301 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002302 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002303 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002304 */
2305
Alan Coxfc6f6232009-01-02 13:43:17 +00002306int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307{
Alan Coxfc6f6232009-01-02 13:43:17 +00002308 struct pid *pgrp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Alan Coxfc6f6232009-01-02 13:43:17 +00002310 /* Lock the tty */
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002311 mutex_lock(&tty->winsize_mutex);
Alan Coxfc6f6232009-01-02 13:43:17 +00002312 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002313 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002314
Peter Hurley5b239542014-10-16 14:59:45 -04002315 /* Signal the foreground process group */
2316 pgrp = tty_get_pgrp(tty);
Alan Cox47f86832008-04-30 00:53:30 -07002317 if (pgrp)
2318 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002319 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002320
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002321 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002322done:
Peter Hurleydee4a0b2013-07-24 16:43:51 -04002323 mutex_unlock(&tty->winsize_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 return 0;
2325}
Martin Schwidefsky4d334fd2013-01-04 14:55:13 +01002326EXPORT_SYMBOL(tty_do_resize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Alan Coxaf9b8972006-08-27 01:24:01 -07002328/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002329 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002330 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002331 * @arg: user buffer for result
2332 *
2333 * Copies the user idea of the window size to the kernel. Traditionally
2334 * this is just advisory information but for the Linux console it
2335 * actually has driver level meaning and triggers a VC resize.
2336 *
2337 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002338 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002339 * tty termios mutex and ctrl_lock. The console takes its own lock
2340 * then calls into the default method.
2341 */
2342
Alan Coxfc6f6232009-01-02 13:43:17 +00002343static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002344{
2345 struct winsize tmp_ws;
2346 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2347 return -EFAULT;
2348
2349 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002350 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002351 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002352 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002353}
2354
2355/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002356 * tioccons - allow admin to move logical console
2357 * @file: the file to become console
2358 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002359 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002360 *
2361 * Locking: uses redirect_lock to guard the redirect information
2362 */
2363
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364static int tioccons(struct file *file)
2365{
2366 if (!capable(CAP_SYS_ADMIN))
2367 return -EPERM;
2368 if (file->f_op->write == redirected_tty_write) {
2369 struct file *f;
2370 spin_lock(&redirect_lock);
2371 f = redirect;
2372 redirect = NULL;
2373 spin_unlock(&redirect_lock);
2374 if (f)
2375 fput(f);
2376 return 0;
2377 }
2378 spin_lock(&redirect_lock);
2379 if (redirect) {
2380 spin_unlock(&redirect_lock);
2381 return -EBUSY;
2382 }
Al Virocb0942b2012-08-27 14:48:26 -04002383 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 spin_unlock(&redirect_lock);
2385 return 0;
2386}
2387
Alan Coxaf9b8972006-08-27 01:24:01 -07002388/**
2389 * fionbio - non blocking ioctl
2390 * @file: file to set blocking value
2391 * @p: user parameter
2392 *
2393 * Historical tty interfaces had a blocking control ioctl before
2394 * the generic functionality existed. This piece of history is preserved
2395 * in the expected tty API of posix OS's.
2396 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002397 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002398 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399
2400static int fionbio(struct file *file, int __user *p)
2401{
2402 int nonblock;
2403
2404 if (get_user(nonblock, p))
2405 return -EFAULT;
2406
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002407 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 if (nonblock)
2409 file->f_flags |= O_NONBLOCK;
2410 else
2411 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002412 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 return 0;
2414}
2415
Alan Coxaf9b8972006-08-27 01:24:01 -07002416/**
2417 * tiocsctty - set controlling tty
2418 * @tty: tty structure
2419 * @arg: user argument
2420 *
2421 * This ioctl is used to manage job control. It permits a session
2422 * leader to set this tty as the controlling tty for the session.
2423 *
2424 * Locking:
Peter Hurleye218eb32014-10-16 14:59:49 -04002425 * Takes tty_lock() to serialize proc_set_tty() for this tty
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002426 * Takes tasklist_lock internally to walk sessions
2427 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002428 */
2429
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430static int tiocsctty(struct tty_struct *tty, int arg)
2431{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002432 int ret = 0;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002433
Peter Hurleye218eb32014-10-16 14:59:49 -04002434 tty_lock(tty);
Peter Hurley2c411c12014-10-16 14:59:47 -04002435 read_lock(&tasklist_lock);
2436
2437 if (current->signal->leader && (task_session(current) == tty->session))
2438 goto unlock;
2439
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 /*
2441 * The process must be a session leader and
2442 * not have a controlling tty already.
2443 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002444 if (!current->signal->leader || current->signal->tty) {
2445 ret = -EPERM;
2446 goto unlock;
2447 }
2448
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002449 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 /*
2451 * This tty is already the controlling
2452 * tty for another session group!
2453 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002454 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 /*
2456 * Steal it away
2457 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002458 session_clear_tty(tty->session);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002459 } else {
2460 ret = -EPERM;
2461 goto unlock;
2462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 }
Peter Hurleybce65f12014-10-16 14:59:43 -04002464 proc_set_tty(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002465unlock:
Peter Hurley2c411c12014-10-16 14:59:47 -04002466 read_unlock(&tasklist_lock);
Peter Hurleye218eb32014-10-16 14:59:49 -04002467 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002468 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469}
2470
Alan Coxaf9b8972006-08-27 01:24:01 -07002471/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002472 * tty_get_pgrp - return a ref counted pgrp pid
2473 * @tty: tty to read
2474 *
2475 * Returns a refcounted instance of the pid struct for the process
2476 * group controlling the tty.
2477 */
2478
2479struct pid *tty_get_pgrp(struct tty_struct *tty)
2480{
2481 unsigned long flags;
2482 struct pid *pgrp;
2483
2484 spin_lock_irqsave(&tty->ctrl_lock, flags);
2485 pgrp = get_pid(tty->pgrp);
2486 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2487
2488 return pgrp;
2489}
2490EXPORT_SYMBOL_GPL(tty_get_pgrp);
2491
Peter Hurleye1c22962014-10-16 14:59:48 -04002492/*
2493 * This checks not only the pgrp, but falls back on the pid if no
2494 * satisfactory pgrp is found. I dunno - gdb doesn't work correctly
2495 * without this...
2496 *
2497 * The caller must hold rcu lock or the tasklist lock.
2498 */
2499static struct pid *session_of_pgrp(struct pid *pgrp)
2500{
2501 struct task_struct *p;
2502 struct pid *sid = NULL;
2503
2504 p = pid_task(pgrp, PIDTYPE_PGID);
2505 if (p == NULL)
2506 p = pid_task(pgrp, PIDTYPE_PID);
2507 if (p != NULL)
2508 sid = task_session(p);
2509
2510 return sid;
2511}
2512
Alan Cox5d0fdf12008-04-30 00:53:31 -07002513/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002514 * tiocgpgrp - get process group
2515 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002516 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002517 * @p: returned pid
2518 *
2519 * Obtain the process group of the tty. If there is no process group
2520 * return an error.
2521 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002522 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002523 */
2524
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2526{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002527 struct pid *pid;
2528 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 /*
2530 * (tty == real_tty) is a cheap way of
2531 * testing if the tty is NOT a master pty.
2532 */
2533 if (tty == real_tty && current->signal->tty != real_tty)
2534 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002535 pid = tty_get_pgrp(real_tty);
2536 ret = put_user(pid_vnr(pid), p);
2537 put_pid(pid);
2538 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539}
2540
Alan Coxaf9b8972006-08-27 01:24:01 -07002541/**
2542 * tiocspgrp - attempt to set process group
2543 * @tty: tty passed by user
2544 * @real_tty: tty side device matching tty passed by user
2545 * @p: pid pointer
2546 *
2547 * Set the process group of the tty to the session passed. Only
2548 * permitted where the tty session is our session.
2549 *
Alan Cox47f86832008-04-30 00:53:30 -07002550 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002551 */
2552
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2554{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002555 struct pid *pgrp;
2556 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002558 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559
2560 if (retval == -EIO)
2561 return -ENOTTY;
2562 if (retval)
2563 return retval;
2564 if (!current->signal->tty ||
2565 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002566 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002568 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002570 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002572 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002573 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002574 retval = -ESRCH;
2575 if (!pgrp)
2576 goto out_unlock;
2577 retval = -EPERM;
2578 if (session_of_pgrp(pgrp) != task_session(current))
2579 goto out_unlock;
2580 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002581 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002582 put_pid(real_tty->pgrp);
2583 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002584 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002585out_unlock:
2586 rcu_read_unlock();
2587 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588}
2589
Alan Coxaf9b8972006-08-27 01:24:01 -07002590/**
2591 * tiocgsid - get session id
2592 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002593 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002594 * @p: pointer to returned session id
2595 *
2596 * Obtain the session id of the tty. If there is no session
2597 * return an error.
2598 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002599 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002600 */
2601
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2603{
2604 /*
2605 * (tty == real_tty) is a cheap way of
2606 * testing if the tty is NOT a master pty.
2607 */
2608 if (tty == real_tty && current->signal->tty != real_tty)
2609 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002610 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002611 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002612 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613}
2614
Alan Coxaf9b8972006-08-27 01:24:01 -07002615/**
2616 * tiocsetd - set line discipline
2617 * @tty: tty device
2618 * @p: pointer to user data
2619 *
2620 * Set the line discipline according to user request.
2621 *
2622 * Locking: see tty_set_ldisc, this function is just a helper
2623 */
2624
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625static int tiocsetd(struct tty_struct *tty, int __user *p)
2626{
2627 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002628 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629
2630 if (get_user(ldisc, p))
2631 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002632
Alan Cox04f378b2008-04-30 00:53:29 -07002633 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002634
2635 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636}
2637
Alan Coxaf9b8972006-08-27 01:24:01 -07002638/**
2639 * send_break - performed time break
2640 * @tty: device to break on
2641 * @duration: timeout in mS
2642 *
2643 * Perform a timed break on hardware that lacks its own driver level
2644 * timed break functionality.
2645 *
2646 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002647 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002648 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002649 */
2650
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002651static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652{
Alan Cox9e989662008-07-22 11:18:03 +01002653 int retval;
2654
2655 if (tty->ops->break_ctl == NULL)
2656 return 0;
2657
2658 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2659 retval = tty->ops->break_ctl(tty, duration);
2660 else {
2661 /* Do the work ourselves */
2662 if (tty_write_lock(tty, 0) < 0)
2663 return -EINTR;
2664 retval = tty->ops->break_ctl(tty, -1);
2665 if (retval)
2666 goto out;
2667 if (!signal_pending(current))
2668 msleep_interruptible(duration);
2669 retval = tty->ops->break_ctl(tty, 0);
2670out:
2671 tty_write_unlock(tty);
2672 if (signal_pending(current))
2673 retval = -EINTR;
2674 }
2675 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676}
2677
Alan Coxaf9b8972006-08-27 01:24:01 -07002678/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002679 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002680 * @tty: tty device
2681 * @file: user file pointer
2682 * @p: pointer to result
2683 *
2684 * Obtain the modem status bits from the tty driver if the feature
2685 * is supported. Return -EINVAL if it is not available.
2686 *
2687 * Locking: none (up to the driver)
2688 */
2689
Alan Cox60b33c12011-02-14 16:26:14 +00002690static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691{
2692 int retval = -EINVAL;
2693
Alan Coxf34d7a52008-04-30 00:54:13 -07002694 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002695 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696
2697 if (retval >= 0)
2698 retval = put_user(retval, p);
2699 }
2700 return retval;
2701}
2702
Alan Coxaf9b8972006-08-27 01:24:01 -07002703/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002704 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002705 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002706 * @cmd: command - clear bits, set bits or set all
2707 * @p: pointer to desired bits
2708 *
2709 * Set the modem status bits from the tty driver if the feature
2710 * is supported. Return -EINVAL if it is not available.
2711 *
2712 * Locking: none (up to the driver)
2713 */
2714
Alan Cox20b9d172011-02-14 16:26:50 +00002715static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716 unsigned __user *p)
2717{
Alan Coxae677512008-07-16 21:56:54 +01002718 int retval;
2719 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720
Alan Coxae677512008-07-16 21:56:54 +01002721 if (tty->ops->tiocmset == NULL)
2722 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723
Alan Coxae677512008-07-16 21:56:54 +01002724 retval = get_user(val, p);
2725 if (retval)
2726 return retval;
2727 set = clear = 0;
2728 switch (cmd) {
2729 case TIOCMBIS:
2730 set = val;
2731 break;
2732 case TIOCMBIC:
2733 clear = val;
2734 break;
2735 case TIOCMSET:
2736 set = val;
2737 clear = ~val;
2738 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739 }
Alan Coxae677512008-07-16 21:56:54 +01002740 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2741 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002742 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743}
2744
Alan Coxd281da72010-09-16 18:21:24 +01002745static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2746{
2747 int retval = -EINVAL;
2748 struct serial_icounter_struct icount;
2749 memset(&icount, 0, sizeof(icount));
2750 if (tty->ops->get_icount)
2751 retval = tty->ops->get_icount(tty, &icount);
2752 if (retval != 0)
2753 return retval;
2754 if (copy_to_user(arg, &icount, sizeof(icount)))
2755 return -EFAULT;
2756 return 0;
2757}
2758
Peter Hurley8f166e02014-10-16 14:59:41 -04002759/*
2760 * if pty, return the slave side (real_tty)
2761 * otherwise, return self
2762 */
2763static struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
Alan Coxe8b70e72009-06-11 12:48:02 +01002764{
2765 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2766 tty->driver->subtype == PTY_TYPE_MASTER)
2767 tty = tty->link;
2768 return tty;
2769}
Alan Coxe8b70e72009-06-11 12:48:02 +01002770
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771/*
2772 * Split this up, as gcc can choke on it otherwise..
2773 */
Alan Cox04f378b2008-04-30 00:53:29 -07002774long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775{
Nick Piggind996b622010-08-18 04:37:36 +10002776 struct tty_struct *tty = file_tty(file);
2777 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 void __user *p = (void __user *)arg;
2779 int retval;
2780 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002781
Al Viro6131ffa2013-02-27 16:59:05 -05002782 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783 return -EINVAL;
2784
Alan Coxe8b70e72009-06-11 12:48:02 +01002785 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786
2787 /*
2788 * Factor out some common prep work
2789 */
2790 switch (cmd) {
2791 case TIOCSETD:
2792 case TIOCSBRK:
2793 case TIOCCBRK:
2794 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002795 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 retval = tty_check_change(tty);
2797 if (retval)
2798 return retval;
2799 if (cmd != TIOCCBRK) {
2800 tty_wait_until_sent(tty, 0);
2801 if (signal_pending(current))
2802 return -EINTR;
2803 }
2804 break;
2805 }
2806
Alan Cox9e989662008-07-22 11:18:03 +01002807 /*
2808 * Now do the stuff.
2809 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002811 case TIOCSTI:
2812 return tiocsti(tty, p);
2813 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002814 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002815 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002816 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002817 case TIOCCONS:
2818 return real_tty != tty ? -EINVAL : tioccons(file);
2819 case FIONBIO:
2820 return fionbio(file, p);
2821 case TIOCEXCL:
2822 set_bit(TTY_EXCLUSIVE, &tty->flags);
2823 return 0;
2824 case TIOCNXCL:
2825 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2826 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002827 case TIOCGEXCL:
2828 {
2829 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2830 return put_user(excl, (int __user *)p);
2831 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002832 case TIOCNOTTY:
2833 if (current->signal->tty != tty)
2834 return -ENOTTY;
2835 no_tty();
2836 return 0;
2837 case TIOCSCTTY:
2838 return tiocsctty(tty, arg);
2839 case TIOCGPGRP:
2840 return tiocgpgrp(tty, real_tty, p);
2841 case TIOCSPGRP:
2842 return tiocspgrp(tty, real_tty, p);
2843 case TIOCGSID:
2844 return tiocgsid(tty, real_tty, p);
2845 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002846 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002847 case TIOCSETD:
2848 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002849 case TIOCVHANGUP:
2850 if (!capable(CAP_SYS_ADMIN))
2851 return -EPERM;
2852 tty_vhangup(tty);
2853 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002854 case TIOCGDEV:
2855 {
2856 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2857 return put_user(ret, (unsigned int __user *)p);
2858 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002859 /*
2860 * Break handling
2861 */
2862 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002863 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002864 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002865 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002866 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002867 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002868 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002869 return 0;
2870 case TCSBRK: /* SVID version: non-zero arg --> no break */
2871 /* non-zero arg means wait for all output data
2872 * to be sent (performed above) but don't send break.
2873 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002875 if (!arg)
2876 return send_break(tty, 250);
2877 return 0;
2878 case TCSBRKP: /* support for POSIX tcsendbreak() */
2879 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880
Alan Cox37bdfb02008-02-08 04:18:47 -08002881 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002882 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002883 case TIOCMSET:
2884 case TIOCMBIC:
2885 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002886 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002887 case TIOCGICOUNT:
2888 retval = tty_tiocgicount(tty, p);
2889 /* For the moment allow fall through to the old method */
2890 if (retval != -EINVAL)
2891 return retval;
2892 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002893 case TCFLSH:
2894 switch (arg) {
2895 case TCIFLUSH:
2896 case TCIOFLUSH:
2897 /* flush tty buffer and allow ldisc to process ioctl */
2898 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002899 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002900 }
2901 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002903 if (tty->ops->ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002904 retval = (tty->ops->ioctl)(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 if (retval != -ENOIOCTLCMD)
2906 return retval;
2907 }
2908 ld = tty_ldisc_ref_wait(tty);
2909 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002910 if (ld->ops->ioctl) {
2911 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002913 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002914 }
2915 tty_ldisc_deref(ld);
2916 return retval;
2917}
2918
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002919#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002920static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002921 unsigned long arg)
2922{
Nick Piggind996b622010-08-18 04:37:36 +10002923 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002924 struct tty_ldisc *ld;
2925 int retval = -ENOIOCTLCMD;
2926
Al Viro6131ffa2013-02-27 16:59:05 -05002927 if (tty_paranoia_check(tty, file_inode(file), "tty_ioctl"))
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002928 return -EINVAL;
2929
Alan Coxf34d7a52008-04-30 00:54:13 -07002930 if (tty->ops->compat_ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002931 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002932 if (retval != -ENOIOCTLCMD)
2933 return retval;
2934 }
2935
2936 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002937 if (ld->ops->compat_ioctl)
2938 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002939 else
2940 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002941 tty_ldisc_deref(ld);
2942
2943 return retval;
2944}
2945#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946
Al Viroc3c073f2012-08-21 22:32:06 -04002947static int this_tty(const void *t, struct file *file, unsigned fd)
2948{
2949 if (likely(file->f_op->read != tty_read))
2950 return 0;
2951 return file_tty(file) != t ? 0 : fd + 1;
2952}
2953
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954/*
2955 * This implements the "Secure Attention Key" --- the idea is to
2956 * prevent trojan horses by killing all processes associated with this
2957 * tty when the user hits the "Secure Attention Key". Required for
2958 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002959 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 * This code could be nicer; ideally it should send a HUP, wait a few
2961 * seconds, then send a INT, and then a KILL signal. But you then
2962 * have to coordinate with the init process, since all processes associated
2963 * with the current tty must be dead before the new getty is allowed
2964 * to spawn.
2965 *
2966 * Now, if it would be correct ;-/ The current code has a nasty hole -
2967 * it doesn't catch files in flight. We may send the descriptor to ourselves
2968 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2969 *
2970 * Nasty bug: do_SAK is being called in interrupt context. This can
2971 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2972 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002973void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974{
2975#ifdef TTY_SOFT_SAK
2976 tty_hangup(tty);
2977#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002978 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002979 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002980 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08002981
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 if (!tty)
2983 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002984 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002985
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002986 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987
Alan Coxf34d7a52008-04-30 00:54:13 -07002988 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002989
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002991 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002992 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002993 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002994 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002995 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002996 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002997 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002998 /* Now kill any processes that happen to have the
2999 * tty open.
3000 */
3001 do_each_thread(g, p) {
3002 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003003 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07003004 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07003005 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003006 send_sig(SIGKILL, p, 1);
3007 continue;
3008 }
3009 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04003010 i = iterate_fd(p->files, 0, this_tty, tty);
3011 if (i != 0) {
3012 printk(KERN_NOTICE "SAK: killed process %d"
3013 " (%s): fd#%d opened to the tty\n",
3014 task_pid_nr(p), p->comm, i - 1);
3015 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003016 }
3017 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08003018 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 read_unlock(&tasklist_lock);
3020#endif
3021}
3022
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08003023static void do_SAK_work(struct work_struct *work)
3024{
3025 struct tty_struct *tty =
3026 container_of(work, struct tty_struct, SAK_work);
3027 __do_SAK(tty);
3028}
3029
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030/*
3031 * The tq handling here is a little racy - tty->SAK_work may already be queued.
3032 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
3033 * the values which we write to it will be identical to the values which it
3034 * already has. --akpm
3035 */
3036void do_SAK(struct tty_struct *tty)
3037{
3038 if (!tty)
3039 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040 schedule_work(&tty->SAK_work);
3041}
3042
3043EXPORT_SYMBOL(do_SAK);
3044
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003045static int dev_match_devt(struct device *dev, const void *data)
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003046{
Greg Kroah-Hartman6e9430a2013-02-06 15:59:18 -08003047 const dev_t *devt = data;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003048 return dev->devt == *devt;
3049}
3050
3051/* Must put_device() after it's unused! */
3052static struct device *tty_get_device(struct tty_struct *tty)
3053{
3054 dev_t devt = tty_devnum(tty);
3055 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
3056}
3057
3058
Alan Coxaf9b8972006-08-27 01:24:01 -07003059/**
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003060 * alloc_tty_struct
Alan Coxaf9b8972006-08-27 01:24:01 -07003061 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003062 * This subroutine allocates and initializes a tty structure.
Alan Coxaf9b8972006-08-27 01:24:01 -07003063 *
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003064 * Locking: none - tty in question is not exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003066
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003067struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068{
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003069 struct tty_struct *tty;
3070
3071 tty = kzalloc(sizeof(*tty), GFP_KERNEL);
3072 if (!tty)
3073 return NULL;
3074
Alan Cox9c9f4de2008-10-13 10:37:26 +01003075 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01003077 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003078 tty->session = NULL;
3079 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01003080 mutex_init(&tty->legacy_mutex);
Peter Hurleyd8c1f922013-06-15 09:14:31 -04003081 mutex_init(&tty->throttle_mutex);
Peter Hurley6a1c0682013-06-15 09:14:23 -04003082 init_rwsem(&tty->termios_rwsem);
Peter Hurleydee4a0b2013-07-24 16:43:51 -04003083 mutex_init(&tty->winsize_mutex);
Peter Hurley36697522013-06-15 07:04:48 -04003084 init_ldsem(&tty->ldisc_sem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085 init_waitqueue_head(&tty->write_wait);
3086 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00003087 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08003088 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07003089 spin_lock_init(&tty->ctrl_lock);
Peter Hurleyf9e053d2014-09-10 15:06:31 -04003090 spin_lock_init(&tty->flow_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07003092 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01003093
3094 tty->driver = driver;
3095 tty->ops = driver->ops;
3096 tty->index = idx;
3097 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04003098 tty->dev = tty_get_device(tty);
Rasmus Villemoes2c964a22014-07-10 21:01:22 +02003099
3100 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101}
3102
Alan Coxf34d7a52008-04-30 00:54:13 -07003103/**
Jiri Slaby67166712011-03-23 10:48:35 +01003104 * deinitialize_tty_struct
3105 * @tty: tty to deinitialize
3106 *
3107 * This subroutine deinitializes a tty structure that has been newly
3108 * allocated but tty_release cannot be called on that yet.
3109 *
3110 * Locking: none - tty in question must not be exposed at this point
3111 */
3112void deinitialize_tty_struct(struct tty_struct *tty)
3113{
3114 tty_ldisc_deinit(tty);
3115}
3116
3117/**
Alan Coxf34d7a52008-04-30 00:54:13 -07003118 * tty_put_char - write one character to a tty
3119 * @tty: tty
3120 * @ch: character
3121 *
3122 * Write one byte to the tty using the provided put_char method
3123 * if present. Returns the number of characters successfully output.
3124 *
3125 * Note: the specific put_char operation in the driver layer may go
3126 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003128
Alan Coxf34d7a52008-04-30 00:54:13 -07003129int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130{
Alan Coxf34d7a52008-04-30 00:54:13 -07003131 if (tty->ops->put_char)
3132 return tty->ops->put_char(tty, ch);
3133 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134}
Alan Coxf34d7a52008-04-30 00:54:13 -07003135EXPORT_SYMBOL_GPL(tty_put_char);
3136
Alan Coxd81ed102008-10-13 10:41:42 +01003137struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003139static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
3140 unsigned int index, unsigned int count)
3141{
3142 /* init here, since reused cdevs cause crashes */
3143 cdev_init(&driver->cdevs[index], &tty_fops);
3144 driver->cdevs[index].owner = driver->owner;
3145 return cdev_add(&driver->cdevs[index], dev, count);
3146}
3147
Linus Torvalds1da177e2005-04-16 15:20:36 -07003148/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003149 * tty_register_device - register a tty device
3150 * @driver: the tty driver that describes the tty device
3151 * @index: the index in the tty driver for this tty device
3152 * @device: a struct device that is associated with this tty device.
3153 * This field is optional, if there is no known struct device
3154 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003156 * Returns a pointer to the struct device for this tty device
3157 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003158 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003159 * This call is required to be made to register an individual tty device
3160 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3161 * that bit is not set, this function should not be called by a tty
3162 * driver.
3163 *
3164 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003166
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003167struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3168 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003170 return tty_register_device_attr(driver, index, device, NULL, NULL);
3171}
3172EXPORT_SYMBOL(tty_register_device);
3173
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003174static void tty_device_create_release(struct device *dev)
3175{
3176 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3177 kfree(dev);
3178}
3179
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003180/**
3181 * tty_register_device_attr - register a tty device
3182 * @driver: the tty driver that describes the tty device
3183 * @index: the index in the tty driver for this tty device
3184 * @device: a struct device that is associated with this tty device.
3185 * This field is optional, if there is no known struct device
3186 * for this tty device it can be set to NULL safely.
3187 * @drvdata: Driver data to be set to device.
3188 * @attr_grp: Attribute group to be set on device.
3189 *
3190 * Returns a pointer to the struct device for this tty device
3191 * (or ERR_PTR(-EFOO) on error).
3192 *
3193 * This call is required to be made to register an individual tty device
3194 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3195 * that bit is not set, this function should not be called by a tty
3196 * driver.
3197 *
3198 * Locking: ??
3199 */
3200struct device *tty_register_device_attr(struct tty_driver *driver,
3201 unsigned index, struct device *device,
3202 void *drvdata,
3203 const struct attribute_group **attr_grp)
3204{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003206 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3207 struct device *dev = NULL;
3208 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003209 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003210
3211 if (index >= driver->num) {
3212 printk(KERN_ERR "Attempt to register invalid tty line number "
3213 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003214 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003215 }
3216
Linus Torvalds1da177e2005-04-16 15:20:36 -07003217 if (driver->type == TTY_DRIVER_TYPE_PTY)
3218 pty_line_name(driver, index, name);
3219 else
3220 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003221
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003222 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003223 retval = tty_cdev_add(driver, devt, index, 1);
3224 if (retval)
3225 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003226 cdev = true;
3227 }
3228
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003229 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3230 if (!dev) {
3231 retval = -ENOMEM;
3232 goto error;
3233 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003234
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003235 dev->devt = devt;
3236 dev->class = tty_class;
3237 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003238 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003239 dev_set_name(dev, "%s", name);
3240 dev->groups = attr_grp;
3241 dev_set_drvdata(dev, drvdata);
3242
3243 retval = device_register(dev);
3244 if (retval)
3245 goto error;
3246
3247 return dev;
3248
3249error:
3250 put_device(dev);
3251 if (cdev)
3252 cdev_del(&driver->cdevs[index]);
3253 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003255EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256
3257/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003258 * tty_unregister_device - unregister a tty device
3259 * @driver: the tty driver that describes the tty device
3260 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003262 * If a tty device is registered with a call to tty_register_device() then
3263 * this function must be called when the tty device is gone.
3264 *
3265 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003267
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268void tty_unregister_device(struct tty_driver *driver, unsigned index)
3269{
Alan Cox37bdfb02008-02-08 04:18:47 -08003270 device_destroy(tty_class,
3271 MKDEV(driver->major, driver->minor_start) + index);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003272 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3273 cdev_del(&driver->cdevs[index]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003274}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275EXPORT_SYMBOL(tty_unregister_device);
3276
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003277/**
3278 * __tty_alloc_driver -- allocate tty driver
3279 * @lines: count of lines this driver can handle at most
3280 * @owner: module which is repsonsible for this driver
3281 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3282 *
3283 * This should not be called directly, some of the provided macros should be
3284 * used instead. Use IS_ERR and friends on @retval.
3285 */
3286struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3287 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003288{
3289 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003290 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003291 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292
Jiri Slaby0019b402012-08-08 22:26:43 +02003293 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003294 return ERR_PTR(-EINVAL);
3295
Jean Delvare506eb992007-07-15 23:40:14 -07003296 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003297 if (!driver)
3298 return ERR_PTR(-ENOMEM);
3299
3300 kref_init(&driver->kref);
3301 driver->magic = TTY_DRIVER_MAGIC;
3302 driver->num = lines;
3303 driver->owner = owner;
3304 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003305
3306 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3307 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3308 GFP_KERNEL);
3309 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3310 GFP_KERNEL);
3311 if (!driver->ttys || !driver->termios) {
3312 err = -ENOMEM;
3313 goto err_free_all;
3314 }
3315 }
3316
3317 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3318 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3319 GFP_KERNEL);
3320 if (!driver->ports) {
3321 err = -ENOMEM;
3322 goto err_free_all;
3323 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003324 cdevs = lines;
3325 }
3326
3327 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3328 if (!driver->cdevs) {
3329 err = -ENOMEM;
3330 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003331 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003332
Linus Torvalds1da177e2005-04-16 15:20:36 -07003333 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003334err_free_all:
3335 kfree(driver->ports);
3336 kfree(driver->ttys);
3337 kfree(driver->termios);
3338 kfree(driver);
3339 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003340}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003341EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003342
Alan Cox7d7b93c2008-10-13 10:42:09 +01003343static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003344{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003345 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3346 int i;
3347 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003348
3349 if (driver->flags & TTY_DRIVER_INSTALLED) {
3350 /*
3351 * Free the termios and termios_locked structures because
3352 * we don't want to get memory leaks when modular tty
3353 * drivers are removed from the kernel.
3354 */
3355 for (i = 0; i < driver->num; i++) {
3356 tp = driver->termios[i];
3357 if (tp) {
3358 driver->termios[i] = NULL;
3359 kfree(tp);
3360 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003361 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3362 tty_unregister_device(driver, i);
3363 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003364 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003365 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3366 cdev_del(&driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003367 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003368 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003369 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003370 kfree(driver->termios);
3371 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372 kfree(driver);
3373}
3374
Alan Cox7d7b93c2008-10-13 10:42:09 +01003375void tty_driver_kref_put(struct tty_driver *driver)
3376{
3377 kref_put(&driver->kref, destruct_tty_driver);
3378}
3379EXPORT_SYMBOL(tty_driver_kref_put);
3380
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003381void tty_set_operations(struct tty_driver *driver,
3382 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003383{
Alan Coxf34d7a52008-04-30 00:54:13 -07003384 driver->ops = op;
3385};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003386EXPORT_SYMBOL(tty_set_operations);
3387
Alan Cox7d7b93c2008-10-13 10:42:09 +01003388void put_tty_driver(struct tty_driver *d)
3389{
3390 tty_driver_kref_put(d);
3391}
3392EXPORT_SYMBOL(put_tty_driver);
3393
Linus Torvalds1da177e2005-04-16 15:20:36 -07003394/*
3395 * Called by a tty driver to register itself.
3396 */
3397int tty_register_driver(struct tty_driver *driver)
3398{
3399 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003400 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003402 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003403
Linus Torvalds1da177e2005-04-16 15:20:36 -07003404 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003405 error = alloc_chrdev_region(&dev, driver->minor_start,
3406 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003407 if (!error) {
3408 driver->major = MAJOR(dev);
3409 driver->minor_start = MINOR(dev);
3410 }
3411 } else {
3412 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003413 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003414 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003415 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003416 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003418 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3419 error = tty_cdev_add(driver, dev, 0, driver->num);
3420 if (error)
3421 goto err_unreg_char;
3422 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003423
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003424 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003426 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003427
3428 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003429 for (i = 0; i < driver->num; i++) {
3430 d = tty_register_device(driver, i, NULL);
3431 if (IS_ERR(d)) {
3432 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003433 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003434 }
3435 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436 }
3437 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003438 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003439 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003440
Jiri Slaby16a02082012-08-08 22:26:42 +02003441err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003442 for (i--; i >= 0; i--)
3443 tty_unregister_device(driver, i);
3444
3445 mutex_lock(&tty_mutex);
3446 list_del(&driver->tty_drivers);
3447 mutex_unlock(&tty_mutex);
3448
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003449err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003450 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003451err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003452 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003453}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003454EXPORT_SYMBOL(tty_register_driver);
3455
3456/*
3457 * Called by a tty driver to unregister itself.
3458 */
3459int tty_unregister_driver(struct tty_driver *driver)
3460{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003461#if 0
3462 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 if (driver->refcount)
3464 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003465#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3467 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003468 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003469 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003470 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471 return 0;
3472}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003473
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474EXPORT_SYMBOL(tty_unregister_driver);
3475
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003476dev_t tty_devnum(struct tty_struct *tty)
3477{
3478 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3479}
3480EXPORT_SYMBOL(tty_devnum);
3481
Alan Coxd81ed102008-10-13 10:41:42 +01003482void tty_default_fops(struct file_operations *fops)
3483{
3484 *fops = tty_fops;
3485}
3486
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487/*
3488 * Initialize the console device. This is called *early*, so
3489 * we can't necessarily depend on lots of kernel help here.
3490 * Just do some early initializations, and do the complex setup
3491 * later.
3492 */
3493void __init console_init(void)
3494{
3495 initcall_t *call;
3496
3497 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003498 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003499
3500 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003501 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502 * inform about problems etc..
3503 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003504 call = __con_initcall_start;
3505 while (call < __con_initcall_end) {
3506 (*call)();
3507 call++;
3508 }
3509}
3510
Al Viro2c9ede52011-07-23 20:24:48 -04003511static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003512{
3513 if (!mode)
3514 return NULL;
3515 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3516 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3517 *mode = 0666;
3518 return NULL;
3519}
3520
Linus Torvalds1da177e2005-04-16 15:20:36 -07003521static int __init tty_class_init(void)
3522{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003523 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003524 if (IS_ERR(tty_class))
3525 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003526 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003527 return 0;
3528}
3529
3530postcore_initcall(tty_class_init);
3531
3532/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003533static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534
Kay Sieversfbc92a32010-12-01 18:51:05 +01003535static ssize_t show_cons_active(struct device *dev,
3536 struct device_attribute *attr, char *buf)
3537{
3538 struct console *cs[16];
3539 int i = 0;
3540 struct console *c;
3541 ssize_t count = 0;
3542
Torben Hohnac751ef2011-01-25 15:07:35 -08003543 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003544 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003545 if (!c->device)
3546 continue;
3547 if (!c->write)
3548 continue;
3549 if ((c->flags & CON_ENABLED) == 0)
3550 continue;
3551 cs[i++] = c;
3552 if (i >= ARRAY_SIZE(cs))
3553 break;
3554 }
Hannes Reinecke723abd82014-02-27 12:30:51 +01003555 while (i--) {
3556 int index = cs[i]->index;
3557 struct tty_driver *drv = cs[i]->device(cs[i], &index);
3558
3559 /* don't resolve tty0 as some programs depend on it */
3560 if (drv && (cs[i]->index > 0 || drv->major != TTY_MAJOR))
3561 count += tty_line_name(drv, index, buf + count);
3562 else
3563 count += sprintf(buf + count, "%s%d",
3564 cs[i]->name, cs[i]->index);
3565
3566 count += sprintf(buf + count, "%c", i ? ' ':'\n');
3567 }
Torben Hohnac751ef2011-01-25 15:07:35 -08003568 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003569
3570 return count;
3571}
3572static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3573
3574static struct device *consdev;
3575
3576void console_sysfs_notify(void)
3577{
3578 if (consdev)
3579 sysfs_notify(&consdev->kobj, NULL, "active");
3580}
3581
Linus Torvalds1da177e2005-04-16 15:20:36 -07003582/*
3583 * Ok, now we can initialize the rest of the tty devices and can count
3584 * on memory allocations, interrupts etc..
3585 */
David Howells31d1d482010-08-06 16:34:43 +01003586int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587{
3588 cdev_init(&tty_cdev, &tty_fops);
3589 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3590 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3591 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003592 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593
3594 cdev_init(&console_cdev, &console_fops);
3595 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3596 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3597 panic("Couldn't register /dev/console driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003598 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003599 "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003600 if (IS_ERR(consdev))
3601 consdev = NULL;
3602 else
Kay Sieversa2a6a822011-01-09 16:39:14 +01003603 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604
Linus Torvalds1da177e2005-04-16 15:20:36 -07003605#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003606 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003607#endif
3608 return 0;
3609}
David Howells31d1d482010-08-06 16:34:43 +01003610