blob: e185db36f8ad1e33830f8521f1731f65d6a8c80c [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Alan Coxa352def2008-07-16 21:53:12 +0100100#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#include <asm/system.h>
102
103#include <linux/kbd_kern.h>
104#include <linux/vt_kern.h>
105#include <linux/selection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107#include <linux/kmod.h>
Pavel Emelyanovb4888932007-10-18 23:40:14 -0700108#include <linux/nsproxy.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110#undef TTY_DEBUG_HANGUP
111
112#define TTY_PARANOIA_CHECK 1
113#define CHECK_TTY_COUNT 1
114
Alan Coxedc6afc2006-12-08 02:38:44 -0800115struct ktermios tty_std_termios = { /* for the benefit of tty drivers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 .c_iflag = ICRNL | IXON,
117 .c_oflag = OPOST | ONLCR,
118 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
119 .c_lflag = ISIG | ICANON | ECHO | ECHOE | ECHOK |
120 ECHOCTL | ECHOKE | IEXTEN,
Alan Coxedc6afc2006-12-08 02:38:44 -0800121 .c_cc = INIT_C_CC,
122 .c_ispeed = 38400,
123 .c_ospeed = 38400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124};
125
126EXPORT_SYMBOL(tty_std_termios);
127
128/* This list gets poked at by procfs and various bits of boot up code. This
129 could do with some rationalisation such as pulling the tty proc function
130 into this file */
Alan Cox37bdfb02008-02-08 04:18:47 -0800131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132LIST_HEAD(tty_drivers); /* linked list of tty drivers */
133
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800134/* Mutex to protect creating and releasing a tty. This is shared with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 vt.c for deeply disgusting hack reasons */
Ingo Molnar70522e12006-03-23 03:00:31 -0800136DEFINE_MUTEX(tty_mutex);
Alan Coxde2a84f2006-09-29 02:00:57 -0700137EXPORT_SYMBOL(tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Nick Pigginee2ffa02010-08-18 04:37:35 +1000139/* Spinlock to protect the tty->tty_files list */
140DEFINE_SPINLOCK(tty_files_lock);
141
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142static ssize_t tty_read(struct file *, char __user *, size_t, loff_t *);
143static ssize_t tty_write(struct file *, const char __user *, size_t, loff_t *);
Alan Cox37bdfb02008-02-08 04:18:47 -0800144ssize_t redirected_tty_write(struct file *, const char __user *,
145 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146static unsigned int tty_poll(struct file *, poll_table *);
147static int tty_open(struct inode *, struct file *);
Alan Cox04f378b2008-04-30 00:53:29 -0700148long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700149#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -0800150static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700151 unsigned long arg);
152#else
153#define tty_compat_ioctl NULL
154#endif
Arnd Bergmannec79d602010-06-01 22:53:01 +0200155static int __tty_fasync(int fd, struct file *filp, int on);
Alan Cox37bdfb02008-02-08 04:18:47 -0800156static int tty_fasync(int fd, struct file *filp, int on);
Christoph Hellwigd5698c22007-02-10 01:46:46 -0800157static void release_tty(struct tty_struct *tty, int idx);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700158static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700159static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Alan Coxaf9b8972006-08-27 01:24:01 -0700161/**
162 * alloc_tty_struct - allocate a tty object
163 *
164 * Return a new empty tty structure. The data fields have not
165 * been initialized in any way but has been zeroed
166 *
167 * Locking: none
Alan Coxaf9b8972006-08-27 01:24:01 -0700168 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Alan Coxbf970ee2008-10-13 10:42:39 +0100170struct tty_struct *alloc_tty_struct(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Alan Cox1266b1e2006-09-29 02:00:40 -0700172 return kzalloc(sizeof(struct tty_struct), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173}
174
Alan Coxaf9b8972006-08-27 01:24:01 -0700175/**
176 * free_tty_struct - free a disused tty
177 * @tty: tty struct to free
178 *
179 * Free the write buffers, tty queue and tty memory itself.
180 *
181 * Locking: none. Must be called after tty is definitely unused
182 */
183
Alan Coxbf970ee2008-10-13 10:42:39 +0100184void free_tty_struct(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400186 if (tty->dev)
187 put_device(tty->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 kfree(tty->write_buf);
Alan Cox33f0f882006-01-09 20:54:13 -0800189 tty_buffer_free_all(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 kfree(tty);
191}
192
Nick Piggind996b622010-08-18 04:37:36 +1000193static inline struct tty_struct *file_tty(struct file *file)
194{
195 return ((struct tty_file_private *)file->private_data)->tty;
196}
197
198/* Associate a new file with the tty structure */
Pekka Enbergf573bd12010-08-24 07:48:34 +0300199int tty_add_file(struct tty_struct *tty, struct file *file)
Nick Piggind996b622010-08-18 04:37:36 +1000200{
201 struct tty_file_private *priv;
202
Pekka Enbergf573bd12010-08-24 07:48:34 +0300203 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
204 if (!priv)
205 return -ENOMEM;
Nick Piggind996b622010-08-18 04:37:36 +1000206
207 priv->tty = tty;
208 priv->file = file;
209 file->private_data = priv;
210
211 spin_lock(&tty_files_lock);
212 list_add(&priv->list, &tty->tty_files);
213 spin_unlock(&tty_files_lock);
Pekka Enbergf573bd12010-08-24 07:48:34 +0300214
215 return 0;
Nick Piggind996b622010-08-18 04:37:36 +1000216}
217
218/* Delete file from its tty */
219void tty_del_file(struct file *file)
220{
221 struct tty_file_private *priv = file->private_data;
222
223 spin_lock(&tty_files_lock);
224 list_del(&priv->list);
225 spin_unlock(&tty_files_lock);
226 file->private_data = NULL;
227 kfree(priv);
228}
229
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231#define TTY_NUMBER(tty) ((tty)->index + (tty)->driver->name_base)
232
Alan Coxaf9b8972006-08-27 01:24:01 -0700233/**
234 * tty_name - return tty naming
235 * @tty: tty structure
236 * @buf: buffer for output
237 *
238 * Convert a tty structure into a name. The name reflects the kernel
239 * naming policy and if udev is in use may not reflect user space
240 *
241 * Locking: none
242 */
243
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244char *tty_name(struct tty_struct *tty, char *buf)
245{
246 if (!tty) /* Hmm. NULL pointer. That's fun. */
247 strcpy(buf, "NULL tty");
248 else
249 strcpy(buf, tty->name);
250 return buf;
251}
252
253EXPORT_SYMBOL(tty_name);
254
Andrew Mortond769a662005-05-05 16:15:50 -0700255int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 const char *routine)
257{
258#ifdef TTY_PARANOIA_CHECK
259 if (!tty) {
260 printk(KERN_WARNING
261 "null TTY for (%d:%d) in %s\n",
262 imajor(inode), iminor(inode), routine);
263 return 1;
264 }
265 if (tty->magic != TTY_MAGIC) {
266 printk(KERN_WARNING
267 "bad magic number for tty struct (%d:%d) in %s\n",
268 imajor(inode), iminor(inode), routine);
269 return 1;
270 }
271#endif
272 return 0;
273}
274
275static int check_tty_count(struct tty_struct *tty, const char *routine)
276{
277#ifdef CHECK_TTY_COUNT
278 struct list_head *p;
279 int count = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -0800280
Nick Pigginee2ffa02010-08-18 04:37:35 +1000281 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 list_for_each(p, &tty->tty_files) {
283 count++;
284 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000285 spin_unlock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
287 tty->driver->subtype == PTY_TYPE_SLAVE &&
288 tty->link && tty->link->count)
289 count++;
290 if (tty->count != count) {
291 printk(KERN_WARNING "Warning: dev (%s) tty->count(%d) "
292 "!= #fd's(%d) in %s\n",
293 tty->name, tty->count, count, routine);
294 return count;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296#endif
297 return 0;
298}
299
Alan Coxaf9b8972006-08-27 01:24:01 -0700300/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700301 * get_tty_driver - find device of a tty
302 * @dev_t: device identifier
303 * @index: returns the index of the tty
304 *
305 * This routine returns a tty driver structure, given a device number
306 * and also passes back the index number.
307 *
308 * Locking: caller must hold tty_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311static struct tty_driver *get_tty_driver(dev_t device, int *index)
312{
313 struct tty_driver *p;
314
315 list_for_each_entry(p, &tty_drivers, tty_drivers) {
316 dev_t base = MKDEV(p->major, p->minor_start);
317 if (device < base || device >= base + p->num)
318 continue;
319 *index = device - base;
Alan Cox7d7b93c2008-10-13 10:42:09 +0100320 return tty_driver_kref_get(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 }
322 return NULL;
323}
324
Jason Wesself2d937f2008-04-17 20:05:37 +0200325#ifdef CONFIG_CONSOLE_POLL
326
327/**
328 * tty_find_polling_driver - find device of a polled tty
329 * @name: name string to match
330 * @line: pointer to resulting tty line nr
331 *
332 * This routine returns a tty driver structure, given a name
333 * and the condition that the tty driver is capable of polled
334 * operation.
335 */
336struct tty_driver *tty_find_polling_driver(char *name, int *line)
337{
338 struct tty_driver *p, *res = NULL;
339 int tty_line = 0;
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500340 int len;
Alan Cox5f0878a2009-06-11 12:46:41 +0100341 char *str, *stp;
Jason Wesself2d937f2008-04-17 20:05:37 +0200342
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500343 for (str = name; *str; str++)
344 if ((*str >= '0' && *str <= '9') || *str == ',')
345 break;
346 if (!*str)
347 return NULL;
348
349 len = str - name;
350 tty_line = simple_strtoul(str, &str, 10);
351
Jason Wesself2d937f2008-04-17 20:05:37 +0200352 mutex_lock(&tty_mutex);
353 /* Search through the tty devices to look for a match */
354 list_for_each_entry(p, &tty_drivers, tty_drivers) {
Jason Wessel0dca0fd2008-09-26 10:36:42 -0500355 if (strncmp(name, p->name, len) != 0)
356 continue;
Alan Cox5f0878a2009-06-11 12:46:41 +0100357 stp = str;
358 if (*stp == ',')
359 stp++;
360 if (*stp == '\0')
361 stp = NULL;
Jason Wesself2d937f2008-04-17 20:05:37 +0200362
Nathael Pajani6eb68d62010-09-02 16:06:16 +0200363 if (tty_line >= 0 && tty_line < p->num && p->ops &&
Alan Cox5f0878a2009-06-11 12:46:41 +0100364 p->ops->poll_init && !p->ops->poll_init(p, tty_line, stp)) {
Alan Cox7d7b93c2008-10-13 10:42:09 +0100365 res = tty_driver_kref_get(p);
Jason Wesself2d937f2008-04-17 20:05:37 +0200366 *line = tty_line;
367 break;
368 }
369 }
370 mutex_unlock(&tty_mutex);
371
372 return res;
373}
374EXPORT_SYMBOL_GPL(tty_find_polling_driver);
375#endif
376
Alan Coxaf9b8972006-08-27 01:24:01 -0700377/**
378 * tty_check_change - check for POSIX terminal changes
379 * @tty: tty to check
380 *
381 * If we try to write to, or set the state of, a terminal and we're
382 * not in the foreground, send a SIGTTOU. If the signal is blocked or
383 * ignored, go ahead and perform the operation. (POSIX 7.2)
384 *
Alan Cox978e5952008-04-30 00:53:59 -0700385 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700387
Alan Cox37bdfb02008-02-08 04:18:47 -0800388int tty_check_change(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389{
Alan Cox47f86832008-04-30 00:53:30 -0700390 unsigned long flags;
391 int ret = 0;
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 if (current->signal->tty != tty)
394 return 0;
Alan Cox47f86832008-04-30 00:53:30 -0700395
396 spin_lock_irqsave(&tty->ctrl_lock, flags);
397
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800398 if (!tty->pgrp) {
399 printk(KERN_WARNING "tty_check_change: tty->pgrp == NULL!\n");
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700400 goto out_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800402 if (task_pgrp(current) == tty->pgrp)
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700403 goto out_unlock;
404 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 if (is_ignored(SIGTTOU))
Alan Cox47f86832008-04-30 00:53:30 -0700406 goto out;
407 if (is_current_pgrp_orphaned()) {
408 ret = -EIO;
409 goto out;
410 }
Oleg Nesterov040b6362007-06-01 00:46:53 -0700411 kill_pgrp(task_pgrp(current), SIGTTOU, 1);
412 set_thread_flag(TIF_SIGPENDING);
Alan Cox47f86832008-04-30 00:53:30 -0700413 ret = -ERESTARTSYS;
414out:
Andrew Morton9ffee4c2008-05-14 16:05:58 -0700415 return ret;
416out_unlock:
Alan Cox47f86832008-04-30 00:53:30 -0700417 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
418 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420
421EXPORT_SYMBOL(tty_check_change);
422
Alan Cox37bdfb02008-02-08 04:18:47 -0800423static ssize_t hung_up_tty_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 size_t count, loff_t *ppos)
425{
426 return 0;
427}
428
Alan Cox37bdfb02008-02-08 04:18:47 -0800429static ssize_t hung_up_tty_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 size_t count, loff_t *ppos)
431{
432 return -EIO;
433}
434
435/* No kernel lock held - none needed ;) */
Alan Cox37bdfb02008-02-08 04:18:47 -0800436static unsigned int hung_up_tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437{
438 return POLLIN | POLLOUT | POLLERR | POLLHUP | POLLRDNORM | POLLWRNORM;
439}
440
Alan Cox04f378b2008-04-30 00:53:29 -0700441static long hung_up_tty_ioctl(struct file *file, unsigned int cmd,
442 unsigned long arg)
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700443{
444 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
445}
446
Alan Cox37bdfb02008-02-08 04:18:47 -0800447static long hung_up_tty_compat_ioctl(struct file *file,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700448 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449{
450 return cmd == TIOCSPGRP ? -ENOTTY : -EIO;
451}
452
Arjan van de Ven62322d22006-07-03 00:24:21 -0700453static const struct file_operations tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 .llseek = no_llseek,
455 .read = tty_read,
456 .write = tty_write,
457 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700458 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700459 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 .open = tty_open,
461 .release = tty_release,
462 .fasync = tty_fasync,
463};
464
Arjan van de Ven62322d22006-07-03 00:24:21 -0700465static const struct file_operations console_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 .llseek = no_llseek,
467 .read = tty_read,
468 .write = redirected_tty_write,
469 .poll = tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700470 .unlocked_ioctl = tty_ioctl,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700471 .compat_ioctl = tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 .open = tty_open,
473 .release = tty_release,
474 .fasync = tty_fasync,
475};
476
Arjan van de Ven62322d22006-07-03 00:24:21 -0700477static const struct file_operations hung_up_tty_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 .llseek = no_llseek,
479 .read = hung_up_tty_read,
480 .write = hung_up_tty_write,
481 .poll = hung_up_tty_poll,
Alan Cox04f378b2008-04-30 00:53:29 -0700482 .unlocked_ioctl = hung_up_tty_ioctl,
Paul Fulghum38ad2ed2007-06-16 10:15:55 -0700483 .compat_ioctl = hung_up_tty_compat_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 .release = tty_release,
485};
486
487static DEFINE_SPINLOCK(redirect_lock);
488static struct file *redirect;
489
490/**
491 * tty_wakeup - request more data
492 * @tty: terminal
493 *
494 * Internal and external helper for wakeups of tty. This function
495 * informs the line discipline if present that the driver is ready
496 * to receive more output data.
497 */
Alan Cox37bdfb02008-02-08 04:18:47 -0800498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499void tty_wakeup(struct tty_struct *tty)
500{
501 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -0800502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 if (test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) {
504 ld = tty_ldisc_ref(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800505 if (ld) {
Alan Coxa352def2008-07-16 21:53:12 +0100506 if (ld->ops->write_wakeup)
507 ld->ops->write_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 tty_ldisc_deref(ld);
509 }
510 }
Davide Libenzi4b194492009-03-31 15:24:24 -0700511 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512}
513
514EXPORT_SYMBOL_GPL(tty_wakeup);
515
516/**
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200517 * __tty_hangup - actual handler for hangup events
David Howells65f27f32006-11-22 14:55:48 +0000518 * @work: tty device
Alan Coxaf9b8972006-08-27 01:24:01 -0700519 *
Alan Cox1bad8792008-07-22 23:38:04 +0100520 * This can be called by the "eventd" kernel thread. That is process
Alan Coxaf9b8972006-08-27 01:24:01 -0700521 * synchronous but doesn't hold any locks, so we need to make sure we
522 * have the appropriate locks for what we're doing.
523 *
524 * The hangup event clears any pending redirections onto the hung up
525 * device. It ensures future writes will error and it does the needed
526 * line discipline hangup and signal delivery. The tty object itself
527 * remains intact.
528 *
529 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200530 * BTM
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800531 * redirect lock for undoing redirection
532 * file list lock for manipulating list of ttys
533 * tty_ldisc_lock from called functions
534 * termios_mutex resetting termios data
535 * tasklist_lock to walk task list for hangup event
536 * ->siglock to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200538void __tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
Alan Cox37bdfb02008-02-08 04:18:47 -0800540 struct file *cons_filp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 struct file *filp, *f = NULL;
542 struct task_struct *p;
Nick Piggind996b622010-08-18 04:37:36 +1000543 struct tty_file_private *priv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 int closecount = 0, n;
Alan Cox47f86832008-04-30 00:53:30 -0700545 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100546 int refs = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
548 if (!tty)
549 return;
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552 spin_lock(&redirect_lock);
Nick Piggind996b622010-08-18 04:37:36 +1000553 if (redirect && file_tty(redirect) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 f = redirect;
555 redirect = NULL;
556 }
557 spin_unlock(&redirect_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800558
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200559 tty_lock();
560
Arnd Bergmannec79d602010-06-01 22:53:01 +0200561 /* inuse_filps is protected by the single tty lock,
562 this really needs to change if we want to flush the
563 workqueue with the lock held */
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200564 check_tty_count(tty, "tty_hangup");
Alan Cox36ba7822009-11-30 13:18:51 +0000565
Nick Pigginee2ffa02010-08-18 04:37:35 +1000566 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 /* This breaks for file handles being sent over AF_UNIX sockets ? */
Nick Piggind996b622010-08-18 04:37:36 +1000568 list_for_each_entry(priv, &tty->tty_files, list) {
569 filp = priv->file;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 if (filp->f_op->write == redirected_tty_write)
571 cons_filp = filp;
572 if (filp->f_op->write != tty_write)
573 continue;
574 closecount++;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200575 __tty_fasync(-1, filp, 0); /* can't block */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 filp->f_op = &hung_up_tty_fops;
577 }
Nick Pigginee2ffa02010-08-18 04:37:35 +1000578 spin_unlock(&tty_files_lock);
Alan Cox37bdfb02008-02-08 04:18:47 -0800579
Alan Coxc65c9bc2009-06-11 12:50:12 +0100580 tty_ldisc_hangup(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800583 if (tty->session) {
584 do_each_pid_task(tty->session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800585 spin_lock_irq(&p->sighand->siglock);
Alan Cox9c9f4de2008-10-13 10:37:26 +0100586 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 p->signal->tty = NULL;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100588 /* We defer the dereferences outside fo
589 the tasklist lock */
590 refs++;
591 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800592 if (!p->signal->leader) {
593 spin_unlock_irq(&p->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 continue;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800595 }
596 __group_send_sig_info(SIGHUP, SEND_SIG_PRIV, p);
597 __group_send_sig_info(SIGCONT, SEND_SIG_PRIV, p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800598 put_pid(p->signal->tty_old_pgrp); /* A noop */
Alan Cox47f86832008-04-30 00:53:30 -0700599 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800600 if (tty->pgrp)
601 p->signal->tty_old_pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -0700602 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800603 spin_unlock_irq(&p->sighand->siglock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800604 } while_each_pid_task(tty->session, PIDTYPE_SID, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 }
606 read_unlock(&tasklist_lock);
607
Alan Cox47f86832008-04-30 00:53:30 -0700608 spin_lock_irqsave(&tty->ctrl_lock, flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100609 clear_bit(TTY_THROTTLED, &tty->flags);
610 clear_bit(TTY_PUSH, &tty->flags);
611 clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -0600612 put_pid(tty->session);
613 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800614 tty->session = NULL;
615 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 tty->ctrl_status = 0;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100617 set_bit(TTY_HUPPED, &tty->flags);
Alan Cox47f86832008-04-30 00:53:30 -0700618 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
619
Alan Cox9c9f4de2008-10-13 10:37:26 +0100620 /* Account for the p->signal references we killed */
621 while (refs--)
622 tty_kref_put(tty);
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 /*
Alan Cox37bdfb02008-02-08 04:18:47 -0800625 * If one of the devices matches a console pointer, we
626 * cannot just call hangup() because that will cause
627 * tty->count and state->count to go out of sync.
628 * So we just call close() the right number of times.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 */
630 if (cons_filp) {
Alan Coxf34d7a52008-04-30 00:54:13 -0700631 if (tty->ops->close)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 for (n = 0; n < closecount; n++)
Alan Coxf34d7a52008-04-30 00:54:13 -0700633 tty->ops->close(tty, cons_filp);
634 } else if (tty->ops->hangup)
635 (tty->ops->hangup)(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -0800636 /*
637 * We don't want to have driver/ldisc interactions beyond
638 * the ones we did here. The driver layer expects no
639 * calls after ->hangup() from the ldisc side. However we
640 * can't yet guarantee all that.
641 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 set_bit(TTY_HUPPED, &tty->flags);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100643 tty_ldisc_enable(tty);
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200644
645 tty_unlock();
646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 if (f)
648 fput(f);
649}
650
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200651static void do_tty_hangup(struct work_struct *work)
652{
653 struct tty_struct *tty =
654 container_of(work, struct tty_struct, hangup_work);
655
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200656 __tty_hangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200657}
658
Alan Coxaf9b8972006-08-27 01:24:01 -0700659/**
660 * tty_hangup - trigger a hangup event
661 * @tty: tty to hangup
662 *
663 * A carrier loss (virtual or otherwise) has occurred on this like
664 * schedule a hangup sequence to run after this event.
665 */
666
Alan Cox37bdfb02008-02-08 04:18:47 -0800667void tty_hangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
669#ifdef TTY_DEBUG_HANGUP
670 char buf[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 printk(KERN_DEBUG "%s hangup...\n", tty_name(tty, buf));
672#endif
673 schedule_work(&tty->hangup_work);
674}
675
676EXPORT_SYMBOL(tty_hangup);
677
Alan Coxaf9b8972006-08-27 01:24:01 -0700678/**
679 * tty_vhangup - process vhangup
680 * @tty: tty to hangup
681 *
682 * The user has asked via system call for the terminal to be hung up.
683 * We do this synchronously so that when the syscall returns the process
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200684 * is complete. That guarantee is necessary for security reasons.
Alan Coxaf9b8972006-08-27 01:24:01 -0700685 */
686
Alan Cox37bdfb02008-02-08 04:18:47 -0800687void tty_vhangup(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688{
689#ifdef TTY_DEBUG_HANGUP
690 char buf[64];
691
692 printk(KERN_DEBUG "%s vhangup...\n", tty_name(tty, buf));
693#endif
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200694 __tty_hangup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695}
Alan Cox37bdfb02008-02-08 04:18:47 -0800696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697EXPORT_SYMBOL(tty_vhangup);
698
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200699
Alan Coxaf9b8972006-08-27 01:24:01 -0700700/**
Alan Cox2cb59982008-10-13 10:40:30 +0100701 * tty_vhangup_self - process vhangup for own ctty
702 *
703 * Perform a vhangup on the current controlling tty
704 */
705
706void tty_vhangup_self(void)
707{
708 struct tty_struct *tty;
709
Alan Cox2cb59982008-10-13 10:40:30 +0100710 tty = get_current_tty();
711 if (tty) {
712 tty_vhangup(tty);
713 tty_kref_put(tty);
714 }
Alan Cox2cb59982008-10-13 10:40:30 +0100715}
716
717/**
Alan Coxaf9b8972006-08-27 01:24:01 -0700718 * tty_hung_up_p - was tty hung up
719 * @filp: file pointer of tty
720 *
721 * Return true if the tty has been subject to a vhangup or a carrier
722 * loss
723 */
724
Alan Cox37bdfb02008-02-08 04:18:47 -0800725int tty_hung_up_p(struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726{
727 return (filp->f_op == &hung_up_tty_fops);
728}
729
730EXPORT_SYMBOL(tty_hung_up_p);
731
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800732static void session_clear_tty(struct pid *session)
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800733{
734 struct task_struct *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800735 do_each_pid_task(session, PIDTYPE_SID, p) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800736 proc_clear_tty(p);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800737 } while_each_pid_task(session, PIDTYPE_SID, p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800738}
739
Alan Coxaf9b8972006-08-27 01:24:01 -0700740/**
741 * disassociate_ctty - disconnect controlling tty
742 * @on_exit: true if exiting so need to "hang up" the session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700744 * This function is typically called only by the session leader, when
745 * it wants to disassociate itself from its controlling tty.
746 *
747 * It performs the following functions:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 * (1) Sends a SIGHUP and SIGCONT to the foreground process group
749 * (2) Clears the tty from being controlling the session
750 * (3) Clears the controlling tty for all processes in the
751 * session group.
752 *
Alan Coxaf9b8972006-08-27 01:24:01 -0700753 * The argument on_exit is set to 1 if called when a process is
754 * exiting; it is 0 if called by the ioctl TIOCNOTTY.
755 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800756 * Locking:
Arnd Bergmannec79d602010-06-01 22:53:01 +0200757 * BTM is taken for hysterical raisins, and held when
758 * called from no_tty().
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800759 * tty_mutex is taken to protect tty
760 * ->siglock is taken to protect ->signal/->sighand
761 * tasklist_lock is taken to walk process list for sessions
762 * ->siglock is taken to protect ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700764
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765void disassociate_ctty(int on_exit)
766{
767 struct tty_struct *tty;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800768 struct pid *tty_pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Alan Cox5ec93d12009-11-30 13:18:45 +0000770 if (!current->signal->leader)
771 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800773 tty = get_current_tty();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 if (tty) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800775 tty_pgrp = get_pid(tty->pgrp);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200776 if (on_exit) {
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200777 if (tty->driver->type != TTY_DRIVER_TYPE_PTY)
Arnd Bergmann11dbf202010-06-18 14:58:07 +0200778 tty_vhangup(tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200779 }
Alan Cox452a00d2008-10-13 10:39:13 +0100780 tty_kref_put(tty);
Eric W. Biederman680a9672007-02-12 00:52:52 -0800781 } else if (on_exit) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800782 struct pid *old_pgrp;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800783 spin_lock_irq(&current->sighand->siglock);
784 old_pgrp = current->signal->tty_old_pgrp;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800785 current->signal->tty_old_pgrp = NULL;
Eric W. Biederman680a9672007-02-12 00:52:52 -0800786 spin_unlock_irq(&current->sighand->siglock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800787 if (old_pgrp) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800788 kill_pgrp(old_pgrp, SIGHUP, on_exit);
789 kill_pgrp(old_pgrp, SIGCONT, on_exit);
790 put_pid(old_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 return;
793 }
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800794 if (tty_pgrp) {
795 kill_pgrp(tty_pgrp, SIGHUP, on_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 if (!on_exit)
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800797 kill_pgrp(tty_pgrp, SIGCONT, on_exit);
798 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 }
800
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800801 spin_lock_irq(&current->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -0700802 put_pid(current->signal->tty_old_pgrp);
Randy Dunlap23cac8d2007-02-20 13:58:05 -0800803 current->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800804 spin_unlock_irq(&current->sighand->siglock);
805
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800806 tty = get_current_tty();
807 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -0700808 unsigned long flags;
809 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800810 put_pid(tty->session);
811 put_pid(tty->pgrp);
812 tty->session = NULL;
813 tty->pgrp = NULL;
Alan Cox47f86832008-04-30 00:53:30 -0700814 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +0100815 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800816 } else {
817#ifdef TTY_DEBUG_HANGUP
818 printk(KERN_DEBUG "error attempted to write to tty [0x%p]"
819 " = NULL", tty);
820#endif
821 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 /* Now clear signal->tty under the lock */
824 read_lock(&tasklist_lock);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800825 session_clear_tty(task_session(current));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 read_unlock(&tasklist_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827}
828
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700829/**
830 *
831 * no_tty - Ensure the current process does not have a controlling tty
832 */
833void no_tty(void)
834{
835 struct task_struct *tsk = current;
Arnd Bergmannec79d602010-06-01 22:53:01 +0200836 tty_lock();
Alan Cox5ec93d12009-11-30 13:18:45 +0000837 disassociate_ctty(0);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200838 tty_unlock();
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700839 proc_clear_tty(tsk);
840}
841
Alan Coxaf9b8972006-08-27 01:24:01 -0700842
843/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200844 * stop_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700845 * @tty: tty to stop
846 *
847 * Perform flow control to the driver. For PTY/TTY pairs we
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200848 * must also propagate the TIOCKPKT status. May be called
Alan Coxaf9b8972006-08-27 01:24:01 -0700849 * on an already stopped device and will not re-call the driver
850 * method.
851 *
852 * This functionality is used by both the line disciplines for
853 * halting incoming flow and by the driver. It may therefore be
854 * called from any context, may be under the tty atomic_write_lock
855 * but not always.
856 *
857 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700858 * Uses the tty control lock internally
Alan Coxaf9b8972006-08-27 01:24:01 -0700859 */
860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861void stop_tty(struct tty_struct *tty)
862{
Alan Cox04f378b2008-04-30 00:53:29 -0700863 unsigned long flags;
864 spin_lock_irqsave(&tty->ctrl_lock, flags);
865 if (tty->stopped) {
866 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700868 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 tty->stopped = 1;
870 if (tty->link && tty->link->packet) {
871 tty->ctrl_status &= ~TIOCPKT_START;
872 tty->ctrl_status |= TIOCPKT_STOP;
Davide Libenzi4b194492009-03-31 15:24:24 -0700873 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 }
Alan Cox04f378b2008-04-30 00:53:29 -0700875 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700876 if (tty->ops->stop)
877 (tty->ops->stop)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
879
880EXPORT_SYMBOL(stop_tty);
881
Alan Coxaf9b8972006-08-27 01:24:01 -0700882/**
Robert P. J. Daybeb7dd82007-05-09 07:14:03 +0200883 * start_tty - propagate flow control
Alan Coxaf9b8972006-08-27 01:24:01 -0700884 * @tty: tty to start
885 *
886 * Start a tty that has been stopped if at all possible. Perform
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200887 * any necessary wakeups and propagate the TIOCPKT status. If this
Alan Coxaf9b8972006-08-27 01:24:01 -0700888 * is the tty was previous stopped and is being started then the
889 * driver start method is invoked and the line discipline woken.
890 *
891 * Locking:
Alan Cox04f378b2008-04-30 00:53:29 -0700892 * ctrl_lock
Alan Coxaf9b8972006-08-27 01:24:01 -0700893 */
894
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895void start_tty(struct tty_struct *tty)
896{
Alan Cox04f378b2008-04-30 00:53:29 -0700897 unsigned long flags;
898 spin_lock_irqsave(&tty->ctrl_lock, flags);
899 if (!tty->stopped || tty->flow_stopped) {
900 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 return;
Alan Cox04f378b2008-04-30 00:53:29 -0700902 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 tty->stopped = 0;
904 if (tty->link && tty->link->packet) {
905 tty->ctrl_status &= ~TIOCPKT_STOP;
906 tty->ctrl_status |= TIOCPKT_START;
Davide Libenzi4b194492009-03-31 15:24:24 -0700907 wake_up_interruptible_poll(&tty->link->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 }
Alan Cox04f378b2008-04-30 00:53:29 -0700909 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Alan Coxf34d7a52008-04-30 00:54:13 -0700910 if (tty->ops->start)
911 (tty->ops->start)(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 /* If we have a running line discipline it may need kicking */
913 tty_wakeup(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
915
916EXPORT_SYMBOL(start_tty);
917
Alan Coxaf9b8972006-08-27 01:24:01 -0700918/**
919 * tty_read - read method for tty device files
920 * @file: pointer to tty file
921 * @buf: user buffer
922 * @count: size of user buffer
923 * @ppos: unused
924 *
925 * Perform the read system call function on this terminal device. Checks
926 * for hung up devices before calling the line discipline method.
927 *
928 * Locking:
Alan Cox47f86832008-04-30 00:53:30 -0700929 * Locks the line discipline internally while needed. Multiple
930 * read calls may be outstanding in parallel.
Alan Coxaf9b8972006-08-27 01:24:01 -0700931 */
932
Alan Cox37bdfb02008-02-08 04:18:47 -0800933static ssize_t tty_read(struct file *file, char __user *buf, size_t count,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 loff_t *ppos)
935{
936 int i;
Nick Piggind996b622010-08-18 04:37:36 +1000937 struct inode *inode = file->f_path.dentry->d_inode;
938 struct tty_struct *tty = file_tty(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 struct tty_ldisc *ld;
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 if (tty_paranoia_check(tty, inode, "tty_read"))
942 return -EIO;
943 if (!tty || (test_bit(TTY_IO_ERROR, &tty->flags)))
944 return -EIO;
945
946 /* We want to wait for the line discipline to sort out in this
947 situation */
948 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +0100949 if (ld->ops->read)
950 i = (ld->ops->read)(tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 else
952 i = -EIO;
953 tty_ldisc_deref(ld);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 if (i > 0)
955 inode->i_atime = current_fs_time(inode->i_sb);
956 return i;
957}
958
Alan Cox9c1729d2007-07-15 23:39:43 -0700959void tty_write_unlock(struct tty_struct *tty)
960{
961 mutex_unlock(&tty->atomic_write_lock);
Davide Libenzi4b194492009-03-31 15:24:24 -0700962 wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
Alan Cox9c1729d2007-07-15 23:39:43 -0700963}
964
965int tty_write_lock(struct tty_struct *tty, int ndelay)
966{
967 if (!mutex_trylock(&tty->atomic_write_lock)) {
968 if (ndelay)
969 return -EAGAIN;
970 if (mutex_lock_interruptible(&tty->atomic_write_lock))
971 return -ERESTARTSYS;
972 }
973 return 0;
974}
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976/*
977 * Split writes up in sane blocksizes to avoid
978 * denial-of-service type attacks
979 */
980static inline ssize_t do_tty_write(
981 ssize_t (*write)(struct tty_struct *, struct file *, const unsigned char *, size_t),
982 struct tty_struct *tty,
983 struct file *file,
984 const char __user *buf,
985 size_t count)
986{
Alan Cox9c1729d2007-07-15 23:39:43 -0700987 ssize_t ret, written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 unsigned int chunk;
Alan Cox37bdfb02008-02-08 04:18:47 -0800989
Alan Cox9c1729d2007-07-15 23:39:43 -0700990 ret = tty_write_lock(tty, file->f_flags & O_NDELAY);
991 if (ret < 0)
992 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
994 /*
995 * We chunk up writes into a temporary buffer. This
996 * simplifies low-level drivers immensely, since they
997 * don't have locking issues and user mode accesses.
998 *
999 * But if TTY_NO_WRITE_SPLIT is set, we should use a
1000 * big chunk-size..
1001 *
1002 * The default chunk-size is 2kB, because the NTTY
1003 * layer has problems with bigger chunks. It will
1004 * claim to be able to handle more characters than
1005 * it actually does.
Alan Coxaf9b8972006-08-27 01:24:01 -07001006 *
1007 * FIXME: This can probably go away now except that 64K chunks
1008 * are too likely to fail unless switched to vmalloc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 */
1010 chunk = 2048;
1011 if (test_bit(TTY_NO_WRITE_SPLIT, &tty->flags))
1012 chunk = 65536;
1013 if (count < chunk)
1014 chunk = count;
1015
Ingo Molnar70522e12006-03-23 03:00:31 -08001016 /* write_buf/write_cnt is protected by the atomic_write_lock mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 if (tty->write_cnt < chunk) {
Jason Wessel402fda92008-10-13 10:45:36 +01001018 unsigned char *buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
1020 if (chunk < 1024)
1021 chunk = 1024;
1022
Jason Wessel402fda92008-10-13 10:45:36 +01001023 buf_chunk = kmalloc(chunk, GFP_KERNEL);
1024 if (!buf_chunk) {
Alan Cox9c1729d2007-07-15 23:39:43 -07001025 ret = -ENOMEM;
1026 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 }
1028 kfree(tty->write_buf);
1029 tty->write_cnt = chunk;
Jason Wessel402fda92008-10-13 10:45:36 +01001030 tty->write_buf = buf_chunk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 }
1032
1033 /* Do the write .. */
1034 for (;;) {
1035 size_t size = count;
1036 if (size > chunk)
1037 size = chunk;
1038 ret = -EFAULT;
1039 if (copy_from_user(tty->write_buf, buf, size))
1040 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 ret = write(tty, file, tty->write_buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 if (ret <= 0)
1043 break;
1044 written += ret;
1045 buf += ret;
1046 count -= ret;
1047 if (!count)
1048 break;
1049 ret = -ERESTARTSYS;
1050 if (signal_pending(current))
1051 break;
1052 cond_resched();
1053 }
1054 if (written) {
Josef Sipeka7113a92006-12-08 02:36:55 -08001055 struct inode *inode = file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 inode->i_mtime = current_fs_time(inode->i_sb);
1057 ret = written;
1058 }
Alan Cox9c1729d2007-07-15 23:39:43 -07001059out:
1060 tty_write_unlock(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 return ret;
1062}
1063
Alan Cox95f9bfc2008-10-13 10:39:23 +01001064/**
1065 * tty_write_message - write a message to a certain tty, not just the console.
1066 * @tty: the destination tty_struct
1067 * @msg: the message to write
1068 *
1069 * This is used for messages that need to be redirected to a specific tty.
1070 * We don't put it into the syslog queue right now maybe in the future if
1071 * really needed.
1072 *
Arnd Bergmannec79d602010-06-01 22:53:01 +02001073 * We must still hold the BTM and test the CLOSING flag for the moment.
Alan Cox95f9bfc2008-10-13 10:39:23 +01001074 */
1075
1076void tty_write_message(struct tty_struct *tty, char *msg)
1077{
Alan Cox95f9bfc2008-10-13 10:39:23 +01001078 if (tty) {
1079 mutex_lock(&tty->atomic_write_lock);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001080 tty_lock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001081 if (tty->ops->write && !test_bit(TTY_CLOSING, &tty->flags)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001082 tty_unlock();
Alan Cox95f9bfc2008-10-13 10:39:23 +01001083 tty->ops->write(tty, msg, strlen(msg));
Alan Coxeeb89d92009-11-30 13:18:29 +00001084 } else
Arnd Bergmannec79d602010-06-01 22:53:01 +02001085 tty_unlock();
Alan Cox95f9bfc2008-10-13 10:39:23 +01001086 tty_write_unlock(tty);
1087 }
Alan Cox95f9bfc2008-10-13 10:39:23 +01001088 return;
1089}
1090
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Alan Coxaf9b8972006-08-27 01:24:01 -07001092/**
1093 * tty_write - write method for tty device file
1094 * @file: tty file pointer
1095 * @buf: user data to write
1096 * @count: bytes to write
1097 * @ppos: unused
1098 *
1099 * Write data to a tty device via the line discipline.
1100 *
1101 * Locking:
1102 * Locks the line discipline as required
1103 * Writes to the tty driver are serialized by the atomic_write_lock
1104 * and are then processed in chunks to the device. The line discipline
Joe Petersona88a69c2009-01-02 13:40:53 +00001105 * write method will not be invoked in parallel for each device.
Alan Coxaf9b8972006-08-27 01:24:01 -07001106 */
1107
Alan Cox37bdfb02008-02-08 04:18:47 -08001108static ssize_t tty_write(struct file *file, const char __user *buf,
1109 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110{
Josef Sipeka7113a92006-12-08 02:36:55 -08001111 struct inode *inode = file->f_path.dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10001112 struct tty_struct *tty = file_tty(file);
1113 struct tty_ldisc *ld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 ssize_t ret;
Alan Cox37bdfb02008-02-08 04:18:47 -08001115
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 if (tty_paranoia_check(tty, inode, "tty_write"))
1117 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001118 if (!tty || !tty->ops->write ||
Alan Cox37bdfb02008-02-08 04:18:47 -08001119 (test_bit(TTY_IO_ERROR, &tty->flags)))
1120 return -EIO;
Alan Coxf34d7a52008-04-30 00:54:13 -07001121 /* Short term debug to catch buggy drivers */
1122 if (tty->ops->write_room == NULL)
1123 printk(KERN_ERR "tty driver %s lacks a write_room method.\n",
1124 tty->driver->name);
Alan Cox37bdfb02008-02-08 04:18:47 -08001125 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001126 if (!ld->ops->write)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 ret = -EIO;
1128 else
Alan Coxa352def2008-07-16 21:53:12 +01001129 ret = do_tty_write(ld->ops->write, tty, file, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 tty_ldisc_deref(ld);
1131 return ret;
1132}
1133
Alan Cox37bdfb02008-02-08 04:18:47 -08001134ssize_t redirected_tty_write(struct file *file, const char __user *buf,
1135 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136{
1137 struct file *p = NULL;
1138
1139 spin_lock(&redirect_lock);
1140 if (redirect) {
1141 get_file(redirect);
1142 p = redirect;
1143 }
1144 spin_unlock(&redirect_lock);
1145
1146 if (p) {
1147 ssize_t res;
1148 res = vfs_write(p, buf, count, &p->f_pos);
1149 fput(p);
1150 return res;
1151 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 return tty_write(file, buf, count, ppos);
1153}
1154
1155static char ptychar[] = "pqrstuvwxyzabcde";
1156
Alan Coxaf9b8972006-08-27 01:24:01 -07001157/**
1158 * pty_line_name - generate name for a pty
1159 * @driver: the tty driver in use
1160 * @index: the minor number
1161 * @p: output buffer of at least 6 bytes
1162 *
1163 * Generate a name from a driver reference and write it to the output
1164 * buffer.
1165 *
1166 * Locking: None
1167 */
1168static void pty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169{
1170 int i = index + driver->name_base;
1171 /* ->name is initialized to "ttyp", but "tty" is expected */
1172 sprintf(p, "%s%c%x",
Alan Cox37bdfb02008-02-08 04:18:47 -08001173 driver->subtype == PTY_TYPE_SLAVE ? "tty" : driver->name,
1174 ptychar[i >> 4 & 0xf], i & 0xf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175}
1176
Alan Coxaf9b8972006-08-27 01:24:01 -07001177/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001178 * tty_line_name - generate name for a tty
Alan Coxaf9b8972006-08-27 01:24:01 -07001179 * @driver: the tty driver in use
1180 * @index: the minor number
1181 * @p: output buffer of at least 7 bytes
1182 *
1183 * Generate a name from a driver reference and write it to the output
1184 * buffer.
1185 *
1186 * Locking: None
1187 */
1188static void tty_line_name(struct tty_driver *driver, int index, char *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189{
1190 sprintf(p, "%s%d", driver->name, index + driver->name_base);
1191}
1192
Alan Cox99f1fe12008-10-13 10:42:00 +01001193/**
1194 * tty_driver_lookup_tty() - find an existing tty, if any
1195 * @driver: the driver for the tty
1196 * @idx: the minor number
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001197 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001198 * Return the tty, if found or ERR_PTR() otherwise.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001199 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001200 * Locking: tty_mutex must be held. If tty is found, the mutex must
1201 * be held until the 'fast-open' is also done. Will change once we
1202 * have refcounting in the driver and per driver locking
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001203 */
Jason Wessela47d5452009-01-02 13:43:04 +00001204static struct tty_struct *tty_driver_lookup_tty(struct tty_driver *driver,
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001205 struct inode *inode, int idx)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001206{
1207 struct tty_struct *tty;
1208
Alan Cox99f1fe12008-10-13 10:42:00 +01001209 if (driver->ops->lookup)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001210 return driver->ops->lookup(driver, inode, idx);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001211
Alan Cox8b0a88d2008-10-13 10:42:19 +01001212 tty = driver->ttys[idx];
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001213 return tty;
1214}
1215
Alan Cox99f1fe12008-10-13 10:42:00 +01001216/**
Alan Coxbf970ee2008-10-13 10:42:39 +01001217 * tty_init_termios - helper for termios setup
1218 * @tty: the tty to set up
1219 *
1220 * Initialise the termios structures for this tty. Thus runs under
1221 * the tty_mutex currently so we can be relaxed about ordering.
1222 */
1223
1224int tty_init_termios(struct tty_struct *tty)
1225{
Alan Coxfe6e29f2008-10-13 10:44:08 +01001226 struct ktermios *tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001227 int idx = tty->index;
1228
1229 tp = tty->driver->termios[idx];
Alan Coxbf970ee2008-10-13 10:42:39 +01001230 if (tp == NULL) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01001231 tp = kzalloc(sizeof(struct ktermios[2]), GFP_KERNEL);
1232 if (tp == NULL)
Alan Coxbf970ee2008-10-13 10:42:39 +01001233 return -ENOMEM;
Alan Coxbf970ee2008-10-13 10:42:39 +01001234 memcpy(tp, &tty->driver->init_termios,
1235 sizeof(struct ktermios));
1236 tty->driver->termios[idx] = tp;
Alan Coxbf970ee2008-10-13 10:42:39 +01001237 }
1238 tty->termios = tp;
Alan Coxfe6e29f2008-10-13 10:44:08 +01001239 tty->termios_locked = tp + 1;
Alan Coxbf970ee2008-10-13 10:42:39 +01001240
1241 /* Compatibility until drivers always set this */
1242 tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
1243 tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
1244 return 0;
1245}
Alan Coxfe1ae7f2009-09-19 13:13:33 -07001246EXPORT_SYMBOL_GPL(tty_init_termios);
Alan Coxbf970ee2008-10-13 10:42:39 +01001247
1248/**
Alan Cox8b0a88d2008-10-13 10:42:19 +01001249 * tty_driver_install_tty() - install a tty entry in the driver
1250 * @driver: the driver for the tty
1251 * @tty: the tty
1252 *
1253 * Install a tty object into the driver tables. The tty->index field
Alan Coxbf970ee2008-10-13 10:42:39 +01001254 * will be set by the time this is called. This method is responsible
1255 * for ensuring any need additional structures are allocated and
1256 * configured.
Alan Cox8b0a88d2008-10-13 10:42:19 +01001257 *
1258 * Locking: tty_mutex for now
1259 */
1260static int tty_driver_install_tty(struct tty_driver *driver,
1261 struct tty_struct *tty)
1262{
Alan Coxbf970ee2008-10-13 10:42:39 +01001263 int idx = tty->index;
Alan Coxeeb89d92009-11-30 13:18:29 +00001264 int ret;
Alan Coxbf970ee2008-10-13 10:42:39 +01001265
Alan Coxeeb89d92009-11-30 13:18:29 +00001266 if (driver->ops->install) {
Alan Coxeeb89d92009-11-30 13:18:29 +00001267 ret = driver->ops->install(driver, tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001268 return ret;
1269 }
Alan Coxbf970ee2008-10-13 10:42:39 +01001270
1271 if (tty_init_termios(tty) == 0) {
1272 tty_driver_kref_get(driver);
1273 tty->count++;
1274 driver->ttys[idx] = tty;
1275 return 0;
1276 }
1277 return -ENOMEM;
Alan Cox8b0a88d2008-10-13 10:42:19 +01001278}
1279
1280/**
1281 * tty_driver_remove_tty() - remove a tty from the driver tables
1282 * @driver: the driver for the tty
1283 * @idx: the minor number
1284 *
1285 * Remvoe a tty object from the driver tables. The tty->index field
1286 * will be set by the time this is called.
1287 *
1288 * Locking: tty_mutex for now
1289 */
1290static void tty_driver_remove_tty(struct tty_driver *driver,
1291 struct tty_struct *tty)
1292{
1293 if (driver->ops->remove)
1294 driver->ops->remove(driver, tty);
1295 else
1296 driver->ttys[tty->index] = NULL;
1297}
1298
1299/*
1300 * tty_reopen() - fast re-open of an open tty
1301 * @tty - the tty to open
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001302 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001303 * Return 0 on success, -errno on error.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001304 *
Alan Cox99f1fe12008-10-13 10:42:00 +01001305 * Locking: tty_mutex must be held from the time the tty was found
1306 * till this open completes.
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001307 */
Alan Cox99f1fe12008-10-13 10:42:00 +01001308static int tty_reopen(struct tty_struct *tty)
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001309{
1310 struct tty_driver *driver = tty->driver;
1311
1312 if (test_bit(TTY_CLOSING, &tty->flags))
1313 return -EIO;
1314
1315 if (driver->type == TTY_DRIVER_TYPE_PTY &&
1316 driver->subtype == PTY_TYPE_MASTER) {
1317 /*
1318 * special case for PTY masters: only one open permitted,
1319 * and the slave side open count is incremented as well.
1320 */
1321 if (tty->count)
1322 return -EIO;
1323
1324 tty->link->count++;
1325 }
1326 tty->count++;
1327 tty->driver = driver; /* N.B. why do this every time?? */
1328
Alan Cox1aa4bed2009-06-16 17:01:33 +01001329 mutex_lock(&tty->ldisc_mutex);
Alan Cox99f1fe12008-10-13 10:42:00 +01001330 WARN_ON(!test_bit(TTY_LDISC, &tty->flags));
Alan Cox1aa4bed2009-06-16 17:01:33 +01001331 mutex_unlock(&tty->ldisc_mutex);
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001332
1333 return 0;
1334}
1335
Alan Coxaf9b8972006-08-27 01:24:01 -07001336/**
Alan Coxd81ed102008-10-13 10:41:42 +01001337 * tty_init_dev - initialise a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001338 * @driver: tty driver we are opening a device on
1339 * @idx: device index
Alan Cox15582d32008-10-13 10:41:03 +01001340 * @ret_tty: returned tty structure
1341 * @first_ok: ok to open a new device (used by ptmx)
Alan Coxaf9b8972006-08-27 01:24:01 -07001342 *
1343 * Prepare a tty device. This may not be a "new" clean device but
1344 * could also be an active device. The pty drivers require special
1345 * handling because of this.
1346 *
1347 * Locking:
1348 * The function is called under the tty_mutex, which
1349 * protects us from the tty struct or driver itself going away.
1350 *
1351 * On exit the tty device has the line discipline attached and
1352 * a reference count of 1. If a pair was created for pty/tty use
1353 * and the other was a pty master then it too has a reference count of 1.
1354 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 * WSH 06/09/97: Rewritten to remove races and properly clean up after a
Ingo Molnar70522e12006-03-23 03:00:31 -08001356 * failed open. The new code protects the open with a mutex, so it's
1357 * really quite straightforward. The mutex locking can probably be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 * relaxed for the (most common) case of reopening a tty.
1359 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001360
Alan Cox73ec06f2008-10-13 10:42:29 +01001361struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
1362 int first_ok)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363{
Alan Coxbf970ee2008-10-13 10:42:39 +01001364 struct tty_struct *tty;
Alan Cox73ec06f2008-10-13 10:42:29 +01001365 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366
Sukadev Bhattiprolu23499702008-10-13 10:41:51 +01001367 /* Check if pty master is being opened multiple times */
Alan Cox15582d32008-10-13 10:41:03 +01001368 if (driver->subtype == PTY_TYPE_MASTER &&
Alan Coxeeb89d92009-11-30 13:18:29 +00001369 (driver->flags & TTY_DRIVER_DEVPTS_MEM) && !first_ok) {
Alan Cox73ec06f2008-10-13 10:42:29 +01001370 return ERR_PTR(-EIO);
Alan Coxeeb89d92009-11-30 13:18:29 +00001371 }
Alan Cox73ec06f2008-10-13 10:42:29 +01001372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 /*
1374 * First time open is complex, especially for PTY devices.
1375 * This code guarantees that either everything succeeds and the
1376 * TTY is ready for operation, or else the table slots are vacated
Alan Cox37bdfb02008-02-08 04:18:47 -08001377 * and the allocated memory released. (Except that the termios
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 * and locked termios may be retained.)
1379 */
1380
Alan Cox73ec06f2008-10-13 10:42:29 +01001381 if (!try_module_get(driver->owner))
1382 return ERR_PTR(-ENODEV);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 tty = alloc_tty_struct();
Alan Cox37bdfb02008-02-08 04:18:47 -08001385 if (!tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 goto fail_no_mem;
Alan Coxbf970ee2008-10-13 10:42:39 +01001387 initialize_tty_struct(tty, driver, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
Alan Cox73ec06f2008-10-13 10:42:29 +01001389 retval = tty_driver_install_tty(driver, tty);
Alan Coxbf970ee2008-10-13 10:42:39 +01001390 if (retval < 0) {
1391 free_tty_struct(tty);
1392 module_put(driver->owner);
1393 return ERR_PTR(retval);
1394 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001395
Alan Cox37bdfb02008-02-08 04:18:47 -08001396 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 * Structures all installed ... call the ldisc open routines.
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001398 * If we fail here just call release_tty to clean up. No need
1399 * to decrement the use counts, as release_tty doesn't care.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 */
Alan Coxbf970ee2008-10-13 10:42:39 +01001401 retval = tty_ldisc_setup(tty, tty->link);
Alan Cox01e1abb2008-07-22 11:16:55 +01001402 if (retval)
1403 goto release_mem_out;
Alan Cox73ec06f2008-10-13 10:42:29 +01001404 return tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406fail_no_mem:
1407 module_put(driver->owner);
Alan Cox73ec06f2008-10-13 10:42:29 +01001408 return ERR_PTR(-ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001410 /* call the tty release_tty routine to clean out this slot */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411release_mem_out:
Akinobu Mita40509142006-09-29 02:01:27 -07001412 if (printk_ratelimit())
Alan Coxd81ed102008-10-13 10:41:42 +01001413 printk(KERN_INFO "tty_init_dev: ldisc open failed, "
Akinobu Mita40509142006-09-29 02:01:27 -07001414 "clearing slot %d\n", idx);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001415 release_tty(tty, idx);
Alan Cox73ec06f2008-10-13 10:42:29 +01001416 return ERR_PTR(retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417}
1418
Alan Coxfeebed62008-10-13 10:41:30 +01001419void tty_free_termios(struct tty_struct *tty)
1420{
1421 struct ktermios *tp;
1422 int idx = tty->index;
1423 /* Kill this flag and push into drivers for locking etc */
1424 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS) {
1425 /* FIXME: Locking on ->termios array */
1426 tp = tty->termios;
1427 tty->driver->termios[idx] = NULL;
1428 kfree(tp);
Alan Coxfeebed62008-10-13 10:41:30 +01001429 }
1430}
1431EXPORT_SYMBOL(tty_free_termios);
1432
1433void tty_shutdown(struct tty_struct *tty)
1434{
Alan Cox8b0a88d2008-10-13 10:42:19 +01001435 tty_driver_remove_tty(tty->driver, tty);
Alan Coxfeebed62008-10-13 10:41:30 +01001436 tty_free_termios(tty);
1437}
1438EXPORT_SYMBOL(tty_shutdown);
1439
Alan Coxaf9b8972006-08-27 01:24:01 -07001440/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001441 * release_one_tty - release tty structure memory
Alan Cox9c9f4de2008-10-13 10:37:26 +01001442 * @kref: kref of tty we are obliterating
Alan Coxaf9b8972006-08-27 01:24:01 -07001443 *
1444 * Releases memory associated with a tty structure, and clears out the
1445 * driver table slots. This function is called when a device is no longer
1446 * in use. It also gets called when setup of a device fails.
1447 *
1448 * Locking:
1449 * tty_mutex - sometimes only
1450 * takes the file list lock internally when working on the list
1451 * of ttys that the driver keeps.
Alan Coxb50989d2009-09-19 13:13:22 -07001452 *
1453 * This method gets called from a work queue so that the driver private
Dave Youngf278a2f2009-09-27 16:00:42 +00001454 * cleanup ops can sleep (needed for USB at least)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 */
Alan Coxb50989d2009-09-19 13:13:22 -07001456static void release_one_tty(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457{
Alan Coxb50989d2009-09-19 13:13:22 -07001458 struct tty_struct *tty =
1459 container_of(work, struct tty_struct, hangup_work);
Alan Cox6f967f72008-10-13 10:37:36 +01001460 struct tty_driver *driver = tty->driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Dave Youngf278a2f2009-09-27 16:00:42 +00001462 if (tty->ops->cleanup)
1463 tty->ops->cleanup(tty);
1464
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 tty->magic = 0;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001466 tty_driver_kref_put(driver);
Alan Cox6f967f72008-10-13 10:37:36 +01001467 module_put(driver->owner);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001468
Nick Pigginee2ffa02010-08-18 04:37:35 +10001469 spin_lock(&tty_files_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 list_del_init(&tty->tty_files);
Nick Pigginee2ffa02010-08-18 04:37:35 +10001471 spin_unlock(&tty_files_lock);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001472
Oleg Nesterov6da8d862010-04-02 18:05:12 +02001473 put_pid(tty->pgrp);
1474 put_pid(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475 free_tty_struct(tty);
1476}
1477
Alan Coxb50989d2009-09-19 13:13:22 -07001478static void queue_release_one_tty(struct kref *kref)
1479{
1480 struct tty_struct *tty = container_of(kref, struct tty_struct, kref);
Dave Youngf278a2f2009-09-27 16:00:42 +00001481
1482 if (tty->ops->shutdown)
1483 tty->ops->shutdown(tty);
1484 else
1485 tty_shutdown(tty);
1486
Alan Coxb50989d2009-09-19 13:13:22 -07001487 /* The hangup queue is now free so we can reuse it rather than
1488 waste a chunk of memory for each port */
1489 INIT_WORK(&tty->hangup_work, release_one_tty);
1490 schedule_work(&tty->hangup_work);
1491}
1492
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001493/**
Alan Cox9c9f4de2008-10-13 10:37:26 +01001494 * tty_kref_put - release a tty kref
1495 * @tty: tty device
1496 *
1497 * Release a reference to a tty device and if need be let the kref
1498 * layer destruct the object for us
1499 */
1500
1501void tty_kref_put(struct tty_struct *tty)
1502{
1503 if (tty)
Alan Coxb50989d2009-09-19 13:13:22 -07001504 kref_put(&tty->kref, queue_release_one_tty);
Alan Cox9c9f4de2008-10-13 10:37:26 +01001505}
1506EXPORT_SYMBOL(tty_kref_put);
1507
1508/**
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001509 * release_tty - release tty structure memory
1510 *
1511 * Release both @tty and a possible linked partner (think pty pair),
1512 * and decrement the refcount of the backing module.
1513 *
1514 * Locking:
1515 * tty_mutex - sometimes only
1516 * takes the file list lock internally when working on the list
1517 * of ttys that the driver keeps.
1518 * FIXME: should we require tty_mutex is held here ??
Alan Cox9c9f4de2008-10-13 10:37:26 +01001519 *
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001520 */
1521static void release_tty(struct tty_struct *tty, int idx)
1522{
Alan Cox9c9f4de2008-10-13 10:37:26 +01001523 /* This should always be true but check for the moment */
1524 WARN_ON(tty->index != idx);
1525
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001526 if (tty->link)
Alan Cox9c9f4de2008-10-13 10:37:26 +01001527 tty_kref_put(tty->link);
1528 tty_kref_put(tty);
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001529}
1530
Alan Coxeeb89d92009-11-30 13:18:29 +00001531/**
1532 * tty_release - vfs callback for close
1533 * @inode: inode of tty
1534 * @filp: file pointer for handle to tty
1535 *
1536 * Called the last time each file handle is closed that references
1537 * this tty. There may however be several such references.
1538 *
1539 * Locking:
1540 * Takes bkl. See tty_release_dev
1541 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 * Even releasing the tty structures is a tricky business.. We have
1543 * to be very careful that the structures are all released at the
1544 * same time, as interrupts might otherwise get the wrong pointers.
1545 *
1546 * WSH 09/09/97: rewritten to avoid some nasty race conditions that could
1547 * lead to double frees or releasing memory still in use.
1548 */
Alan Coxeeb89d92009-11-30 13:18:29 +00001549
1550int tty_release(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551{
Nick Piggind996b622010-08-18 04:37:36 +10001552 struct tty_struct *tty = file_tty(filp);
1553 struct tty_struct *o_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 int pty_master, tty_closing, o_tty_closing, do_sleep;
Paul Fulghum14a62832006-04-10 22:54:19 -07001555 int devpts;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 int idx;
1557 char buf[64];
Alan Cox37bdfb02008-02-08 04:18:47 -08001558
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001559 if (tty_paranoia_check(tty, inode, "tty_release_dev"))
Alan Coxeeb89d92009-11-30 13:18:29 +00001560 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Arnd Bergmannec79d602010-06-01 22:53:01 +02001562 tty_lock();
Alan Coxd81ed102008-10-13 10:41:42 +01001563 check_tty_count(tty, "tty_release_dev");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Arnd Bergmannec79d602010-06-01 22:53:01 +02001565 __tty_fasync(-1, filp, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
1567 idx = tty->index;
1568 pty_master = (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1569 tty->driver->subtype == PTY_TYPE_MASTER);
1570 devpts = (tty->driver->flags & TTY_DRIVER_DEVPTS_MEM) != 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 o_tty = tty->link;
1572
1573#ifdef TTY_PARANOIA_CHECK
1574 if (idx < 0 || idx >= tty->driver->num) {
Alan Coxd81ed102008-10-13 10:41:42 +01001575 printk(KERN_DEBUG "tty_release_dev: bad idx when trying to "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 "free (%s)\n", tty->name);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001577 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001578 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 }
Alan Cox8b0a88d2008-10-13 10:42:19 +01001580 if (!devpts) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 if (tty != tty->driver->ttys[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001582 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001583 printk(KERN_DEBUG "tty_release_dev: driver.table[%d] not tty "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 "for (%s)\n", idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001585 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 }
1587 if (tty->termios != tty->driver->termios[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001588 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001589 printk(KERN_DEBUG "tty_release_dev: driver.termios[%d] not termios "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 "for (%s)\n",
1591 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001592 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 }
1595#endif
1596
1597#ifdef TTY_DEBUG_HANGUP
Alan Coxd81ed102008-10-13 10:41:42 +01001598 printk(KERN_DEBUG "tty_release_dev of %s (tty count=%d)...",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 tty_name(tty, buf), tty->count);
1600#endif
1601
1602#ifdef TTY_PARANOIA_CHECK
1603 if (tty->driver->other &&
1604 !(tty->driver->flags & TTY_DRIVER_DEVPTS_MEM)) {
1605 if (o_tty != tty->driver->other->ttys[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001606 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001607 printk(KERN_DEBUG "tty_release_dev: other->table[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 "not o_tty for (%s)\n",
1609 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001610 return 0 ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 }
1612 if (o_tty->termios != tty->driver->other->termios[idx]) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001613 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001614 printk(KERN_DEBUG "tty_release_dev: other->termios[%d] "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 "not o_termios for (%s)\n",
1616 idx, tty->name);
Alan Coxeeb89d92009-11-30 13:18:29 +00001617 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 if (o_tty->link != tty) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001620 tty_unlock();
Alan Coxd81ed102008-10-13 10:41:42 +01001621 printk(KERN_DEBUG "tty_release_dev: bad pty pointers\n");
Alan Coxeeb89d92009-11-30 13:18:29 +00001622 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623 }
1624 }
1625#endif
Alan Coxf34d7a52008-04-30 00:54:13 -07001626 if (tty->ops->close)
1627 tty->ops->close(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Arnd Bergmannec79d602010-06-01 22:53:01 +02001629 tty_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630 /*
1631 * Sanity check: if tty->count is going to zero, there shouldn't be
1632 * any waiters on tty->read_wait or tty->write_wait. We test the
1633 * wait queues and kick everyone out _before_ actually starting to
1634 * close. This ensures that we won't block while releasing the tty
1635 * structure.
1636 *
1637 * The test for the o_tty closing is necessary, since the master and
1638 * slave sides may close in any order. If the slave side closes out
1639 * first, its count will be one, since the master side holds an open.
1640 * Thus this test wouldn't be triggered at the time the slave closes,
1641 * so we do it now.
1642 *
1643 * Note that it's possible for the tty to be opened again while we're
1644 * flushing out waiters. By recalculating the closing flags before
1645 * each iteration we avoid any problems.
1646 */
1647 while (1) {
1648 /* Guard against races with tty->count changes elsewhere and
1649 opens on /dev/tty */
Alan Cox37bdfb02008-02-08 04:18:47 -08001650
Ingo Molnar70522e12006-03-23 03:00:31 -08001651 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001652 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 tty_closing = tty->count <= 1;
1654 o_tty_closing = o_tty &&
1655 (o_tty->count <= (pty_master ? 1 : 0));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656 do_sleep = 0;
1657
1658 if (tty_closing) {
1659 if (waitqueue_active(&tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001660 wake_up_poll(&tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 do_sleep++;
1662 }
1663 if (waitqueue_active(&tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001664 wake_up_poll(&tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 do_sleep++;
1666 }
1667 }
1668 if (o_tty_closing) {
1669 if (waitqueue_active(&o_tty->read_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001670 wake_up_poll(&o_tty->read_wait, POLLIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 do_sleep++;
1672 }
1673 if (waitqueue_active(&o_tty->write_wait)) {
Davide Libenzi4b194492009-03-31 15:24:24 -07001674 wake_up_poll(&o_tty->write_wait, POLLOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 do_sleep++;
1676 }
1677 }
1678 if (!do_sleep)
1679 break;
1680
Alan Coxd81ed102008-10-13 10:41:42 +01001681 printk(KERN_WARNING "tty_release_dev: %s: read/write wait queue "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 "active!\n", tty_name(tty, buf));
Arnd Bergmannec79d602010-06-01 22:53:01 +02001683 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001684 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 schedule();
Alan Cox37bdfb02008-02-08 04:18:47 -08001686 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
1688 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08001689 * The closing flags are now consistent with the open counts on
1690 * both sides, and we've completed the last operation that could
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 * block, so it's safe to proceed with closing.
1692 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 if (pty_master) {
1694 if (--o_tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001695 printk(KERN_WARNING "tty_release_dev: bad pty slave count "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 "(%d) for %s\n",
1697 o_tty->count, tty_name(o_tty, buf));
1698 o_tty->count = 0;
1699 }
1700 }
1701 if (--tty->count < 0) {
Alan Coxd81ed102008-10-13 10:41:42 +01001702 printk(KERN_WARNING "tty_release_dev: bad tty->count (%d) for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 tty->count, tty_name(tty, buf));
1704 tty->count = 0;
1705 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001706
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 /*
1708 * We've decremented tty->count, so we need to remove this file
1709 * descriptor off the tty->tty_files list; this serves two
1710 * purposes:
1711 * - check_tty_count sees the correct number of file descriptors
1712 * associated with this tty.
1713 * - do_tty_hangup no longer sees this file descriptor as
1714 * something that needs to be handled for hangups.
1715 */
Nick Piggind996b622010-08-18 04:37:36 +10001716 tty_del_file(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
1718 /*
1719 * Perform some housekeeping before deciding whether to return.
1720 *
1721 * Set the TTY_CLOSING flag if this was the last open. In the
1722 * case of a pty we may have to wait around for the other side
1723 * to close, and TTY_CLOSING makes sure we can't be reopened.
1724 */
Alan Cox37bdfb02008-02-08 04:18:47 -08001725 if (tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 set_bit(TTY_CLOSING, &tty->flags);
Alan Cox37bdfb02008-02-08 04:18:47 -08001727 if (o_tty_closing)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 set_bit(TTY_CLOSING, &o_tty->flags);
1729
1730 /*
1731 * If _either_ side is closing, make sure there aren't any
1732 * processes that still think tty or o_tty is their controlling
1733 * tty.
1734 */
1735 if (tty_closing || o_tty_closing) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001737 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 if (o_tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001739 session_clear_tty(o_tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 read_unlock(&tasklist_lock);
1741 }
1742
Ingo Molnar70522e12006-03-23 03:00:31 -08001743 mutex_unlock(&tty_mutex);
Paul Fulghumda965822006-02-14 13:53:00 -08001744
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 /* check whether both sides are closing ... */
Alan Coxeeb89d92009-11-30 13:18:29 +00001746 if (!tty_closing || (o_tty && !o_tty_closing)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001747 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001748 return 0;
1749 }
Alan Cox37bdfb02008-02-08 04:18:47 -08001750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751#ifdef TTY_DEBUG_HANGUP
1752 printk(KERN_DEBUG "freeing tty structure...");
1753#endif
1754 /*
Alan Cox01e1abb2008-07-22 11:16:55 +01001755 * Ask the line discipline code to release its structures
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 */
Alan Cox01e1abb2008-07-22 11:16:55 +01001757 tty_ldisc_release(tty, o_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 /*
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001759 * The release_tty function takes care of the details of clearing
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 * the slots and preserving the termios structure.
1761 */
Christoph Hellwigd5698c22007-02-10 01:46:46 -08001762 release_tty(tty, idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 /* Make this pty number available for reallocation */
Sukadev Bhattiprolu718a9162008-04-30 00:54:21 -07001765 if (devpts)
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001766 devpts_kill_index(inode, idx);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001767 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001768 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769}
1770
Alan Coxaf9b8972006-08-27 01:24:01 -07001771/**
Alan Coxeeb89d92009-11-30 13:18:29 +00001772 * tty_open - open a tty device
Alan Coxaf9b8972006-08-27 01:24:01 -07001773 * @inode: inode of device file
1774 * @filp: file pointer to tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001776 * tty_open and tty_release keep up the tty count that contains the
1777 * number of opens done on a tty. We cannot use the inode-count, as
1778 * different inodes might point to the same tty.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 *
Alan Coxaf9b8972006-08-27 01:24:01 -07001780 * Open-counting is needed for pty masters, as well as for keeping
1781 * track of serial lines: DTR is dropped when the last close happens.
1782 * (This is not done solely through tty->count, now. - Ted 1/27/92)
1783 *
1784 * The termios state of a pty is reset on first open so that
1785 * settings don't persist across reuse.
1786 *
Alan Coxd81ed102008-10-13 10:41:42 +01001787 * Locking: tty_mutex protects tty, get_tty_driver and tty_init_dev work.
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001788 * tty->count should protect the rest.
1789 * ->siglock protects ->signal/->sighand
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 */
Alan Coxaf9b8972006-08-27 01:24:01 -07001791
Alan Coxeeb89d92009-11-30 13:18:29 +00001792static int tty_open(struct inode *inode, struct file *filp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793{
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001794 struct tty_struct *tty = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 int noctty, retval;
1796 struct tty_driver *driver;
1797 int index;
1798 dev_t device = inode->i_rdev;
Andrew Morton846c1512009-04-02 16:56:36 -07001799 unsigned saved_flags = filp->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
1801 nonseekable_open(inode, filp);
Alan Cox37bdfb02008-02-08 04:18:47 -08001802
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803retry_open:
1804 noctty = filp->f_flags & O_NOCTTY;
1805 index = -1;
1806 retval = 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001807
Ingo Molnar70522e12006-03-23 03:00:31 -08001808 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001809 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
Alan Cox37bdfb02008-02-08 04:18:47 -08001811 if (device == MKDEV(TTYAUX_MAJOR, 0)) {
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001812 tty = get_current_tty();
1813 if (!tty) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001814 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001815 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 return -ENXIO;
1817 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01001818 driver = tty_driver_kref_get(tty->driver);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001819 index = tty->index;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 filp->f_flags |= O_NONBLOCK; /* Don't let /dev/tty block */
1821 /* noctty = 1; */
Alan Cox452a00d2008-10-13 10:39:13 +01001822 /* FIXME: Should we take a driver reference ? */
1823 tty_kref_put(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 goto got_driver;
1825 }
1826#ifdef CONFIG_VT
Alan Cox37bdfb02008-02-08 04:18:47 -08001827 if (device == MKDEV(TTY_MAJOR, 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 extern struct tty_driver *console_driver;
Alan Cox7d7b93c2008-10-13 10:42:09 +01001829 driver = tty_driver_kref_get(console_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 index = fg_console;
1831 noctty = 1;
1832 goto got_driver;
1833 }
1834#endif
Alan Cox37bdfb02008-02-08 04:18:47 -08001835 if (device == MKDEV(TTYAUX_MAJOR, 1)) {
Will Newton296fa7f2008-12-01 11:36:06 +00001836 struct tty_driver *console_driver = console_device(&index);
1837 if (console_driver) {
1838 driver = tty_driver_kref_get(console_driver);
1839 if (driver) {
1840 /* Don't let /dev/console block */
1841 filp->f_flags |= O_NONBLOCK;
1842 noctty = 1;
1843 goto got_driver;
1844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 }
Arnd Bergmannec79d602010-06-01 22:53:01 +02001846 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001847 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 return -ENODEV;
1849 }
1850
1851 driver = get_tty_driver(device, &index);
1852 if (!driver) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001853 tty_unlock();
Ingo Molnar70522e12006-03-23 03:00:31 -08001854 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 return -ENODEV;
1856 }
1857got_driver:
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001858 if (!tty) {
1859 /* check whether we're reopening an existing tty */
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +01001860 tty = tty_driver_lookup_tty(driver, inode, index);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001861
Eric Paris808ffa32009-01-27 11:50:37 +00001862 if (IS_ERR(tty)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001863 tty_unlock();
Eric Paris808ffa32009-01-27 11:50:37 +00001864 mutex_unlock(&tty_mutex);
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001865 return PTR_ERR(tty);
Eric Paris808ffa32009-01-27 11:50:37 +00001866 }
Sukadev Bhattiprolu4a2b5fd2008-10-13 10:42:49 +01001867 }
1868
1869 if (tty) {
1870 retval = tty_reopen(tty);
1871 if (retval)
1872 tty = ERR_PTR(retval);
1873 } else
1874 tty = tty_init_dev(driver, index, 0);
1875
Ingo Molnar70522e12006-03-23 03:00:31 -08001876 mutex_unlock(&tty_mutex);
Alan Cox7d7b93c2008-10-13 10:42:09 +01001877 tty_driver_kref_put(driver);
Alan Coxeeb89d92009-11-30 13:18:29 +00001878 if (IS_ERR(tty)) {
Arnd Bergmannec79d602010-06-01 22:53:01 +02001879 tty_unlock();
Alan Cox73ec06f2008-10-13 10:42:29 +01001880 return PTR_ERR(tty);
Alan Coxeeb89d92009-11-30 13:18:29 +00001881 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882
Pekka Enbergf573bd12010-08-24 07:48:34 +03001883 retval = tty_add_file(tty, filp);
1884 if (retval) {
1885 tty_unlock();
1886 return retval;
1887 }
Nick Piggind996b622010-08-18 04:37:36 +10001888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 check_tty_count(tty, "tty_open");
1890 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
1891 tty->driver->subtype == PTY_TYPE_MASTER)
1892 noctty = 1;
1893#ifdef TTY_DEBUG_HANGUP
1894 printk(KERN_DEBUG "opening %s...", tty->name);
1895#endif
1896 if (!retval) {
Alan Coxf34d7a52008-04-30 00:54:13 -07001897 if (tty->ops->open)
1898 retval = tty->ops->open(tty, filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 else
1900 retval = -ENODEV;
1901 }
1902 filp->f_flags = saved_flags;
1903
Alan Cox37bdfb02008-02-08 04:18:47 -08001904 if (!retval && test_bit(TTY_EXCLUSIVE, &tty->flags) &&
1905 !capable(CAP_SYS_ADMIN))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 retval = -EBUSY;
1907
1908 if (retval) {
1909#ifdef TTY_DEBUG_HANGUP
1910 printk(KERN_DEBUG "error %d in opening %s...", retval,
1911 tty->name);
1912#endif
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001913 tty_unlock(); /* need to call tty_release without BTM */
Alan Coxeeb89d92009-11-30 13:18:29 +00001914 tty_release(inode, filp);
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001915 if (retval != -ERESTARTSYS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001917
1918 if (signal_pending(current))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 return retval;
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001920
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 schedule();
1922 /*
1923 * Need to reset f_op in case a hangup happened.
1924 */
Arnd Bergmann64ba3dc2010-06-01 22:53:02 +02001925 tty_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 if (filp->f_op == &hung_up_tty_fops)
1927 filp->f_op = &tty_fops;
Arnd Bergmannec79d602010-06-01 22:53:01 +02001928 tty_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 goto retry_open;
1930 }
Arnd Bergmannec79d602010-06-01 22:53:01 +02001931 tty_unlock();
Alan Coxeeb89d92009-11-30 13:18:29 +00001932
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001933
1934 mutex_lock(&tty_mutex);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001935 tty_lock();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001936 spin_lock_irq(&current->sighand->siglock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 if (!noctty &&
1938 current->signal->leader &&
1939 !current->signal->tty &&
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001940 tty->session == NULL)
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07001941 __proc_set_tty(current, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001942 spin_unlock_irq(&current->sighand->siglock);
Arnd Bergmannec79d602010-06-01 22:53:01 +02001943 tty_unlock();
Peter Zijlstra24ec8392006-12-08 02:36:04 -08001944 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 return 0;
1946}
1947
Jonathan Corbet39d95b92008-05-16 09:10:50 -06001948
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
Alan Coxaf9b8972006-08-27 01:24:01 -07001950/**
1951 * tty_poll - check tty status
1952 * @filp: file being polled
1953 * @wait: poll wait structures to update
1954 *
1955 * Call the line discipline polling method to obtain the poll
1956 * status of the device.
1957 *
1958 * Locking: locks called line discipline but ldisc poll method
1959 * may be re-entered freely by other callers.
1960 */
1961
Alan Cox37bdfb02008-02-08 04:18:47 -08001962static unsigned int tty_poll(struct file *filp, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963{
Nick Piggind996b622010-08-18 04:37:36 +10001964 struct tty_struct *tty = file_tty(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 struct tty_ldisc *ld;
1966 int ret = 0;
1967
Josef Sipeka7113a92006-12-08 02:36:55 -08001968 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_poll"))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08001970
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01001972 if (ld->ops->poll)
1973 ret = (ld->ops->poll)(tty, filp, wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 tty_ldisc_deref(ld);
1975 return ret;
1976}
1977
Arnd Bergmannec79d602010-06-01 22:53:01 +02001978static int __tty_fasync(int fd, struct file *filp, int on)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979{
Nick Piggind996b622010-08-18 04:37:36 +10001980 struct tty_struct *tty = file_tty(filp);
Alan Cox47f86832008-04-30 00:53:30 -07001981 unsigned long flags;
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001982 int retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Josef Sipeka7113a92006-12-08 02:36:55 -08001984 if (tty_paranoia_check(tty, filp->f_path.dentry->d_inode, "tty_fasync"))
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001985 goto out;
Alan Cox37bdfb02008-02-08 04:18:47 -08001986
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 retval = fasync_helper(fd, filp, on, &tty->fasync);
1988 if (retval <= 0)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06001989 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
1991 if (on) {
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001992 enum pid_type type;
1993 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 if (!waitqueue_active(&tty->read_wait))
1995 tty->minimum_to_wake = 1;
Alan Cox47f86832008-04-30 00:53:30 -07001996 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08001997 if (tty->pgrp) {
1998 pid = tty->pgrp;
1999 type = PIDTYPE_PGID;
2000 } else {
2001 pid = task_pid(current);
2002 type = PIDTYPE_PID;
2003 }
Linus Torvalds80e1e822010-02-07 10:11:23 -08002004 get_pid(pid);
Greg Kroah-Hartman70362512009-12-17 07:07:19 -08002005 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds80e1e822010-02-07 10:11:23 -08002006 retval = __f_setown(filp, pid, type, 0);
2007 put_pid(pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 if (retval)
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002009 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 } else {
2011 if (!tty->fasync && !waitqueue_active(&tty->read_wait))
2012 tty->minimum_to_wake = N_TTY_BUF_SIZE;
2013 }
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002014 retval = 0;
2015out:
Arnd Bergmannec79d602010-06-01 22:53:01 +02002016 return retval;
2017}
2018
2019static int tty_fasync(int fd, struct file *filp, int on)
2020{
2021 int retval;
2022 tty_lock();
2023 retval = __tty_fasync(fd, filp, on);
2024 tty_unlock();
Jonathan Corbet5d1e3232008-06-19 16:04:53 -06002025 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026}
2027
Alan Coxaf9b8972006-08-27 01:24:01 -07002028/**
2029 * tiocsti - fake input character
2030 * @tty: tty to fake input into
2031 * @p: pointer to character
2032 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +02002033 * Fake input to a tty device. Does the necessary locking and
Alan Coxaf9b8972006-08-27 01:24:01 -07002034 * input management.
2035 *
2036 * FIXME: does not honour flow control ??
2037 *
2038 * Locking:
2039 * Called functions take tty_ldisc_lock
2040 * current->signal->tty check is safe without locks
Alan Cox28298232006-09-29 02:00:58 -07002041 *
2042 * FIXME: may race normal receive processing
Alan Coxaf9b8972006-08-27 01:24:01 -07002043 */
2044
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045static int tiocsti(struct tty_struct *tty, char __user *p)
2046{
2047 char ch, mbz = 0;
2048 struct tty_ldisc *ld;
Alan Cox37bdfb02008-02-08 04:18:47 -08002049
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 if ((current->signal->tty != tty) && !capable(CAP_SYS_ADMIN))
2051 return -EPERM;
2052 if (get_user(ch, p))
2053 return -EFAULT;
Al Viro1e641742008-12-09 09:23:33 +00002054 tty_audit_tiocsti(tty, ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002056 ld->ops->receive_buf(tty, &ch, &mbz, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 tty_ldisc_deref(ld);
2058 return 0;
2059}
2060
Alan Coxaf9b8972006-08-27 01:24:01 -07002061/**
2062 * tiocgwinsz - implement window query ioctl
2063 * @tty; tty
2064 * @arg: user buffer for result
2065 *
Alan Cox808a0d32006-09-29 02:00:40 -07002066 * Copies the kernel idea of the window size into the user buffer.
Alan Coxaf9b8972006-08-27 01:24:01 -07002067 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002068 * Locking: tty->termios_mutex is taken to ensure the winsize data
Alan Cox808a0d32006-09-29 02:00:40 -07002069 * is consistent.
Alan Coxaf9b8972006-08-27 01:24:01 -07002070 */
2071
Alan Cox37bdfb02008-02-08 04:18:47 -08002072static int tiocgwinsz(struct tty_struct *tty, struct winsize __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073{
Alan Cox808a0d32006-09-29 02:00:40 -07002074 int err;
2075
Arjan van de Ven5785c952006-09-29 02:00:43 -07002076 mutex_lock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002077 err = copy_to_user(arg, &tty->winsize, sizeof(*arg));
Arjan van de Ven5785c952006-09-29 02:00:43 -07002078 mutex_unlock(&tty->termios_mutex);
Alan Cox808a0d32006-09-29 02:00:40 -07002079
2080 return err ? -EFAULT: 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081}
2082
Alan Coxaf9b8972006-08-27 01:24:01 -07002083/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002084 * tty_do_resize - resize event
2085 * @tty: tty being resized
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002086 * @rows: rows (character)
2087 * @cols: cols (character)
Alan Coxaf9b8972006-08-27 01:24:01 -07002088 *
Daniel Mack3ad2f3f2010-02-03 08:01:28 +08002089 * Update the termios variables and send the necessary signals to
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002090 * peform a terminal resize correctly
Alan Coxaf9b8972006-08-27 01:24:01 -07002091 */
2092
Alan Coxfc6f6232009-01-02 13:43:17 +00002093int tty_do_resize(struct tty_struct *tty, struct winsize *ws)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
Alan Coxfc6f6232009-01-02 13:43:17 +00002095 struct pid *pgrp;
Alan Cox47f86832008-04-30 00:53:30 -07002096 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097
Alan Coxfc6f6232009-01-02 13:43:17 +00002098 /* Lock the tty */
2099 mutex_lock(&tty->termios_mutex);
2100 if (!memcmp(ws, &tty->winsize, sizeof(*ws)))
Alan Coxca9bda02006-09-29 02:00:03 -07002101 goto done;
Alan Cox47f86832008-04-30 00:53:30 -07002102 /* Get the PID values and reference them so we can
2103 avoid holding the tty ctrl lock while sending signals */
2104 spin_lock_irqsave(&tty->ctrl_lock, flags);
2105 pgrp = get_pid(tty->pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002106 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2107
2108 if (pgrp)
2109 kill_pgrp(pgrp, SIGWINCH, 1);
Alan Cox47f86832008-04-30 00:53:30 -07002110 put_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002111
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002112 tty->winsize = *ws;
Alan Coxca9bda02006-09-29 02:00:03 -07002113done:
Alan Coxfc6f6232009-01-02 13:43:17 +00002114 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 return 0;
2116}
2117
Alan Coxaf9b8972006-08-27 01:24:01 -07002118/**
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002119 * tiocswinsz - implement window size set ioctl
Alan Coxfc6f6232009-01-02 13:43:17 +00002120 * @tty; tty side of tty
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002121 * @arg: user buffer for result
2122 *
2123 * Copies the user idea of the window size to the kernel. Traditionally
2124 * this is just advisory information but for the Linux console it
2125 * actually has driver level meaning and triggers a VC resize.
2126 *
2127 * Locking:
2128 * Driver dependant. The default do_resize method takes the
2129 * tty termios mutex and ctrl_lock. The console takes its own lock
2130 * then calls into the default method.
2131 */
2132
Alan Coxfc6f6232009-01-02 13:43:17 +00002133static int tiocswinsz(struct tty_struct *tty, struct winsize __user *arg)
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002134{
2135 struct winsize tmp_ws;
2136 if (copy_from_user(&tmp_ws, arg, sizeof(*arg)))
2137 return -EFAULT;
2138
2139 if (tty->ops->resize)
Alan Coxfc6f6232009-01-02 13:43:17 +00002140 return tty->ops->resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002141 else
Alan Coxfc6f6232009-01-02 13:43:17 +00002142 return tty_do_resize(tty, &tmp_ws);
Alan Cox8c9a9dd2008-08-15 10:39:38 +01002143}
2144
2145/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002146 * tioccons - allow admin to move logical console
2147 * @file: the file to become console
2148 *
2149 * Allow the adminstrator to move the redirected console device
2150 *
2151 * Locking: uses redirect_lock to guard the redirect information
2152 */
2153
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154static int tioccons(struct file *file)
2155{
2156 if (!capable(CAP_SYS_ADMIN))
2157 return -EPERM;
2158 if (file->f_op->write == redirected_tty_write) {
2159 struct file *f;
2160 spin_lock(&redirect_lock);
2161 f = redirect;
2162 redirect = NULL;
2163 spin_unlock(&redirect_lock);
2164 if (f)
2165 fput(f);
2166 return 0;
2167 }
2168 spin_lock(&redirect_lock);
2169 if (redirect) {
2170 spin_unlock(&redirect_lock);
2171 return -EBUSY;
2172 }
2173 get_file(file);
2174 redirect = file;
2175 spin_unlock(&redirect_lock);
2176 return 0;
2177}
2178
Alan Coxaf9b8972006-08-27 01:24:01 -07002179/**
2180 * fionbio - non blocking ioctl
2181 * @file: file to set blocking value
2182 * @p: user parameter
2183 *
2184 * Historical tty interfaces had a blocking control ioctl before
2185 * the generic functionality existed. This piece of history is preserved
2186 * in the expected tty API of posix OS's.
2187 *
Alan Cox6146b9a2009-09-19 13:13:19 -07002188 * Locking: none, the open file handle ensures it won't go away.
Alan Coxaf9b8972006-08-27 01:24:01 -07002189 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190
2191static int fionbio(struct file *file, int __user *p)
2192{
2193 int nonblock;
2194
2195 if (get_user(nonblock, p))
2196 return -EFAULT;
2197
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002198 spin_lock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 if (nonblock)
2200 file->f_flags |= O_NONBLOCK;
2201 else
2202 file->f_flags &= ~O_NONBLOCK;
Jonathan Corbetdb1dd4d2009-02-06 15:25:24 -07002203 spin_unlock(&file->f_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 return 0;
2205}
2206
Alan Coxaf9b8972006-08-27 01:24:01 -07002207/**
2208 * tiocsctty - set controlling tty
2209 * @tty: tty structure
2210 * @arg: user argument
2211 *
2212 * This ioctl is used to manage job control. It permits a session
2213 * leader to set this tty as the controlling tty for the session.
2214 *
2215 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002216 * Takes tty_mutex() to protect tty instance
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002217 * Takes tasklist_lock internally to walk sessions
2218 * Takes ->siglock() when updating signal->tty
Alan Coxaf9b8972006-08-27 01:24:01 -07002219 */
2220
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221static int tiocsctty(struct tty_struct *tty, int arg)
2222{
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002223 int ret = 0;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002224 if (current->signal->leader && (task_session(current) == tty->session))
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002225 return ret;
2226
2227 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 /*
2229 * The process must be a session leader and
2230 * not have a controlling tty already.
2231 */
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002232 if (!current->signal->leader || current->signal->tty) {
2233 ret = -EPERM;
2234 goto unlock;
2235 }
2236
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002237 if (tty->session) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 /*
2239 * This tty is already the controlling
2240 * tty for another session group!
2241 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002242 if (arg == 1 && capable(CAP_SYS_ADMIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 /*
2244 * Steal it away
2245 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 read_lock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002247 session_clear_tty(tty->session);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 read_unlock(&tasklist_lock);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002249 } else {
2250 ret = -EPERM;
2251 goto unlock;
2252 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002254 proc_set_tty(current, tty);
2255unlock:
Alan Cox28298232006-09-29 02:00:58 -07002256 mutex_unlock(&tty_mutex);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002257 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258}
2259
Alan Coxaf9b8972006-08-27 01:24:01 -07002260/**
Alan Cox5d0fdf12008-04-30 00:53:31 -07002261 * tty_get_pgrp - return a ref counted pgrp pid
2262 * @tty: tty to read
2263 *
2264 * Returns a refcounted instance of the pid struct for the process
2265 * group controlling the tty.
2266 */
2267
2268struct pid *tty_get_pgrp(struct tty_struct *tty)
2269{
2270 unsigned long flags;
2271 struct pid *pgrp;
2272
2273 spin_lock_irqsave(&tty->ctrl_lock, flags);
2274 pgrp = get_pid(tty->pgrp);
2275 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
2276
2277 return pgrp;
2278}
2279EXPORT_SYMBOL_GPL(tty_get_pgrp);
2280
2281/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002282 * tiocgpgrp - get process group
2283 * @tty: tty passed by user
2284 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2285 * @p: returned pid
2286 *
2287 * Obtain the process group of the tty. If there is no process group
2288 * return an error.
2289 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002290 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002291 */
2292
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293static int tiocgpgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2294{
Alan Cox5d0fdf12008-04-30 00:53:31 -07002295 struct pid *pid;
2296 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 /*
2298 * (tty == real_tty) is a cheap way of
2299 * testing if the tty is NOT a master pty.
2300 */
2301 if (tty == real_tty && current->signal->tty != real_tty)
2302 return -ENOTTY;
Alan Cox5d0fdf12008-04-30 00:53:31 -07002303 pid = tty_get_pgrp(real_tty);
2304 ret = put_user(pid_vnr(pid), p);
2305 put_pid(pid);
2306 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307}
2308
Alan Coxaf9b8972006-08-27 01:24:01 -07002309/**
2310 * tiocspgrp - attempt to set process group
2311 * @tty: tty passed by user
2312 * @real_tty: tty side device matching tty passed by user
2313 * @p: pid pointer
2314 *
2315 * Set the process group of the tty to the session passed. Only
2316 * permitted where the tty session is our session.
2317 *
Alan Cox47f86832008-04-30 00:53:30 -07002318 * Locking: RCU, ctrl lock
Alan Coxaf9b8972006-08-27 01:24:01 -07002319 */
2320
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321static int tiocspgrp(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2322{
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002323 struct pid *pgrp;
2324 pid_t pgrp_nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 int retval = tty_check_change(real_tty);
Alan Cox47f86832008-04-30 00:53:30 -07002326 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
2328 if (retval == -EIO)
2329 return -ENOTTY;
2330 if (retval)
2331 return retval;
2332 if (!current->signal->tty ||
2333 (current->signal->tty != real_tty) ||
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002334 (real_tty->session != task_session(current)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 return -ENOTTY;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002336 if (get_user(pgrp_nr, p))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 return -EFAULT;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002338 if (pgrp_nr < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 return -EINVAL;
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002340 rcu_read_lock();
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002341 pgrp = find_vpid(pgrp_nr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002342 retval = -ESRCH;
2343 if (!pgrp)
2344 goto out_unlock;
2345 retval = -EPERM;
2346 if (session_of_pgrp(pgrp) != task_session(current))
2347 goto out_unlock;
2348 retval = 0;
Alan Cox47f86832008-04-30 00:53:30 -07002349 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002350 put_pid(real_tty->pgrp);
2351 real_tty->pgrp = get_pid(pgrp);
Alan Cox47f86832008-04-30 00:53:30 -07002352 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -08002353out_unlock:
2354 rcu_read_unlock();
2355 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356}
2357
Alan Coxaf9b8972006-08-27 01:24:01 -07002358/**
2359 * tiocgsid - get session id
2360 * @tty: tty passed by user
2361 * @real_tty: tty side of the tty pased by the user if a pty else the tty
2362 * @p: pointer to returned session id
2363 *
2364 * Obtain the session id of the tty. If there is no session
2365 * return an error.
2366 *
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002367 * Locking: none. Reference to current->signal->tty is safe.
Alan Coxaf9b8972006-08-27 01:24:01 -07002368 */
2369
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370static int tiocgsid(struct tty_struct *tty, struct tty_struct *real_tty, pid_t __user *p)
2371{
2372 /*
2373 * (tty == real_tty) is a cheap way of
2374 * testing if the tty is NOT a master pty.
2375 */
2376 if (tty == real_tty && current->signal->tty != real_tty)
2377 return -ENOTTY;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002378 if (!real_tty->session)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 return -ENOTTY;
Pavel Emelyanovb4888932007-10-18 23:40:14 -07002380 return put_user(pid_vnr(real_tty->session), p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381}
2382
Alan Coxaf9b8972006-08-27 01:24:01 -07002383/**
2384 * tiocsetd - set line discipline
2385 * @tty: tty device
2386 * @p: pointer to user data
2387 *
2388 * Set the line discipline according to user request.
2389 *
2390 * Locking: see tty_set_ldisc, this function is just a helper
2391 */
2392
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393static int tiocsetd(struct tty_struct *tty, int __user *p)
2394{
2395 int ldisc;
Alan Cox04f378b2008-04-30 00:53:29 -07002396 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397
2398 if (get_user(ldisc, p))
2399 return -EFAULT;
Alan Cox04f378b2008-04-30 00:53:29 -07002400
Alan Cox04f378b2008-04-30 00:53:29 -07002401 ret = tty_set_ldisc(tty, ldisc);
Alan Cox04f378b2008-04-30 00:53:29 -07002402
2403 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404}
2405
Alan Coxaf9b8972006-08-27 01:24:01 -07002406/**
2407 * send_break - performed time break
2408 * @tty: device to break on
2409 * @duration: timeout in mS
2410 *
2411 * Perform a timed break on hardware that lacks its own driver level
2412 * timed break functionality.
2413 *
2414 * Locking:
Alan Cox28298232006-09-29 02:00:58 -07002415 * atomic_write_lock serializes
Alan Coxaf9b8972006-08-27 01:24:01 -07002416 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002417 */
2418
Domen Puncerb20f3ae2005-06-25 14:58:42 -07002419static int send_break(struct tty_struct *tty, unsigned int duration)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002420{
Alan Cox9e989662008-07-22 11:18:03 +01002421 int retval;
2422
2423 if (tty->ops->break_ctl == NULL)
2424 return 0;
2425
2426 if (tty->driver->flags & TTY_DRIVER_HARDWARE_BREAK)
2427 retval = tty->ops->break_ctl(tty, duration);
2428 else {
2429 /* Do the work ourselves */
2430 if (tty_write_lock(tty, 0) < 0)
2431 return -EINTR;
2432 retval = tty->ops->break_ctl(tty, -1);
2433 if (retval)
2434 goto out;
2435 if (!signal_pending(current))
2436 msleep_interruptible(duration);
2437 retval = tty->ops->break_ctl(tty, 0);
2438out:
2439 tty_write_unlock(tty);
2440 if (signal_pending(current))
2441 retval = -EINTR;
2442 }
2443 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444}
2445
Alan Coxaf9b8972006-08-27 01:24:01 -07002446/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002447 * tty_tiocmget - get modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002448 * @tty: tty device
2449 * @file: user file pointer
2450 * @p: pointer to result
2451 *
2452 * Obtain the modem status bits from the tty driver if the feature
2453 * is supported. Return -EINVAL if it is not available.
2454 *
2455 * Locking: none (up to the driver)
2456 */
2457
2458static int tty_tiocmget(struct tty_struct *tty, struct file *file, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459{
2460 int retval = -EINVAL;
2461
Alan Coxf34d7a52008-04-30 00:54:13 -07002462 if (tty->ops->tiocmget) {
2463 retval = tty->ops->tiocmget(tty, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
2465 if (retval >= 0)
2466 retval = put_user(retval, p);
2467 }
2468 return retval;
2469}
2470
Alan Coxaf9b8972006-08-27 01:24:01 -07002471/**
Alan Coxf34d7a52008-04-30 00:54:13 -07002472 * tty_tiocmset - set modem status
Alan Coxaf9b8972006-08-27 01:24:01 -07002473 * @tty: tty device
2474 * @file: user file pointer
2475 * @cmd: command - clear bits, set bits or set all
2476 * @p: pointer to desired bits
2477 *
2478 * Set the modem status bits from the tty driver if the feature
2479 * is supported. Return -EINVAL if it is not available.
2480 *
2481 * Locking: none (up to the driver)
2482 */
2483
2484static int tty_tiocmset(struct tty_struct *tty, struct file *file, unsigned int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485 unsigned __user *p)
2486{
Alan Coxae677512008-07-16 21:56:54 +01002487 int retval;
2488 unsigned int set, clear, val;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489
Alan Coxae677512008-07-16 21:56:54 +01002490 if (tty->ops->tiocmset == NULL)
2491 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492
Alan Coxae677512008-07-16 21:56:54 +01002493 retval = get_user(val, p);
2494 if (retval)
2495 return retval;
2496 set = clear = 0;
2497 switch (cmd) {
2498 case TIOCMBIS:
2499 set = val;
2500 break;
2501 case TIOCMBIC:
2502 clear = val;
2503 break;
2504 case TIOCMSET:
2505 set = val;
2506 clear = ~val;
2507 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508 }
Alan Coxae677512008-07-16 21:56:54 +01002509 set &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2510 clear &= TIOCM_DTR|TIOCM_RTS|TIOCM_OUT1|TIOCM_OUT2|TIOCM_LOOP;
2511 return tty->ops->tiocmset(tty, file, set, clear);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512}
2513
Alan Coxe8b70e72009-06-11 12:48:02 +01002514struct tty_struct *tty_pair_get_tty(struct tty_struct *tty)
2515{
2516 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2517 tty->driver->subtype == PTY_TYPE_MASTER)
2518 tty = tty->link;
2519 return tty;
2520}
2521EXPORT_SYMBOL(tty_pair_get_tty);
2522
2523struct tty_struct *tty_pair_get_pty(struct tty_struct *tty)
2524{
2525 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
2526 tty->driver->subtype == PTY_TYPE_MASTER)
2527 return tty;
2528 return tty->link;
2529}
2530EXPORT_SYMBOL(tty_pair_get_pty);
2531
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532/*
2533 * Split this up, as gcc can choke on it otherwise..
2534 */
Alan Cox04f378b2008-04-30 00:53:29 -07002535long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536{
Nick Piggind996b622010-08-18 04:37:36 +10002537 struct tty_struct *tty = file_tty(file);
2538 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 void __user *p = (void __user *)arg;
2540 int retval;
2541 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -07002542 struct inode *inode = file->f_dentry->d_inode;
Alan Cox37bdfb02008-02-08 04:18:47 -08002543
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2545 return -EINVAL;
2546
Alan Coxe8b70e72009-06-11 12:48:02 +01002547 real_tty = tty_pair_get_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
2549 /*
2550 * Factor out some common prep work
2551 */
2552 switch (cmd) {
2553 case TIOCSETD:
2554 case TIOCSBRK:
2555 case TIOCCBRK:
2556 case TCSBRK:
Alan Cox37bdfb02008-02-08 04:18:47 -08002557 case TCSBRKP:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 retval = tty_check_change(tty);
2559 if (retval)
2560 return retval;
2561 if (cmd != TIOCCBRK) {
2562 tty_wait_until_sent(tty, 0);
2563 if (signal_pending(current))
2564 return -EINTR;
2565 }
2566 break;
2567 }
2568
Alan Cox9e989662008-07-22 11:18:03 +01002569 /*
2570 * Now do the stuff.
2571 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572 switch (cmd) {
Alan Cox37bdfb02008-02-08 04:18:47 -08002573 case TIOCSTI:
2574 return tiocsti(tty, p);
2575 case TIOCGWINSZ:
Alan Cox8f520022008-10-13 10:38:46 +01002576 return tiocgwinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002577 case TIOCSWINSZ:
Alan Coxfc6f6232009-01-02 13:43:17 +00002578 return tiocswinsz(real_tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002579 case TIOCCONS:
2580 return real_tty != tty ? -EINVAL : tioccons(file);
2581 case FIONBIO:
2582 return fionbio(file, p);
2583 case TIOCEXCL:
2584 set_bit(TTY_EXCLUSIVE, &tty->flags);
2585 return 0;
2586 case TIOCNXCL:
2587 clear_bit(TTY_EXCLUSIVE, &tty->flags);
2588 return 0;
2589 case TIOCNOTTY:
2590 if (current->signal->tty != tty)
2591 return -ENOTTY;
2592 no_tty();
2593 return 0;
2594 case TIOCSCTTY:
2595 return tiocsctty(tty, arg);
2596 case TIOCGPGRP:
2597 return tiocgpgrp(tty, real_tty, p);
2598 case TIOCSPGRP:
2599 return tiocspgrp(tty, real_tty, p);
2600 case TIOCGSID:
2601 return tiocgsid(tty, real_tty, p);
2602 case TIOCGETD:
Alan Coxc65c9bc2009-06-11 12:50:12 +01002603 return put_user(tty->ldisc->ops->num, (int __user *)p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002604 case TIOCSETD:
2605 return tiocsetd(tty, p);
Alan Cox37bdfb02008-02-08 04:18:47 -08002606 /*
2607 * Break handling
2608 */
2609 case TIOCSBRK: /* Turn break on, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002610 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002611 return tty->ops->break_ctl(tty, -1);
Alan Cox37bdfb02008-02-08 04:18:47 -08002612 return 0;
Alan Cox37bdfb02008-02-08 04:18:47 -08002613 case TIOCCBRK: /* Turn break off, unconditionally */
Alan Coxf34d7a52008-04-30 00:54:13 -07002614 if (tty->ops->break_ctl)
Alan Cox9e989662008-07-22 11:18:03 +01002615 return tty->ops->break_ctl(tty, 0);
Alan Cox37bdfb02008-02-08 04:18:47 -08002616 return 0;
2617 case TCSBRK: /* SVID version: non-zero arg --> no break */
2618 /* non-zero arg means wait for all output data
2619 * to be sent (performed above) but don't send break.
2620 * This is used by the tcdrain() termios function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621 */
Alan Cox37bdfb02008-02-08 04:18:47 -08002622 if (!arg)
2623 return send_break(tty, 250);
2624 return 0;
2625 case TCSBRKP: /* support for POSIX tcsendbreak() */
2626 return send_break(tty, arg ? arg*100 : 250);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627
Alan Cox37bdfb02008-02-08 04:18:47 -08002628 case TIOCMGET:
2629 return tty_tiocmget(tty, file, p);
2630 case TIOCMSET:
2631 case TIOCMBIC:
2632 case TIOCMBIS:
2633 return tty_tiocmset(tty, file, cmd, p);
2634 case TCFLSH:
2635 switch (arg) {
2636 case TCIFLUSH:
2637 case TCIOFLUSH:
2638 /* flush tty buffer and allow ldisc to process ioctl */
2639 tty_buffer_flush(tty);
Paul Fulghumc5c34d42007-05-12 10:36:55 -07002640 break;
Alan Cox37bdfb02008-02-08 04:18:47 -08002641 }
2642 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002644 if (tty->ops->ioctl) {
2645 retval = (tty->ops->ioctl)(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 if (retval != -ENOIOCTLCMD)
2647 return retval;
2648 }
2649 ld = tty_ldisc_ref_wait(tty);
2650 retval = -EINVAL;
Alan Coxa352def2008-07-16 21:53:12 +01002651 if (ld->ops->ioctl) {
2652 retval = ld->ops->ioctl(tty, file, cmd, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 if (retval == -ENOIOCTLCMD)
2654 retval = -EINVAL;
2655 }
2656 tty_ldisc_deref(ld);
2657 return retval;
2658}
2659
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002660#ifdef CONFIG_COMPAT
Alan Cox37bdfb02008-02-08 04:18:47 -08002661static long tty_compat_ioctl(struct file *file, unsigned int cmd,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002662 unsigned long arg)
2663{
2664 struct inode *inode = file->f_dentry->d_inode;
Nick Piggind996b622010-08-18 04:37:36 +10002665 struct tty_struct *tty = file_tty(file);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002666 struct tty_ldisc *ld;
2667 int retval = -ENOIOCTLCMD;
2668
2669 if (tty_paranoia_check(tty, inode, "tty_ioctl"))
2670 return -EINVAL;
2671
Alan Coxf34d7a52008-04-30 00:54:13 -07002672 if (tty->ops->compat_ioctl) {
2673 retval = (tty->ops->compat_ioctl)(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002674 if (retval != -ENOIOCTLCMD)
2675 return retval;
2676 }
2677
2678 ld = tty_ldisc_ref_wait(tty);
Alan Coxa352def2008-07-16 21:53:12 +01002679 if (ld->ops->compat_ioctl)
2680 retval = ld->ops->compat_ioctl(tty, file, cmd, arg);
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002681 tty_ldisc_deref(ld);
2682
2683 return retval;
2684}
2685#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686
2687/*
2688 * This implements the "Secure Attention Key" --- the idea is to
2689 * prevent trojan horses by killing all processes associated with this
2690 * tty when the user hits the "Secure Attention Key". Required for
2691 * super-paranoid applications --- see the Orange Book for more details.
Alan Cox37bdfb02008-02-08 04:18:47 -08002692 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 * This code could be nicer; ideally it should send a HUP, wait a few
2694 * seconds, then send a INT, and then a KILL signal. But you then
2695 * have to coordinate with the init process, since all processes associated
2696 * with the current tty must be dead before the new getty is allowed
2697 * to spawn.
2698 *
2699 * Now, if it would be correct ;-/ The current code has a nasty hole -
2700 * it doesn't catch files in flight. We may send the descriptor to ourselves
2701 * via AF_UNIX socket, close it and later fetch from socket. FIXME.
2702 *
2703 * Nasty bug: do_SAK is being called in interrupt context. This can
2704 * deadlock. We punt it up to process context. AKPM - 16Mar2001
2705 */
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002706void __do_SAK(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707{
2708#ifdef TTY_SOFT_SAK
2709 tty_hangup(tty);
2710#else
Eric W. Biederman652486f2006-03-28 16:11:02 -08002711 struct task_struct *g, *p;
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002712 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713 int i;
2714 struct file *filp;
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002715 struct fdtable *fdt;
Alan Cox37bdfb02008-02-08 04:18:47 -08002716
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 if (!tty)
2718 return;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08002719 session = tty->session;
Alan Cox37bdfb02008-02-08 04:18:47 -08002720
Dan Carpenterb3f13de2006-12-13 00:35:09 -08002721 tty_ldisc_flush(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
Alan Coxf34d7a52008-04-30 00:54:13 -07002723 tty_driver_flush_buffer(tty);
Alan Cox37bdfb02008-02-08 04:18:47 -08002724
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 read_lock(&tasklist_lock);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002726 /* Kill the entire session */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002727 do_each_pid_task(session, PIDTYPE_SID, p) {
Eric W. Biederman652486f2006-03-28 16:11:02 -08002728 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002729 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002730 task_pid_nr(p), p->comm);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002731 send_sig(SIGKILL, p, 1);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002732 } while_each_pid_task(session, PIDTYPE_SID, p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002733 /* Now kill any processes that happen to have the
2734 * tty open.
2735 */
2736 do_each_thread(g, p) {
2737 if (p->signal->tty == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 printk(KERN_NOTICE "SAK: killed process %d"
Oleg Nesterov1b0f7ff2009-04-02 16:58:39 -07002739 " (%s): task_session(p)==tty->session\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002740 task_pid_nr(p), p->comm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002741 send_sig(SIGKILL, p, 1);
2742 continue;
2743 }
2744 task_lock(p);
2745 if (p->files) {
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002746 /*
2747 * We don't take a ref to the file, so we must
2748 * hold ->file_lock instead.
2749 */
2750 spin_lock(&p->files->file_lock);
Dipankar Sarmabadf1662005-09-09 13:04:10 -07002751 fdt = files_fdtable(p->files);
Alan Cox37bdfb02008-02-08 04:18:47 -08002752 for (i = 0; i < fdt->max_fds; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753 filp = fcheck_files(p->files, i);
2754 if (!filp)
2755 continue;
2756 if (filp->f_op->read == tty_read &&
Nick Piggind996b622010-08-18 04:37:36 +10002757 file_tty(filp) == tty) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758 printk(KERN_NOTICE "SAK: killed process %d"
2759 " (%s): fd#%d opened to the tty\n",
Pavel Emelyanovba25f9d2007-10-18 23:40:40 -07002760 task_pid_nr(p), p->comm, i);
Eric W. Biederman20ac9432006-04-13 04:49:07 -06002761 force_sig(SIGKILL, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 break;
2763 }
2764 }
Dipankar Sarmaca99c1d2006-04-18 22:21:46 -07002765 spin_unlock(&p->files->file_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 }
2767 task_unlock(p);
Eric W. Biederman652486f2006-03-28 16:11:02 -08002768 } while_each_thread(g, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 read_unlock(&tasklist_lock);
2770#endif
2771}
2772
Eric W. Biederman8b6312f2007-02-10 01:44:34 -08002773static void do_SAK_work(struct work_struct *work)
2774{
2775 struct tty_struct *tty =
2776 container_of(work, struct tty_struct, SAK_work);
2777 __do_SAK(tty);
2778}
2779
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780/*
2781 * The tq handling here is a little racy - tty->SAK_work may already be queued.
2782 * Fortunately we don't need to worry, because if ->SAK_work is already queued,
2783 * the values which we write to it will be identical to the values which it
2784 * already has. --akpm
2785 */
2786void do_SAK(struct tty_struct *tty)
2787{
2788 if (!tty)
2789 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 schedule_work(&tty->SAK_work);
2791}
2792
2793EXPORT_SYMBOL(do_SAK);
2794
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002795static int dev_match_devt(struct device *dev, void *data)
2796{
2797 dev_t *devt = data;
2798 return dev->devt == *devt;
2799}
2800
2801/* Must put_device() after it's unused! */
2802static struct device *tty_get_device(struct tty_struct *tty)
2803{
2804 dev_t devt = tty_devnum(tty);
2805 return class_find_device(tty_class, NULL, &devt, dev_match_devt);
2806}
2807
2808
Alan Coxaf9b8972006-08-27 01:24:01 -07002809/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002810 * initialize_tty_struct
2811 * @tty: tty to initialize
2812 *
2813 * This subroutine initializes a tty structure that has been newly
2814 * allocated.
2815 *
2816 * Locking: none - tty in question must not be exposed at this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07002817 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002818
Alan Coxbf970ee2008-10-13 10:42:39 +01002819void initialize_tty_struct(struct tty_struct *tty,
2820 struct tty_driver *driver, int idx)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002821{
2822 memset(tty, 0, sizeof(struct tty_struct));
Alan Cox9c9f4de2008-10-13 10:37:26 +01002823 kref_init(&tty->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 tty->magic = TTY_MAGIC;
Alan Cox01e1abb2008-07-22 11:16:55 +01002825 tty_ldisc_init(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08002826 tty->session = NULL;
2827 tty->pgrp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828 tty->overrun_time = jiffies;
Alan Cox33f0f882006-01-09 20:54:13 -08002829 tty->buf.head = tty->buf.tail = NULL;
2830 tty_buffer_init(tty);
Arjan van de Ven5785c952006-09-29 02:00:43 -07002831 mutex_init(&tty->termios_mutex);
Alan Coxc65c9bc2009-06-11 12:50:12 +01002832 mutex_init(&tty->ldisc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 init_waitqueue_head(&tty->write_wait);
2834 init_waitqueue_head(&tty->read_wait);
David Howells65f27f32006-11-22 14:55:48 +00002835 INIT_WORK(&tty->hangup_work, do_tty_hangup);
Ingo Molnar70522e12006-03-23 03:00:31 -08002836 mutex_init(&tty->atomic_read_lock);
2837 mutex_init(&tty->atomic_write_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +00002838 mutex_init(&tty->output_lock);
2839 mutex_init(&tty->echo_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 spin_lock_init(&tty->read_lock);
Alan Cox04f378b2008-04-30 00:53:29 -07002841 spin_lock_init(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002842 INIT_LIST_HEAD(&tty->tty_files);
Eric W. Biederman7f1f86a2007-02-13 14:38:58 -07002843 INIT_WORK(&tty->SAK_work, do_SAK_work);
Alan Coxbf970ee2008-10-13 10:42:39 +01002844
2845 tty->driver = driver;
2846 tty->ops = driver->ops;
2847 tty->index = idx;
2848 tty_line_name(driver, idx, tty->name);
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +04002849 tty->dev = tty_get_device(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850}
2851
Alan Coxf34d7a52008-04-30 00:54:13 -07002852/**
2853 * tty_put_char - write one character to a tty
2854 * @tty: tty
2855 * @ch: character
2856 *
2857 * Write one byte to the tty using the provided put_char method
2858 * if present. Returns the number of characters successfully output.
2859 *
2860 * Note: the specific put_char operation in the driver layer may go
2861 * away soon. Don't call it directly, use this method
Linus Torvalds1da177e2005-04-16 15:20:36 -07002862 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002863
Alan Coxf34d7a52008-04-30 00:54:13 -07002864int tty_put_char(struct tty_struct *tty, unsigned char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865{
Alan Coxf34d7a52008-04-30 00:54:13 -07002866 if (tty->ops->put_char)
2867 return tty->ops->put_char(tty, ch);
2868 return tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002869}
Alan Coxf34d7a52008-04-30 00:54:13 -07002870EXPORT_SYMBOL_GPL(tty_put_char);
2871
Alan Coxd81ed102008-10-13 10:41:42 +01002872struct class *tty_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873
2874/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002875 * tty_register_device - register a tty device
2876 * @driver: the tty driver that describes the tty device
2877 * @index: the index in the tty driver for this tty device
2878 * @device: a struct device that is associated with this tty device.
2879 * This field is optional, if there is no known struct device
2880 * for this tty device it can be set to NULL safely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002881 *
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002882 * Returns a pointer to the struct device for this tty device
2883 * (or ERR_PTR(-EFOO) on error).
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002884 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002885 * This call is required to be made to register an individual tty device
2886 * if the tty driver's flags have the TTY_DRIVER_DYNAMIC_DEV bit set. If
2887 * that bit is not set, this function should not be called by a tty
2888 * driver.
2889 *
2890 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002892
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -07002893struct device *tty_register_device(struct tty_driver *driver, unsigned index,
2894 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895{
2896 char name[64];
2897 dev_t dev = MKDEV(driver->major, driver->minor_start) + index;
2898
2899 if (index >= driver->num) {
2900 printk(KERN_ERR "Attempt to register invalid tty line number "
2901 " (%d).\n", index);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002902 return ERR_PTR(-EINVAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903 }
2904
Linus Torvalds1da177e2005-04-16 15:20:36 -07002905 if (driver->type == TTY_DRIVER_TYPE_PTY)
2906 pty_line_name(driver, index, name);
2907 else
2908 tty_line_name(driver, index, name);
Hansjoerg Lipp1cdcb6b2006-04-22 18:36:53 +02002909
Greg Kroah-Hartman03457cd2008-07-21 20:03:34 -07002910 return device_create(tty_class, device, dev, NULL, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002912EXPORT_SYMBOL(tty_register_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002913
2914/**
Alan Coxaf9b8972006-08-27 01:24:01 -07002915 * tty_unregister_device - unregister a tty device
2916 * @driver: the tty driver that describes the tty device
2917 * @index: the index in the tty driver for this tty device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 *
Alan Coxaf9b8972006-08-27 01:24:01 -07002919 * If a tty device is registered with a call to tty_register_device() then
2920 * this function must be called when the tty device is gone.
2921 *
2922 * Locking: ??
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923 */
Alan Coxaf9b8972006-08-27 01:24:01 -07002924
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925void tty_unregister_device(struct tty_driver *driver, unsigned index)
2926{
Alan Cox37bdfb02008-02-08 04:18:47 -08002927 device_destroy(tty_class,
2928 MKDEV(driver->major, driver->minor_start) + index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930EXPORT_SYMBOL(tty_unregister_device);
2931
2932struct tty_driver *alloc_tty_driver(int lines)
2933{
2934 struct tty_driver *driver;
2935
Jean Delvare506eb992007-07-15 23:40:14 -07002936 driver = kzalloc(sizeof(struct tty_driver), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 if (driver) {
Alan Cox7d7b93c2008-10-13 10:42:09 +01002938 kref_init(&driver->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939 driver->magic = TTY_DRIVER_MAGIC;
2940 driver->num = lines;
2941 /* later we'll move allocation of tables here */
2942 }
2943 return driver;
2944}
Alan Cox7d7b93c2008-10-13 10:42:09 +01002945EXPORT_SYMBOL(alloc_tty_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002946
Alan Cox7d7b93c2008-10-13 10:42:09 +01002947static void destruct_tty_driver(struct kref *kref)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948{
Alan Cox7d7b93c2008-10-13 10:42:09 +01002949 struct tty_driver *driver = container_of(kref, struct tty_driver, kref);
2950 int i;
2951 struct ktermios *tp;
2952 void *p;
2953
2954 if (driver->flags & TTY_DRIVER_INSTALLED) {
2955 /*
2956 * Free the termios and termios_locked structures because
2957 * we don't want to get memory leaks when modular tty
2958 * drivers are removed from the kernel.
2959 */
2960 for (i = 0; i < driver->num; i++) {
2961 tp = driver->termios[i];
2962 if (tp) {
2963 driver->termios[i] = NULL;
2964 kfree(tp);
2965 }
Alan Cox7d7b93c2008-10-13 10:42:09 +01002966 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV))
2967 tty_unregister_device(driver, i);
2968 }
2969 p = driver->ttys;
2970 proc_tty_unregister_driver(driver);
2971 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01002972 driver->termios = NULL;
Alan Cox7d7b93c2008-10-13 10:42:09 +01002973 kfree(p);
2974 cdev_del(&driver->cdev);
2975 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 kfree(driver);
2977}
2978
Alan Cox7d7b93c2008-10-13 10:42:09 +01002979void tty_driver_kref_put(struct tty_driver *driver)
2980{
2981 kref_put(&driver->kref, destruct_tty_driver);
2982}
2983EXPORT_SYMBOL(tty_driver_kref_put);
2984
Jeff Dikeb68e31d2006-10-02 02:17:18 -07002985void tty_set_operations(struct tty_driver *driver,
2986 const struct tty_operations *op)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987{
Alan Coxf34d7a52008-04-30 00:54:13 -07002988 driver->ops = op;
2989};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002990EXPORT_SYMBOL(tty_set_operations);
2991
Alan Cox7d7b93c2008-10-13 10:42:09 +01002992void put_tty_driver(struct tty_driver *d)
2993{
2994 tty_driver_kref_put(d);
2995}
2996EXPORT_SYMBOL(put_tty_driver);
2997
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998/*
2999 * Called by a tty driver to register itself.
3000 */
3001int tty_register_driver(struct tty_driver *driver)
3002{
3003 int error;
Alan Cox37bdfb02008-02-08 04:18:47 -08003004 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003005 dev_t dev;
3006 void **p = NULL;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003007 struct device *d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008
Andy Whitcroft543691a62007-05-06 14:49:33 -07003009 if (!(driver->flags & TTY_DRIVER_DEVPTS_MEM) && driver->num) {
Alan Coxfe6e29f2008-10-13 10:44:08 +01003010 p = kzalloc(driver->num * 2 * sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011 if (!p)
3012 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 }
3014
3015 if (!driver->major) {
Alan Cox37bdfb02008-02-08 04:18:47 -08003016 error = alloc_chrdev_region(&dev, driver->minor_start,
3017 driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 if (!error) {
3019 driver->major = MAJOR(dev);
3020 driver->minor_start = MINOR(dev);
3021 }
3022 } else {
3023 dev = MKDEV(driver->major, driver->minor_start);
Geert Uytterhoevene5717c42007-02-20 15:45:21 +01003024 error = register_chrdev_region(dev, driver->num, driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003025 }
3026 if (error < 0) {
3027 kfree(p);
3028 return error;
3029 }
3030
3031 if (p) {
3032 driver->ttys = (struct tty_struct **)p;
Alan Coxedc6afc2006-12-08 02:38:44 -08003033 driver->termios = (struct ktermios **)(p + driver->num);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003034 } else {
3035 driver->ttys = NULL;
3036 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003037 }
3038
3039 cdev_init(&driver->cdev, &tty_fops);
3040 driver->cdev.owner = driver->owner;
3041 error = cdev_add(&driver->cdev, dev, driver->num);
3042 if (error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 unregister_chrdev_region(dev, driver->num);
3044 driver->ttys = NULL;
Alan Coxfe6e29f2008-10-13 10:44:08 +01003045 driver->termios = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003046 kfree(p);
3047 return error;
3048 }
3049
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003050 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003051 list_add(&driver->tty_drivers, &tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003052 mutex_unlock(&tty_mutex);
Alan Cox37bdfb02008-02-08 04:18:47 -08003053
3054 if (!(driver->flags & TTY_DRIVER_DYNAMIC_DEV)) {
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003055 for (i = 0; i < driver->num; i++) {
3056 d = tty_register_device(driver, i, NULL);
3057 if (IS_ERR(d)) {
3058 error = PTR_ERR(d);
3059 goto err;
3060 }
3061 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062 }
3063 proc_tty_register_driver(driver);
Alan Cox7d7b93c2008-10-13 10:42:09 +01003064 driver->flags |= TTY_DRIVER_INSTALLED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003065 return 0;
Vasiliy Kulikovb670bde2010-09-05 22:32:22 +04003066
3067err:
3068 for (i--; i >= 0; i--)
3069 tty_unregister_device(driver, i);
3070
3071 mutex_lock(&tty_mutex);
3072 list_del(&driver->tty_drivers);
3073 mutex_unlock(&tty_mutex);
3074
3075 unregister_chrdev_region(dev, driver->num);
3076 driver->ttys = NULL;
3077 driver->termios = NULL;
3078 kfree(p);
3079 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080}
3081
3082EXPORT_SYMBOL(tty_register_driver);
3083
3084/*
3085 * Called by a tty driver to unregister itself.
3086 */
3087int tty_unregister_driver(struct tty_driver *driver)
3088{
Alan Cox7d7b93c2008-10-13 10:42:09 +01003089#if 0
3090 /* FIXME */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091 if (driver->refcount)
3092 return -EBUSY;
Alan Cox7d7b93c2008-10-13 10:42:09 +01003093#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003094 unregister_chrdev_region(MKDEV(driver->major, driver->minor_start),
3095 driver->num);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003096 mutex_lock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003097 list_del(&driver->tty_drivers);
Alexey Dobriyanca509f62007-05-08 00:27:12 -07003098 mutex_unlock(&tty_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099 return 0;
3100}
Alan Cox7d7b93c2008-10-13 10:42:09 +01003101
Linus Torvalds1da177e2005-04-16 15:20:36 -07003102EXPORT_SYMBOL(tty_unregister_driver);
3103
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003104dev_t tty_devnum(struct tty_struct *tty)
3105{
3106 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
3107}
3108EXPORT_SYMBOL(tty_devnum);
3109
3110void proc_clear_tty(struct task_struct *p)
3111{
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003112 unsigned long flags;
Alan Cox9c9f4de2008-10-13 10:37:26 +01003113 struct tty_struct *tty;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003114 spin_lock_irqsave(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003115 tty = p->signal->tty;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003116 p->signal->tty = NULL;
Arjan van de Ven7c3b1dc2008-10-15 10:52:34 +01003117 spin_unlock_irqrestore(&p->sighand->siglock, flags);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003118 tty_kref_put(tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003119}
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003120
Alan Cox47f86832008-04-30 00:53:30 -07003121/* Called under the sighand lock */
3122
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003123static void __proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003124{
3125 if (tty) {
Alan Cox47f86832008-04-30 00:53:30 -07003126 unsigned long flags;
3127 /* We should not have a session or pgrp to put here but.... */
3128 spin_lock_irqsave(&tty->ctrl_lock, flags);
Eric W. Biedermand9c1e9a2007-03-18 12:45:44 -06003129 put_pid(tty->session);
3130 put_pid(tty->pgrp);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003131 tty->pgrp = get_pid(task_pgrp(tsk));
Alan Cox47f86832008-04-30 00:53:30 -07003132 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
3133 tty->session = get_pid(task_session(tsk));
Alan Cox9c9f4de2008-10-13 10:37:26 +01003134 if (tsk->signal->tty) {
3135 printk(KERN_DEBUG "tty not NULL!!\n");
3136 tty_kref_put(tsk->signal->tty);
3137 }
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003138 }
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003139 put_pid(tsk->signal->tty_old_pgrp);
Alan Cox9c9f4de2008-10-13 10:37:26 +01003140 tsk->signal->tty = tty_kref_get(tty);
Eric W. Biedermanab521dc2007-02-12 00:53:00 -08003141 tsk->signal->tty_old_pgrp = NULL;
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003142}
3143
Eric W. Biederman98a27ba2007-05-08 00:26:56 -07003144static void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty)
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003145{
3146 spin_lock_irq(&tsk->sighand->siglock);
Eric W. Biederman2a65f1d2007-05-08 00:26:53 -07003147 __proc_set_tty(tsk, tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003148 spin_unlock_irq(&tsk->sighand->siglock);
3149}
3150
3151struct tty_struct *get_current_tty(void)
3152{
3153 struct tty_struct *tty;
Alan Cox934e6eb2008-10-13 10:40:43 +01003154 unsigned long flags;
3155
3156 spin_lock_irqsave(&current->sighand->siglock, flags);
Alan Cox452a00d2008-10-13 10:39:13 +01003157 tty = tty_kref_get(current->signal->tty);
Alan Cox934e6eb2008-10-13 10:40:43 +01003158 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Peter Zijlstra24ec8392006-12-08 02:36:04 -08003159 return tty;
3160}
Heiko Carstensa311f742006-12-13 00:33:41 -08003161EXPORT_SYMBOL_GPL(get_current_tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162
Alan Coxd81ed102008-10-13 10:41:42 +01003163void tty_default_fops(struct file_operations *fops)
3164{
3165 *fops = tty_fops;
3166}
3167
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168/*
3169 * Initialize the console device. This is called *early*, so
3170 * we can't necessarily depend on lots of kernel help here.
3171 * Just do some early initializations, and do the complex setup
3172 * later.
3173 */
3174void __init console_init(void)
3175{
3176 initcall_t *call;
3177
3178 /* Setup the default TTY line discipline. */
Alan Cox01e1abb2008-07-22 11:16:55 +01003179 tty_ldisc_begin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180
3181 /*
Alan Cox37bdfb02008-02-08 04:18:47 -08003182 * set up the console device so that later boot sequences can
Linus Torvalds1da177e2005-04-16 15:20:36 -07003183 * inform about problems etc..
3184 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003185 call = __con_initcall_start;
3186 while (call < __con_initcall_end) {
3187 (*call)();
3188 call++;
3189 }
3190}
3191
Kay Sieverse454cea2009-09-18 23:01:12 +02003192static char *tty_devnode(struct device *dev, mode_t *mode)
3193{
3194 if (!mode)
3195 return NULL;
3196 if (dev->devt == MKDEV(TTYAUX_MAJOR, 0) ||
3197 dev->devt == MKDEV(TTYAUX_MAJOR, 2))
3198 *mode = 0666;
3199 return NULL;
3200}
3201
Linus Torvalds1da177e2005-04-16 15:20:36 -07003202static int __init tty_class_init(void)
3203{
gregkh@suse.de7fe845d2005-03-15 14:23:15 -08003204 tty_class = class_create(THIS_MODULE, "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205 if (IS_ERR(tty_class))
3206 return PTR_ERR(tty_class);
Kay Sieverse454cea2009-09-18 23:01:12 +02003207 tty_class->devnode = tty_devnode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003208 return 0;
3209}
3210
3211postcore_initcall(tty_class_init);
3212
3213/* 3/2004 jmc: why do these devices exist? */
3214
3215static struct cdev tty_cdev, console_cdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003216
3217/*
3218 * Ok, now we can initialize the rest of the tty devices and can count
3219 * on memory allocations, interrupts etc..
3220 */
David Howells31d1d482010-08-06 16:34:43 +01003221int __init tty_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003222{
3223 cdev_init(&tty_cdev, &tty_fops);
3224 if (cdev_add(&tty_cdev, MKDEV(TTYAUX_MAJOR, 0), 1) ||
3225 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 0), 1, "/dev/tty") < 0)
3226 panic("Couldn't register /dev/tty driver\n");
Alan Coxd81ed102008-10-13 10:41:42 +01003227 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 0), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003228 "tty");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229
3230 cdev_init(&console_cdev, &console_fops);
3231 if (cdev_add(&console_cdev, MKDEV(TTYAUX_MAJOR, 1), 1) ||
3232 register_chrdev_region(MKDEV(TTYAUX_MAJOR, 1), 1, "/dev/console") < 0)
3233 panic("Couldn't register /dev/console driver\n");
Alan Coxd81ed102008-10-13 10:41:42 +01003234 device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1), NULL,
Greg Kroah-Hartman47aa5792008-05-21 12:52:33 -07003235 "console");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236
Linus Torvalds1da177e2005-04-16 15:20:36 -07003237#ifdef CONFIG_VT
Alan Coxd81ed102008-10-13 10:41:42 +01003238 vty_init(&console_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003239#endif
3240 return 0;
3241}
David Howells31d1d482010-08-06 16:34:43 +01003242