blob: 8f44d627cceab85268ec037eec799d8c0494c7bc [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);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700156static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700157static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Alan Coxaf9b8972006-08-27 01:24:01 -0700159/**
160 * alloc_tty_struct - allocate a tty object
161 *
162 * Return a new empty tty structure. The data fields have not
163 * been initialized in any way but has been zeroed
164 *
165 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700166 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Alan Coxbf970ee2008-10-13 10:42:39 +0100168struct tty_struct *alloc_tty_struct(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169{
Alan Cox1266b1e2006-09-29 02:00:40 -0700170 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
172
Alan Coxaf9b8972006-08-27 01:24:01 -0700173/**
174 * free_tty_struct - free a disused tty
175 * @tty: tty struct to free
176 *
177 * Free the write buffers, tty queue and tty memory itself.
178 *
179 * Locking: none. Must be called after tty is definitely unused
180 */
181
Alan Coxbf970ee2008-10-13 10:42:39 +0100182void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
Dan Carpenterdc6802a2012-07-24 12:52:04 +0100184 if (!tty)
185 return;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400186 if (tty->dev)
187 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 kfree(tty->write_buf);
Alan Cox89c8d912012-08-08 16:30:13 +0100189 tty->magic = 0xDEADDEAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 kfree(tty);
191}
192
Nick Piggind996b622010-08-18 04:37:36 +1000193static inline struct tty_struct *file_tty(struct file *file)
194{
195 return ((struct tty_file_private *)file->private_data)->tty;
196}
197
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200198int tty_alloc_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000199{
200 struct tty_file_private *priv;
201
Pekka Enbergf573bd12010-08-24 07:48:34 +0300202 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
203 if (!priv)
204 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000205
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200206 file->private_data = priv;
207
208 return 0;
209}
210
211/* Associate a new file with the tty structure */
212void tty_add_file(struct tty_struct *tty, struct file *file)
213{
214 struct tty_file_private *priv = file->private_data;
215
Nick Piggind996b622010-08-18 04:37:36 +1000216 priv->tty = tty;
217 priv->file = file;
Nick Piggind996b622010-08-18 04:37:36 +1000218
219 spin_lock(&tty_files_lock);
220 list_add(&priv->list, &tty->tty_files);
221 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200222}
Pekka Enbergf573bd12010-08-24 07:48:34 +0300223
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200224/**
225 * tty_free_file - free file->private_data
226 *
227 * This shall be used only for fail path handling when tty_add_file was not
228 * called yet.
229 */
230void tty_free_file(struct file *file)
231{
232 struct tty_file_private *priv = file->private_data;
233
234 file->private_data = NULL;
235 kfree(priv);
Nick Piggind996b622010-08-18 04:37:36 +1000236}
237
238/* Delete file from its tty */
Josh Triplett2520e272012-11-18 21:27:47 -0800239static void tty_del_file(struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000240{
241 struct tty_file_private *priv = file->private_data;
242
243 spin_lock(&tty_files_lock);
244 list_del(&priv->list);
245 spin_unlock(&tty_files_lock);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200246 tty_free_file(file);
Nick Piggind996b622010-08-18 04:37:36 +1000247}
248
249
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
251
Alan Coxaf9b8972006-08-27 01:24:01 -0700252/**
253 * tty_name - return tty naming
254 * @tty: tty structure
255 * @buf: buffer for output
256 *
257 * Convert a tty structure into a name. The name reflects the kernel
258 * naming policy and if udev is in use may not reflect user space
259 *
260 * Locking: none
261 */
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263char *tty_name(struct tty_struct *tty, char *buf)
264{
265 if (!tty) /* Hmm. NULL pointer. That's fun. */
266 strcpy(buf, "NULL tty");
267 else
268 strcpy(buf, tty->name);
269 return buf;
270}
271
272EXPORT_SYMBOL(tty_name);
273
Andrew Mortond769a662005-05-05 16:15:50 -0700274int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 const char *routine)
276{
277#ifdef TTY_PARANOIA_CHECK
278 if (!tty) {
279 printk(KERN_WARNING
280 "null TTY for (%d:%d) in %s\n",
281 imajor(inode), iminor(inode), routine);
282 return 1;
283 }
284 if (tty->magic != TTY_MAGIC) {
285 printk(KERN_WARNING
286 "bad magic number for tty struct (%d:%d) in %s\n",
287 imajor(inode), iminor(inode), routine);
288 return 1;
289 }
290#endif
291 return 0;
292}
293
294static int check_tty_count(struct tty_struct *tty, const char *routine)
295{
296#ifdef CHECK_TTY_COUNT
297 struct list_head *p;
298 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800299
Nick Pigginee2ffa02010-08-18 04:37:35 +1000300 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 list_for_each(p, &tty->tty_files) {
302 count++;
303 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000304 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
306 tty->driver->subtype == PTY_TYPE_SLAVE &&
307 tty->link && tty->link->count)
308 count++;
309 if (tty->count != count) {
310 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
311 "!= #fd's(%d) in %s\n",
312 tty->name, tty->count, count, routine);
313 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800314 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#endif
316 return 0;
317}
318
Alan Coxaf9b8972006-08-27 01:24:01 -0700319/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700320 * get_tty_driver - find device of a tty
321 * @dev_t: device identifier
322 * @index: returns the index of the tty
323 *
324 * This routine returns a tty driver structure, given a device number
325 * and also passes back the index number.
326 *
327 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330static struct tty_driver *get_tty_driver(dev_t device, int *index)
331{
332 struct tty_driver *p;
333
334 list_for_each_entry(p, &tty_drivers, tty_drivers) {
335 dev_t base = MKDEV(p->major, p->minor_start);
336 if (device < base || device >= base + p->num)
337 continue;
338 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100339 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 }
341 return NULL;
342}
343
Jason Wesself2d937f2008-04-17 20:05:37 +0200344#ifdef CONFIG_CONSOLE_POLL
345
346/**
347 * tty_find_polling_driver - find device of a polled tty
348 * @name: name string to match
349 * @line: pointer to resulting tty line nr
350 *
351 * This routine returns a tty driver structure, given a name
352 * and the condition that the tty driver is capable of polled
353 * operation.
354 */
355struct tty_driver *tty_find_polling_driver(char *name, int *line)
356{
357 struct tty_driver *p, *res = NULL;
358 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500359 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100360 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200361
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500362 for (str = name; *str; str++)
363 if ((*str >= '0' && *str <= '9') || *str == ',')
364 break;
365 if (!*str)
366 return NULL;
367
368 len = str - name;
369 tty_line = simple_strtoul(str, &str, 10);
370
Jason Wesself2d937f2008-04-17 20:05:37 +0200371 mutex_lock(&tty_mutex);
372 /* Search through the tty devices to look for a match */
373 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500374 if (strncmp(name, p->name, len) != 0)
375 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100376 stp = str;
377 if (*stp == ',')
378 stp++;
379 if (*stp == '\0')
380 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200381
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200382 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100383 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100384 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200385 *line = tty_line;
386 break;
387 }
388 }
389 mutex_unlock(&tty_mutex);
390
391 return res;
392}
393EXPORT_SYMBOL_GPL(tty_find_polling_driver);
394#endif
395
Alan Coxaf9b8972006-08-27 01:24:01 -0700396/**
397 * tty_check_change - check for POSIX terminal changes
398 * @tty: tty to check
399 *
400 * If we try to write to, or set the state of, a terminal and we're
401 * not in the foreground, send a SIGTTOU. If the signal is blocked or
402 * ignored, go ahead and perform the operation. (POSIX 7.2)
403 *
Alan Cox978e5952008-04-30 00:53:59 -0700404 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700406
Alan Cox37bdfb02008-02-08 04:18:47 -0800407int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Alan Cox47f86832008-04-30 00:53:30 -0700409 unsigned long flags;
410 int ret = 0;
411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if (current->signal->tty != tty)
413 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700414
415 spin_lock_irqsave(&tty->ctrl_lock, flags);
416
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800417 if (!tty->pgrp) {
418 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700419 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800421 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700422 goto out_unlock;
423 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700425 goto out;
426 if (is_current_pgrp_orphaned()) {
427 ret = -EIO;
428 goto out;
429 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700430 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
431 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700432 ret = -ERESTARTSYS;
433out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700434 return ret;
435out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700436 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
437 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438}
439
440EXPORT_SYMBOL(tty_check_change);
441
Alan Cox37bdfb02008-02-08 04:18:47 -0800442static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 size_t count, loff_t *ppos)
444{
445 return 0;
446}
447
Alan Cox37bdfb02008-02-08 04:18:47 -0800448static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 size_t count, loff_t *ppos)
450{
451 return -EIO;
452}
453
454/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800455static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
458}
459
Alan Cox04f378b2008-04-30 00:53:29 -0700460static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
461 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700462{
463 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
464}
465
Alan Cox37bdfb02008-02-08 04:18:47 -0800466static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700467 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468{
469 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
470}
471
Arjan van de Ven62322d22006-07-03 00:24:21 -0700472static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 .llseek = no_llseek,
474 .read = tty_read,
475 .write = tty_write,
476 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700477 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700478 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 .open = tty_open,
480 .release = tty_release,
481 .fasync = tty_fasync,
482};
483
Arjan van de Ven62322d22006-07-03 00:24:21 -0700484static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 .llseek = no_llseek,
486 .read = tty_read,
487 .write = redirected_tty_write,
488 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700489 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700490 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 .open = tty_open,
492 .release = tty_release,
493 .fasync = tty_fasync,
494};
495
Arjan van de Ven62322d22006-07-03 00:24:21 -0700496static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 .llseek = no_llseek,
498 .read = hung_up_tty_read,
499 .write = hung_up_tty_write,
500 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700501 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700502 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 .release = tty_release,
504};
505
506static DEFINE_SPINLOCK(redirect_lock);
507static struct file *redirect;
508
509/**
510 * tty_wakeup - request more data
511 * @tty: terminal
512 *
513 * Internal and external helper for wakeups of tty. This function
514 * informs the line discipline if present that the driver is ready
515 * to receive more output data.
516 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518void tty_wakeup(struct tty_struct *tty)
519{
520 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
523 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800524 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100525 if (ld->ops->write_wakeup)
526 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 tty_ldisc_deref(ld);
528 }
529 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700530 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531}
532
533EXPORT_SYMBOL_GPL(tty_wakeup);
534
535/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200536 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000537 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700538 *
Kevin Cernekeeef4f5272012-12-26 20:43:41 -0800539 * This can be called by a "kworker" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700540 * synchronous but doesn't hold any locks, so we need to make sure we
541 * have the appropriate locks for what we're doing.
542 *
543 * The hangup event clears any pending redirections onto the hung up
544 * device. It ensures future writes will error and it does the needed
545 * line discipline hangup and signal delivery. The tty object itself
546 * remains intact.
547 *
548 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200549 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800550 * redirect lock for undoing redirection
551 * file list lock for manipulating list of ttys
552 * tty_ldisc_lock from called functions
553 * termios_mutex resetting termios data
554 * tasklist_lock to walk task list for hangup event
555 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 */
Josh Triplett2520e272012-11-18 21:27:47 -0800557static void __tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Alan Cox37bdfb02008-02-08 04:18:47 -0800559 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 struct file *filp, *f = NULL;
561 struct task_struct *p;
Nick Piggind996b622010-08-18 04:37:36 +1000562 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700564 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100565 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
567 if (!tty)
568 return;
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
571 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000572 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 f = redirect;
574 redirect = NULL;
575 }
576 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800577
Alan Cox89c8d912012-08-08 16:30:13 +0100578 tty_lock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200579
Jiri Slabyacfa7472010-11-29 10:16:54 +0100580 /* some functions below drop BTM, so we need this bit */
581 set_bit(TTY_HUPPING, &tty->flags);
582
Arnd Bergmannec79d602010-06-01 22:53:01 +0200583 /* inuse_filps is protected by the single tty lock,
584 this really needs to change if we want to flush the
585 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200586 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000587
Nick Pigginee2ffa02010-08-18 04:37:35 +1000588 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000590 list_for_each_entry(priv, &tty->tty_files, list) {
591 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (filp->f_op->write == redirected_tty_write)
593 cons_filp = filp;
594 if (filp->f_op->write != tty_write)
595 continue;
596 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200597 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 filp->f_op = &hung_up_tty_fops;
599 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000600 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800601
Jiri Slabyacfa7472010-11-29 10:16:54 +0100602 /*
603 * it drops BTM and thus races with reopen
604 * we protect the race by TTY_HUPPING
605 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100606 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800607
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800609 if (tty->session) {
610 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800611 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100612 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100614 /* We defer the dereferences outside fo
615 the tasklist lock */
616 refs++;
617 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800618 if (!p->signal->leader) {
619 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800621 }
622 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
623 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800624 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700625 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800626 if (tty->pgrp)
627 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700628 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800629 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800630 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 }
632 read_unlock(&tasklist_lock);
633
Alan Cox47f86832008-04-30 00:53:30 -0700634 spin_lock_irqsave(&tty->ctrl_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100635 clear_bit(TTY_THROTTLED, &tty->flags);
636 clear_bit(TTY_PUSH, &tty->flags);
637 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600638 put_pid(tty->session);
639 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800640 tty->session = NULL;
641 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700643 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
644
Alan Cox9c9f4de2008-10-13 10:37:26 +0100645 /* Account for the p->signal references we killed */
646 while (refs--)
647 tty_kref_put(tty);
648
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800650 * If one of the devices matches a console pointer, we
651 * cannot just call hangup() because that will cause
652 * tty->count and state->count to go out of sync.
653 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 */
655 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700656 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700658 tty->ops->close(tty, cons_filp);
659 } else if (tty->ops->hangup)
660 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800661 /*
662 * We don't want to have driver/ldisc interactions beyond
663 * the ones we did here. The driver layer expects no
664 * calls after ->hangup() from the ldisc side. However we
665 * can't yet guarantee all that.
666 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 set_bit(TTY_HUPPED, &tty->flags);
Jiri Slabyacfa7472010-11-29 10:16:54 +0100668 clear_bit(TTY_HUPPING, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100669 tty_ldisc_enable(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200670
Alan Cox89c8d912012-08-08 16:30:13 +0100671 tty_unlock(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200672
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 if (f)
674 fput(f);
675}
676
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200677static void do_tty_hangup(struct work_struct *work)
678{
679 struct tty_struct *tty =
680 container_of(work, struct tty_struct, hangup_work);
681
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200682 __tty_hangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200683}
684
Alan Coxaf9b8972006-08-27 01:24:01 -0700685/**
686 * tty_hangup - trigger a hangup event
687 * @tty: tty to hangup
688 *
689 * A carrier loss (virtual or otherwise) has occurred on this like
690 * schedule a hangup sequence to run after this event.
691 */
692
Alan Cox37bdfb02008-02-08 04:18:47 -0800693void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694{
695#ifdef TTY_DEBUG_HANGUP
696 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
698#endif
699 schedule_work(&tty->hangup_work);
700}
701
702EXPORT_SYMBOL(tty_hangup);
703
Alan Coxaf9b8972006-08-27 01:24:01 -0700704/**
705 * tty_vhangup - process vhangup
706 * @tty: tty to hangup
707 *
708 * The user has asked via system call for the terminal to be hung up.
709 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200710 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700711 */
712
Alan Cox37bdfb02008-02-08 04:18:47 -0800713void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
715#ifdef TTY_DEBUG_HANGUP
716 char buf[64];
717
718 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
719#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200720 __tty_hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721}
Alan Cox37bdfb02008-02-08 04:18:47 -0800722
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723EXPORT_SYMBOL(tty_vhangup);
724
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200725
Alan Coxaf9b8972006-08-27 01:24:01 -0700726/**
Alan Cox2cb59982008-10-13 10:40:30 +0100727 * tty_vhangup_self - process vhangup for own ctty
728 *
729 * Perform a vhangup on the current controlling tty
730 */
731
732void tty_vhangup_self(void)
733{
734 struct tty_struct *tty;
735
Alan Cox2cb59982008-10-13 10:40:30 +0100736 tty = get_current_tty();
737 if (tty) {
738 tty_vhangup(tty);
739 tty_kref_put(tty);
740 }
Alan Cox2cb59982008-10-13 10:40:30 +0100741}
742
743/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700744 * tty_hung_up_p - was tty hung up
745 * @filp: file pointer of tty
746 *
747 * Return true if the tty has been subject to a vhangup or a carrier
748 * loss
749 */
750
Alan Cox37bdfb02008-02-08 04:18:47 -0800751int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752{
753 return (filp->f_op == &hung_up_tty_fops);
754}
755
756EXPORT_SYMBOL(tty_hung_up_p);
757
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800758static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800759{
760 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800761 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800762 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800763 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800764}
765
Alan Coxaf9b8972006-08-27 01:24:01 -0700766/**
767 * disassociate_ctty - disconnect controlling tty
768 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700770 * This function is typically called only by the session leader, when
771 * it wants to disassociate itself from its controlling tty.
772 *
773 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
775 * (2) Clears the tty from being controlling the session
776 * (3) Clears the controlling tty for all processes in the
777 * session group.
778 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700779 * The argument on_exit is set to 1 if called when a process is
780 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
781 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800782 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200783 * BTM is taken for hysterical raisins, and held when
784 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800785 * tty_mutex is taken to protect tty
786 * ->siglock is taken to protect ->signal/->sighand
787 * tasklist_lock is taken to walk process list for sessions
788 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791void disassociate_ctty(int on_exit)
792{
793 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Alan Cox5ec93d12009-11-30 13:18:45 +0000795 if (!current->signal->leader)
796 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800798 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 if (tty) {
Jiri Slaby1411dc42011-11-09 21:33:18 +0100800 struct pid *tty_pgrp = get_pid(tty->pgrp);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200801 if (on_exit) {
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200802 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200803 tty_vhangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200804 }
Alan Cox452a00d2008-10-13 10:39:13 +0100805 tty_kref_put(tty);
Jiri Slaby1411dc42011-11-09 21:33:18 +0100806 if (tty_pgrp) {
807 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
808 if (!on_exit)
809 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
810 put_pid(tty_pgrp);
811 }
Eric W. Biederman680a9672007-02-12 00:52:52 -0800812 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800813 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800814 spin_lock_irq(&current->sighand->siglock);
815 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800816 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800817 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800818 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800819 kill_pgrp(old_pgrp, SIGHUP, on_exit);
820 kill_pgrp(old_pgrp, SIGCONT, on_exit);
821 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return;
824 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800826 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700827 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800828 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800829 spin_unlock_irq(&current->sighand->siglock);
830
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800831 tty = get_current_tty();
832 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700833 unsigned long flags;
834 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800835 put_pid(tty->session);
836 put_pid(tty->pgrp);
837 tty->session = NULL;
838 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700839 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100840 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800841 } else {
842#ifdef TTY_DEBUG_HANGUP
843 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
844 " = NULL", tty);
845#endif
846 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
848 /* Now clear signal->tty under the lock */
849 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800850 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852}
853
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700854/**
855 *
856 * no_tty - Ensure the current process does not have a controlling tty
857 */
858void no_tty(void)
859{
Alan Cox3af502b2012-05-03 22:21:53 +0100860 /* FIXME: Review locking here. The tty_lock never covered any race
861 between a new association and proc_clear_tty but possible we need
862 to protect against this anyway */
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700863 struct task_struct *tsk = current;
Alan Cox5ec93d12009-11-30 13:18:45 +0000864 disassociate_ctty(0);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700865 proc_clear_tty(tsk);
866}
867
Alan Coxaf9b8972006-08-27 01:24:01 -0700868
869/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200870 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700871 * @tty: tty to stop
872 *
873 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200874 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700875 * on an already stopped device and will not re-call the driver
876 * method.
877 *
878 * This functionality is used by both the line disciplines for
879 * halting incoming flow and by the driver. It may therefore be
880 * called from any context, may be under the tty atomic_write_lock
881 * but not always.
882 *
883 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700884 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700885 */
886
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887void stop_tty(struct tty_struct *tty)
888{
Alan Cox04f378b2008-04-30 00:53:29 -0700889 unsigned long flags;
890 spin_lock_irqsave(&tty->ctrl_lock, flags);
891 if (tty->stopped) {
892 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700894 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 tty->stopped = 1;
896 if (tty->link && tty->link->packet) {
897 tty->ctrl_status &= ~TIOCPKT_START;
898 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700899 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 }
Alan Cox04f378b2008-04-30 00:53:29 -0700901 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700902 if (tty->ops->stop)
903 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904}
905
906EXPORT_SYMBOL(stop_tty);
907
Alan Coxaf9b8972006-08-27 01:24:01 -0700908/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200909 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700910 * @tty: tty to start
911 *
912 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200913 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700914 * is the tty was previous stopped and is being started then the
915 * driver start method is invoked and the line discipline woken.
916 *
917 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700918 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700919 */
920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921void start_tty(struct tty_struct *tty)
922{
Alan Cox04f378b2008-04-30 00:53:29 -0700923 unsigned long flags;
924 spin_lock_irqsave(&tty->ctrl_lock, flags);
925 if (!tty->stopped || tty->flow_stopped) {
926 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 tty->stopped = 0;
930 if (tty->link && tty->link->packet) {
931 tty->ctrl_status &= ~TIOCPKT_STOP;
932 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700933 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 }
Alan Cox04f378b2008-04-30 00:53:29 -0700935 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700936 if (tty->ops->start)
937 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 /* If we have a running line discipline it may need kicking */
939 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940}
941
942EXPORT_SYMBOL(start_tty);
943
Alan Coxaf9b8972006-08-27 01:24:01 -0700944/**
945 * tty_read - read method for tty device files
946 * @file: pointer to tty file
947 * @buf: user buffer
948 * @count: size of user buffer
949 * @ppos: unused
950 *
951 * Perform the read system call function on this terminal device. Checks
952 * for hung up devices before calling the line discipline method.
953 *
954 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700955 * Locks the line discipline internally while needed. Multiple
956 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700957 */
958
Alan Cox37bdfb02008-02-08 04:18:47 -0800959static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 loff_t *ppos)
961{
962 int i;
Nick Piggind996b622010-08-18 04:37:36 +1000963 struct inode *inode = file->f_path.dentry->d_inode;
964 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 struct tty_ldisc *ld;
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 if (tty_paranoia_check(tty, inode, "tty_read"))
968 return -EIO;
969 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
970 return -EIO;
971
972 /* We want to wait for the line discipline to sort out in this
973 situation */
974 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100975 if (ld->ops->read)
976 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 else
978 i = -EIO;
979 tty_ldisc_deref(ld);
Jiri Slabyb0de59b2013-02-15 15:25:05 +0100980
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 return i;
982}
983
Alan Cox9c1729d2007-07-15 23:39:43 -0700984void tty_write_unlock(struct tty_struct *tty)
Jiri Slaby83c67572011-04-20 10:43:18 +0200985 __releases(&tty->atomic_write_lock)
Alan Cox9c1729d2007-07-15 23:39:43 -0700986{
987 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700988 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -0700989}
990
991int tty_write_lock(struct tty_struct *tty, int ndelay)
Jiri Slaby83c67572011-04-20 10:43:18 +0200992 __acquires(&tty->atomic_write_lock)
Alan Cox9c1729d2007-07-15 23:39:43 -0700993{
994 if (!mutex_trylock(&tty->atomic_write_lock)) {
995 if (ndelay)
996 return -EAGAIN;
997 if (mutex_lock_interruptible(&tty->atomic_write_lock))
998 return -ERESTARTSYS;
999 }
1000 return 0;
1001}
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003/*
1004 * Split writes up in sane blocksizes to avoid
1005 * denial-of-service type attacks
1006 */
1007static inline ssize_t do_tty_write(
1008 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
1009 struct tty_struct *tty,
1010 struct file *file,
1011 const char __user *buf,
1012 size_t count)
1013{
Alan Cox9c1729d2007-07-15 23:39:43 -07001014 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -08001016
Alan Cox9c1729d2007-07-15 23:39:43 -07001017 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
1018 if (ret < 0)
1019 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
1021 /*
1022 * We chunk up writes into a temporary buffer. This
1023 * simplifies low-level drivers immensely, since they
1024 * don't have locking issues and user mode accesses.
1025 *
1026 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1027 * big chunk-size..
1028 *
1029 * The default chunk-size is 2kB, because the NTTY
1030 * layer has problems with bigger chunks. It will
1031 * claim to be able to handle more characters than
1032 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001033 *
1034 * FIXME: This can probably go away now except that 64K chunks
1035 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 */
1037 chunk = 2048;
1038 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1039 chunk = 65536;
1040 if (count < chunk)
1041 chunk = count;
1042
Ingo Molnar70522e12006-03-23 03:00:31 -08001043 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001045 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046
1047 if (chunk < 1024)
1048 chunk = 1024;
1049
Jason Wessel402fda92008-10-13 10:45:36 +01001050 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1051 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001052 ret = -ENOMEM;
1053 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 }
1055 kfree(tty->write_buf);
1056 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001057 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 }
1059
1060 /* Do the write .. */
1061 for (;;) {
1062 size_t size = count;
1063 if (size > chunk)
1064 size = chunk;
1065 ret = -EFAULT;
1066 if (copy_from_user(tty->write_buf, buf, size))
1067 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 if (ret <= 0)
1070 break;
1071 written += ret;
1072 buf += ret;
1073 count -= ret;
1074 if (!count)
1075 break;
1076 ret = -ERESTARTSYS;
1077 if (signal_pending(current))
1078 break;
1079 cond_resched();
1080 }
Jiri Slabyb0de59b2013-02-15 15:25:05 +01001081 if (written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 ret = written;
Alan Cox9c1729d2007-07-15 23:39:43 -07001083out:
1084 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 return ret;
1086}
1087
Alan Cox95f9bfc2008-10-13 10:39:23 +01001088/**
1089 * tty_write_message - write a message to a certain tty, not just the console.
1090 * @tty: the destination tty_struct
1091 * @msg: the message to write
1092 *
1093 * This is used for messages that need to be redirected to a specific tty.
1094 * We don't put it into the syslog queue right now maybe in the future if
1095 * really needed.
1096 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001097 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001098 */
1099
1100void tty_write_message(struct tty_struct *tty, char *msg)
1101{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001102 if (tty) {
1103 mutex_lock(&tty->atomic_write_lock);
Alan Cox89c8d912012-08-08 16:30:13 +01001104 tty_lock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001105 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001106 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001107 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001108 } else
Alan Cox89c8d912012-08-08 16:30:13 +01001109 tty_unlock(tty);
Alan Cox95f9bfc2008-10-13 10:39:23 +01001110 tty_write_unlock(tty);
1111 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001112 return;
1113}
1114
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115
Alan Coxaf9b8972006-08-27 01:24:01 -07001116/**
1117 * tty_write - write method for tty device file
1118 * @file: tty file pointer
1119 * @buf: user data to write
1120 * @count: bytes to write
1121 * @ppos: unused
1122 *
1123 * Write data to a tty device via the line discipline.
1124 *
1125 * Locking:
1126 * Locks the line discipline as required
1127 * Writes to the tty driver are serialized by the atomic_write_lock
1128 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001129 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001130 */
1131
Alan Cox37bdfb02008-02-08 04:18:47 -08001132static ssize_t tty_write(struct file *file, const char __user *buf,
1133 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134{
Josef Sipeka7113a92006-12-08 02:36:55 -08001135 struct inode *inode = file->f_path.dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10001136 struct tty_struct *tty = file_tty(file);
1137 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 if (tty_paranoia_check(tty, inode, "tty_write"))
1141 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001142 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001143 (test_bit(TTY_IO_ERROR, &tty->flags)))
1144 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001145 /* Short term debug to catch buggy drivers */
1146 if (tty->ops->write_room == NULL)
1147 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1148 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001149 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001150 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 ret = -EIO;
1152 else
Alan Coxa352def2008-07-16 21:53:12 +01001153 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 tty_ldisc_deref(ld);
1155 return ret;
1156}
1157
Alan Cox37bdfb02008-02-08 04:18:47 -08001158ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1159 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160{
1161 struct file *p = NULL;
1162
1163 spin_lock(&redirect_lock);
Al Virocb0942b2012-08-27 14:48:26 -04001164 if (redirect)
1165 p = get_file(redirect);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 spin_unlock(&redirect_lock);
1167
1168 if (p) {
1169 ssize_t res;
1170 res = vfs_write(p, buf, count, &p->f_pos);
1171 fput(p);
1172 return res;
1173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 return tty_write(file, buf, count, ppos);
1175}
1176
1177static char ptychar[] = "pqrstuvwxyzabcde";
1178
Alan Coxaf9b8972006-08-27 01:24:01 -07001179/**
1180 * pty_line_name - generate name for a pty
1181 * @driver: the tty driver in use
1182 * @index: the minor number
1183 * @p: output buffer of at least 6 bytes
1184 *
1185 * Generate a name from a driver reference and write it to the output
1186 * buffer.
1187 *
1188 * Locking: None
1189 */
1190static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
1192 int i = index + driver->name_base;
1193 /* ->name is initialized to "ttyp", but "tty" is expected */
1194 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001195 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1196 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197}
1198
Alan Coxaf9b8972006-08-27 01:24:01 -07001199/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001200 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001201 * @driver: the tty driver in use
1202 * @index: the minor number
1203 * @p: output buffer of at least 7 bytes
1204 *
1205 * Generate a name from a driver reference and write it to the output
1206 * buffer.
1207 *
1208 * Locking: None
1209 */
1210static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211{
Jiri Slaby0019b402012-08-08 22:26:43 +02001212 if (driver->flags & TTY_DRIVER_UNNUMBERED_NODE)
1213 strcpy(p, driver->name);
1214 else
1215 sprintf(p, "%s%d", driver->name, index + driver->name_base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216}
1217
Alan Cox99f1fe12008-10-13 10:42:00 +01001218/**
1219 * tty_driver_lookup_tty() - find an existing tty, if any
1220 * @driver: the driver for the tty
1221 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001222 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001223 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001224 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001225 * Locking: tty_mutex must be held. If tty is found, the mutex must
1226 * be held until the 'fast-open' is also done. Will change once we
1227 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001228 */
Jason Wessela47d5452009-01-02 13:43:04 +00001229static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001230 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001231{
Alan Cox99f1fe12008-10-13 10:42:00 +01001232 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001233 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001234
Jiri Slabyd4834262012-03-05 14:51:53 +01001235 return driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001236}
1237
Alan Cox99f1fe12008-10-13 10:42:00 +01001238/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001239 * tty_init_termios - helper for termios setup
1240 * @tty: the tty to set up
1241 *
1242 * Initialise the termios structures for this tty. Thus runs under
1243 * the tty_mutex currently so we can be relaxed about ordering.
1244 */
1245
1246int tty_init_termios(struct tty_struct *tty)
1247{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001248 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001249 int idx = tty->index;
1250
Alan Cox36b3c072012-07-17 17:06:57 +01001251 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1252 tty->termios = tty->driver->init_termios;
1253 else {
1254 /* Check for lazy saved data */
1255 tp = tty->driver->termios[idx];
1256 if (tp != NULL)
1257 tty->termios = *tp;
1258 else
1259 tty->termios = tty->driver->init_termios;
Alan Coxbf970ee2008-10-13 10:42:39 +01001260 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001261 /* Compatibility until drivers always set this */
Alan Coxadc8d742012-07-14 15:31:47 +01001262 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
1263 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001264 return 0;
1265}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001266EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001267
Jiri Slaby66d450e2012-01-30 21:14:28 +01001268int tty_standard_install(struct tty_driver *driver, struct tty_struct *tty)
1269{
1270 int ret = tty_init_termios(tty);
1271 if (ret)
1272 return ret;
1273
1274 tty_driver_kref_get(driver);
1275 tty->count++;
1276 driver->ttys[tty->index] = tty;
1277 return 0;
1278}
1279EXPORT_SYMBOL_GPL(tty_standard_install);
1280
Alan Coxbf970ee2008-10-13 10:42:39 +01001281/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001282 * tty_driver_install_tty() - install a tty entry in the driver
1283 * @driver: the driver for the tty
1284 * @tty: the tty
1285 *
1286 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001287 * will be set by the time this is called. This method is responsible
1288 * for ensuring any need additional structures are allocated and
1289 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001290 *
1291 * Locking: tty_mutex for now
1292 */
1293static int tty_driver_install_tty(struct tty_driver *driver,
1294 struct tty_struct *tty)
1295{
Jiri Slaby66d450e2012-01-30 21:14:28 +01001296 return driver->ops->install ? driver->ops->install(driver, tty) :
1297 tty_standard_install(driver, tty);
Alan Cox8b0a88d2008-10-13 10:42:19 +01001298}
1299
1300/**
1301 * tty_driver_remove_tty() - remove a tty from the driver tables
1302 * @driver: the driver for the tty
1303 * @idx: the minor number
1304 *
1305 * Remvoe a tty object from the driver tables. The tty->index field
1306 * will be set by the time this is called.
1307 *
1308 * Locking: tty_mutex for now
1309 */
Jiri Slaby24d406a2011-08-10 14:59:28 +02001310void tty_driver_remove_tty(struct tty_driver *driver, struct tty_struct *tty)
Alan Cox8b0a88d2008-10-13 10:42:19 +01001311{
1312 if (driver->ops->remove)
1313 driver->ops->remove(driver, tty);
1314 else
1315 driver->ttys[tty->index] = NULL;
1316}
1317
1318/*
1319 * tty_reopen() - fast re-open of an open tty
1320 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001321 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001322 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001323 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001324 * Locking: tty_mutex must be held from the time the tty was found
1325 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001326 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001327static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001328{
1329 struct tty_driver *driver = tty->driver;
1330
Jiri Slabye2efafb2010-11-29 10:16:53 +01001331 if (test_bit(TTY_CLOSING, &tty->flags) ||
Jiri Slabyacfa7472010-11-29 10:16:54 +01001332 test_bit(TTY_HUPPING, &tty->flags) ||
Jiri Slabye2efafb2010-11-29 10:16:53 +01001333 test_bit(TTY_LDISC_CHANGING, &tty->flags))
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001334 return -EIO;
1335
1336 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1337 driver->subtype == PTY_TYPE_MASTER) {
1338 /*
1339 * special case for PTY masters: only one open permitted,
1340 * and the slave side open count is incremented as well.
1341 */
1342 if (tty->count)
1343 return -EIO;
1344
1345 tty->link->count++;
1346 }
1347 tty->count++;
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001348
Alan Cox1aa4bed2009-06-16 17:01:33 +01001349 mutex_lock(&tty->ldisc_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +01001350 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Alan Cox1aa4bed2009-06-16 17:01:33 +01001351 mutex_unlock(&tty->ldisc_mutex);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001352
1353 return 0;
1354}
1355
Alan Coxaf9b8972006-08-27 01:24:01 -07001356/**
Alan Coxd81ed102008-10-13 10:41:42 +01001357 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001358 * @driver: tty driver we are opening a device on
1359 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001360 * @ret_tty: returned tty structure
Alan Coxaf9b8972006-08-27 01:24:01 -07001361 *
1362 * Prepare a tty device. This may not be a "new" clean device but
1363 * could also be an active device. The pty drivers require special
1364 * handling because of this.
1365 *
1366 * Locking:
1367 * The function is called under the tty_mutex, which
1368 * protects us from the tty struct or driver itself going away.
1369 *
1370 * On exit the tty device has the line discipline attached and
1371 * a reference count of 1. If a pair was created for pty/tty use
1372 * and the other was a pty master then it too has a reference count of 1.
1373 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001375 * failed open. The new code protects the open with a mutex, so it's
1376 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 * relaxed for the (most common) case of reopening a tty.
1378 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001379
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001380struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381{
Alan Coxbf970ee2008-10-13 10:42:39 +01001382 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001383 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 /*
1386 * First time open is complex, especially for PTY devices.
1387 * This code guarantees that either everything succeeds and the
1388 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001389 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390 * and locked termios may be retained.)
1391 */
1392
Alan Cox73ec06f2008-10-13 10:42:29 +01001393 if (!try_module_get(driver->owner))
1394 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 tty = alloc_tty_struct();
Jiri Slabyd5543502011-03-23 10:48:32 +01001397 if (!tty) {
1398 retval = -ENOMEM;
1399 goto err_module_put;
1400 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001401 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Alan Cox89c8d912012-08-08 16:30:13 +01001403 tty_lock(tty);
Alan Cox73ec06f2008-10-13 10:42:29 +01001404 retval = tty_driver_install_tty(driver, tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001405 if (retval < 0)
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001406 goto err_deinit_tty;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001407
Jiri Slaby04831dc2012-06-04 13:35:36 +02001408 if (!tty->port)
1409 tty->port = driver->ports[idx];
1410
Jiri Slaby5d4121c2012-08-17 14:27:52 +02001411 WARN_RATELIMIT(!tty->port,
1412 "%s: %s driver does not set tty->port. This will crash the kernel later. Fix the driver!\n",
1413 __func__, tty->driver->name);
1414
Jiri Slaby967fab62012-10-18 22:26:46 +02001415 tty->port->itty = tty;
1416
Alan Cox37bdfb02008-02-08 04:18:47 -08001417 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001419 * If we fail here just call release_tty to clean up. No need
1420 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001422 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001423 if (retval)
Jiri Slabyd5543502011-03-23 10:48:32 +01001424 goto err_release_tty;
Alan Cox89c8d912012-08-08 16:30:13 +01001425 /* Return the tty locked so that it cannot vanish under the caller */
Alan Cox73ec06f2008-10-13 10:42:29 +01001426 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001428err_deinit_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001429 tty_unlock(tty);
Jiri Slabya9dccdd2011-03-23 10:48:36 +01001430 deinitialize_tty_struct(tty);
Jiri Slabyd5543502011-03-23 10:48:32 +01001431 free_tty_struct(tty);
1432err_module_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433 module_put(driver->owner);
Jiri Slabyd5543502011-03-23 10:48:32 +01001434 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001436 /* call the tty release_tty routine to clean out this slot */
Jiri Slabyd5543502011-03-23 10:48:32 +01001437err_release_tty:
Alan Cox89c8d912012-08-08 16:30:13 +01001438 tty_unlock(tty);
Manuel Zerpies5a3c6b22011-06-16 14:07:22 +02001439 printk_ratelimited(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001440 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001441 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001442 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443}
1444
Alan Coxfeebed62008-10-13 10:41:30 +01001445void tty_free_termios(struct tty_struct *tty)
1446{
1447 struct ktermios *tp;
1448 int idx = tty->index;
Alan Cox36b3c072012-07-17 17:06:57 +01001449
1450 /* If the port is going to reset then it has no termios to save */
1451 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
1452 return;
1453
1454 /* Stash the termios data */
1455 tp = tty->driver->termios[idx];
1456 if (tp == NULL) {
1457 tp = kmalloc(sizeof(struct ktermios), GFP_KERNEL);
1458 if (tp == NULL) {
1459 pr_warn("tty: no memory to save termios state.\n");
1460 return;
1461 }
Dan Carpenter4ac5d702012-07-24 12:51:52 +01001462 tty->driver->termios[idx] = tp;
Alan Coxfeebed62008-10-13 10:41:30 +01001463 }
Alan Cox36b3c072012-07-17 17:06:57 +01001464 *tp = tty->termios;
Alan Coxfeebed62008-10-13 10:41:30 +01001465}
1466EXPORT_SYMBOL(tty_free_termios);
1467
Alan Coxfeebed62008-10-13 10:41:30 +01001468
Alan Coxaf9b8972006-08-27 01:24:01 -07001469/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001470 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001471 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001472 *
1473 * Releases memory associated with a tty structure, and clears out the
1474 * driver table slots. This function is called when a device is no longer
1475 * in use. It also gets called when setup of a device fails.
1476 *
1477 * Locking:
Alan Coxaf9b8972006-08-27 01:24:01 -07001478 * takes the file list lock internally when working on the list
1479 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001480 *
1481 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001482 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 */
Alan Coxb50989d2009-09-19 13:13:22 -07001484static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485{
Alan Coxb50989d2009-09-19 13:13:22 -07001486 struct tty_struct *tty =
1487 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001488 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
Dave Youngf278a2f2009-09-27 16:00:42 +00001490 if (tty->ops->cleanup)
1491 tty->ops->cleanup(tty);
1492
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001494 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001495 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001496
Nick Pigginee2ffa02010-08-18 04:37:35 +10001497 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001499 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001500
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001501 put_pid(tty->pgrp);
1502 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 free_tty_struct(tty);
1504}
1505
Alan Coxb50989d2009-09-19 13:13:22 -07001506static void queue_release_one_tty(struct kref *kref)
1507{
1508 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001509
Alan Coxb50989d2009-09-19 13:13:22 -07001510 /* The hangup queue is now free so we can reuse it rather than
1511 waste a chunk of memory for each port */
1512 INIT_WORK(&tty->hangup_work, release_one_tty);
1513 schedule_work(&tty->hangup_work);
1514}
1515
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001516/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001517 * tty_kref_put - release a tty kref
1518 * @tty: tty device
1519 *
1520 * Release a reference to a tty device and if need be let the kref
1521 * layer destruct the object for us
1522 */
1523
1524void tty_kref_put(struct tty_struct *tty)
1525{
1526 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001527 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001528}
1529EXPORT_SYMBOL(tty_kref_put);
1530
1531/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001532 * release_tty - release tty structure memory
1533 *
1534 * Release both @tty and a possible linked partner (think pty pair),
1535 * and decrement the refcount of the backing module.
1536 *
1537 * Locking:
Alan Coxd1552552012-07-27 18:02:54 +01001538 * tty_mutex
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001539 * takes the file list lock internally when working on the list
1540 * of ttys that the driver keeps.
Alan Cox9c9f4de2008-10-13 10:37:26 +01001541 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001542 */
1543static void release_tty(struct tty_struct *tty, int idx)
1544{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001545 /* This should always be true but check for the moment */
1546 WARN_ON(tty->index != idx);
Alan Coxd1552552012-07-27 18:02:54 +01001547 WARN_ON(!mutex_is_locked(&tty_mutex));
Alan Cox36b3c072012-07-17 17:06:57 +01001548 if (tty->ops->shutdown)
1549 tty->ops->shutdown(tty);
1550 tty_free_termios(tty);
1551 tty_driver_remove_tty(tty->driver, tty);
Jiri Slaby967fab62012-10-18 22:26:46 +02001552 tty->port->itty = NULL;
Alan Cox36b3c072012-07-17 17:06:57 +01001553
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001554 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001555 tty_kref_put(tty->link);
1556 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001557}
1558
Alan Coxeeb89d92009-11-30 13:18:29 +00001559/**
Jiri Slaby955787ca2011-11-11 10:47:23 +01001560 * tty_release_checks - check a tty before real release
1561 * @tty: tty to check
1562 * @o_tty: link of @tty (if any)
1563 * @idx: index of the tty
1564 *
1565 * Performs some paranoid checking before true release of the @tty.
1566 * This is a no-op unless TTY_PARANOIA_CHECK is defined.
1567 */
1568static int tty_release_checks(struct tty_struct *tty, struct tty_struct *o_tty,
1569 int idx)
1570{
1571#ifdef TTY_PARANOIA_CHECK
1572 if (idx < 0 || idx >= tty->driver->num) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001573 printk(KERN_DEBUG "%s: bad idx when trying to free (%s)\n",
1574 __func__, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001575 return -1;
1576 }
1577
1578 /* not much to check for devpts */
1579 if (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)
1580 return 0;
1581
1582 if (tty != tty->driver->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001583 printk(KERN_DEBUG "%s: driver.table[%d] not tty for (%s)\n",
1584 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001585 return -1;
1586 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001587 if (tty->driver->other) {
1588 if (o_tty != tty->driver->other->ttys[idx]) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001589 printk(KERN_DEBUG "%s: other->table[%d] not o_tty for (%s)\n",
1590 __func__, idx, tty->name);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001591 return -1;
1592 }
Jiri Slaby955787ca2011-11-11 10:47:23 +01001593 if (o_tty->link != tty) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001594 printk(KERN_DEBUG "%s: bad pty pointers\n", __func__);
Jiri Slaby955787ca2011-11-11 10:47:23 +01001595 return -1;
1596 }
1597 }
1598#endif
1599 return 0;
1600}
1601
1602/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001603 * tty_release - vfs callback for close
1604 * @inode: inode of tty
1605 * @filp: file pointer for handle to tty
1606 *
1607 * Called the last time each file handle is closed that references
1608 * this tty. There may however be several such references.
1609 *
1610 * Locking:
1611 * Takes bkl. See tty_release_dev
1612 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 * Even releasing the tty structures is a tricky business.. We have
1614 * to be very careful that the structures are all released at the
1615 * same time, as interrupts might otherwise get the wrong pointers.
1616 *
1617 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1618 * lead to double frees or releasing memory still in use.
1619 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001620
1621int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
Nick Piggind996b622010-08-18 04:37:36 +10001623 struct tty_struct *tty = file_tty(filp);
1624 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 int pty_master, tty_closing, o_tty_closing, do_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 int idx;
1627 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001628
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001629 if (tty_paranoia_check(tty, inode, __func__))
Alan Coxeeb89d92009-11-30 13:18:29 +00001630 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Alan Cox89c8d912012-08-08 16:30:13 +01001632 tty_lock(tty);
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001633 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
Arnd Bergmannec79d602010-06-01 22:53:01 +02001635 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
1637 idx = tty->index;
1638 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1639 tty->driver->subtype == PTY_TYPE_MASTER);
Alan Cox89c8d912012-08-08 16:30:13 +01001640 /* Review: parallel close */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 o_tty = tty->link;
1642
Jiri Slaby955787ca2011-11-11 10:47:23 +01001643 if (tty_release_checks(tty, o_tty, idx)) {
Alan Cox89c8d912012-08-08 16:30:13 +01001644 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001645 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
1648#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001649 printk(KERN_DEBUG "%s: %s (tty count=%d)...\n", __func__,
1650 tty_name(tty, buf), tty->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651#endif
1652
Alan Coxf34d7a52008-04-30 00:54:13 -07001653 if (tty->ops->close)
1654 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
Alan Cox89c8d912012-08-08 16:30:13 +01001656 tty_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 /*
1658 * Sanity check: if tty->count is going to zero, there shouldn't be
1659 * any waiters on tty->read_wait or tty->write_wait. We test the
1660 * wait queues and kick everyone out _before_ actually starting to
1661 * close. This ensures that we won't block while releasing the tty
1662 * structure.
1663 *
1664 * The test for the o_tty closing is necessary, since the master and
1665 * slave sides may close in any order. If the slave side closes out
1666 * first, its count will be one, since the master side holds an open.
1667 * Thus this test wouldn't be triggered at the time the slave closes,
1668 * so we do it now.
1669 *
1670 * Note that it's possible for the tty to be opened again while we're
1671 * flushing out waiters. By recalculating the closing flags before
1672 * each iteration we avoid any problems.
1673 */
1674 while (1) {
1675 /* Guard against races with tty->count changes elsewhere and
1676 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001677
Ingo Molnar70522e12006-03-23 03:00:31 -08001678 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001679 tty_lock_pair(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 tty_closing = tty->count <= 1;
1681 o_tty_closing = o_tty &&
1682 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 do_sleep = 0;
1684
1685 if (tty_closing) {
1686 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001687 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 do_sleep++;
1689 }
1690 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001691 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 do_sleep++;
1693 }
1694 }
1695 if (o_tty_closing) {
1696 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001697 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 do_sleep++;
1699 }
1700 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001701 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 do_sleep++;
1703 }
1704 }
1705 if (!do_sleep)
1706 break;
1707
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001708 printk(KERN_WARNING "%s: %s: read/write wait queue active!\n",
1709 __func__, tty_name(tty, buf));
Alan Cox89c8d912012-08-08 16:30:13 +01001710 tty_unlock_pair(tty, o_tty);
Ingo Molnar70522e12006-03-23 03:00:31 -08001711 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001713 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
1715 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001716 * The closing flags are now consistent with the open counts on
1717 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 * block, so it's safe to proceed with closing.
Alan Coxd1552552012-07-27 18:02:54 +01001719 *
1720 * We must *not* drop the tty_mutex until we ensure that a further
1721 * entry into tty_open can not pick up this tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 if (pty_master) {
1724 if (--o_tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001725 printk(KERN_WARNING "%s: bad pty slave count (%d) for %s\n",
1726 __func__, o_tty->count, tty_name(o_tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 o_tty->count = 0;
1728 }
1729 }
1730 if (--tty->count < 0) {
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001731 printk(KERN_WARNING "%s: bad tty->count (%d) for %s\n",
1732 __func__, tty->count, tty_name(tty, buf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 tty->count = 0;
1734 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 /*
1737 * We've decremented tty->count, so we need to remove this file
1738 * descriptor off the tty->tty_files list; this serves two
1739 * purposes:
1740 * - check_tty_count sees the correct number of file descriptors
1741 * associated with this tty.
1742 * - do_tty_hangup no longer sees this file descriptor as
1743 * something that needs to be handled for hangups.
1744 */
Nick Piggind996b622010-08-18 04:37:36 +10001745 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
1747 /*
1748 * Perform some housekeeping before deciding whether to return.
1749 *
1750 * Set the TTY_CLOSING flag if this was the last open. In the
1751 * case of a pty we may have to wait around for the other side
1752 * to close, and TTY_CLOSING makes sure we can't be reopened.
1753 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001754 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001756 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 set_bit(TTY_CLOSING, &o_tty->flags);
1758
1759 /*
1760 * If _either_ side is closing, make sure there aren't any
1761 * processes that still think tty or o_tty is their controlling
1762 * tty.
1763 */
1764 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001766 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001768 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 read_unlock(&tasklist_lock);
1770 }
1771
Ingo Molnar70522e12006-03-23 03:00:31 -08001772 mutex_unlock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001773 tty_unlock_pair(tty, o_tty);
Alan Coxd1552552012-07-27 18:02:54 +01001774 /* At this point the TTY_CLOSING flag should ensure a dead tty
1775 cannot be re-opened by a racing opener */
Paul Fulghumda965822006-02-14 13:53:00 -08001776
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 /* check whether both sides are closing ... */
Alan Coxd1552552012-07-27 18:02:54 +01001778 if (!tty_closing || (o_tty && !o_tty_closing))
Alan Coxeeb89d92009-11-30 13:18:29 +00001779 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001780
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001782 printk(KERN_DEBUG "%s: freeing tty structure...\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783#endif
1784 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001785 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001787 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001789 * The release_tty function takes care of the details of clearing
Alan Cox89c8d912012-08-08 16:30:13 +01001790 * the slots and preserving the termios structure. The tty_unlock_pair
1791 * should be safe as we keep a kref while the tty is locked (so the
1792 * unlock never unlocks a freed tty).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 */
Alan Coxd1552552012-07-27 18:02:54 +01001794 mutex_lock(&tty_mutex);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001795 release_tty(tty, idx);
Alan Coxd1552552012-07-27 18:02:54 +01001796 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Alan Coxeeb89d92009-11-30 13:18:29 +00001798 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799}
1800
Alan Coxaf9b8972006-08-27 01:24:01 -07001801/**
Jiri Slabyb82154a2011-11-09 21:33:19 +01001802 * tty_open_current_tty - get tty of current task for open
1803 * @device: device number
1804 * @filp: file pointer to tty
1805 * @return: tty of the current task iff @device is /dev/tty
1806 *
1807 * We cannot return driver and index like for the other nodes because
1808 * devpts will not work then. It expects inodes to be from devpts FS.
Alan Cox3af502b2012-05-03 22:21:53 +01001809 *
1810 * We need to move to returning a refcounted object from all the lookup
1811 * paths including this one.
Jiri Slabyb82154a2011-11-09 21:33:19 +01001812 */
1813static struct tty_struct *tty_open_current_tty(dev_t device, struct file *filp)
1814{
1815 struct tty_struct *tty;
1816
1817 if (device != MKDEV(TTYAUX_MAJOR, 0))
1818 return NULL;
1819
1820 tty = get_current_tty();
1821 if (!tty)
1822 return ERR_PTR(-ENXIO);
1823
1824 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1825 /* noctty = 1; */
1826 tty_kref_put(tty);
1827 /* FIXME: we put a reference and return a TTY! */
Alan Cox3af502b2012-05-03 22:21:53 +01001828 /* This is only safe because the caller holds tty_mutex */
Jiri Slabyb82154a2011-11-09 21:33:19 +01001829 return tty;
1830}
1831
1832/**
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001833 * tty_lookup_driver - lookup a tty driver for a given device file
1834 * @device: device number
1835 * @filp: file pointer to tty
1836 * @noctty: set if the device should not become a controlling tty
1837 * @index: index for the device in the @return driver
1838 * @return: driver for this inode (with increased refcount)
1839 *
1840 * If @return is not erroneous, the caller is responsible to decrement the
1841 * refcount by tty_driver_kref_put.
1842 *
1843 * Locking: tty_mutex protects get_tty_driver
1844 */
1845static struct tty_driver *tty_lookup_driver(dev_t device, struct file *filp,
1846 int *noctty, int *index)
1847{
1848 struct tty_driver *driver;
1849
Jiri Slaby2cd00502011-11-09 21:33:22 +01001850 switch (device) {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001851#ifdef CONFIG_VT
Jiri Slaby2cd00502011-11-09 21:33:22 +01001852 case MKDEV(TTY_MAJOR, 0): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001853 extern struct tty_driver *console_driver;
1854 driver = tty_driver_kref_get(console_driver);
1855 *index = fg_console;
1856 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001857 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001858 }
1859#endif
Jiri Slaby2cd00502011-11-09 21:33:22 +01001860 case MKDEV(TTYAUX_MAJOR, 1): {
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001861 struct tty_driver *console_driver = console_device(index);
1862 if (console_driver) {
1863 driver = tty_driver_kref_get(console_driver);
1864 if (driver) {
1865 /* Don't let /dev/console block */
1866 filp->f_flags |= O_NONBLOCK;
1867 *noctty = 1;
Jiri Slaby2cd00502011-11-09 21:33:22 +01001868 break;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001869 }
1870 }
1871 return ERR_PTR(-ENODEV);
1872 }
Jiri Slaby2cd00502011-11-09 21:33:22 +01001873 default:
1874 driver = get_tty_driver(device, index);
1875 if (!driver)
1876 return ERR_PTR(-ENODEV);
1877 break;
1878 }
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001879 return driver;
1880}
1881
1882/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001883 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001884 * @inode: inode of device file
1885 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001887 * tty_open and tty_release keep up the tty count that contains the
1888 * number of opens done on a tty. We cannot use the inode-count, as
1889 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001891 * Open-counting is needed for pty masters, as well as for keeping
1892 * track of serial lines: DTR is dropped when the last close happens.
1893 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1894 *
1895 * The termios state of a pty is reset on first open so that
1896 * settings don't persist across reuse.
1897 *
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001898 * Locking: tty_mutex protects tty, tty_lookup_driver and tty_init_dev.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001899 * tty->count should protect the rest.
1900 * ->siglock protects ->signal/->sighand
Alan Cox89c8d912012-08-08 16:30:13 +01001901 *
1902 * Note: the tty_unlock/lock cases without a ref are only safe due to
1903 * tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001905
Alan Coxeeb89d92009-11-30 13:18:29 +00001906static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907{
Jiri Slabyb82154a2011-11-09 21:33:19 +01001908 struct tty_struct *tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 int noctty, retval;
Jiri Slabyb82154a2011-11-09 21:33:19 +01001910 struct tty_driver *driver = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 int index;
1912 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001913 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914
1915 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001916
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917retry_open:
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02001918 retval = tty_alloc_file(filp);
1919 if (retval)
1920 return -ENOMEM;
1921
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 noctty = filp->f_flags & O_NOCTTY;
1923 index = -1;
1924 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001925
Ingo Molnar70522e12006-03-23 03:00:31 -08001926 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01001927 /* This is protected by the tty_mutex */
Jiri Slabyb82154a2011-11-09 21:33:19 +01001928 tty = tty_open_current_tty(device, filp);
1929 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001930 retval = PTR_ERR(tty);
1931 goto err_unlock;
Jiri Slaby5b5e7042011-11-09 21:33:20 +01001932 } else if (!tty) {
1933 driver = tty_lookup_driver(device, filp, &noctty, &index);
1934 if (IS_ERR(driver)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001935 retval = PTR_ERR(driver);
1936 goto err_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001939 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001940 tty = tty_driver_lookup_tty(driver, inode, index);
Eric Paris808ffa32009-01-27 11:50:37 +00001941 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001942 retval = PTR_ERR(tty);
1943 goto err_unlock;
Eric Paris808ffa32009-01-27 11:50:37 +00001944 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001945 }
1946
1947 if (tty) {
Alan Cox89c8d912012-08-08 16:30:13 +01001948 tty_lock(tty);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001949 retval = tty_reopen(tty);
Alan Cox89c8d912012-08-08 16:30:13 +01001950 if (retval < 0) {
1951 tty_unlock(tty);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001952 tty = ERR_PTR(retval);
Alan Cox89c8d912012-08-08 16:30:13 +01001953 }
1954 } else /* Returns with the tty_lock held for now */
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +04001955 tty = tty_init_dev(driver, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001956
Ingo Molnar70522e12006-03-23 03:00:31 -08001957 mutex_unlock(&tty_mutex);
Jiri Slabyb82154a2011-11-09 21:33:19 +01001958 if (driver)
1959 tty_driver_kref_put(driver);
Alan Coxeeb89d92009-11-30 13:18:29 +00001960 if (IS_ERR(tty)) {
Jiri Slabyba5db442011-11-09 21:33:21 +01001961 retval = PTR_ERR(tty);
1962 goto err_file;
Alan Coxeeb89d92009-11-30 13:18:29 +00001963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964
Jiri Slabyfa90e1c2011-10-12 11:32:43 +02001965 tty_add_file(tty, filp);
Nick Piggind996b622010-08-18 04:37:36 +10001966
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001967 check_tty_count(tty, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1969 tty->driver->subtype == PTY_TYPE_MASTER)
1970 noctty = 1;
1971#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001972 printk(KERN_DEBUG "%s: opening %s...\n", __func__, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973#endif
Herton Ronaldo Krzesinski909bc772011-03-31 15:35:31 -03001974 if (tty->ops->open)
1975 retval = tty->ops->open(tty, filp);
1976 else
1977 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978 filp->f_flags = saved_flags;
1979
Alan Cox37bdfb02008-02-08 04:18:47 -08001980 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1981 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 retval = -EBUSY;
1983
1984 if (retval) {
1985#ifdef TTY_DEBUG_HANGUP
Jiri Slaby9de44bd2011-11-09 21:33:24 +01001986 printk(KERN_DEBUG "%s: error %d in opening %s...\n", __func__,
1987 retval, tty->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988#endif
Alan Cox89c8d912012-08-08 16:30:13 +01001989 tty_unlock(tty); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00001990 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001991 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001993
1994 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 schedule();
1998 /*
1999 * Need to reset f_op in case a hangup happened.
2000 */
2001 if (filp->f_op == &hung_up_tty_fops)
2002 filp->f_op = &tty_fops;
2003 goto retry_open;
2004 }
Alan Cox89c8d912012-08-08 16:30:13 +01002005 tty_unlock(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00002006
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002007
2008 mutex_lock(&tty_mutex);
Alan Cox89c8d912012-08-08 16:30:13 +01002009 tty_lock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002010 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 if (!noctty &&
2012 current->signal->leader &&
2013 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002014 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07002015 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002016 spin_unlock_irq(&current->sighand->siglock);
Alan Cox89c8d912012-08-08 16:30:13 +01002017 tty_unlock(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002018 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 return 0;
Jiri Slabyba5db442011-11-09 21:33:21 +01002020err_unlock:
Jiri Slabyba5db442011-11-09 21:33:21 +01002021 mutex_unlock(&tty_mutex);
2022 /* after locks to avoid deadlock */
2023 if (!IS_ERR_OR_NULL(driver))
2024 tty_driver_kref_put(driver);
2025err_file:
2026 tty_free_file(filp);
2027 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028}
2029
Jonathan Corbet39d95b92008-05-16 09:10:50 -06002030
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Alan Coxaf9b8972006-08-27 01:24:01 -07002032/**
2033 * tty_poll - check tty status
2034 * @filp: file being polled
2035 * @wait: poll wait structures to update
2036 *
2037 * Call the line discipline polling method to obtain the poll
2038 * status of the device.
2039 *
2040 * Locking: locks called line discipline but ldisc poll method
2041 * may be re-entered freely by other callers.
2042 */
2043
Alan Cox37bdfb02008-02-08 04:18:47 -08002044static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045{
Nick Piggind996b622010-08-18 04:37:36 +10002046 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 struct tty_ldisc *ld;
2048 int ret = 0;
2049
Josef Sipeka7113a92006-12-08 02:36:55 -08002050 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002052
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002054 if (ld->ops->poll)
2055 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056 tty_ldisc_deref(ld);
2057 return ret;
2058}
2059
Arnd Bergmannec79d602010-06-01 22:53:01 +02002060static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061{
Nick Piggind996b622010-08-18 04:37:36 +10002062 struct tty_struct *tty = file_tty(filp);
Alan Cox47f86832008-04-30 00:53:30 -07002063 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002064 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
Josef Sipeka7113a92006-12-08 02:36:55 -08002066 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002067 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08002068
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 retval = fasync_helper(fd, filp, on, &tty->fasync);
2070 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002071 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072
2073 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002074 enum pid_type type;
2075 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 if (!waitqueue_active(&tty->read_wait))
2077 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002078 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002079 if (tty->pgrp) {
2080 pid = tty->pgrp;
2081 type = PIDTYPE_PGID;
2082 } else {
2083 pid = task_pid(current);
2084 type = PIDTYPE_PID;
2085 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002086 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002087 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002088 retval = __f_setown(filp, pid, type, 0);
2089 put_pid(pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002091 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 } else {
2093 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2094 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2095 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002096 retval = 0;
2097out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002098 return retval;
2099}
2100
2101static int tty_fasync(int fd, struct file *filp, int on)
2102{
Alan Cox89c8d912012-08-08 16:30:13 +01002103 struct tty_struct *tty = file_tty(filp);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002104 int retval;
Alan Cox89c8d912012-08-08 16:30:13 +01002105
2106 tty_lock(tty);
Arnd Bergmannec79d602010-06-01 22:53:01 +02002107 retval = __tty_fasync(fd, filp, on);
Alan Cox89c8d912012-08-08 16:30:13 +01002108 tty_unlock(tty);
2109
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002110 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111}
2112
Alan Coxaf9b8972006-08-27 01:24:01 -07002113/**
2114 * tiocsti - fake input character
2115 * @tty: tty to fake input into
2116 * @p: pointer to character
2117 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002118 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002119 * input management.
2120 *
2121 * FIXME: does not honour flow control ??
2122 *
2123 * Locking:
2124 * Called functions take tty_ldisc_lock
2125 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002126 *
2127 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002128 */
2129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130static int tiocsti(struct tty_struct *tty, char __user *p)
2131{
2132 char ch, mbz = 0;
2133 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002134
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2136 return -EPERM;
2137 if (get_user(ch, p))
2138 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002139 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002141 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 tty_ldisc_deref(ld);
2143 return 0;
2144}
2145
Alan Coxaf9b8972006-08-27 01:24:01 -07002146/**
2147 * tiocgwinsz - implement window query ioctl
2148 * @tty; tty
2149 * @arg: user buffer for result
2150 *
Alan Cox808a0d32006-09-29 02:00:40 -07002151 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002152 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002153 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002154 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002155 */
2156
Alan Cox37bdfb02008-02-08 04:18:47 -08002157static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158{
Alan Cox808a0d32006-09-29 02:00:40 -07002159 int err;
2160
Arjan van de Ven5785c952006-09-29 02:00:43 -07002161 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002162 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002163 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002164
2165 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166}
2167
Alan Coxaf9b8972006-08-27 01:24:01 -07002168/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002169 * tty_do_resize - resize event
2170 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002171 * @rows: rows (character)
2172 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002173 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002174 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002175 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002176 */
2177
Alan Coxfc6f6232009-01-02 13:43:17 +00002178int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179{
Alan Coxfc6f6232009-01-02 13:43:17 +00002180 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002181 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182
Alan Coxfc6f6232009-01-02 13:43:17 +00002183 /* Lock the tty */
2184 mutex_lock(&tty->termios_mutex);
2185 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002186 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002187 /* Get the PID values and reference them so we can
2188 avoid holding the tty ctrl lock while sending signals */
2189 spin_lock_irqsave(&tty->ctrl_lock, flags);
2190 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002191 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2192
2193 if (pgrp)
2194 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002195 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002196
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002197 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002198done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002199 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 return 0;
2201}
2202
Alan Coxaf9b8972006-08-27 01:24:01 -07002203/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002204 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002205 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002206 * @arg: user buffer for result
2207 *
2208 * Copies the user idea of the window size to the kernel. Traditionally
2209 * this is just advisory information but for the Linux console it
2210 * actually has driver level meaning and triggers a VC resize.
2211 *
2212 * Locking:
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002213 * Driver dependent. The default do_resize method takes the
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002214 * tty termios mutex and ctrl_lock. The console takes its own lock
2215 * then calls into the default method.
2216 */
2217
Alan Coxfc6f6232009-01-02 13:43:17 +00002218static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002219{
2220 struct winsize tmp_ws;
2221 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2222 return -EFAULT;
2223
2224 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002225 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002226 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002227 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002228}
2229
2230/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002231 * tioccons - allow admin to move logical console
2232 * @file: the file to become console
2233 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002234 * Allow the administrator to move the redirected console device
Alan Coxaf9b8972006-08-27 01:24:01 -07002235 *
2236 * Locking: uses redirect_lock to guard the redirect information
2237 */
2238
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239static int tioccons(struct file *file)
2240{
2241 if (!capable(CAP_SYS_ADMIN))
2242 return -EPERM;
2243 if (file->f_op->write == redirected_tty_write) {
2244 struct file *f;
2245 spin_lock(&redirect_lock);
2246 f = redirect;
2247 redirect = NULL;
2248 spin_unlock(&redirect_lock);
2249 if (f)
2250 fput(f);
2251 return 0;
2252 }
2253 spin_lock(&redirect_lock);
2254 if (redirect) {
2255 spin_unlock(&redirect_lock);
2256 return -EBUSY;
2257 }
Al Virocb0942b2012-08-27 14:48:26 -04002258 redirect = get_file(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 spin_unlock(&redirect_lock);
2260 return 0;
2261}
2262
Alan Coxaf9b8972006-08-27 01:24:01 -07002263/**
2264 * fionbio - non blocking ioctl
2265 * @file: file to set blocking value
2266 * @p: user parameter
2267 *
2268 * Historical tty interfaces had a blocking control ioctl before
2269 * the generic functionality existed. This piece of history is preserved
2270 * in the expected tty API of posix OS's.
2271 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002272 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002273 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
2275static int fionbio(struct file *file, int __user *p)
2276{
2277 int nonblock;
2278
2279 if (get_user(nonblock, p))
2280 return -EFAULT;
2281
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002282 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 if (nonblock)
2284 file->f_flags |= O_NONBLOCK;
2285 else
2286 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002287 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 return 0;
2289}
2290
Alan Coxaf9b8972006-08-27 01:24:01 -07002291/**
2292 * tiocsctty - set controlling tty
2293 * @tty: tty structure
2294 * @arg: user argument
2295 *
2296 * This ioctl is used to manage job control. It permits a session
2297 * leader to set this tty as the controlling tty for the session.
2298 *
2299 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002300 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002301 * Takes tasklist_lock internally to walk sessions
2302 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002303 */
2304
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305static int tiocsctty(struct tty_struct *tty, int arg)
2306{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002307 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002308 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002309 return ret;
2310
2311 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 /*
2313 * The process must be a session leader and
2314 * not have a controlling tty already.
2315 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002316 if (!current->signal->leader || current->signal->tty) {
2317 ret = -EPERM;
2318 goto unlock;
2319 }
2320
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002321 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 /*
2323 * This tty is already the controlling
2324 * tty for another session group!
2325 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002326 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 /*
2328 * Steal it away
2329 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002331 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002333 } else {
2334 ret = -EPERM;
2335 goto unlock;
2336 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002338 proc_set_tty(current, tty);
2339unlock:
Alan Cox28298232006-09-29 02:00:58 -07002340 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002341 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342}
2343
Alan Coxaf9b8972006-08-27 01:24:01 -07002344/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002345 * tty_get_pgrp - return a ref counted pgrp pid
2346 * @tty: tty to read
2347 *
2348 * Returns a refcounted instance of the pid struct for the process
2349 * group controlling the tty.
2350 */
2351
2352struct pid *tty_get_pgrp(struct tty_struct *tty)
2353{
2354 unsigned long flags;
2355 struct pid *pgrp;
2356
2357 spin_lock_irqsave(&tty->ctrl_lock, flags);
2358 pgrp = get_pid(tty->pgrp);
2359 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2360
2361 return pgrp;
2362}
2363EXPORT_SYMBOL_GPL(tty_get_pgrp);
2364
2365/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002366 * tiocgpgrp - get process group
2367 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002368 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002369 * @p: returned pid
2370 *
2371 * Obtain the process group of the tty. If there is no process group
2372 * return an error.
2373 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002374 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002375 */
2376
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2378{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002379 struct pid *pid;
2380 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 /*
2382 * (tty == real_tty) is a cheap way of
2383 * testing if the tty is NOT a master pty.
2384 */
2385 if (tty == real_tty && current->signal->tty != real_tty)
2386 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002387 pid = tty_get_pgrp(real_tty);
2388 ret = put_user(pid_vnr(pid), p);
2389 put_pid(pid);
2390 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391}
2392
Alan Coxaf9b8972006-08-27 01:24:01 -07002393/**
2394 * tiocspgrp - attempt to set process group
2395 * @tty: tty passed by user
2396 * @real_tty: tty side device matching tty passed by user
2397 * @p: pid pointer
2398 *
2399 * Set the process group of the tty to the session passed. Only
2400 * permitted where the tty session is our session.
2401 *
Alan Cox47f86832008-04-30 00:53:30 -07002402 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002403 */
2404
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2406{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002407 struct pid *pgrp;
2408 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002410 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411
2412 if (retval == -EIO)
2413 return -ENOTTY;
2414 if (retval)
2415 return retval;
2416 if (!current->signal->tty ||
2417 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002418 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002420 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002422 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002424 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002425 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002426 retval = -ESRCH;
2427 if (!pgrp)
2428 goto out_unlock;
2429 retval = -EPERM;
2430 if (session_of_pgrp(pgrp) != task_session(current))
2431 goto out_unlock;
2432 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002433 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002434 put_pid(real_tty->pgrp);
2435 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002436 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002437out_unlock:
2438 rcu_read_unlock();
2439 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440}
2441
Alan Coxaf9b8972006-08-27 01:24:01 -07002442/**
2443 * tiocgsid - get session id
2444 * @tty: tty passed by user
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002445 * @real_tty: tty side of the tty passed by the user if a pty else the tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002446 * @p: pointer to returned session id
2447 *
2448 * Obtain the session id of the tty. If there is no session
2449 * return an error.
2450 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002451 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002452 */
2453
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2455{
2456 /*
2457 * (tty == real_tty) is a cheap way of
2458 * testing if the tty is NOT a master pty.
2459 */
2460 if (tty == real_tty && current->signal->tty != real_tty)
2461 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002462 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002464 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465}
2466
Alan Coxaf9b8972006-08-27 01:24:01 -07002467/**
2468 * tiocsetd - set line discipline
2469 * @tty: tty device
2470 * @p: pointer to user data
2471 *
2472 * Set the line discipline according to user request.
2473 *
2474 * Locking: see tty_set_ldisc, this function is just a helper
2475 */
2476
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477static int tiocsetd(struct tty_struct *tty, int __user *p)
2478{
2479 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002480 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481
2482 if (get_user(ldisc, p))
2483 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002484
Alan Cox04f378b2008-04-30 00:53:29 -07002485 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002486
2487 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488}
2489
Alan Coxaf9b8972006-08-27 01:24:01 -07002490/**
2491 * send_break - performed time break
2492 * @tty: device to break on
2493 * @duration: timeout in mS
2494 *
2495 * Perform a timed break on hardware that lacks its own driver level
2496 * timed break functionality.
2497 *
2498 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002499 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002500 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002501 */
2502
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002503static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504{
Alan Cox9e989662008-07-22 11:18:03 +01002505 int retval;
2506
2507 if (tty->ops->break_ctl == NULL)
2508 return 0;
2509
2510 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2511 retval = tty->ops->break_ctl(tty, duration);
2512 else {
2513 /* Do the work ourselves */
2514 if (tty_write_lock(tty, 0) < 0)
2515 return -EINTR;
2516 retval = tty->ops->break_ctl(tty, -1);
2517 if (retval)
2518 goto out;
2519 if (!signal_pending(current))
2520 msleep_interruptible(duration);
2521 retval = tty->ops->break_ctl(tty, 0);
2522out:
2523 tty_write_unlock(tty);
2524 if (signal_pending(current))
2525 retval = -EINTR;
2526 }
2527 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528}
2529
Alan Coxaf9b8972006-08-27 01:24:01 -07002530/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002531 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002532 * @tty: tty device
2533 * @file: user file pointer
2534 * @p: pointer to result
2535 *
2536 * Obtain the modem status bits from the tty driver if the feature
2537 * is supported. Return -EINVAL if it is not available.
2538 *
2539 * Locking: none (up to the driver)
2540 */
2541
Alan Cox60b33c12011-02-14 16:26:14 +00002542static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543{
2544 int retval = -EINVAL;
2545
Alan Coxf34d7a52008-04-30 00:54:13 -07002546 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002547 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
2549 if (retval >= 0)
2550 retval = put_user(retval, p);
2551 }
2552 return retval;
2553}
2554
Alan Coxaf9b8972006-08-27 01:24:01 -07002555/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002556 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002557 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002558 * @cmd: command - clear bits, set bits or set all
2559 * @p: pointer to desired bits
2560 *
2561 * Set the modem status bits from the tty driver if the feature
2562 * is supported. Return -EINVAL if it is not available.
2563 *
2564 * Locking: none (up to the driver)
2565 */
2566
Alan Cox20b9d172011-02-14 16:26:50 +00002567static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 unsigned __user *p)
2569{
Alan Coxae677512008-07-16 21:56:54 +01002570 int retval;
2571 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572
Alan Coxae677512008-07-16 21:56:54 +01002573 if (tty->ops->tiocmset == NULL)
2574 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575
Alan Coxae677512008-07-16 21:56:54 +01002576 retval = get_user(val, p);
2577 if (retval)
2578 return retval;
2579 set = clear = 0;
2580 switch (cmd) {
2581 case TIOCMBIS:
2582 set = val;
2583 break;
2584 case TIOCMBIC:
2585 clear = val;
2586 break;
2587 case TIOCMSET:
2588 set = val;
2589 clear = ~val;
2590 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 }
Alan Coxae677512008-07-16 21:56:54 +01002592 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2593 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002594 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595}
2596
Alan Coxd281da72010-09-16 18:21:24 +01002597static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2598{
2599 int retval = -EINVAL;
2600 struct serial_icounter_struct icount;
2601 memset(&icount, 0, sizeof(icount));
2602 if (tty->ops->get_icount)
2603 retval = tty->ops->get_icount(tty, &icount);
2604 if (retval != 0)
2605 return retval;
2606 if (copy_to_user(arg, &icount, sizeof(icount)))
2607 return -EFAULT;
2608 return 0;
2609}
2610
Alan Coxe8b70e72009-06-11 12:48:02 +01002611struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2612{
2613 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2614 tty->driver->subtype == PTY_TYPE_MASTER)
2615 tty = tty->link;
2616 return tty;
2617}
2618EXPORT_SYMBOL(tty_pair_get_tty);
2619
2620struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2621{
2622 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2623 tty->driver->subtype == PTY_TYPE_MASTER)
2624 return tty;
2625 return tty->link;
2626}
2627EXPORT_SYMBOL(tty_pair_get_pty);
2628
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629/*
2630 * Split this up, as gcc can choke on it otherwise..
2631 */
Alan Cox04f378b2008-04-30 00:53:29 -07002632long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633{
Nick Piggind996b622010-08-18 04:37:36 +10002634 struct tty_struct *tty = file_tty(file);
2635 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636 void __user *p = (void __user *)arg;
2637 int retval;
2638 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002639 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002640
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2642 return -EINVAL;
2643
Alan Coxe8b70e72009-06-11 12:48:02 +01002644 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645
2646 /*
2647 * Factor out some common prep work
2648 */
2649 switch (cmd) {
2650 case TIOCSETD:
2651 case TIOCSBRK:
2652 case TIOCCBRK:
2653 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002654 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655 retval = tty_check_change(tty);
2656 if (retval)
2657 return retval;
2658 if (cmd != TIOCCBRK) {
2659 tty_wait_until_sent(tty, 0);
2660 if (signal_pending(current))
2661 return -EINTR;
2662 }
2663 break;
2664 }
2665
Alan Cox9e989662008-07-22 11:18:03 +01002666 /*
2667 * Now do the stuff.
2668 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002670 case TIOCSTI:
2671 return tiocsti(tty, p);
2672 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002673 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002674 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002675 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002676 case TIOCCONS:
2677 return real_tty != tty ? -EINVAL : tioccons(file);
2678 case FIONBIO:
2679 return fionbio(file, p);
2680 case TIOCEXCL:
2681 set_bit(TTY_EXCLUSIVE, &tty->flags);
2682 return 0;
2683 case TIOCNXCL:
2684 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2685 return 0;
Cyrill Gorcunov84fd7bd2012-10-24 23:43:22 +04002686 case TIOCGEXCL:
2687 {
2688 int excl = test_bit(TTY_EXCLUSIVE, &tty->flags);
2689 return put_user(excl, (int __user *)p);
2690 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002691 case TIOCNOTTY:
2692 if (current->signal->tty != tty)
2693 return -ENOTTY;
2694 no_tty();
2695 return 0;
2696 case TIOCSCTTY:
2697 return tiocsctty(tty, arg);
2698 case TIOCGPGRP:
2699 return tiocgpgrp(tty, real_tty, p);
2700 case TIOCSPGRP:
2701 return tiocspgrp(tty, real_tty, p);
2702 case TIOCGSID:
2703 return tiocgsid(tty, real_tty, p);
2704 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002705 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002706 case TIOCSETD:
2707 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002708 case TIOCVHANGUP:
2709 if (!capable(CAP_SYS_ADMIN))
2710 return -EPERM;
2711 tty_vhangup(tty);
2712 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002713 case TIOCGDEV:
2714 {
2715 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2716 return put_user(ret, (unsigned int __user *)p);
2717 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002718 /*
2719 * Break handling
2720 */
2721 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002722 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002723 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002724 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002725 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002726 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002727 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002728 return 0;
2729 case TCSBRK: /* SVID version: non-zero arg --> no break */
2730 /* non-zero arg means wait for all output data
2731 * to be sent (performed above) but don't send break.
2732 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002734 if (!arg)
2735 return send_break(tty, 250);
2736 return 0;
2737 case TCSBRKP: /* support for POSIX tcsendbreak() */
2738 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739
Alan Cox37bdfb02008-02-08 04:18:47 -08002740 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002741 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002742 case TIOCMSET:
2743 case TIOCMBIC:
2744 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002745 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002746 case TIOCGICOUNT:
2747 retval = tty_tiocgicount(tty, p);
2748 /* For the moment allow fall through to the old method */
2749 if (retval != -EINVAL)
2750 return retval;
2751 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002752 case TCFLSH:
2753 switch (arg) {
2754 case TCIFLUSH:
2755 case TCIOFLUSH:
2756 /* flush tty buffer and allow ldisc to process ioctl */
2757 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002758 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002759 }
2760 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002762 if (tty->ops->ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002763 retval = (tty->ops->ioctl)(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 if (retval != -ENOIOCTLCMD)
2765 return retval;
2766 }
2767 ld = tty_ldisc_ref_wait(tty);
2768 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002769 if (ld->ops->ioctl) {
2770 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 if (retval == -ENOIOCTLCMD)
Wanlong Gaobbb63c52012-08-27 15:23:12 +08002772 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 }
2774 tty_ldisc_deref(ld);
2775 return retval;
2776}
2777
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002778#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002779static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002780 unsigned long arg)
2781{
2782 struct inode *inode = file->f_dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10002783 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002784 struct tty_ldisc *ld;
2785 int retval = -ENOIOCTLCMD;
2786
2787 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2788 return -EINVAL;
2789
Alan Coxf34d7a52008-04-30 00:54:13 -07002790 if (tty->ops->compat_ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002791 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002792 if (retval != -ENOIOCTLCMD)
2793 return retval;
2794 }
2795
2796 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002797 if (ld->ops->compat_ioctl)
2798 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Thomas Meyer8193c422011-10-05 23:13:13 +02002799 else
2800 retval = n_tty_compat_ioctl_helper(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002801 tty_ldisc_deref(ld);
2802
2803 return retval;
2804}
2805#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806
Al Viroc3c073f2012-08-21 22:32:06 -04002807static int this_tty(const void *t, struct file *file, unsigned fd)
2808{
2809 if (likely(file->f_op->read != tty_read))
2810 return 0;
2811 return file_tty(file) != t ? 0 : fd + 1;
2812}
2813
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814/*
2815 * This implements the "Secure Attention Key" --- the idea is to
2816 * prevent trojan horses by killing all processes associated with this
2817 * tty when the user hits the "Secure Attention Key". Required for
2818 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002819 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 * This code could be nicer; ideally it should send a HUP, wait a few
2821 * seconds, then send a INT, and then a KILL signal. But you then
2822 * have to coordinate with the init process, since all processes associated
2823 * with the current tty must be dead before the new getty is allowed
2824 * to spawn.
2825 *
2826 * Now, if it would be correct ;-/ The current code has a nasty hole -
2827 * it doesn't catch files in flight. We may send the descriptor to ourselves
2828 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2829 *
2830 * Nasty bug: do_SAK is being called in interrupt context. This can
2831 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2832 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002833void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834{
2835#ifdef TTY_SOFT_SAK
2836 tty_hangup(tty);
2837#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002838 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002839 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 int i;
Alan Cox37bdfb02008-02-08 04:18:47 -08002841
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 if (!tty)
2843 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002844 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002845
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002846 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847
Alan Coxf34d7a52008-04-30 00:54:13 -07002848 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002849
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002851 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002852 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002853 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002854 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002855 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002856 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002857 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002858 /* Now kill any processes that happen to have the
2859 * tty open.
2860 */
2861 do_each_thread(g, p) {
2862 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002864 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002865 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002866 send_sig(SIGKILL, p, 1);
2867 continue;
2868 }
2869 task_lock(p);
Al Viroc3c073f2012-08-21 22:32:06 -04002870 i = iterate_fd(p->files, 0, this_tty, tty);
2871 if (i != 0) {
2872 printk(KERN_NOTICE "SAK: killed process %d"
2873 " (%s): fd#%d opened to the tty\n",
2874 task_pid_nr(p), p->comm, i - 1);
2875 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876 }
2877 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002878 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 read_unlock(&tasklist_lock);
2880#endif
2881}
2882
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002883static void do_SAK_work(struct work_struct *work)
2884{
2885 struct tty_struct *tty =
2886 container_of(work, struct tty_struct, SAK_work);
2887 __do_SAK(tty);
2888}
2889
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890/*
2891 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2892 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2893 * the values which we write to it will be identical to the values which it
2894 * already has. --akpm
2895 */
2896void do_SAK(struct tty_struct *tty)
2897{
2898 if (!tty)
2899 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 schedule_work(&tty->SAK_work);
2901}
2902
2903EXPORT_SYMBOL(do_SAK);
2904
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002905static int dev_match_devt(struct device *dev, void *data)
2906{
2907 dev_t *devt = data;
2908 return dev->devt == *devt;
2909}
2910
2911/* Must put_device() after it's unused! */
2912static struct device *tty_get_device(struct tty_struct *tty)
2913{
2914 dev_t devt = tty_devnum(tty);
2915 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2916}
2917
2918
Alan Coxaf9b8972006-08-27 01:24:01 -07002919/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002920 * initialize_tty_struct
2921 * @tty: tty to initialize
2922 *
2923 * This subroutine initializes a tty structure that has been newly
2924 * allocated.
2925 *
2926 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002928
Alan Coxbf970ee2008-10-13 10:42:39 +01002929void initialize_tty_struct(struct tty_struct *tty,
2930 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931{
2932 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002933 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002935 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002936 tty->session = NULL;
2937 tty->pgrp = NULL;
Alan Cox89c8d912012-08-08 16:30:13 +01002938 mutex_init(&tty->legacy_mutex);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002939 mutex_init(&tty->termios_mutex);
Alan Coxc65c9bc2009-06-11 12:50:12 +01002940 mutex_init(&tty->ldisc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941 init_waitqueue_head(&tty->write_wait);
2942 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002943 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002944 mutex_init(&tty->atomic_write_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002945 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002947 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002948
2949 tty->driver = driver;
2950 tty->ops = driver->ops;
2951 tty->index = idx;
2952 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002953 tty->dev = tty_get_device(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954}
2955
Alan Coxf34d7a52008-04-30 00:54:13 -07002956/**
Jiri Slaby67166712011-03-23 10:48:35 +01002957 * deinitialize_tty_struct
2958 * @tty: tty to deinitialize
2959 *
2960 * This subroutine deinitializes a tty structure that has been newly
2961 * allocated but tty_release cannot be called on that yet.
2962 *
2963 * Locking: none - tty in question must not be exposed at this point
2964 */
2965void deinitialize_tty_struct(struct tty_struct *tty)
2966{
2967 tty_ldisc_deinit(tty);
2968}
2969
2970/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002971 * tty_put_char - write one character to a tty
2972 * @tty: tty
2973 * @ch: character
2974 *
2975 * Write one byte to the tty using the provided put_char method
2976 * if present. Returns the number of characters successfully output.
2977 *
2978 * Note: the specific put_char operation in the driver layer may go
2979 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002980 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002981
Alan Coxf34d7a52008-04-30 00:54:13 -07002982int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983{
Alan Coxf34d7a52008-04-30 00:54:13 -07002984 if (tty->ops->put_char)
2985 return tty->ops->put_char(tty, ch);
2986 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987}
Alan Coxf34d7a52008-04-30 00:54:13 -07002988EXPORT_SYMBOL_GPL(tty_put_char);
2989
Alan Coxd81ed102008-10-13 10:41:42 +01002990struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991
Jiri Slaby7e73eca2012-08-08 22:26:44 +02002992static int tty_cdev_add(struct tty_driver *driver, dev_t dev,
2993 unsigned int index, unsigned int count)
2994{
2995 /* init here, since reused cdevs cause crashes */
2996 cdev_init(&driver->cdevs[index], &tty_fops);
2997 driver->cdevs[index].owner = driver->owner;
2998 return cdev_add(&driver->cdevs[index], dev, count);
2999}
3000
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003002 * tty_register_device - register a tty device
3003 * @driver: the tty driver that describes the tty device
3004 * @index: the index in the tty driver for this tty device
3005 * @device: a struct device that is associated with this tty device.
3006 * This field is optional, if there is no known struct device
3007 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003009 * Returns a pointer to the struct device for this tty device
3010 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003011 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003012 * This call is required to be made to register an individual tty device
3013 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3014 * that bit is not set, this function should not be called by a tty
3015 * driver.
3016 *
3017 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003019
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07003020struct device *tty_register_device(struct tty_driver *driver, unsigned index,
3021 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022{
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003023 return tty_register_device_attr(driver, index, device, NULL, NULL);
3024}
3025EXPORT_SYMBOL(tty_register_device);
3026
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003027static void tty_device_create_release(struct device *dev)
3028{
3029 pr_debug("device: '%s': %s\n", dev_name(dev), __func__);
3030 kfree(dev);
3031}
3032
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003033/**
3034 * tty_register_device_attr - register a tty device
3035 * @driver: the tty driver that describes the tty device
3036 * @index: the index in the tty driver for this tty device
3037 * @device: a struct device that is associated with this tty device.
3038 * This field is optional, if there is no known struct device
3039 * for this tty device it can be set to NULL safely.
3040 * @drvdata: Driver data to be set to device.
3041 * @attr_grp: Attribute group to be set on device.
3042 *
3043 * Returns a pointer to the struct device for this tty device
3044 * (or ERR_PTR(-EFOO) on error).
3045 *
3046 * This call is required to be made to register an individual tty device
3047 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
3048 * that bit is not set, this function should not be called by a tty
3049 * driver.
3050 *
3051 * Locking: ??
3052 */
3053struct device *tty_register_device_attr(struct tty_driver *driver,
3054 unsigned index, struct device *device,
3055 void *drvdata,
3056 const struct attribute_group **attr_grp)
3057{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003058 char name[64];
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003059 dev_t devt = MKDEV(driver->major, driver->minor_start) + index;
3060 struct device *dev = NULL;
3061 int retval = -ENODEV;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003062 bool cdev = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063
3064 if (index >= driver->num) {
3065 printk(KERN_ERR "Attempt to register invalid tty line number "
3066 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003067 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068 }
3069
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070 if (driver->type == TTY_DRIVER_TYPE_PTY)
3071 pty_line_name(driver, index, name);
3072 else
3073 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02003074
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003075 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003076 retval = tty_cdev_add(driver, devt, index, 1);
3077 if (retval)
3078 goto error;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003079 cdev = true;
3080 }
3081
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003082 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
3083 if (!dev) {
3084 retval = -ENOMEM;
3085 goto error;
3086 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003087
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003088 dev->devt = devt;
3089 dev->class = tty_class;
3090 dev->parent = device;
Tomas Hlavacekb1b79912012-09-06 23:17:47 +02003091 dev->release = tty_device_create_release;
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003092 dev_set_name(dev, "%s", name);
3093 dev->groups = attr_grp;
3094 dev_set_drvdata(dev, drvdata);
3095
3096 retval = device_register(dev);
3097 if (retval)
3098 goto error;
3099
3100 return dev;
3101
3102error:
3103 put_device(dev);
3104 if (cdev)
3105 cdev_del(&driver->cdevs[index]);
3106 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003107}
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +02003108EXPORT_SYMBOL_GPL(tty_register_device_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003109
3110/**
Alan Coxaf9b8972006-08-27 01:24:01 -07003111 * tty_unregister_device - unregister a tty device
3112 * @driver: the tty driver that describes the tty device
3113 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114 *
Alan Coxaf9b8972006-08-27 01:24:01 -07003115 * If a tty device is registered with a call to tty_register_device() then
3116 * this function must be called when the tty device is gone.
3117 *
3118 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119 */
Alan Coxaf9b8972006-08-27 01:24:01 -07003120
Linus Torvalds1da177e2005-04-16 15:20:36 -07003121void tty_unregister_device(struct tty_driver *driver, unsigned index)
3122{
Alan Cox37bdfb02008-02-08 04:18:47 -08003123 device_destroy(tty_class,
3124 MKDEV(driver->major, driver->minor_start) + index);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003125 if (!(driver->flags & TTY_DRIVER_DYNAMIC_ALLOC))
3126 cdev_del(&driver->cdevs[index]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003128EXPORT_SYMBOL(tty_unregister_device);
3129
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003130/**
3131 * __tty_alloc_driver -- allocate tty driver
3132 * @lines: count of lines this driver can handle at most
3133 * @owner: module which is repsonsible for this driver
3134 * @flags: some of TTY_DRIVER_* flags, will be set in driver->flags
3135 *
3136 * This should not be called directly, some of the provided macros should be
3137 * used instead. Use IS_ERR and friends on @retval.
3138 */
3139struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
3140 unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003141{
3142 struct tty_driver *driver;
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003143 unsigned int cdevs = 1;
Jiri Slaby16a02082012-08-08 22:26:42 +02003144 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145
Jiri Slaby0019b402012-08-08 22:26:43 +02003146 if (!lines || (flags & TTY_DRIVER_UNNUMBERED_NODE && lines > 1))
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003147 return ERR_PTR(-EINVAL);
3148
Jean Delvare506eb992007-07-15 23:40:14 -07003149 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003150 if (!driver)
3151 return ERR_PTR(-ENOMEM);
3152
3153 kref_init(&driver->kref);
3154 driver->magic = TTY_DRIVER_MAGIC;
3155 driver->num = lines;
3156 driver->owner = owner;
3157 driver->flags = flags;
Jiri Slaby16a02082012-08-08 22:26:42 +02003158
3159 if (!(flags & TTY_DRIVER_DEVPTS_MEM)) {
3160 driver->ttys = kcalloc(lines, sizeof(*driver->ttys),
3161 GFP_KERNEL);
3162 driver->termios = kcalloc(lines, sizeof(*driver->termios),
3163 GFP_KERNEL);
3164 if (!driver->ttys || !driver->termios) {
3165 err = -ENOMEM;
3166 goto err_free_all;
3167 }
3168 }
3169
3170 if (!(flags & TTY_DRIVER_DYNAMIC_ALLOC)) {
3171 driver->ports = kcalloc(lines, sizeof(*driver->ports),
3172 GFP_KERNEL);
3173 if (!driver->ports) {
3174 err = -ENOMEM;
3175 goto err_free_all;
3176 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003177 cdevs = lines;
3178 }
3179
3180 driver->cdevs = kcalloc(cdevs, sizeof(*driver->cdevs), GFP_KERNEL);
3181 if (!driver->cdevs) {
3182 err = -ENOMEM;
3183 goto err_free_all;
Jiri Slaby16a02082012-08-08 22:26:42 +02003184 }
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003185
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186 return driver;
Jiri Slaby16a02082012-08-08 22:26:42 +02003187err_free_all:
3188 kfree(driver->ports);
3189 kfree(driver->ttys);
3190 kfree(driver->termios);
3191 kfree(driver);
3192 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003193}
Jiri Slaby7f0bc6a2012-08-07 21:47:42 +02003194EXPORT_SYMBOL(__tty_alloc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195
Alan Cox7d7b93c2008-10-13 10:42:09 +01003196static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003198 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
3199 int i;
3200 struct ktermios *tp;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003201
3202 if (driver->flags & TTY_DRIVER_INSTALLED) {
3203 /*
3204 * Free the termios and termios_locked structures because
3205 * we don't want to get memory leaks when modular tty
3206 * drivers are removed from the kernel.
3207 */
3208 for (i = 0; i < driver->num; i++) {
3209 tp = driver->termios[i];
3210 if (tp) {
3211 driver->termios[i] = NULL;
3212 kfree(tp);
3213 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003214 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3215 tty_unregister_device(driver, i);
3216 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003217 proc_tty_unregister_driver(driver);
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003218 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC)
3219 cdev_del(&driver->cdevs[0]);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003220 }
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003221 kfree(driver->cdevs);
Jiri Slaby04831dc2012-06-04 13:35:36 +02003222 kfree(driver->ports);
Jiri Slaby16a02082012-08-08 22:26:42 +02003223 kfree(driver->termios);
3224 kfree(driver->ttys);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 kfree(driver);
3226}
3227
Alan Cox7d7b93c2008-10-13 10:42:09 +01003228void tty_driver_kref_put(struct tty_driver *driver)
3229{
3230 kref_put(&driver->kref, destruct_tty_driver);
3231}
3232EXPORT_SYMBOL(tty_driver_kref_put);
3233
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003234void tty_set_operations(struct tty_driver *driver,
3235 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236{
Alan Coxf34d7a52008-04-30 00:54:13 -07003237 driver->ops = op;
3238};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003239EXPORT_SYMBOL(tty_set_operations);
3240
Alan Cox7d7b93c2008-10-13 10:42:09 +01003241void put_tty_driver(struct tty_driver *d)
3242{
3243 tty_driver_kref_put(d);
3244}
3245EXPORT_SYMBOL(put_tty_driver);
3246
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247/*
3248 * Called by a tty driver to register itself.
3249 */
3250int tty_register_driver(struct tty_driver *driver)
3251{
3252 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003253 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254 dev_t dev;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003255 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256
Linus Torvalds1da177e2005-04-16 15:20:36 -07003257 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003258 error = alloc_chrdev_region(&dev, driver->minor_start,
3259 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003260 if (!error) {
3261 driver->major = MAJOR(dev);
3262 driver->minor_start = MINOR(dev);
3263 }
3264 } else {
3265 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003266 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003267 }
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003268 if (error < 0)
Jiri Slaby16a02082012-08-08 22:26:42 +02003269 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003270
Jiri Slaby7e73eca2012-08-08 22:26:44 +02003271 if (driver->flags & TTY_DRIVER_DYNAMIC_ALLOC) {
3272 error = tty_cdev_add(driver, dev, 0, driver->num);
3273 if (error)
3274 goto err_unreg_char;
3275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003276
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003277 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003279 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003280
3281 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003282 for (i = 0; i < driver->num; i++) {
3283 d = tty_register_device(driver, i, NULL);
3284 if (IS_ERR(d)) {
3285 error = PTR_ERR(d);
Jiri Slaby16a02082012-08-08 22:26:42 +02003286 goto err_unreg_devs;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003287 }
3288 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 }
3290 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003291 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003293
Jiri Slaby16a02082012-08-08 22:26:42 +02003294err_unreg_devs:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003295 for (i--; i >= 0; i--)
3296 tty_unregister_device(driver, i);
3297
3298 mutex_lock(&tty_mutex);
3299 list_del(&driver->tty_drivers);
3300 mutex_unlock(&tty_mutex);
3301
Jiri Slaby9bb8a3d2012-06-04 13:35:35 +02003302err_unreg_char:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003303 unregister_chrdev_region(dev, driver->num);
Jiri Slaby16a02082012-08-08 22:26:42 +02003304err:
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003305 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003307EXPORT_SYMBOL(tty_register_driver);
3308
3309/*
3310 * Called by a tty driver to unregister itself.
3311 */
3312int tty_unregister_driver(struct tty_driver *driver)
3313{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003314#if 0
3315 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003316 if (driver->refcount)
3317 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003318#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003319 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3320 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003321 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003322 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003323 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003324 return 0;
3325}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003326
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327EXPORT_SYMBOL(tty_unregister_driver);
3328
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003329dev_t tty_devnum(struct tty_struct *tty)
3330{
3331 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3332}
3333EXPORT_SYMBOL(tty_devnum);
3334
3335void proc_clear_tty(struct task_struct *p)
3336{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003337 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003338 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003339 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003340 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003341 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003342 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003343 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003344}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003345
Alan Cox47f86832008-04-30 00:53:30 -07003346/* Called under the sighand lock */
3347
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003348static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003349{
3350 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003351 unsigned long flags;
3352 /* We should not have a session or pgrp to put here but.... */
3353 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003354 put_pid(tty->session);
3355 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003356 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003357 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3358 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003359 if (tsk->signal->tty) {
3360 printk(KERN_DEBUG "tty not NULL!!\n");
3361 tty_kref_put(tsk->signal->tty);
3362 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003363 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003364 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003365 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003366 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003367}
3368
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003369static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003370{
3371 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003372 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003373 spin_unlock_irq(&tsk->sighand->siglock);
3374}
3375
3376struct tty_struct *get_current_tty(void)
3377{
3378 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003379 unsigned long flags;
3380
3381 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003382 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003383 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003384 return tty;
3385}
Heiko Carstensa311f742006-12-13 00:33:41 -08003386EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003387
Alan Coxd81ed102008-10-13 10:41:42 +01003388void tty_default_fops(struct file_operations *fops)
3389{
3390 *fops = tty_fops;
3391}
3392
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393/*
3394 * Initialize the console device. This is called *early*, so
3395 * we can't necessarily depend on lots of kernel help here.
3396 * Just do some early initializations, and do the complex setup
3397 * later.
3398 */
3399void __init console_init(void)
3400{
3401 initcall_t *call;
3402
3403 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003404 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003405
3406 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003407 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003408 * inform about problems etc..
3409 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003410 call = __con_initcall_start;
3411 while (call < __con_initcall_end) {
3412 (*call)();
3413 call++;
3414 }
3415}
3416
Al Viro2c9ede52011-07-23 20:24:48 -04003417static char *tty_devnode(struct device *dev, umode_t *mode)
Kay Sieverse454cea2009-09-18 23:01:12 +02003418{
3419 if (!mode)
3420 return NULL;
3421 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3422 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3423 *mode = 0666;
3424 return NULL;
3425}
3426
Linus Torvalds1da177e2005-04-16 15:20:36 -07003427static int __init tty_class_init(void)
3428{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003429 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003430 if (IS_ERR(tty_class))
3431 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003432 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003433 return 0;
3434}
3435
3436postcore_initcall(tty_class_init);
3437
3438/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003439static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003440
Kay Sieversfbc92a32010-12-01 18:51:05 +01003441static ssize_t show_cons_active(struct device *dev,
3442 struct device_attribute *attr, char *buf)
3443{
3444 struct console *cs[16];
3445 int i = 0;
3446 struct console *c;
3447 ssize_t count = 0;
3448
Torben Hohnac751ef2011-01-25 15:07:35 -08003449 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003450 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003451 if (!c->device)
3452 continue;
3453 if (!c->write)
3454 continue;
3455 if ((c->flags & CON_ENABLED) == 0)
3456 continue;
3457 cs[i++] = c;
3458 if (i >= ARRAY_SIZE(cs))
3459 break;
3460 }
3461 while (i--)
3462 count += sprintf(buf + count, "%s%d%c",
3463 cs[i]->name, cs[i]->index, i ? ' ':'\n');
Torben Hohnac751ef2011-01-25 15:07:35 -08003464 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003465
3466 return count;
3467}
3468static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3469
3470static struct device *consdev;
3471
3472void console_sysfs_notify(void)
3473{
3474 if (consdev)
3475 sysfs_notify(&consdev->kobj, NULL, "active");
3476}
3477
Linus Torvalds1da177e2005-04-16 15:20:36 -07003478/*
3479 * Ok, now we can initialize the rest of the tty devices and can count
3480 * on memory allocations, interrupts etc..
3481 */
David Howells31d1d482010-08-06 16:34:43 +01003482int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483{
3484 cdev_init(&tty_cdev, &tty_fops);
3485 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3486 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3487 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003488 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489
3490 cdev_init(&console_cdev, &console_fops);
3491 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3492 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3493 panic("Couldn't register /dev/console driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003494 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003495 "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003496 if (IS_ERR(consdev))
3497 consdev = NULL;
3498 else
Kay Sieversa2a6a822011-01-09 16:39:14 +01003499 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003502 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503#endif
3504 return 0;
3505}
David Howells31d1d482010-08-06 16:34:43 +01003506