blob: 8ef2d69470ec9379773f2cfc20a5eb976f2e1fa9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/tty_io.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
6
7/*
8 * 'tty_io.c' gives an orthogonal feeling to tty's, be they consoles
9 * or rs-channels. It also implements echoing, cooked mode etc.
10 *
11 * Kill-line thanks to John T Kohl, who also corrected VMIN = VTIME = 0.
12 *
13 * Modified by Theodore Ts'o, 9/14/92, to dynamically allocate the
14 * tty_struct and tty_queue structures. Previously there was an array
15 * of 256 tty_struct's which was statically allocated, and the
16 * tty_queue structures were allocated at boot time. Both are now
17 * dynamically allocated only when the tty is open.
18 *
19 * Also restructured routines so that there is more of a separation
20 * between the high-level tty routines (tty_io.c and tty_ioctl.c) and
21 * the low-level tty routines (serial.c, pty.c, console.c). This
Alan Cox37bdfb02008-02-08 04:18:47 -080022 * makes for cleaner and more compact code. -TYT, 9/17/92
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 *
24 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
25 * which can be dynamically activated and de-activated by the line
26 * discipline handling modules (like SLIP).
27 *
28 * NOTE: pay no attention to the line discipline code (yet); its
29 * interface is still subject to change in this version...
30 * -- TYT, 1/31/92
31 *
32 * Added functionality to the OPOST tty handling. No delays, but all
33 * other bits should be there.
34 * -- Nick Holloway <alfie@dcs.warwick.ac.uk>, 27th May 1993.
35 *
36 * Rewrote canonical mode and added more termios flags.
37 * -- julian@uhunix.uhcc.hawaii.edu (J. Cowley), 13Jan94
38 *
39 * Reorganized FASYNC support so mouse code can share it.
40 * -- ctm@ardi.com, 9Sep95
41 *
42 * New TIOCLINUX variants added.
43 * -- mj@k332.feld.cvut.cz, 19-Nov-95
Alan Cox37bdfb02008-02-08 04:18:47 -080044 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * Restrict vt switching via ioctl()
46 * -- grif@cs.ucr.edu, 5-Dec-95
47 *
48 * Move console and virtual terminal code to more appropriate files,
49 * implement CONFIG_VT and generalize console device interface.
50 * -- Marko Kohtala <Marko.Kohtala@hut.fi>, March 97
51 *
Alan Coxd81ed102008-10-13 10:41:42 +010052 * Rewrote tty_init_dev and tty_release_dev to eliminate races.
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * -- Bill Hawes <whawes@star.net>, June 97
54 *
55 * Added devfs support.
56 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 13-Jan-1998
57 *
58 * Added support for a Unix98-style ptmx device.
59 * -- C. Scott Ananian <cananian@alumni.princeton.edu>, 14-Jan-1998
60 *
61 * Reduced memory usage for older ARM systems
62 * -- Russell King <rmk@arm.linux.org.uk>
63 *
64 * Move do_SAK() into process context. Less stack use in devfs functions.
Alan Cox37bdfb02008-02-08 04:18:47 -080065 * alloc_tty_struct() always uses kmalloc()
66 * -- Andrew Morton <andrewm@uow.edu.eu> 17Mar01
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 */
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include <linux/types.h>
70#include <linux/major.h>
71#include <linux/errno.h>
72#include <linux/signal.h>
73#include <linux/fcntl.h>
74#include <linux/sched.h>
75#include <linux/interrupt.h>
76#include <linux/tty.h>
77#include <linux/tty_driver.h>
78#include <linux/tty_flip.h>
79#include <linux/devpts_fs.h>
80#include <linux/file.h>
Al Viro9f3acc32008-04-24 07:44:08 -040081#include <linux/fdtable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#include <linux/console.h>
83#include <linux/timer.h>
84#include <linux/ctype.h>
85#include <linux/kd.h>
86#include <linux/mm.h>
87#include <linux/string.h>
88#include <linux/slab.h>
89#include <linux/poll.h>
90#include <linux/proc_fs.h>
91#include <linux/init.h>
92#include <linux/module.h>
93#include <linux/smp_lock.h>
94#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#include <linux/wait.h>
96#include <linux/bitops.h>
Domen Puncerb20f3ae2005-06-25 14:58:42 -070097#include <linux/delay.h>
Alan Coxa352def2008-07-16 21:53:12 +010098#include <linux/seq_file.h>
Alan Coxd281da72010-09-16 18:21:24 +010099#include <linux/serial.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Alan Coxa352def2008-07-16 21:53:12 +0100101#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#include <asm/system.h>
103
104#include <linux/kbd_kern.h>
105#include <linux/vt_kern.h>
106#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700109#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111#undef TTY_DEBUG_HANGUP
112
113#define TTY_PARANOIA_CHECK 1
114#define CHECK_TTY_COUNT 1
115
Alan Coxedc6afc2006-12-08 02:38:44 -0800116struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 .c_iflag = ICRNL | IXON,
118 .c_oflag = OPOST | ONLCR,
119 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
120 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
121 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800122 .c_cc = INIT_C_CC,
123 .c_ispeed = 38400,
124 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125};
126
127EXPORT_SYMBOL(tty_std_termios);
128
129/* This list gets poked at by procfs and various bits of boot up code. This
130 could do with some rationalisation such as pulling the tty proc function
131 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800132
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133LIST_HEAD(tty_drivers); /* linked list of tty drivers */
134
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800135/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800137DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700138EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Nick Pigginee2ffa02010-08-18 04:37:35 +1000140/* Spinlock to protect the tty->tty_files list */
141DEFINE_SPINLOCK(tty_files_lock);
142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
144static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800145ssize_t redirected_tty_write(struct file *, const char __user *,
146 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147static unsigned int tty_poll(struct file *, poll_table *);
148static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700149long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700150#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800151static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700152 unsigned long arg);
153#else
154#define tty_compat_ioctl NULL
155#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200156static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800157static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800158static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700159static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700160static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Alan Coxaf9b8972006-08-27 01:24:01 -0700162/**
163 * alloc_tty_struct - allocate a tty object
164 *
165 * Return a new empty tty structure. The data fields have not
166 * been initialized in any way but has been zeroed
167 *
168 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700169 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Alan Coxbf970ee2008-10-13 10:42:39 +0100171struct tty_struct *alloc_tty_struct(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Alan Cox1266b1e2006-09-29 02:00:40 -0700173 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174}
175
Alan Coxaf9b8972006-08-27 01:24:01 -0700176/**
177 * free_tty_struct - free a disused tty
178 * @tty: tty struct to free
179 *
180 * Free the write buffers, tty queue and tty memory itself.
181 *
182 * Locking: none. Must be called after tty is definitely unused
183 */
184
Alan Coxbf970ee2008-10-13 10:42:39 +0100185void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186{
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400187 if (tty->dev)
188 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800190 tty_buffer_free_all(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 kfree(tty);
192}
193
Nick Piggind996b622010-08-18 04:37:36 +1000194static inline struct tty_struct *file_tty(struct file *file)
195{
196 return ((struct tty_file_private *)file->private_data)->tty;
197}
198
199/* Associate a new file with the tty structure */
Pekka Enbergf573bd12010-08-24 07:48:34 +0300200int tty_add_file(struct tty_struct *tty, struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000201{
202 struct tty_file_private *priv;
203
Pekka Enbergf573bd12010-08-24 07:48:34 +0300204 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
205 if (!priv)
206 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000207
208 priv->tty = tty;
209 priv->file = file;
210 file->private_data = priv;
211
212 spin_lock(&tty_files_lock);
213 list_add(&priv->list, &tty->tty_files);
214 spin_unlock(&tty_files_lock);
Pekka Enbergf573bd12010-08-24 07:48:34 +0300215
216 return 0;
Nick Piggind996b622010-08-18 04:37:36 +1000217}
218
219/* Delete file from its tty */
220void tty_del_file(struct file *file)
221{
222 struct tty_file_private *priv = file->private_data;
223
224 spin_lock(&tty_files_lock);
225 list_del(&priv->list);
226 spin_unlock(&tty_files_lock);
227 file->private_data = NULL;
228 kfree(priv);
229}
230
231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
233
Alan Coxaf9b8972006-08-27 01:24:01 -0700234/**
235 * tty_name - return tty naming
236 * @tty: tty structure
237 * @buf: buffer for output
238 *
239 * Convert a tty structure into a name. The name reflects the kernel
240 * naming policy and if udev is in use may not reflect user space
241 *
242 * Locking: none
243 */
244
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245char *tty_name(struct tty_struct *tty, char *buf)
246{
247 if (!tty) /* Hmm. NULL pointer. That's fun. */
248 strcpy(buf, "NULL tty");
249 else
250 strcpy(buf, tty->name);
251 return buf;
252}
253
254EXPORT_SYMBOL(tty_name);
255
Andrew Mortond769a662005-05-05 16:15:50 -0700256int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 const char *routine)
258{
259#ifdef TTY_PARANOIA_CHECK
260 if (!tty) {
261 printk(KERN_WARNING
262 "null TTY for (%d:%d) in %s\n",
263 imajor(inode), iminor(inode), routine);
264 return 1;
265 }
266 if (tty->magic != TTY_MAGIC) {
267 printk(KERN_WARNING
268 "bad magic number for tty struct (%d:%d) in %s\n",
269 imajor(inode), iminor(inode), routine);
270 return 1;
271 }
272#endif
273 return 0;
274}
275
276static int check_tty_count(struct tty_struct *tty, const char *routine)
277{
278#ifdef CHECK_TTY_COUNT
279 struct list_head *p;
280 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800281
Nick Pigginee2ffa02010-08-18 04:37:35 +1000282 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 list_for_each(p, &tty->tty_files) {
284 count++;
285 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000286 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
288 tty->driver->subtype == PTY_TYPE_SLAVE &&
289 tty->link && tty->link->count)
290 count++;
291 if (tty->count != count) {
292 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
293 "!= #fd's(%d) in %s\n",
294 tty->name, tty->count, count, routine);
295 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800296 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297#endif
298 return 0;
299}
300
Alan Coxaf9b8972006-08-27 01:24:01 -0700301/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700302 * get_tty_driver - find device of a tty
303 * @dev_t: device identifier
304 * @index: returns the index of the tty
305 *
306 * This routine returns a tty driver structure, given a device number
307 * and also passes back the index number.
308 *
309 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312static struct tty_driver *get_tty_driver(dev_t device, int *index)
313{
314 struct tty_driver *p;
315
316 list_for_each_entry(p, &tty_drivers, tty_drivers) {
317 dev_t base = MKDEV(p->major, p->minor_start);
318 if (device < base || device >= base + p->num)
319 continue;
320 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100321 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 }
323 return NULL;
324}
325
Jason Wesself2d937f2008-04-17 20:05:37 +0200326#ifdef CONFIG_CONSOLE_POLL
327
328/**
329 * tty_find_polling_driver - find device of a polled tty
330 * @name: name string to match
331 * @line: pointer to resulting tty line nr
332 *
333 * This routine returns a tty driver structure, given a name
334 * and the condition that the tty driver is capable of polled
335 * operation.
336 */
337struct tty_driver *tty_find_polling_driver(char *name, int *line)
338{
339 struct tty_driver *p, *res = NULL;
340 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500341 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100342 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200343
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500344 for (str = name; *str; str++)
345 if ((*str >= '0' && *str <= '9') || *str == ',')
346 break;
347 if (!*str)
348 return NULL;
349
350 len = str - name;
351 tty_line = simple_strtoul(str, &str, 10);
352
Jason Wesself2d937f2008-04-17 20:05:37 +0200353 mutex_lock(&tty_mutex);
354 /* Search through the tty devices to look for a match */
355 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500356 if (strncmp(name, p->name, len) != 0)
357 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100358 stp = str;
359 if (*stp == ',')
360 stp++;
361 if (*stp == '\0')
362 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200363
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200364 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100365 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100366 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200367 *line = tty_line;
368 break;
369 }
370 }
371 mutex_unlock(&tty_mutex);
372
373 return res;
374}
375EXPORT_SYMBOL_GPL(tty_find_polling_driver);
376#endif
377
Alan Coxaf9b8972006-08-27 01:24:01 -0700378/**
379 * tty_check_change - check for POSIX terminal changes
380 * @tty: tty to check
381 *
382 * If we try to write to, or set the state of, a terminal and we're
383 * not in the foreground, send a SIGTTOU. If the signal is blocked or
384 * ignored, go ahead and perform the operation. (POSIX 7.2)
385 *
Alan Cox978e5952008-04-30 00:53:59 -0700386 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700388
Alan Cox37bdfb02008-02-08 04:18:47 -0800389int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390{
Alan Cox47f86832008-04-30 00:53:30 -0700391 unsigned long flags;
392 int ret = 0;
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 if (current->signal->tty != tty)
395 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700396
397 spin_lock_irqsave(&tty->ctrl_lock, flags);
398
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800399 if (!tty->pgrp) {
400 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700401 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800403 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700404 goto out_unlock;
405 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700407 goto out;
408 if (is_current_pgrp_orphaned()) {
409 ret = -EIO;
410 goto out;
411 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700412 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
413 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700414 ret = -ERESTARTSYS;
415out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700416 return ret;
417out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700418 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
419 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421
422EXPORT_SYMBOL(tty_check_change);
423
Alan Cox37bdfb02008-02-08 04:18:47 -0800424static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 size_t count, loff_t *ppos)
426{
427 return 0;
428}
429
Alan Cox37bdfb02008-02-08 04:18:47 -0800430static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 size_t count, loff_t *ppos)
432{
433 return -EIO;
434}
435
436/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800437static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
439 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
440}
441
Alan Cox04f378b2008-04-30 00:53:29 -0700442static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
443 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700444{
445 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
446}
447
Alan Cox37bdfb02008-02-08 04:18:47 -0800448static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700449 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
451 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
452}
453
Arjan van de Ven62322d22006-07-03 00:24:21 -0700454static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 .llseek = no_llseek,
456 .read = tty_read,
457 .write = tty_write,
458 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700459 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700460 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 .open = tty_open,
462 .release = tty_release,
463 .fasync = tty_fasync,
464};
465
Arjan van de Ven62322d22006-07-03 00:24:21 -0700466static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 .llseek = no_llseek,
468 .read = tty_read,
469 .write = redirected_tty_write,
470 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700471 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700472 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 .open = tty_open,
474 .release = tty_release,
475 .fasync = tty_fasync,
476};
477
Arjan van de Ven62322d22006-07-03 00:24:21 -0700478static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 .llseek = no_llseek,
480 .read = hung_up_tty_read,
481 .write = hung_up_tty_write,
482 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700483 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700484 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 .release = tty_release,
486};
487
488static DEFINE_SPINLOCK(redirect_lock);
489static struct file *redirect;
490
491/**
492 * tty_wakeup - request more data
493 * @tty: terminal
494 *
495 * Internal and external helper for wakeups of tty. This function
496 * informs the line discipline if present that the driver is ready
497 * to receive more output data.
498 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800499
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500void tty_wakeup(struct tty_struct *tty)
501{
502 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
505 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800506 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100507 if (ld->ops->write_wakeup)
508 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 tty_ldisc_deref(ld);
510 }
511 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700512 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513}
514
515EXPORT_SYMBOL_GPL(tty_wakeup);
516
517/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200518 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000519 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700520 *
Alan Cox1bad8792008-07-22 23:38:04 +0100521 * This can be called by the "eventd" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700522 * synchronous but doesn't hold any locks, so we need to make sure we
523 * have the appropriate locks for what we're doing.
524 *
525 * The hangup event clears any pending redirections onto the hung up
526 * device. It ensures future writes will error and it does the needed
527 * line discipline hangup and signal delivery. The tty object itself
528 * remains intact.
529 *
530 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200531 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800532 * redirect lock for undoing redirection
533 * file list lock for manipulating list of ttys
534 * tty_ldisc_lock from called functions
535 * termios_mutex resetting termios data
536 * tasklist_lock to walk task list for hangup event
537 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200539void __tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
Alan Cox37bdfb02008-02-08 04:18:47 -0800541 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 struct file *filp, *f = NULL;
543 struct task_struct *p;
Nick Piggind996b622010-08-18 04:37:36 +1000544 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700546 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100547 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549 if (!tty)
550 return;
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000554 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 f = redirect;
556 redirect = NULL;
557 }
558 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800559
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200560 tty_lock();
561
Jiri Slabyacfa7472010-11-29 10:16:54 +0100562 /* some functions below drop BTM, so we need this bit */
563 set_bit(TTY_HUPPING, &tty->flags);
564
Arnd Bergmannec79d602010-06-01 22:53:01 +0200565 /* inuse_filps is protected by the single tty lock,
566 this really needs to change if we want to flush the
567 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200568 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000569
Nick Pigginee2ffa02010-08-18 04:37:35 +1000570 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000572 list_for_each_entry(priv, &tty->tty_files, list) {
573 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (filp->f_op->write == redirected_tty_write)
575 cons_filp = filp;
576 if (filp->f_op->write != tty_write)
577 continue;
578 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200579 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 filp->f_op = &hung_up_tty_fops;
581 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000582 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800583
Jiri Slabyacfa7472010-11-29 10:16:54 +0100584 /*
585 * it drops BTM and thus races with reopen
586 * we protect the race by TTY_HUPPING
587 */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100588 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800591 if (tty->session) {
592 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800593 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100594 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100596 /* We defer the dereferences outside fo
597 the tasklist lock */
598 refs++;
599 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800600 if (!p->signal->leader) {
601 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800603 }
604 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
605 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800606 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700607 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800608 if (tty->pgrp)
609 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700610 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800611 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800612 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 }
614 read_unlock(&tasklist_lock);
615
Alan Cox47f86832008-04-30 00:53:30 -0700616 spin_lock_irqsave(&tty->ctrl_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100617 clear_bit(TTY_THROTTLED, &tty->flags);
618 clear_bit(TTY_PUSH, &tty->flags);
619 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600620 put_pid(tty->session);
621 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800622 tty->session = NULL;
623 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 tty->ctrl_status = 0;
Alan Cox47f86832008-04-30 00:53:30 -0700625 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
626
Alan Cox9c9f4de2008-10-13 10:37:26 +0100627 /* Account for the p->signal references we killed */
628 while (refs--)
629 tty_kref_put(tty);
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800632 * If one of the devices matches a console pointer, we
633 * cannot just call hangup() because that will cause
634 * tty->count and state->count to go out of sync.
635 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 */
637 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700638 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700640 tty->ops->close(tty, cons_filp);
641 } else if (tty->ops->hangup)
642 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800643 /*
644 * We don't want to have driver/ldisc interactions beyond
645 * the ones we did here. The driver layer expects no
646 * calls after ->hangup() from the ldisc side. However we
647 * can't yet guarantee all that.
648 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 set_bit(TTY_HUPPED, &tty->flags);
Jiri Slabyacfa7472010-11-29 10:16:54 +0100650 clear_bit(TTY_HUPPING, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100651 tty_ldisc_enable(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200652
653 tty_unlock();
654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (f)
656 fput(f);
657}
658
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200659static void do_tty_hangup(struct work_struct *work)
660{
661 struct tty_struct *tty =
662 container_of(work, struct tty_struct, hangup_work);
663
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200664 __tty_hangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200665}
666
Alan Coxaf9b8972006-08-27 01:24:01 -0700667/**
668 * tty_hangup - trigger a hangup event
669 * @tty: tty to hangup
670 *
671 * A carrier loss (virtual or otherwise) has occurred on this like
672 * schedule a hangup sequence to run after this event.
673 */
674
Alan Cox37bdfb02008-02-08 04:18:47 -0800675void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676{
677#ifdef TTY_DEBUG_HANGUP
678 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
680#endif
681 schedule_work(&tty->hangup_work);
682}
683
684EXPORT_SYMBOL(tty_hangup);
685
Alan Coxaf9b8972006-08-27 01:24:01 -0700686/**
687 * tty_vhangup - process vhangup
688 * @tty: tty to hangup
689 *
690 * The user has asked via system call for the terminal to be hung up.
691 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200692 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700693 */
694
Alan Cox37bdfb02008-02-08 04:18:47 -0800695void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696{
697#ifdef TTY_DEBUG_HANGUP
698 char buf[64];
699
700 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
701#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200702 __tty_hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703}
Alan Cox37bdfb02008-02-08 04:18:47 -0800704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705EXPORT_SYMBOL(tty_vhangup);
706
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200707
Alan Coxaf9b8972006-08-27 01:24:01 -0700708/**
Alan Cox2cb59982008-10-13 10:40:30 +0100709 * tty_vhangup_self - process vhangup for own ctty
710 *
711 * Perform a vhangup on the current controlling tty
712 */
713
714void tty_vhangup_self(void)
715{
716 struct tty_struct *tty;
717
Alan Cox2cb59982008-10-13 10:40:30 +0100718 tty = get_current_tty();
719 if (tty) {
720 tty_vhangup(tty);
721 tty_kref_put(tty);
722 }
Alan Cox2cb59982008-10-13 10:40:30 +0100723}
724
725/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700726 * tty_hung_up_p - was tty hung up
727 * @filp: file pointer of tty
728 *
729 * Return true if the tty has been subject to a vhangup or a carrier
730 * loss
731 */
732
Alan Cox37bdfb02008-02-08 04:18:47 -0800733int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
735 return (filp->f_op == &hung_up_tty_fops);
736}
737
738EXPORT_SYMBOL(tty_hung_up_p);
739
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800740static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800741{
742 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800743 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800744 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800745 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800746}
747
Alan Coxaf9b8972006-08-27 01:24:01 -0700748/**
749 * disassociate_ctty - disconnect controlling tty
750 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700752 * This function is typically called only by the session leader, when
753 * it wants to disassociate itself from its controlling tty.
754 *
755 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
757 * (2) Clears the tty from being controlling the session
758 * (3) Clears the controlling tty for all processes in the
759 * session group.
760 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700761 * The argument on_exit is set to 1 if called when a process is
762 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
763 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800764 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200765 * BTM is taken for hysterical raisins, and held when
766 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800767 * tty_mutex is taken to protect tty
768 * ->siglock is taken to protect ->signal/->sighand
769 * tasklist_lock is taken to walk process list for sessions
770 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700772
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773void disassociate_ctty(int on_exit)
774{
775 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800776 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Alan Cox5ec93d12009-11-30 13:18:45 +0000778 if (!current->signal->leader)
779 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800781 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800783 tty_pgrp = get_pid(tty->pgrp);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200784 if (on_exit) {
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200785 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200786 tty_vhangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200787 }
Alan Cox452a00d2008-10-13 10:39:13 +0100788 tty_kref_put(tty);
Eric W. Biederman680a9672007-02-12 00:52:52 -0800789 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800790 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800791 spin_lock_irq(&current->sighand->siglock);
792 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800793 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800794 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800795 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800796 kill_pgrp(old_pgrp, SIGHUP, on_exit);
797 kill_pgrp(old_pgrp, SIGCONT, on_exit);
798 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 return;
801 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800802 if (tty_pgrp) {
803 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800805 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
806 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 }
808
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800809 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700810 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800811 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800812 spin_unlock_irq(&current->sighand->siglock);
813
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800814 tty = get_current_tty();
815 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700816 unsigned long flags;
817 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800818 put_pid(tty->session);
819 put_pid(tty->pgrp);
820 tty->session = NULL;
821 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700822 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100823 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800824 } else {
825#ifdef TTY_DEBUG_HANGUP
826 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
827 " = NULL", tty);
828#endif
829 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
831 /* Now clear signal->tty under the lock */
832 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800833 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700837/**
838 *
839 * no_tty - Ensure the current process does not have a controlling tty
840 */
841void no_tty(void)
842{
843 struct task_struct *tsk = current;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200844 tty_lock();
Alan Cox5ec93d12009-11-30 13:18:45 +0000845 disassociate_ctty(0);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200846 tty_unlock();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700847 proc_clear_tty(tsk);
848}
849
Alan Coxaf9b8972006-08-27 01:24:01 -0700850
851/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200852 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700853 * @tty: tty to stop
854 *
855 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200856 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700857 * on an already stopped device and will not re-call the driver
858 * method.
859 *
860 * This functionality is used by both the line disciplines for
861 * halting incoming flow and by the driver. It may therefore be
862 * called from any context, may be under the tty atomic_write_lock
863 * but not always.
864 *
865 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700866 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700867 */
868
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869void stop_tty(struct tty_struct *tty)
870{
Alan Cox04f378b2008-04-30 00:53:29 -0700871 unsigned long flags;
872 spin_lock_irqsave(&tty->ctrl_lock, flags);
873 if (tty->stopped) {
874 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700876 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 tty->stopped = 1;
878 if (tty->link && tty->link->packet) {
879 tty->ctrl_status &= ~TIOCPKT_START;
880 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700881 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 }
Alan Cox04f378b2008-04-30 00:53:29 -0700883 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700884 if (tty->ops->stop)
885 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886}
887
888EXPORT_SYMBOL(stop_tty);
889
Alan Coxaf9b8972006-08-27 01:24:01 -0700890/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200891 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700892 * @tty: tty to start
893 *
894 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200895 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700896 * is the tty was previous stopped and is being started then the
897 * driver start method is invoked and the line discipline woken.
898 *
899 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700900 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700901 */
902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903void start_tty(struct tty_struct *tty)
904{
Alan Cox04f378b2008-04-30 00:53:29 -0700905 unsigned long flags;
906 spin_lock_irqsave(&tty->ctrl_lock, flags);
907 if (!tty->stopped || tty->flow_stopped) {
908 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700910 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 tty->stopped = 0;
912 if (tty->link && tty->link->packet) {
913 tty->ctrl_status &= ~TIOCPKT_STOP;
914 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700915 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 }
Alan Cox04f378b2008-04-30 00:53:29 -0700917 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700918 if (tty->ops->start)
919 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 /* If we have a running line discipline it may need kicking */
921 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922}
923
924EXPORT_SYMBOL(start_tty);
925
Alan Coxaf9b8972006-08-27 01:24:01 -0700926/**
927 * tty_read - read method for tty device files
928 * @file: pointer to tty file
929 * @buf: user buffer
930 * @count: size of user buffer
931 * @ppos: unused
932 *
933 * Perform the read system call function on this terminal device. Checks
934 * for hung up devices before calling the line discipline method.
935 *
936 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700937 * Locks the line discipline internally while needed. Multiple
938 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700939 */
940
Alan Cox37bdfb02008-02-08 04:18:47 -0800941static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 loff_t *ppos)
943{
944 int i;
Nick Piggind996b622010-08-18 04:37:36 +1000945 struct inode *inode = file->f_path.dentry->d_inode;
946 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 struct tty_ldisc *ld;
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 if (tty_paranoia_check(tty, inode, "tty_read"))
950 return -EIO;
951 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
952 return -EIO;
953
954 /* We want to wait for the line discipline to sort out in this
955 situation */
956 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100957 if (ld->ops->read)
958 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 else
960 i = -EIO;
961 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 if (i > 0)
963 inode->i_atime = current_fs_time(inode->i_sb);
964 return i;
965}
966
Alan Cox9c1729d2007-07-15 23:39:43 -0700967void tty_write_unlock(struct tty_struct *tty)
968{
969 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700970 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -0700971}
972
973int tty_write_lock(struct tty_struct *tty, int ndelay)
974{
975 if (!mutex_trylock(&tty->atomic_write_lock)) {
976 if (ndelay)
977 return -EAGAIN;
978 if (mutex_lock_interruptible(&tty->atomic_write_lock))
979 return -ERESTARTSYS;
980 }
981 return 0;
982}
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984/*
985 * Split writes up in sane blocksizes to avoid
986 * denial-of-service type attacks
987 */
988static inline ssize_t do_tty_write(
989 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
990 struct tty_struct *tty,
991 struct file *file,
992 const char __user *buf,
993 size_t count)
994{
Alan Cox9c1729d2007-07-15 23:39:43 -0700995 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -0800997
Alan Cox9c1729d2007-07-15 23:39:43 -0700998 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
999 if (ret < 0)
1000 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
1002 /*
1003 * We chunk up writes into a temporary buffer. This
1004 * simplifies low-level drivers immensely, since they
1005 * don't have locking issues and user mode accesses.
1006 *
1007 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1008 * big chunk-size..
1009 *
1010 * The default chunk-size is 2kB, because the NTTY
1011 * layer has problems with bigger chunks. It will
1012 * claim to be able to handle more characters than
1013 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001014 *
1015 * FIXME: This can probably go away now except that 64K chunks
1016 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 */
1018 chunk = 2048;
1019 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1020 chunk = 65536;
1021 if (count < chunk)
1022 chunk = count;
1023
Ingo Molnar70522e12006-03-23 03:00:31 -08001024 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001026 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
1028 if (chunk < 1024)
1029 chunk = 1024;
1030
Jason Wessel402fda92008-10-13 10:45:36 +01001031 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1032 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001033 ret = -ENOMEM;
1034 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 }
1036 kfree(tty->write_buf);
1037 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001038 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 }
1040
1041 /* Do the write .. */
1042 for (;;) {
1043 size_t size = count;
1044 if (size > chunk)
1045 size = chunk;
1046 ret = -EFAULT;
1047 if (copy_from_user(tty->write_buf, buf, size))
1048 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 if (ret <= 0)
1051 break;
1052 written += ret;
1053 buf += ret;
1054 count -= ret;
1055 if (!count)
1056 break;
1057 ret = -ERESTARTSYS;
1058 if (signal_pending(current))
1059 break;
1060 cond_resched();
1061 }
1062 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001063 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 inode->i_mtime = current_fs_time(inode->i_sb);
1065 ret = written;
1066 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001067out:
1068 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 return ret;
1070}
1071
Alan Cox95f9bfc2008-10-13 10:39:23 +01001072/**
1073 * tty_write_message - write a message to a certain tty, not just the console.
1074 * @tty: the destination tty_struct
1075 * @msg: the message to write
1076 *
1077 * This is used for messages that need to be redirected to a specific tty.
1078 * We don't put it into the syslog queue right now maybe in the future if
1079 * really needed.
1080 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001081 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001082 */
1083
1084void tty_write_message(struct tty_struct *tty, char *msg)
1085{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001086 if (tty) {
1087 mutex_lock(&tty->atomic_write_lock);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001088 tty_lock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001089 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001090 tty_unlock();
Alan Cox95f9bfc2008-10-13 10:39:23 +01001091 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001092 } else
Arnd Bergmannec79d602010-06-01 22:53:01 +02001093 tty_unlock();
Alan Cox95f9bfc2008-10-13 10:39:23 +01001094 tty_write_unlock(tty);
1095 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001096 return;
1097}
1098
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Alan Coxaf9b8972006-08-27 01:24:01 -07001100/**
1101 * tty_write - write method for tty device file
1102 * @file: tty file pointer
1103 * @buf: user data to write
1104 * @count: bytes to write
1105 * @ppos: unused
1106 *
1107 * Write data to a tty device via the line discipline.
1108 *
1109 * Locking:
1110 * Locks the line discipline as required
1111 * Writes to the tty driver are serialized by the atomic_write_lock
1112 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001113 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001114 */
1115
Alan Cox37bdfb02008-02-08 04:18:47 -08001116static ssize_t tty_write(struct file *file, const char __user *buf,
1117 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118{
Josef Sipeka7113a92006-12-08 02:36:55 -08001119 struct inode *inode = file->f_path.dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10001120 struct tty_struct *tty = file_tty(file);
1121 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001123
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 if (tty_paranoia_check(tty, inode, "tty_write"))
1125 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001126 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001127 (test_bit(TTY_IO_ERROR, &tty->flags)))
1128 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001129 /* Short term debug to catch buggy drivers */
1130 if (tty->ops->write_room == NULL)
1131 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1132 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001133 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001134 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 ret = -EIO;
1136 else
Alan Coxa352def2008-07-16 21:53:12 +01001137 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 tty_ldisc_deref(ld);
1139 return ret;
1140}
1141
Alan Cox37bdfb02008-02-08 04:18:47 -08001142ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1143 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144{
1145 struct file *p = NULL;
1146
1147 spin_lock(&redirect_lock);
1148 if (redirect) {
1149 get_file(redirect);
1150 p = redirect;
1151 }
1152 spin_unlock(&redirect_lock);
1153
1154 if (p) {
1155 ssize_t res;
1156 res = vfs_write(p, buf, count, &p->f_pos);
1157 fput(p);
1158 return res;
1159 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 return tty_write(file, buf, count, ppos);
1161}
1162
1163static char ptychar[] = "pqrstuvwxyzabcde";
1164
Alan Coxaf9b8972006-08-27 01:24:01 -07001165/**
1166 * pty_line_name - generate name for a pty
1167 * @driver: the tty driver in use
1168 * @index: the minor number
1169 * @p: output buffer of at least 6 bytes
1170 *
1171 * Generate a name from a driver reference and write it to the output
1172 * buffer.
1173 *
1174 * Locking: None
1175 */
1176static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177{
1178 int i = index + driver->name_base;
1179 /* ->name is initialized to "ttyp", but "tty" is expected */
1180 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001181 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1182 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183}
1184
Alan Coxaf9b8972006-08-27 01:24:01 -07001185/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001186 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001187 * @driver: the tty driver in use
1188 * @index: the minor number
1189 * @p: output buffer of at least 7 bytes
1190 *
1191 * Generate a name from a driver reference and write it to the output
1192 * buffer.
1193 *
1194 * Locking: None
1195 */
1196static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197{
1198 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1199}
1200
Alan Cox99f1fe12008-10-13 10:42:00 +01001201/**
1202 * tty_driver_lookup_tty() - find an existing tty, if any
1203 * @driver: the driver for the tty
1204 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001205 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001206 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001207 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001208 * Locking: tty_mutex must be held. If tty is found, the mutex must
1209 * be held until the 'fast-open' is also done. Will change once we
1210 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001211 */
Jason Wessela47d5452009-01-02 13:43:04 +00001212static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001213 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001214{
1215 struct tty_struct *tty;
1216
Alan Cox99f1fe12008-10-13 10:42:00 +01001217 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001218 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001219
Alan Cox8b0a88d2008-10-13 10:42:19 +01001220 tty = driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001221 return tty;
1222}
1223
Alan Cox99f1fe12008-10-13 10:42:00 +01001224/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001225 * tty_init_termios - helper for termios setup
1226 * @tty: the tty to set up
1227 *
1228 * Initialise the termios structures for this tty. Thus runs under
1229 * the tty_mutex currently so we can be relaxed about ordering.
1230 */
1231
1232int tty_init_termios(struct tty_struct *tty)
1233{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001234 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001235 int idx = tty->index;
1236
1237 tp = tty->driver->termios[idx];
Alan Coxbf970ee2008-10-13 10:42:39 +01001238 if (tp == NULL) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01001239 tp = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
1240 if (tp == NULL)
Alan Coxbf970ee2008-10-13 10:42:39 +01001241 return -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +01001242 memcpy(tp, &tty->driver->init_termios,
1243 sizeof(struct ktermios));
1244 tty->driver->termios[idx] = tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001245 }
1246 tty->termios = tp;
Alan Coxfe6e29f2008-10-13 10:44:08 +01001247 tty->termios_locked = tp + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +01001248
1249 /* Compatibility until drivers always set this */
1250 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1251 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1252 return 0;
1253}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001254EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001255
1256/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001257 * tty_driver_install_tty() - install a tty entry in the driver
1258 * @driver: the driver for the tty
1259 * @tty: the tty
1260 *
1261 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001262 * will be set by the time this is called. This method is responsible
1263 * for ensuring any need additional structures are allocated and
1264 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001265 *
1266 * Locking: tty_mutex for now
1267 */
1268static int tty_driver_install_tty(struct tty_driver *driver,
1269 struct tty_struct *tty)
1270{
Alan Coxbf970ee2008-10-13 10:42:39 +01001271 int idx = tty->index;
Alan Coxeeb89d92009-11-30 13:18:29 +00001272 int ret;
Alan Coxbf970ee2008-10-13 10:42:39 +01001273
Alan Coxeeb89d92009-11-30 13:18:29 +00001274 if (driver->ops->install) {
Alan Coxeeb89d92009-11-30 13:18:29 +00001275 ret = driver->ops->install(driver, tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001276 return ret;
1277 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001278
1279 if (tty_init_termios(tty) == 0) {
1280 tty_driver_kref_get(driver);
1281 tty->count++;
1282 driver->ttys[idx] = tty;
1283 return 0;
1284 }
1285 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001286}
1287
1288/**
1289 * tty_driver_remove_tty() - remove a tty from the driver tables
1290 * @driver: the driver for the tty
1291 * @idx: the minor number
1292 *
1293 * Remvoe a tty object from the driver tables. The tty->index field
1294 * will be set by the time this is called.
1295 *
1296 * Locking: tty_mutex for now
1297 */
1298static void tty_driver_remove_tty(struct tty_driver *driver,
1299 struct tty_struct *tty)
1300{
1301 if (driver->ops->remove)
1302 driver->ops->remove(driver, tty);
1303 else
1304 driver->ttys[tty->index] = NULL;
1305}
1306
1307/*
1308 * tty_reopen() - fast re-open of an open tty
1309 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001310 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001311 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001312 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001313 * Locking: tty_mutex must be held from the time the tty was found
1314 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001315 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001316static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001317{
1318 struct tty_driver *driver = tty->driver;
1319
Jiri Slabye2efafb2010-11-29 10:16:53 +01001320 if (test_bit(TTY_CLOSING, &tty->flags) ||
Jiri Slabyacfa7472010-11-29 10:16:54 +01001321 test_bit(TTY_HUPPING, &tty->flags) ||
Jiri Slabye2efafb2010-11-29 10:16:53 +01001322 test_bit(TTY_LDISC_CHANGING, &tty->flags))
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001323 return -EIO;
1324
1325 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1326 driver->subtype == PTY_TYPE_MASTER) {
1327 /*
1328 * special case for PTY masters: only one open permitted,
1329 * and the slave side open count is incremented as well.
1330 */
1331 if (tty->count)
1332 return -EIO;
1333
1334 tty->link->count++;
1335 }
1336 tty->count++;
1337 tty->driver = driver; /* N.B. why do this every time?? */
1338
Alan Cox1aa4bed2009-06-16 17:01:33 +01001339 mutex_lock(&tty->ldisc_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +01001340 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Alan Cox1aa4bed2009-06-16 17:01:33 +01001341 mutex_unlock(&tty->ldisc_mutex);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001342
1343 return 0;
1344}
1345
Alan Coxaf9b8972006-08-27 01:24:01 -07001346/**
Alan Coxd81ed102008-10-13 10:41:42 +01001347 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001348 * @driver: tty driver we are opening a device on
1349 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001350 * @ret_tty: returned tty structure
1351 * @first_ok: ok to open a new device (used by ptmx)
Alan Coxaf9b8972006-08-27 01:24:01 -07001352 *
1353 * Prepare a tty device. This may not be a "new" clean device but
1354 * could also be an active device. The pty drivers require special
1355 * handling because of this.
1356 *
1357 * Locking:
1358 * The function is called under the tty_mutex, which
1359 * protects us from the tty struct or driver itself going away.
1360 *
1361 * On exit the tty device has the line discipline attached and
1362 * a reference count of 1. If a pair was created for pty/tty use
1363 * and the other was a pty master then it too has a reference count of 1.
1364 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001366 * failed open. The new code protects the open with a mutex, so it's
1367 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 * relaxed for the (most common) case of reopening a tty.
1369 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001370
Alan Cox73ec06f2008-10-13 10:42:29 +01001371struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
1372 int first_ok)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373{
Alan Coxbf970ee2008-10-13 10:42:39 +01001374 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001375 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001377 /* Check if pty master is being opened multiple times */
Alan Cox15582d32008-10-13 10:41:03 +01001378 if (driver->subtype == PTY_TYPE_MASTER &&
Alan Coxeeb89d92009-11-30 13:18:29 +00001379 (driver->flags & TTY_DRIVER_DEVPTS_MEM) && !first_ok) {
Alan Cox73ec06f2008-10-13 10:42:29 +01001380 return ERR_PTR(-EIO);
Alan Coxeeb89d92009-11-30 13:18:29 +00001381 }
Alan Cox73ec06f2008-10-13 10:42:29 +01001382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 /*
1384 * First time open is complex, especially for PTY devices.
1385 * This code guarantees that either everything succeeds and the
1386 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001387 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 * and locked termios may be retained.)
1389 */
1390
Alan Cox73ec06f2008-10-13 10:42:29 +01001391 if (!try_module_get(driver->owner))
1392 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 tty = alloc_tty_struct();
Alan Cox37bdfb02008-02-08 04:18:47 -08001395 if (!tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 goto fail_no_mem;
Alan Coxbf970ee2008-10-13 10:42:39 +01001397 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
Alan Cox73ec06f2008-10-13 10:42:29 +01001399 retval = tty_driver_install_tty(driver, tty);
Alan Coxbf970ee2008-10-13 10:42:39 +01001400 if (retval < 0) {
1401 free_tty_struct(tty);
1402 module_put(driver->owner);
1403 return ERR_PTR(retval);
1404 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001405
Alan Cox37bdfb02008-02-08 04:18:47 -08001406 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001408 * If we fail here just call release_tty to clean up. No need
1409 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001411 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001412 if (retval)
1413 goto release_mem_out;
Alan Cox73ec06f2008-10-13 10:42:29 +01001414 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416fail_no_mem:
1417 module_put(driver->owner);
Alan Cox73ec06f2008-10-13 10:42:29 +01001418 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001420 /* call the tty release_tty routine to clean out this slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421release_mem_out:
Akinobu Mita40509142006-09-29 02:01:27 -07001422 if (printk_ratelimit())
Alan Coxd81ed102008-10-13 10:41:42 +01001423 printk(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001424 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001425 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001426 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
1428
Alan Coxfeebed62008-10-13 10:41:30 +01001429void tty_free_termios(struct tty_struct *tty)
1430{
1431 struct ktermios *tp;
1432 int idx = tty->index;
1433 /* Kill this flag and push into drivers for locking etc */
1434 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1435 /* FIXME: Locking on ->termios array */
1436 tp = tty->termios;
1437 tty->driver->termios[idx] = NULL;
1438 kfree(tp);
Alan Coxfeebed62008-10-13 10:41:30 +01001439 }
1440}
1441EXPORT_SYMBOL(tty_free_termios);
1442
1443void tty_shutdown(struct tty_struct *tty)
1444{
Alan Cox8b0a88d2008-10-13 10:42:19 +01001445 tty_driver_remove_tty(tty->driver, tty);
Alan Coxfeebed62008-10-13 10:41:30 +01001446 tty_free_termios(tty);
1447}
1448EXPORT_SYMBOL(tty_shutdown);
1449
Alan Coxaf9b8972006-08-27 01:24:01 -07001450/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001451 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001452 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001453 *
1454 * Releases memory associated with a tty structure, and clears out the
1455 * driver table slots. This function is called when a device is no longer
1456 * in use. It also gets called when setup of a device fails.
1457 *
1458 * Locking:
1459 * tty_mutex - sometimes only
1460 * takes the file list lock internally when working on the list
1461 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001462 *
1463 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001464 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 */
Alan Coxb50989d2009-09-19 13:13:22 -07001466static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467{
Alan Coxb50989d2009-09-19 13:13:22 -07001468 struct tty_struct *tty =
1469 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001470 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Dave Youngf278a2f2009-09-27 16:00:42 +00001472 if (tty->ops->cleanup)
1473 tty->ops->cleanup(tty);
1474
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001476 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001477 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001478
Nick Pigginee2ffa02010-08-18 04:37:35 +10001479 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001481 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001482
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001483 put_pid(tty->pgrp);
1484 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 free_tty_struct(tty);
1486}
1487
Alan Coxb50989d2009-09-19 13:13:22 -07001488static void queue_release_one_tty(struct kref *kref)
1489{
1490 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001491
1492 if (tty->ops->shutdown)
1493 tty->ops->shutdown(tty);
1494 else
1495 tty_shutdown(tty);
1496
Alan Coxb50989d2009-09-19 13:13:22 -07001497 /* The hangup queue is now free so we can reuse it rather than
1498 waste a chunk of memory for each port */
1499 INIT_WORK(&tty->hangup_work, release_one_tty);
1500 schedule_work(&tty->hangup_work);
1501}
1502
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001503/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001504 * tty_kref_put - release a tty kref
1505 * @tty: tty device
1506 *
1507 * Release a reference to a tty device and if need be let the kref
1508 * layer destruct the object for us
1509 */
1510
1511void tty_kref_put(struct tty_struct *tty)
1512{
1513 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001514 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001515}
1516EXPORT_SYMBOL(tty_kref_put);
1517
1518/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001519 * release_tty - release tty structure memory
1520 *
1521 * Release both @tty and a possible linked partner (think pty pair),
1522 * and decrement the refcount of the backing module.
1523 *
1524 * Locking:
1525 * tty_mutex - sometimes only
1526 * takes the file list lock internally when working on the list
1527 * of ttys that the driver keeps.
1528 * FIXME: should we require tty_mutex is held here ??
Alan Cox9c9f4de2008-10-13 10:37:26 +01001529 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001530 */
1531static void release_tty(struct tty_struct *tty, int idx)
1532{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001533 /* This should always be true but check for the moment */
1534 WARN_ON(tty->index != idx);
1535
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001536 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001537 tty_kref_put(tty->link);
1538 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001539}
1540
Alan Coxeeb89d92009-11-30 13:18:29 +00001541/**
1542 * tty_release - vfs callback for close
1543 * @inode: inode of tty
1544 * @filp: file pointer for handle to tty
1545 *
1546 * Called the last time each file handle is closed that references
1547 * this tty. There may however be several such references.
1548 *
1549 * Locking:
1550 * Takes bkl. See tty_release_dev
1551 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 * Even releasing the tty structures is a tricky business.. We have
1553 * to be very careful that the structures are all released at the
1554 * same time, as interrupts might otherwise get the wrong pointers.
1555 *
1556 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1557 * lead to double frees or releasing memory still in use.
1558 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001559
1560int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561{
Nick Piggind996b622010-08-18 04:37:36 +10001562 struct tty_struct *tty = file_tty(filp);
1563 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07001565 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 int idx;
1567 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001568
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001569 if (tty_paranoia_check(tty, inode, "tty_release_dev"))
Alan Coxeeb89d92009-11-30 13:18:29 +00001570 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Arnd Bergmannec79d602010-06-01 22:53:01 +02001572 tty_lock();
Alan Coxd81ed102008-10-13 10:41:42 +01001573 check_tty_count(tty, "tty_release_dev");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Arnd Bergmannec79d602010-06-01 22:53:01 +02001575 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577 idx = tty->index;
1578 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1579 tty->driver->subtype == PTY_TYPE_MASTER);
1580 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 o_tty = tty->link;
1582
1583#ifdef TTY_PARANOIA_CHECK
1584 if (idx < 0 || idx >= tty->driver->num) {
Alan Coxd81ed102008-10-13 10:41:42 +01001585 printk(KERN_DEBUG "tty_release_dev: bad idx when trying to "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 "free (%s)\n", tty->name);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001587 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001588 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001590 if (!devpts) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 if (tty != tty->driver->ttys[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001592 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001593 printk(KERN_DEBUG "tty_release_dev: driver.table[%d] not tty "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 "for (%s)\n", idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001595 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 }
1597 if (tty->termios != tty->driver->termios[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001598 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001599 printk(KERN_DEBUG "tty_release_dev: driver.termios[%d] not termios "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 "for (%s)\n",
1601 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001602 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 }
1605#endif
1606
1607#ifdef TTY_DEBUG_HANGUP
Alan Coxd81ed102008-10-13 10:41:42 +01001608 printk(KERN_DEBUG "tty_release_dev of %s (tty count=%d)...",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 tty_name(tty, buf), tty->count);
1610#endif
1611
1612#ifdef TTY_PARANOIA_CHECK
1613 if (tty->driver->other &&
1614 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1615 if (o_tty != tty->driver->other->ttys[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001616 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001617 printk(KERN_DEBUG "tty_release_dev: other->table[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 "not o_tty for (%s)\n",
1619 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001620 return 0 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 }
1622 if (o_tty->termios != tty->driver->other->termios[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001623 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001624 printk(KERN_DEBUG "tty_release_dev: other->termios[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 "not o_termios for (%s)\n",
1626 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001627 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 if (o_tty->link != tty) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001630 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001631 printk(KERN_DEBUG "tty_release_dev: bad pty pointers\n");
Alan Coxeeb89d92009-11-30 13:18:29 +00001632 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 }
1634 }
1635#endif
Alan Coxf34d7a52008-04-30 00:54:13 -07001636 if (tty->ops->close)
1637 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Arnd Bergmannec79d602010-06-01 22:53:01 +02001639 tty_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 /*
1641 * Sanity check: if tty->count is going to zero, there shouldn't be
1642 * any waiters on tty->read_wait or tty->write_wait. We test the
1643 * wait queues and kick everyone out _before_ actually starting to
1644 * close. This ensures that we won't block while releasing the tty
1645 * structure.
1646 *
1647 * The test for the o_tty closing is necessary, since the master and
1648 * slave sides may close in any order. If the slave side closes out
1649 * first, its count will be one, since the master side holds an open.
1650 * Thus this test wouldn't be triggered at the time the slave closes,
1651 * so we do it now.
1652 *
1653 * Note that it's possible for the tty to be opened again while we're
1654 * flushing out waiters. By recalculating the closing flags before
1655 * each iteration we avoid any problems.
1656 */
1657 while (1) {
1658 /* Guard against races with tty->count changes elsewhere and
1659 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001660
Ingo Molnar70522e12006-03-23 03:00:31 -08001661 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001662 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 tty_closing = tty->count <= 1;
1664 o_tty_closing = o_tty &&
1665 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 do_sleep = 0;
1667
1668 if (tty_closing) {
1669 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001670 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 do_sleep++;
1672 }
1673 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001674 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 do_sleep++;
1676 }
1677 }
1678 if (o_tty_closing) {
1679 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001680 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681 do_sleep++;
1682 }
1683 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001684 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 do_sleep++;
1686 }
1687 }
1688 if (!do_sleep)
1689 break;
1690
Alan Coxd81ed102008-10-13 10:41:42 +01001691 printk(KERN_WARNING "tty_release_dev: %s: read/write wait queue "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 "active!\n", tty_name(tty, buf));
Arnd Bergmannec79d602010-06-01 22:53:01 +02001693 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001694 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001699 * The closing flags are now consistent with the open counts on
1700 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 * block, so it's safe to proceed with closing.
1702 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 if (pty_master) {
1704 if (--o_tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001705 printk(KERN_WARNING "tty_release_dev: bad pty slave count "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 "(%d) for %s\n",
1707 o_tty->count, tty_name(o_tty, buf));
1708 o_tty->count = 0;
1709 }
1710 }
1711 if (--tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001712 printk(KERN_WARNING "tty_release_dev: bad tty->count (%d) for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 tty->count, tty_name(tty, buf));
1714 tty->count = 0;
1715 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001716
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 /*
1718 * We've decremented tty->count, so we need to remove this file
1719 * descriptor off the tty->tty_files list; this serves two
1720 * purposes:
1721 * - check_tty_count sees the correct number of file descriptors
1722 * associated with this tty.
1723 * - do_tty_hangup no longer sees this file descriptor as
1724 * something that needs to be handled for hangups.
1725 */
Nick Piggind996b622010-08-18 04:37:36 +10001726 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
1728 /*
1729 * Perform some housekeeping before deciding whether to return.
1730 *
1731 * Set the TTY_CLOSING flag if this was the last open. In the
1732 * case of a pty we may have to wait around for the other side
1733 * to close, and TTY_CLOSING makes sure we can't be reopened.
1734 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001735 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001737 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 set_bit(TTY_CLOSING, &o_tty->flags);
1739
1740 /*
1741 * If _either_ side is closing, make sure there aren't any
1742 * processes that still think tty or o_tty is their controlling
1743 * tty.
1744 */
1745 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001747 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001749 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 read_unlock(&tasklist_lock);
1751 }
1752
Ingo Molnar70522e12006-03-23 03:00:31 -08001753 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08001754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 /* check whether both sides are closing ... */
Alan Coxeeb89d92009-11-30 13:18:29 +00001756 if (!tty_closing || (o_tty && !o_tty_closing)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001757 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001758 return 0;
1759 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001760
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761#ifdef TTY_DEBUG_HANGUP
1762 printk(KERN_DEBUG "freeing tty structure...");
1763#endif
1764 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001765 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001767 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001769 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 * the slots and preserving the termios structure.
1771 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001772 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 /* Make this pty number available for reallocation */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07001775 if (devpts)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001776 devpts_kill_index(inode, idx);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001777 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001778 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779}
1780
Alan Coxaf9b8972006-08-27 01:24:01 -07001781/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001782 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001783 * @inode: inode of device file
1784 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001786 * tty_open and tty_release keep up the tty count that contains the
1787 * number of opens done on a tty. We cannot use the inode-count, as
1788 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001790 * Open-counting is needed for pty masters, as well as for keeping
1791 * track of serial lines: DTR is dropped when the last close happens.
1792 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1793 *
1794 * The termios state of a pty is reset on first open so that
1795 * settings don't persist across reuse.
1796 *
Alan Coxd81ed102008-10-13 10:41:42 +01001797 * Locking: tty_mutex protects tty, get_tty_driver and tty_init_dev work.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001798 * tty->count should protect the rest.
1799 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001801
Alan Coxeeb89d92009-11-30 13:18:29 +00001802static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803{
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001804 struct tty_struct *tty = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 int noctty, retval;
1806 struct tty_driver *driver;
1807 int index;
1808 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001809 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
1811 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001812
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813retry_open:
1814 noctty = filp->f_flags & O_NOCTTY;
1815 index = -1;
1816 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001817
Ingo Molnar70522e12006-03-23 03:00:31 -08001818 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001819 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820
Alan Cox37bdfb02008-02-08 04:18:47 -08001821 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001822 tty = get_current_tty();
1823 if (!tty) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001824 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001825 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 return -ENXIO;
1827 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01001828 driver = tty_driver_kref_get(tty->driver);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001829 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1831 /* noctty = 1; */
Alan Cox452a00d2008-10-13 10:39:13 +01001832 /* FIXME: Should we take a driver reference ? */
1833 tty_kref_put(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 goto got_driver;
1835 }
1836#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08001837 if (device == MKDEV(TTY_MAJOR, 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 extern struct tty_driver *console_driver;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001839 driver = tty_driver_kref_get(console_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 index = fg_console;
1841 noctty = 1;
1842 goto got_driver;
1843 }
1844#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08001845 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
Will Newton296fa7f2008-12-01 11:36:06 +00001846 struct tty_driver *console_driver = console_device(&index);
1847 if (console_driver) {
1848 driver = tty_driver_kref_get(console_driver);
1849 if (driver) {
1850 /* Don't let /dev/console block */
1851 filp->f_flags |= O_NONBLOCK;
1852 noctty = 1;
1853 goto got_driver;
1854 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 }
Arnd Bergmannec79d602010-06-01 22:53:01 +02001856 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001857 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 return -ENODEV;
1859 }
1860
1861 driver = get_tty_driver(device, &index);
1862 if (!driver) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001863 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001864 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 return -ENODEV;
1866 }
1867got_driver:
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001868 if (!tty) {
1869 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001870 tty = tty_driver_lookup_tty(driver, inode, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001871
Eric Paris808ffa32009-01-27 11:50:37 +00001872 if (IS_ERR(tty)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001873 tty_unlock();
Eric Paris808ffa32009-01-27 11:50:37 +00001874 mutex_unlock(&tty_mutex);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001875 return PTR_ERR(tty);
Eric Paris808ffa32009-01-27 11:50:37 +00001876 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001877 }
1878
1879 if (tty) {
1880 retval = tty_reopen(tty);
1881 if (retval)
1882 tty = ERR_PTR(retval);
1883 } else
1884 tty = tty_init_dev(driver, index, 0);
1885
Ingo Molnar70522e12006-03-23 03:00:31 -08001886 mutex_unlock(&tty_mutex);
Alan Cox7d7b93c2008-10-13 10:42:09 +01001887 tty_driver_kref_put(driver);
Alan Coxeeb89d92009-11-30 13:18:29 +00001888 if (IS_ERR(tty)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001889 tty_unlock();
Alan Cox73ec06f2008-10-13 10:42:29 +01001890 return PTR_ERR(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001891 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892
Pekka Enbergf573bd12010-08-24 07:48:34 +03001893 retval = tty_add_file(tty, filp);
1894 if (retval) {
1895 tty_unlock();
1896 return retval;
1897 }
Nick Piggind996b622010-08-18 04:37:36 +10001898
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 check_tty_count(tty, "tty_open");
1900 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1901 tty->driver->subtype == PTY_TYPE_MASTER)
1902 noctty = 1;
1903#ifdef TTY_DEBUG_HANGUP
1904 printk(KERN_DEBUG "opening %s...", tty->name);
1905#endif
1906 if (!retval) {
Alan Coxf34d7a52008-04-30 00:54:13 -07001907 if (tty->ops->open)
1908 retval = tty->ops->open(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 else
1910 retval = -ENODEV;
1911 }
1912 filp->f_flags = saved_flags;
1913
Alan Cox37bdfb02008-02-08 04:18:47 -08001914 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1915 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 retval = -EBUSY;
1917
1918 if (retval) {
1919#ifdef TTY_DEBUG_HANGUP
1920 printk(KERN_DEBUG "error %d in opening %s...", retval,
1921 tty->name);
1922#endif
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001923 tty_unlock(); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00001924 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001925 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001927
1928 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001930
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 schedule();
1932 /*
1933 * Need to reset f_op in case a hangup happened.
1934 */
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001935 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 if (filp->f_op == &hung_up_tty_fops)
1937 filp->f_op = &tty_fops;
Arnd Bergmannec79d602010-06-01 22:53:01 +02001938 tty_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 goto retry_open;
1940 }
Arnd Bergmannec79d602010-06-01 22:53:01 +02001941 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001942
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001943
1944 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001945 tty_lock();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001946 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 if (!noctty &&
1948 current->signal->leader &&
1949 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001950 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001951 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001952 spin_unlock_irq(&current->sighand->siglock);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001953 tty_unlock();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001954 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 return 0;
1956}
1957
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001958
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959
Alan Coxaf9b8972006-08-27 01:24:01 -07001960/**
1961 * tty_poll - check tty status
1962 * @filp: file being polled
1963 * @wait: poll wait structures to update
1964 *
1965 * Call the line discipline polling method to obtain the poll
1966 * status of the device.
1967 *
1968 * Locking: locks called line discipline but ldisc poll method
1969 * may be re-entered freely by other callers.
1970 */
1971
Alan Cox37bdfb02008-02-08 04:18:47 -08001972static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973{
Nick Piggind996b622010-08-18 04:37:36 +10001974 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 struct tty_ldisc *ld;
1976 int ret = 0;
1977
Josef Sipeka7113a92006-12-08 02:36:55 -08001978 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001980
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001982 if (ld->ops->poll)
1983 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 tty_ldisc_deref(ld);
1985 return ret;
1986}
1987
Arnd Bergmannec79d602010-06-01 22:53:01 +02001988static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989{
Nick Piggind996b622010-08-18 04:37:36 +10001990 struct tty_struct *tty = file_tty(filp);
Alan Cox47f86832008-04-30 00:53:30 -07001991 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001992 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Josef Sipeka7113a92006-12-08 02:36:55 -08001994 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001995 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08001996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 retval = fasync_helper(fd, filp, on, &tty->fasync);
1998 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001999 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
2001 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002002 enum pid_type type;
2003 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 if (!waitqueue_active(&tty->read_wait))
2005 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07002006 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002007 if (tty->pgrp) {
2008 pid = tty->pgrp;
2009 type = PIDTYPE_PGID;
2010 } else {
2011 pid = task_pid(current);
2012 type = PIDTYPE_PID;
2013 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002014 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002015 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002016 retval = __f_setown(filp, pid, type, 0);
2017 put_pid(pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002019 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 } else {
2021 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2022 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2023 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002024 retval = 0;
2025out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002026 return retval;
2027}
2028
2029static int tty_fasync(int fd, struct file *filp, int on)
2030{
2031 int retval;
2032 tty_lock();
2033 retval = __tty_fasync(fd, filp, on);
2034 tty_unlock();
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002035 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036}
2037
Alan Coxaf9b8972006-08-27 01:24:01 -07002038/**
2039 * tiocsti - fake input character
2040 * @tty: tty to fake input into
2041 * @p: pointer to character
2042 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002043 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002044 * input management.
2045 *
2046 * FIXME: does not honour flow control ??
2047 *
2048 * Locking:
2049 * Called functions take tty_ldisc_lock
2050 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002051 *
2052 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002053 */
2054
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055static int tiocsti(struct tty_struct *tty, char __user *p)
2056{
2057 char ch, mbz = 0;
2058 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2061 return -EPERM;
2062 if (get_user(ch, p))
2063 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002064 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002066 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 tty_ldisc_deref(ld);
2068 return 0;
2069}
2070
Alan Coxaf9b8972006-08-27 01:24:01 -07002071/**
2072 * tiocgwinsz - implement window query ioctl
2073 * @tty; tty
2074 * @arg: user buffer for result
2075 *
Alan Cox808a0d32006-09-29 02:00:40 -07002076 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002077 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002078 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002079 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002080 */
2081
Alan Cox37bdfb02008-02-08 04:18:47 -08002082static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083{
Alan Cox808a0d32006-09-29 02:00:40 -07002084 int err;
2085
Arjan van de Ven5785c952006-09-29 02:00:43 -07002086 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002087 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002088 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002089
2090 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091}
2092
Alan Coxaf9b8972006-08-27 01:24:01 -07002093/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002094 * tty_do_resize - resize event
2095 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002096 * @rows: rows (character)
2097 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002098 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002099 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002100 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002101 */
2102
Alan Coxfc6f6232009-01-02 13:43:17 +00002103int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104{
Alan Coxfc6f6232009-01-02 13:43:17 +00002105 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002106 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107
Alan Coxfc6f6232009-01-02 13:43:17 +00002108 /* Lock the tty */
2109 mutex_lock(&tty->termios_mutex);
2110 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002111 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002112 /* Get the PID values and reference them so we can
2113 avoid holding the tty ctrl lock while sending signals */
2114 spin_lock_irqsave(&tty->ctrl_lock, flags);
2115 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002116 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2117
2118 if (pgrp)
2119 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002120 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002121
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002122 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002123done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002124 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 return 0;
2126}
2127
Alan Coxaf9b8972006-08-27 01:24:01 -07002128/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002129 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002130 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002131 * @arg: user buffer for result
2132 *
2133 * Copies the user idea of the window size to the kernel. Traditionally
2134 * this is just advisory information but for the Linux console it
2135 * actually has driver level meaning and triggers a VC resize.
2136 *
2137 * Locking:
2138 * Driver dependant. The default do_resize method takes the
2139 * tty termios mutex and ctrl_lock. The console takes its own lock
2140 * then calls into the default method.
2141 */
2142
Alan Coxfc6f6232009-01-02 13:43:17 +00002143static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002144{
2145 struct winsize tmp_ws;
2146 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2147 return -EFAULT;
2148
2149 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002150 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002151 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002152 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002153}
2154
2155/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002156 * tioccons - allow admin to move logical console
2157 * @file: the file to become console
2158 *
2159 * Allow the adminstrator to move the redirected console device
2160 *
2161 * Locking: uses redirect_lock to guard the redirect information
2162 */
2163
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164static int tioccons(struct file *file)
2165{
2166 if (!capable(CAP_SYS_ADMIN))
2167 return -EPERM;
2168 if (file->f_op->write == redirected_tty_write) {
2169 struct file *f;
2170 spin_lock(&redirect_lock);
2171 f = redirect;
2172 redirect = NULL;
2173 spin_unlock(&redirect_lock);
2174 if (f)
2175 fput(f);
2176 return 0;
2177 }
2178 spin_lock(&redirect_lock);
2179 if (redirect) {
2180 spin_unlock(&redirect_lock);
2181 return -EBUSY;
2182 }
2183 get_file(file);
2184 redirect = file;
2185 spin_unlock(&redirect_lock);
2186 return 0;
2187}
2188
Alan Coxaf9b8972006-08-27 01:24:01 -07002189/**
2190 * fionbio - non blocking ioctl
2191 * @file: file to set blocking value
2192 * @p: user parameter
2193 *
2194 * Historical tty interfaces had a blocking control ioctl before
2195 * the generic functionality existed. This piece of history is preserved
2196 * in the expected tty API of posix OS's.
2197 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002198 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002199 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201static int fionbio(struct file *file, int __user *p)
2202{
2203 int nonblock;
2204
2205 if (get_user(nonblock, p))
2206 return -EFAULT;
2207
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002208 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 if (nonblock)
2210 file->f_flags |= O_NONBLOCK;
2211 else
2212 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002213 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 return 0;
2215}
2216
Alan Coxaf9b8972006-08-27 01:24:01 -07002217/**
2218 * tiocsctty - set controlling tty
2219 * @tty: tty structure
2220 * @arg: user argument
2221 *
2222 * This ioctl is used to manage job control. It permits a session
2223 * leader to set this tty as the controlling tty for the session.
2224 *
2225 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002226 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002227 * Takes tasklist_lock internally to walk sessions
2228 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002229 */
2230
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231static int tiocsctty(struct tty_struct *tty, int arg)
2232{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002233 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002234 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002235 return ret;
2236
2237 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 /*
2239 * The process must be a session leader and
2240 * not have a controlling tty already.
2241 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002242 if (!current->signal->leader || current->signal->tty) {
2243 ret = -EPERM;
2244 goto unlock;
2245 }
2246
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002247 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 /*
2249 * This tty is already the controlling
2250 * tty for another session group!
2251 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002252 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 /*
2254 * Steal it away
2255 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002257 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002259 } else {
2260 ret = -EPERM;
2261 goto unlock;
2262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002264 proc_set_tty(current, tty);
2265unlock:
Alan Cox28298232006-09-29 02:00:58 -07002266 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002267 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268}
2269
Alan Coxaf9b8972006-08-27 01:24:01 -07002270/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002271 * tty_get_pgrp - return a ref counted pgrp pid
2272 * @tty: tty to read
2273 *
2274 * Returns a refcounted instance of the pid struct for the process
2275 * group controlling the tty.
2276 */
2277
2278struct pid *tty_get_pgrp(struct tty_struct *tty)
2279{
2280 unsigned long flags;
2281 struct pid *pgrp;
2282
2283 spin_lock_irqsave(&tty->ctrl_lock, flags);
2284 pgrp = get_pid(tty->pgrp);
2285 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2286
2287 return pgrp;
2288}
2289EXPORT_SYMBOL_GPL(tty_get_pgrp);
2290
2291/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002292 * tiocgpgrp - get process group
2293 * @tty: tty passed by user
2294 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2295 * @p: returned pid
2296 *
2297 * Obtain the process group of the tty. If there is no process group
2298 * return an error.
2299 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002300 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002301 */
2302
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2304{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002305 struct pid *pid;
2306 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 /*
2308 * (tty == real_tty) is a cheap way of
2309 * testing if the tty is NOT a master pty.
2310 */
2311 if (tty == real_tty && current->signal->tty != real_tty)
2312 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002313 pid = tty_get_pgrp(real_tty);
2314 ret = put_user(pid_vnr(pid), p);
2315 put_pid(pid);
2316 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317}
2318
Alan Coxaf9b8972006-08-27 01:24:01 -07002319/**
2320 * tiocspgrp - attempt to set process group
2321 * @tty: tty passed by user
2322 * @real_tty: tty side device matching tty passed by user
2323 * @p: pid pointer
2324 *
2325 * Set the process group of the tty to the session passed. Only
2326 * permitted where the tty session is our session.
2327 *
Alan Cox47f86832008-04-30 00:53:30 -07002328 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002329 */
2330
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2332{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002333 struct pid *pgrp;
2334 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002336 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337
2338 if (retval == -EIO)
2339 return -ENOTTY;
2340 if (retval)
2341 return retval;
2342 if (!current->signal->tty ||
2343 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002344 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002346 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002348 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002350 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002351 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002352 retval = -ESRCH;
2353 if (!pgrp)
2354 goto out_unlock;
2355 retval = -EPERM;
2356 if (session_of_pgrp(pgrp) != task_session(current))
2357 goto out_unlock;
2358 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002359 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002360 put_pid(real_tty->pgrp);
2361 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002362 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002363out_unlock:
2364 rcu_read_unlock();
2365 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366}
2367
Alan Coxaf9b8972006-08-27 01:24:01 -07002368/**
2369 * tiocgsid - get session id
2370 * @tty: tty passed by user
2371 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2372 * @p: pointer to returned session id
2373 *
2374 * Obtain the session id of the tty. If there is no session
2375 * return an error.
2376 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002377 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002378 */
2379
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2381{
2382 /*
2383 * (tty == real_tty) is a cheap way of
2384 * testing if the tty is NOT a master pty.
2385 */
2386 if (tty == real_tty && current->signal->tty != real_tty)
2387 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002388 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002390 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391}
2392
Alan Coxaf9b8972006-08-27 01:24:01 -07002393/**
2394 * tiocsetd - set line discipline
2395 * @tty: tty device
2396 * @p: pointer to user data
2397 *
2398 * Set the line discipline according to user request.
2399 *
2400 * Locking: see tty_set_ldisc, this function is just a helper
2401 */
2402
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403static int tiocsetd(struct tty_struct *tty, int __user *p)
2404{
2405 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002406 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407
2408 if (get_user(ldisc, p))
2409 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002410
Alan Cox04f378b2008-04-30 00:53:29 -07002411 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002412
2413 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414}
2415
Alan Coxaf9b8972006-08-27 01:24:01 -07002416/**
2417 * send_break - performed time break
2418 * @tty: device to break on
2419 * @duration: timeout in mS
2420 *
2421 * Perform a timed break on hardware that lacks its own driver level
2422 * timed break functionality.
2423 *
2424 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002425 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002426 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002427 */
2428
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002429static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430{
Alan Cox9e989662008-07-22 11:18:03 +01002431 int retval;
2432
2433 if (tty->ops->break_ctl == NULL)
2434 return 0;
2435
2436 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2437 retval = tty->ops->break_ctl(tty, duration);
2438 else {
2439 /* Do the work ourselves */
2440 if (tty_write_lock(tty, 0) < 0)
2441 return -EINTR;
2442 retval = tty->ops->break_ctl(tty, -1);
2443 if (retval)
2444 goto out;
2445 if (!signal_pending(current))
2446 msleep_interruptible(duration);
2447 retval = tty->ops->break_ctl(tty, 0);
2448out:
2449 tty_write_unlock(tty);
2450 if (signal_pending(current))
2451 retval = -EINTR;
2452 }
2453 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454}
2455
Alan Coxaf9b8972006-08-27 01:24:01 -07002456/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002457 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002458 * @tty: tty device
2459 * @file: user file pointer
2460 * @p: pointer to result
2461 *
2462 * Obtain the modem status bits from the tty driver if the feature
2463 * is supported. Return -EINVAL if it is not available.
2464 *
2465 * Locking: none (up to the driver)
2466 */
2467
Alan Cox60b33c12011-02-14 16:26:14 +00002468static int tty_tiocmget(struct tty_struct *tty, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469{
2470 int retval = -EINVAL;
2471
Alan Coxf34d7a52008-04-30 00:54:13 -07002472 if (tty->ops->tiocmget) {
Alan Cox60b33c12011-02-14 16:26:14 +00002473 retval = tty->ops->tiocmget(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
2475 if (retval >= 0)
2476 retval = put_user(retval, p);
2477 }
2478 return retval;
2479}
2480
Alan Coxaf9b8972006-08-27 01:24:01 -07002481/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002482 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002483 * @tty: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07002484 * @cmd: command - clear bits, set bits or set all
2485 * @p: pointer to desired bits
2486 *
2487 * Set the modem status bits from the tty driver if the feature
2488 * is supported. Return -EINVAL if it is not available.
2489 *
2490 * Locking: none (up to the driver)
2491 */
2492
Alan Cox20b9d172011-02-14 16:26:50 +00002493static int tty_tiocmset(struct tty_struct *tty, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 unsigned __user *p)
2495{
Alan Coxae677512008-07-16 21:56:54 +01002496 int retval;
2497 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498
Alan Coxae677512008-07-16 21:56:54 +01002499 if (tty->ops->tiocmset == NULL)
2500 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501
Alan Coxae677512008-07-16 21:56:54 +01002502 retval = get_user(val, p);
2503 if (retval)
2504 return retval;
2505 set = clear = 0;
2506 switch (cmd) {
2507 case TIOCMBIS:
2508 set = val;
2509 break;
2510 case TIOCMBIC:
2511 clear = val;
2512 break;
2513 case TIOCMSET:
2514 set = val;
2515 clear = ~val;
2516 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 }
Alan Coxae677512008-07-16 21:56:54 +01002518 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2519 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
Alan Cox20b9d172011-02-14 16:26:50 +00002520 return tty->ops->tiocmset(tty, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521}
2522
Alan Coxd281da72010-09-16 18:21:24 +01002523static int tty_tiocgicount(struct tty_struct *tty, void __user *arg)
2524{
2525 int retval = -EINVAL;
2526 struct serial_icounter_struct icount;
2527 memset(&icount, 0, sizeof(icount));
2528 if (tty->ops->get_icount)
2529 retval = tty->ops->get_icount(tty, &icount);
2530 if (retval != 0)
2531 return retval;
2532 if (copy_to_user(arg, &icount, sizeof(icount)))
2533 return -EFAULT;
2534 return 0;
2535}
2536
Alan Coxe8b70e72009-06-11 12:48:02 +01002537struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2538{
2539 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2540 tty->driver->subtype == PTY_TYPE_MASTER)
2541 tty = tty->link;
2542 return tty;
2543}
2544EXPORT_SYMBOL(tty_pair_get_tty);
2545
2546struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2547{
2548 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2549 tty->driver->subtype == PTY_TYPE_MASTER)
2550 return tty;
2551 return tty->link;
2552}
2553EXPORT_SYMBOL(tty_pair_get_pty);
2554
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555/*
2556 * Split this up, as gcc can choke on it otherwise..
2557 */
Alan Cox04f378b2008-04-30 00:53:29 -07002558long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559{
Nick Piggind996b622010-08-18 04:37:36 +10002560 struct tty_struct *tty = file_tty(file);
2561 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 void __user *p = (void __user *)arg;
2563 int retval;
2564 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002565 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002566
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2568 return -EINVAL;
2569
Alan Coxe8b70e72009-06-11 12:48:02 +01002570 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571
2572 /*
2573 * Factor out some common prep work
2574 */
2575 switch (cmd) {
2576 case TIOCSETD:
2577 case TIOCSBRK:
2578 case TIOCCBRK:
2579 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002580 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 retval = tty_check_change(tty);
2582 if (retval)
2583 return retval;
2584 if (cmd != TIOCCBRK) {
2585 tty_wait_until_sent(tty, 0);
2586 if (signal_pending(current))
2587 return -EINTR;
2588 }
2589 break;
2590 }
2591
Alan Cox9e989662008-07-22 11:18:03 +01002592 /*
2593 * Now do the stuff.
2594 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002596 case TIOCSTI:
2597 return tiocsti(tty, p);
2598 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002599 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002600 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002601 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002602 case TIOCCONS:
2603 return real_tty != tty ? -EINVAL : tioccons(file);
2604 case FIONBIO:
2605 return fionbio(file, p);
2606 case TIOCEXCL:
2607 set_bit(TTY_EXCLUSIVE, &tty->flags);
2608 return 0;
2609 case TIOCNXCL:
2610 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2611 return 0;
2612 case TIOCNOTTY:
2613 if (current->signal->tty != tty)
2614 return -ENOTTY;
2615 no_tty();
2616 return 0;
2617 case TIOCSCTTY:
2618 return tiocsctty(tty, arg);
2619 case TIOCGPGRP:
2620 return tiocgpgrp(tty, real_tty, p);
2621 case TIOCSPGRP:
2622 return tiocspgrp(tty, real_tty, p);
2623 case TIOCGSID:
2624 return tiocgsid(tty, real_tty, p);
2625 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002626 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002627 case TIOCSETD:
2628 return tiocsetd(tty, p);
Kay Sievers3c95c982011-02-17 18:39:28 +01002629 case TIOCVHANGUP:
2630 if (!capable(CAP_SYS_ADMIN))
2631 return -EPERM;
2632 tty_vhangup(tty);
2633 return 0;
Werner Finkb7b8de02010-12-03 12:48:23 +01002634 case TIOCGDEV:
2635 {
2636 unsigned int ret = new_encode_dev(tty_devnum(real_tty));
2637 return put_user(ret, (unsigned int __user *)p);
2638 }
Alan Cox37bdfb02008-02-08 04:18:47 -08002639 /*
2640 * Break handling
2641 */
2642 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002643 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002644 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002645 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002646 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002647 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002648 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002649 return 0;
2650 case TCSBRK: /* SVID version: non-zero arg --> no break */
2651 /* non-zero arg means wait for all output data
2652 * to be sent (performed above) but don't send break.
2653 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002655 if (!arg)
2656 return send_break(tty, 250);
2657 return 0;
2658 case TCSBRKP: /* support for POSIX tcsendbreak() */
2659 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660
Alan Cox37bdfb02008-02-08 04:18:47 -08002661 case TIOCMGET:
Alan Cox60b33c12011-02-14 16:26:14 +00002662 return tty_tiocmget(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002663 case TIOCMSET:
2664 case TIOCMBIC:
2665 case TIOCMBIS:
Alan Cox20b9d172011-02-14 16:26:50 +00002666 return tty_tiocmset(tty, cmd, p);
Alan Coxd281da72010-09-16 18:21:24 +01002667 case TIOCGICOUNT:
2668 retval = tty_tiocgicount(tty, p);
2669 /* For the moment allow fall through to the old method */
2670 if (retval != -EINVAL)
2671 return retval;
2672 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002673 case TCFLSH:
2674 switch (arg) {
2675 case TCIFLUSH:
2676 case TCIOFLUSH:
2677 /* flush tty buffer and allow ldisc to process ioctl */
2678 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002679 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002680 }
2681 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002683 if (tty->ops->ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002684 retval = (tty->ops->ioctl)(tty, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 if (retval != -ENOIOCTLCMD)
2686 return retval;
2687 }
2688 ld = tty_ldisc_ref_wait(tty);
2689 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002690 if (ld->ops->ioctl) {
2691 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002692 if (retval == -ENOIOCTLCMD)
2693 retval = -EINVAL;
2694 }
2695 tty_ldisc_deref(ld);
2696 return retval;
2697}
2698
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002699#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002700static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002701 unsigned long arg)
2702{
2703 struct inode *inode = file->f_dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10002704 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002705 struct tty_ldisc *ld;
2706 int retval = -ENOIOCTLCMD;
2707
2708 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2709 return -EINVAL;
2710
Alan Coxf34d7a52008-04-30 00:54:13 -07002711 if (tty->ops->compat_ioctl) {
Alan Cox6caa76b2011-02-14 16:27:22 +00002712 retval = (tty->ops->compat_ioctl)(tty, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002713 if (retval != -ENOIOCTLCMD)
2714 return retval;
2715 }
2716
2717 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002718 if (ld->ops->compat_ioctl)
2719 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002720 tty_ldisc_deref(ld);
2721
2722 return retval;
2723}
2724#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
2726/*
2727 * This implements the "Secure Attention Key" --- the idea is to
2728 * prevent trojan horses by killing all processes associated with this
2729 * tty when the user hits the "Secure Attention Key". Required for
2730 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002731 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732 * This code could be nicer; ideally it should send a HUP, wait a few
2733 * seconds, then send a INT, and then a KILL signal. But you then
2734 * have to coordinate with the init process, since all processes associated
2735 * with the current tty must be dead before the new getty is allowed
2736 * to spawn.
2737 *
2738 * Now, if it would be correct ;-/ The current code has a nasty hole -
2739 * it doesn't catch files in flight. We may send the descriptor to ourselves
2740 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2741 *
2742 * Nasty bug: do_SAK is being called in interrupt context. This can
2743 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2744 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002745void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746{
2747#ifdef TTY_SOFT_SAK
2748 tty_hangup(tty);
2749#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002750 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002751 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752 int i;
2753 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002754 struct fdtable *fdt;
Alan Cox37bdfb02008-02-08 04:18:47 -08002755
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 if (!tty)
2757 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002758 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002759
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002760 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761
Alan Coxf34d7a52008-04-30 00:54:13 -07002762 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002763
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002765 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002766 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002767 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002768 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002769 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002770 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002771 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002772 /* Now kill any processes that happen to have the
2773 * tty open.
2774 */
2775 do_each_thread(g, p) {
2776 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002777 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002778 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002779 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780 send_sig(SIGKILL, p, 1);
2781 continue;
2782 }
2783 task_lock(p);
2784 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002785 /*
2786 * We don't take a ref to the file, so we must
2787 * hold ->file_lock instead.
2788 */
2789 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002790 fdt = files_fdtable(p->files);
Alan Cox37bdfb02008-02-08 04:18:47 -08002791 for (i = 0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 filp = fcheck_files(p->files, i);
2793 if (!filp)
2794 continue;
2795 if (filp->f_op->read == tty_read &&
Nick Piggind996b622010-08-18 04:37:36 +10002796 file_tty(filp) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002797 printk(KERN_NOTICE "SAK: killed process %d"
2798 " (%s): fd#%d opened to the tty\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002799 task_pid_nr(p), p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06002800 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 break;
2802 }
2803 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002804 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 }
2806 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002807 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 read_unlock(&tasklist_lock);
2809#endif
2810}
2811
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002812static void do_SAK_work(struct work_struct *work)
2813{
2814 struct tty_struct *tty =
2815 container_of(work, struct tty_struct, SAK_work);
2816 __do_SAK(tty);
2817}
2818
Linus Torvalds1da177e2005-04-16 15:20:36 -07002819/*
2820 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2821 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2822 * the values which we write to it will be identical to the values which it
2823 * already has. --akpm
2824 */
2825void do_SAK(struct tty_struct *tty)
2826{
2827 if (!tty)
2828 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 schedule_work(&tty->SAK_work);
2830}
2831
2832EXPORT_SYMBOL(do_SAK);
2833
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002834static int dev_match_devt(struct device *dev, void *data)
2835{
2836 dev_t *devt = data;
2837 return dev->devt == *devt;
2838}
2839
2840/* Must put_device() after it's unused! */
2841static struct device *tty_get_device(struct tty_struct *tty)
2842{
2843 dev_t devt = tty_devnum(tty);
2844 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2845}
2846
2847
Alan Coxaf9b8972006-08-27 01:24:01 -07002848/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002849 * initialize_tty_struct
2850 * @tty: tty to initialize
2851 *
2852 * This subroutine initializes a tty structure that has been newly
2853 * allocated.
2854 *
2855 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002857
Alan Coxbf970ee2008-10-13 10:42:39 +01002858void initialize_tty_struct(struct tty_struct *tty,
2859 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860{
2861 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002862 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002864 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002865 tty->session = NULL;
2866 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002867 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08002868 tty->buf.head = tty->buf.tail = NULL;
2869 tty_buffer_init(tty);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002870 mutex_init(&tty->termios_mutex);
Alan Coxc65c9bc2009-06-11 12:50:12 +01002871 mutex_init(&tty->ldisc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872 init_waitqueue_head(&tty->write_wait);
2873 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002874 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002875 mutex_init(&tty->atomic_read_lock);
2876 mutex_init(&tty->atomic_write_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +00002877 mutex_init(&tty->output_lock);
2878 mutex_init(&tty->echo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002879 spin_lock_init(&tty->read_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002880 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002882 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002883
2884 tty->driver = driver;
2885 tty->ops = driver->ops;
2886 tty->index = idx;
2887 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002888 tty->dev = tty_get_device(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889}
2890
Alan Coxf34d7a52008-04-30 00:54:13 -07002891/**
2892 * tty_put_char - write one character to a tty
2893 * @tty: tty
2894 * @ch: character
2895 *
2896 * Write one byte to the tty using the provided put_char method
2897 * if present. Returns the number of characters successfully output.
2898 *
2899 * Note: the specific put_char operation in the driver layer may go
2900 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002902
Alan Coxf34d7a52008-04-30 00:54:13 -07002903int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904{
Alan Coxf34d7a52008-04-30 00:54:13 -07002905 if (tty->ops->put_char)
2906 return tty->ops->put_char(tty, ch);
2907 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002908}
Alan Coxf34d7a52008-04-30 00:54:13 -07002909EXPORT_SYMBOL_GPL(tty_put_char);
2910
Alan Coxd81ed102008-10-13 10:41:42 +01002911struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912
2913/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002914 * tty_register_device - register a tty device
2915 * @driver: the tty driver that describes the tty device
2916 * @index: the index in the tty driver for this tty device
2917 * @device: a struct device that is associated with this tty device.
2918 * This field is optional, if there is no known struct device
2919 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002920 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002921 * Returns a pointer to the struct device for this tty device
2922 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002923 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002924 * This call is required to be made to register an individual tty device
2925 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2926 * that bit is not set, this function should not be called by a tty
2927 * driver.
2928 *
2929 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002931
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002932struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2933 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934{
2935 char name[64];
2936 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2937
2938 if (index >= driver->num) {
2939 printk(KERN_ERR "Attempt to register invalid tty line number "
2940 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002941 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002942 }
2943
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944 if (driver->type == TTY_DRIVER_TYPE_PTY)
2945 pty_line_name(driver, index, name);
2946 else
2947 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002948
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -07002949 return device_create(tty_class, device, dev, NULL, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002950}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002951EXPORT_SYMBOL(tty_register_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952
2953/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002954 * tty_unregister_device - unregister a tty device
2955 * @driver: the tty driver that describes the tty device
2956 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002958 * If a tty device is registered with a call to tty_register_device() then
2959 * this function must be called when the tty device is gone.
2960 *
2961 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002962 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002963
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964void tty_unregister_device(struct tty_driver *driver, unsigned index)
2965{
Alan Cox37bdfb02008-02-08 04:18:47 -08002966 device_destroy(tty_class,
2967 MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969EXPORT_SYMBOL(tty_unregister_device);
2970
2971struct tty_driver *alloc_tty_driver(int lines)
2972{
2973 struct tty_driver *driver;
2974
Jean Delvare506eb992007-07-15 23:40:14 -07002975 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 if (driver) {
Alan Cox7d7b93c2008-10-13 10:42:09 +01002977 kref_init(&driver->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978 driver->magic = TTY_DRIVER_MAGIC;
2979 driver->num = lines;
2980 /* later we'll move allocation of tables here */
2981 }
2982 return driver;
2983}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002984EXPORT_SYMBOL(alloc_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002985
Alan Cox7d7b93c2008-10-13 10:42:09 +01002986static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987{
Alan Cox7d7b93c2008-10-13 10:42:09 +01002988 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
2989 int i;
2990 struct ktermios *tp;
2991 void *p;
2992
2993 if (driver->flags & TTY_DRIVER_INSTALLED) {
2994 /*
2995 * Free the termios and termios_locked structures because
2996 * we don't want to get memory leaks when modular tty
2997 * drivers are removed from the kernel.
2998 */
2999 for (i = 0; i < driver->num; i++) {
3000 tp = driver->termios[i];
3001 if (tp) {
3002 driver->termios[i] = NULL;
3003 kfree(tp);
3004 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01003005 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
3006 tty_unregister_device(driver, i);
3007 }
3008 p = driver->ttys;
3009 proc_tty_unregister_driver(driver);
3010 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01003011 driver->termios = NULL;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003012 kfree(p);
3013 cdev_del(&driver->cdev);
3014 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015 kfree(driver);
3016}
3017
Alan Cox7d7b93c2008-10-13 10:42:09 +01003018void tty_driver_kref_put(struct tty_driver *driver)
3019{
3020 kref_put(&driver->kref, destruct_tty_driver);
3021}
3022EXPORT_SYMBOL(tty_driver_kref_put);
3023
Jeff Dikeb68e31d2006-10-02 02:17:18 -07003024void tty_set_operations(struct tty_driver *driver,
3025 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026{
Alan Coxf34d7a52008-04-30 00:54:13 -07003027 driver->ops = op;
3028};
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029EXPORT_SYMBOL(tty_set_operations);
3030
Alan Cox7d7b93c2008-10-13 10:42:09 +01003031void put_tty_driver(struct tty_driver *d)
3032{
3033 tty_driver_kref_put(d);
3034}
3035EXPORT_SYMBOL(put_tty_driver);
3036
Linus Torvalds1da177e2005-04-16 15:20:36 -07003037/*
3038 * Called by a tty driver to register itself.
3039 */
3040int tty_register_driver(struct tty_driver *driver)
3041{
3042 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003043 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044 dev_t dev;
3045 void **p = NULL;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003046 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047
Andy Whitcroft543691a62007-05-06 14:49:33 -07003048 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01003049 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050 if (!p)
3051 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003052 }
3053
3054 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003055 error = alloc_chrdev_region(&dev, driver->minor_start,
3056 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057 if (!error) {
3058 driver->major = MAJOR(dev);
3059 driver->minor_start = MINOR(dev);
3060 }
3061 } else {
3062 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003063 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 }
3065 if (error < 0) {
3066 kfree(p);
3067 return error;
3068 }
3069
3070 if (p) {
3071 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08003072 driver->termios = (struct ktermios **)(p + driver->num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073 } else {
3074 driver->ttys = NULL;
3075 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076 }
3077
3078 cdev_init(&driver->cdev, &tty_fops);
3079 driver->cdev.owner = driver->owner;
3080 error = cdev_add(&driver->cdev, dev, driver->num);
3081 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 unregister_chrdev_region(dev, driver->num);
3083 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01003084 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085 kfree(p);
3086 return error;
3087 }
3088
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003089 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003091 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003092
3093 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003094 for (i = 0; i < driver->num; i++) {
3095 d = tty_register_device(driver, i, NULL);
3096 if (IS_ERR(d)) {
3097 error = PTR_ERR(d);
3098 goto err;
3099 }
3100 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003101 }
3102 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003103 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003105
3106err:
3107 for (i--; i >= 0; i--)
3108 tty_unregister_device(driver, i);
3109
3110 mutex_lock(&tty_mutex);
3111 list_del(&driver->tty_drivers);
3112 mutex_unlock(&tty_mutex);
3113
3114 unregister_chrdev_region(dev, driver->num);
3115 driver->ttys = NULL;
3116 driver->termios = NULL;
3117 kfree(p);
3118 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119}
3120
3121EXPORT_SYMBOL(tty_register_driver);
3122
3123/*
3124 * Called by a tty driver to unregister itself.
3125 */
3126int tty_unregister_driver(struct tty_driver *driver)
3127{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003128#if 0
3129 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003130 if (driver->refcount)
3131 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003132#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003133 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3134 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003135 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003136 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003137 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003138 return 0;
3139}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003140
Linus Torvalds1da177e2005-04-16 15:20:36 -07003141EXPORT_SYMBOL(tty_unregister_driver);
3142
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003143dev_t tty_devnum(struct tty_struct *tty)
3144{
3145 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3146}
3147EXPORT_SYMBOL(tty_devnum);
3148
3149void proc_clear_tty(struct task_struct *p)
3150{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003151 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003152 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003153 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003154 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003155 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003156 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003157 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003158}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003159
Alan Cox47f86832008-04-30 00:53:30 -07003160/* Called under the sighand lock */
3161
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003162static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003163{
3164 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003165 unsigned long flags;
3166 /* We should not have a session or pgrp to put here but.... */
3167 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003168 put_pid(tty->session);
3169 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003170 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003171 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3172 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003173 if (tsk->signal->tty) {
3174 printk(KERN_DEBUG "tty not NULL!!\n");
3175 tty_kref_put(tsk->signal->tty);
3176 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003177 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003178 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003179 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003180 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003181}
3182
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003183static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003184{
3185 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003186 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003187 spin_unlock_irq(&tsk->sighand->siglock);
3188}
3189
3190struct tty_struct *get_current_tty(void)
3191{
3192 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003193 unsigned long flags;
3194
3195 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003196 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003197 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003198 return tty;
3199}
Heiko Carstensa311f742006-12-13 00:33:41 -08003200EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003201
Alan Coxd81ed102008-10-13 10:41:42 +01003202void tty_default_fops(struct file_operations *fops)
3203{
3204 *fops = tty_fops;
3205}
3206
Linus Torvalds1da177e2005-04-16 15:20:36 -07003207/*
3208 * Initialize the console device. This is called *early*, so
3209 * we can't necessarily depend on lots of kernel help here.
3210 * Just do some early initializations, and do the complex setup
3211 * later.
3212 */
3213void __init console_init(void)
3214{
3215 initcall_t *call;
3216
3217 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003218 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003219
3220 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003221 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222 * inform about problems etc..
3223 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224 call = __con_initcall_start;
3225 while (call < __con_initcall_end) {
3226 (*call)();
3227 call++;
3228 }
3229}
3230
Kay Sieverse454cea2009-09-18 23:01:12 +02003231static char *tty_devnode(struct device *dev, mode_t *mode)
3232{
3233 if (!mode)
3234 return NULL;
3235 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3236 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3237 *mode = 0666;
3238 return NULL;
3239}
3240
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241static int __init tty_class_init(void)
3242{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003243 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003244 if (IS_ERR(tty_class))
3245 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003246 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247 return 0;
3248}
3249
3250postcore_initcall(tty_class_init);
3251
3252/* 3/2004 jmc: why do these devices exist? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003253static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003254
Kay Sieversfbc92a32010-12-01 18:51:05 +01003255static ssize_t show_cons_active(struct device *dev,
3256 struct device_attribute *attr, char *buf)
3257{
3258 struct console *cs[16];
3259 int i = 0;
3260 struct console *c;
3261 ssize_t count = 0;
3262
Torben Hohnac751ef2011-01-25 15:07:35 -08003263 console_lock();
Kay Sieversa2a6a822011-01-09 16:39:14 +01003264 for_each_console(c) {
Kay Sieversfbc92a32010-12-01 18:51:05 +01003265 if (!c->device)
3266 continue;
3267 if (!c->write)
3268 continue;
3269 if ((c->flags & CON_ENABLED) == 0)
3270 continue;
3271 cs[i++] = c;
3272 if (i >= ARRAY_SIZE(cs))
3273 break;
3274 }
3275 while (i--)
3276 count += sprintf(buf + count, "%s%d%c",
3277 cs[i]->name, cs[i]->index, i ? ' ':'\n');
Torben Hohnac751ef2011-01-25 15:07:35 -08003278 console_unlock();
Kay Sieversfbc92a32010-12-01 18:51:05 +01003279
3280 return count;
3281}
3282static DEVICE_ATTR(active, S_IRUGO, show_cons_active, NULL);
3283
3284static struct device *consdev;
3285
3286void console_sysfs_notify(void)
3287{
3288 if (consdev)
3289 sysfs_notify(&consdev->kobj, NULL, "active");
3290}
3291
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292/*
3293 * Ok, now we can initialize the rest of the tty devices and can count
3294 * on memory allocations, interrupts etc..
3295 */
David Howells31d1d482010-08-06 16:34:43 +01003296int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297{
3298 cdev_init(&tty_cdev, &tty_fops);
3299 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3300 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3301 panic("Couldn't register /dev/tty driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003302 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303
3304 cdev_init(&console_cdev, &console_fops);
3305 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3306 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3307 panic("Couldn't register /dev/console driver\n");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003308 consdev = device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003309 "console");
Kay Sieversfbc92a32010-12-01 18:51:05 +01003310 if (IS_ERR(consdev))
3311 consdev = NULL;
3312 else
Kay Sieversa2a6a822011-01-09 16:39:14 +01003313 WARN_ON(device_create_file(consdev, &dev_attr_active) < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314
Linus Torvalds1da177e2005-04-16 15:20:36 -07003315#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003316 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003317#endif
3318 return 0;
3319}
David Howells31d1d482010-08-06 16:34:43 +01003320